Update api.md
This commit is contained in:
parent
364dc704b2
commit
92bd06ed81
12
docs/api.md
12
docs/api.md
|
@ -58,6 +58,12 @@ The messageData object will be converted to JSON and passed as a parsed object t
|
||||||
## Frontend
|
## Frontend
|
||||||
|
|
||||||
### events
|
### events
|
||||||
|
* `worksheetOpened`
|
||||||
|
* Called when a worksheet has been opened (probably from a file)
|
||||||
|
* Event data:
|
||||||
|
* `content` - the brief contents of the file, **can be modified**, but please don't
|
||||||
|
* `worksheetReset``
|
||||||
|
* Called when a new worksheet has been initialized
|
||||||
* `formulaRender`
|
* `formulaRender`
|
||||||
* Called before a LaTeX formula is sent to the renderer
|
* Called before a LaTeX formula is sent to the renderer
|
||||||
* Event data:
|
* Event data:
|
||||||
|
@ -65,7 +71,9 @@ The messageData object will be converted to JSON and passed as a parsed object t
|
||||||
* `pageSave`
|
* `pageSave`
|
||||||
* Called before saving the contents of a page
|
* Called before saving the contents of a page
|
||||||
* Event data:
|
* Event data:
|
||||||
|
* `pageId` - the id of the page
|
||||||
* `content` - the HTML content, **can be modified**
|
* `content` - the HTML content, **can be modified**
|
||||||
|
* `data` - page metadata object, **can be modified**
|
||||||
* `pageLoad`
|
* `pageLoad`
|
||||||
* Called before loading a page
|
* Called before loading a page
|
||||||
* Event data
|
* Event data
|
||||||
|
@ -74,4 +82,8 @@ The messageData object will be converted to JSON and passed as a parsed object t
|
||||||
* Called when a page has been loaded and is about to be shown
|
* Called when a page has been loaded and is about to be shown
|
||||||
* Event data
|
* Event data
|
||||||
* `content` - the HTML content, **can be modified**
|
* `content` - the HTML content, **can be modified**
|
||||||
|
* `pageAdd`
|
||||||
|
* Called when a page is about to be created
|
||||||
|
* Event data:
|
||||||
|
* `pageName` - the name of the new page, **can be modified**
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user