Update api.md

This commit is contained in:
Roni Lehto 2021-04-07 19:48:20 +00:00
parent 4fbaa63794
commit c1d8951833

View File

@ -86,6 +86,37 @@ Returns the absolute path to L'Math's plugin folder
## Frontend ## Frontend
### api.getWindow() (`window`)
Returns the vanilla JS `window` object.
### api.getDocument() (`document`)
Returns the vanilla JS `window.document` object.
### api.getJQuery() (`jQuery`)
Returns the jQuery (`$`) object of the window.
### api.gui
All returned elements are **plain DOM objects**, not jQuery objects.
#### gui.getEditor()
Returns the main ContentEditable editor area (`#_editor_area`)
#### gui.getSidebar()
Returns the left-hand side sidebar (`#_work_tabs`)
#### gui.getToolbox()
Returns the main top toolbar (`#_toolbox`)
#### gui.getTextToolbar()
Returns the text toolbar (`#_bottom_row`)
#### gui.getCalc()
Returns the T'Calc addon calculator window (`#_minicalc`)
#### gui.getImageToolbox()
Returns the floating image toolbox (`#_image_editor`)
#### gui.getSpinner()
Returns the loading spinner
#### gui.getSpinnerDimmer()
Returns the loading spinner dimmer
#### gui.getDialogContainer()
Returns the special dialog container (that contains e.g. the welcome and settings dialogs)
### events ### events
* `worksheetLoading` * `worksheetLoading`
* Called when a worksheet is being loaded * Called when a worksheet is being loaded