# Supernote

## Docs

- [cancelRecognize](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/cancel-recognize.md): Cancel the ongoing recognition task initiated by [recognizeElements](/en/api-reference/supernote-plugin/plugin-comm-api/recognize-elements).
- [clearElementCache](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/clear-trail-cache.md): Clear the Android local cache for Elements. After clearing, previously obtained Element objects can no longer be used.
- [convertElement2Sticker](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/convert-trail2-sticker.md): Convert elements to a sticker.
- [createElement](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/create-trail.md): Create a new Element object.
- [deleteLassoElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/delete-lasso-data.md): Delete lasso-selected elements.
- [generateStickerThumbnail](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/generate-sticker-thumbnail.md): Generate a sticker thumbnail.
- [getCurrentFilePath](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-current-file-path.md): Get the file path of the currently opened file.
- [getCurrentPageNum](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-current-page-num.md): Get the current page index of the currently opened file.
- [getLassoElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-lasso-data.md): Get lasso data (element list). On success, accessor fields are filled.
- [getLassoElementTypeCounts](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-lasso-data-type-counts.md): Get lasso element type counts.
- [getLassoGeometries](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-lasso-geometries.md): Get lasso-selected geometries.
- [getLassoRect](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-lasso-rect.md): Get the lasso rectangle.
- [getNoteSystemTemplates](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-note-system-templates.md): Get system note templates. You can use these templates when creating note files.
- [getPenInfo](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-pen-info.md): Get current pen information.
- [getStickerSize](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/get-sticker-size.md): Get sticker size.
- [PluginCommAPI](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/index.md): Common APIs that can be called in both NOTE and DOC.
- [insertFiveStar](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/insert-five-star.md): Insert a five-point star into the current file and page (and current layer for NOTE).
- [insertGeometry](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/insert-geometry.md): Insert geometry.
- [insertSticker](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/insert-sticker.md): Insert sticker.
- [lassoElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/lasso-elements.md): Create a lasso selection for elements in a rectangle.
- [modifyLassoGeometry](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/modify-lasso-geometry.md): Modify the lasso-selected geometry.
- [recognizeElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/recognize-elements.md): Recognize elements as text.
- [recycleElement](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/recycle-trail.md): Recycle an Element object and release native Android cache on the native side.
- [reloadFile](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/reload-file.md): Reload the currently opened NOTE/DOC file.
- [resizeLassoRect](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/resize-lasso-rect.md): Resize the lasso rectangle.
- [saveStickerByLasso](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/save-sticker-by-lasso.md): Save lasso-selected strokes as a sticker.
- [setLassoBoxState](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-comm-api/set-lasso-box-state.md): Set lasso box state.
- [getCurrentDocText](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-doc-api/get-current-doc-text.md): Get text content of a page in the currently opened DOC.
- [getCurrentTotalPages](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-doc-api/get-current-total-pages.md): Get total page count of the currently opened DOC.
- [getLastSelectedText](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-doc-api/get-last-selected-text.md): Get the last selected text content.
- [PluginDocAPI](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-doc-api/index.md): DOC-related API index.
- [clearMarkElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/clear-mark-trails.md): Clear handwriting elements in a DOC file.
- [clearLayerElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/clear-page-layer-data.md): Clear elements on a specific layer of a note page.
- [createNote](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/create-note.md): Create a note file.
- [deleteElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/delete-elements.md): Delete existing page elements (only existing elements can be deleted).
- [deleteKeyWord](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/delete-key-word.md): Delete a keyword from a NOTE/DOC file.
- [deleteLayers](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/delete-layers.md): Delete layers.
- [generateMarkThumbnails](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/generate-mark-thumbnails.md): Generate a thumbnail for a DOC mark page.
- [generateNotePng](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/generate-note-png.md): Generate a PNG for a note page.
- [generateNoteTemplatePng](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/generate-note-template-png.md): Generate a background-template PNG for a note page.
- [getElement](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-element.md): Get an element from a note page by element number.
- [getElementCounts](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-element-counts.md): Get the number of elements on a note page.
- [getElementNumList](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-element-num-list.md): Get the element number list for a note page.
- [getFileMachineType](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-file-machine-type.md): Get the device type that created this note/annotation file.
- [getKeyWords](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-key-words.md): Get keywords from a NOTE/DOC file.
- [getLastElement](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-last-element.md): Get the last element of the current note page.
- [getLayers](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-layers.md): Get layer data of a note page.
- [getMarkPages](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-mark-pages.md): Get the page indices that have mark pages in a DOC file.
- [getNotePageTemplate](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-note-page-template.md): Get the template information of a note page.
- [getNoteTotalPageNum](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-note-total-page-num.md): Get the total page count of a note file.
- [getNoteType](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-note-type.md): Get a note file type.
- [getPageSize](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-page-size.md): Get page size of a file (pixels).
- [getElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-page-trails.md): Get page elements, including strokes, links, titles, TextBox elements, and five-star elements.
- [getTitles](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/get-titles.md): Get titles from a NOTE file.
- [PluginFileAPI](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/index.md): File-related API index.
- [insertKeyWord](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/insert-key-word.md): Insert keyword.
- [insertLayer](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/insert-layer.md): Insert a layer.
- [insertNotePage](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/insert-note-page.md): Insert a new page into a note file.
- [insertElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/insert-trails.md): Insert elements into a NOTE/DOC file page.
- [modifyLayers](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/modify-layers.md): Modify page layer data (non-existent layers are ignored).
- [modifyElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/modify-trails.md): Modify existing page elements (only existing elements can be modified).
- [removeNotePage](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/remove-note-page.md): Delete a page from a note file.
- [replaceElements](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/replace-trails.md): Replace all elements on a page.
- [searchFiveStars](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/search-five-stars.md): Search a file for five-star elements and return the page indices.
- [sortLayers](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-file-api/sort-layers.md): Sort layers (the first layer is on top).
- [closePluginView](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/close-plugin-view.md): Close the plugin UI.
- [getButtonState](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/get-button-state.md): Get whether a plugin button is enabled.
- [getDeviceType](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/get-device-type.md): Get devicetype.
- [getPluginDirPath](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/get-plugin-dir-path.md): Get the plugin installation directory path.
- [getPluginName](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/get-plugin-name.md): Get pluginname.
- [Overview](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/index.md): Management entry for plugin lifecycle, buttons, and event listeners.
- [init](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/init.md): Initialize the plugin environment.
- [Plugin Button Registration and Listener](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/register-button.md): Register plugin buttons and listen for button press events.
- [Config Button Registration and Listener](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/register-config-button.md): Register the plugin config button and listen for config button click events.
- [registerEventListener](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/register-event-listener.md): Register a plugin event listener.
- [registerLangListener](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/register-lang-listener.md): Listen for system language changes.
- [setButtonState](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/set-button-state.md): Enable or disable a button.
- [unregisterButton](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-manager/unregister-button.md): Unregister a plugin button.
- [getLassoLinks](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/get-lasso-link.md): Get lasso link data.
- [getLassoText](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/get-lasso-text.md): Get lasso-selected TextBox elements.
- [getLassoTitles](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/get-lasso-title.md): Get lasso-selected titles.
- [PluginNoteAPI](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/index.md): NOTE-related API index. APIs in this section can only be called in NOTE.
- [insertImage](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/insert-image.md): Insert an image into the current layer of the current note page.
- [insertText](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/insert-text.md): Insert TextBox.
- [insertTextLink](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/insert-text-link.md): Insert a text link into the main layer of the currently opened note page.
- [modifyLassoLink](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/modify-lasso-link.md): Modify link data.
- [modifyLassoText](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/modify-lasso-text.md): Modify the lasso-selected TextBox.
- [modifyLassoTitle](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/modify-lasso-title.md): Modify lasso title.
- [saveCurrentNote](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/save-current-note.md): Save the currently opened note file.
- [setLassoStrokeLink](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/set-lasso-stroke-link.md): Set lasso-selected elements as a link.
- [setLassoTitle](https://docs.supernote.com/en/api-reference/supernote-plugin/plugin-note-api/set-lasso-title.md): Set lasso-selected strokes or geometries as a title.
- [APIResponse](https://docs.supernote.com/en/api-reference/supernote-plugin/types/api-response.md): Unified API return result.
- [Geometry](https://docs.supernote.com/en/api-reference/supernote-plugin/types/geometry.md): Geometry data.
- [Overview](https://docs.supernote.com/en/api-reference/supernote-plugin/types/index.md): SDK data structures and constants.
- [KeyWord](https://docs.supernote.com/en/api-reference/supernote-plugin/types/key-word.md): Keyword data type.
- [LassoLink](https://docs.supernote.com/en/api-reference/supernote-plugin/types/lasso-link.md): Link data structure returned from lasso selections.
- [Layer](https://docs.supernote.com/en/api-reference/supernote-plugin/types/layer.md): Layer data type.
- [Link](https://docs.supernote.com/en/api-reference/supernote-plugin/types/link.md): Link element detail data structure.
- [PenInfo](https://docs.supernote.com/en/api-reference/supernote-plugin/types/pen-info.md): Pen information.
- [Picture](https://docs.supernote.com/en/api-reference/supernote-plugin/types/picture.md): Picture element data.
- [PluginButton](https://docs.supernote.com/en/api-reference/supernote-plugin/types/plugin-button.md): PluginButton data structure.
- [Point](https://docs.supernote.com/en/api-reference/supernote-plugin/types/point.md): 2D point coordinate.
- [RecogResultData](https://docs.supernote.com/en/api-reference/supernote-plugin/types/recog-result-data.md): Element recognition result data structure.
- [RecognData](https://docs.supernote.com/en/api-reference/supernote-plugin/types/recogn-data.md): Recognition point data.
- [Rect](https://docs.supernote.com/en/api-reference/supernote-plugin/types/rect.md): Rectangle region (top-left / bottom-right).
- [Size](https://docs.supernote.com/en/api-reference/supernote-plugin/types/size.md): sizeobject.
- [Stroke](https://docs.supernote.com/en/api-reference/supernote-plugin/types/stroke.md): Raw stroke data (present when an Element is a stroke).
- [Template](https://docs.supernote.com/en/api-reference/supernote-plugin/types/template.md): System note template data.
- [TextBox](https://docs.supernote.com/en/api-reference/supernote-plugin/types/text-box.md): TextBox data structure in NOTE.
- [TextLink](https://docs.supernote.com/en/api-reference/supernote-plugin/types/text-link.md): TextLink data structure (used for insertTextLink).
- [Title](https://docs.supernote.com/en/api-reference/supernote-plugin/types/title.md): Title data structure in NOTE.
- [Element](https://docs.supernote.com/en/api-reference/supernote-plugin/types/trail.md): Unified data structure for visible elements in notes/documents.
- [ElementDataAccessor](https://docs.supernote.com/en/api-reference/supernote-plugin/types/trail-data-accessor.md): Accessor for large point datasets and the point data types it provides.
- [androidPoint2Emr](https://docs.supernote.com/en/api-reference/supernote-plugin/utils/point-utils/android-point2-emr.md): Convert a screen pixel point to an EMR coordinate point.
- [emrPoint2Android](https://docs.supernote.com/en/api-reference/supernote-plugin/utils/point-utils/emr-point2-android.md): Convert an EMR coordinate point to a screen pixel point.
- [PointUtils](https://docs.supernote.com/en/api-reference/supernote-plugin/utils/point-utils/index.md): Conversion utilities between the EMR coordinate system and screen pixel coordinates.
- [Environment Setup](https://docs.supernote.com/en/environment.md): Set up React Native and Android build environments for Supernote plugin development.
- [Your First Plugin](https://docs.supernote.com/en/first-plugin.md): Create, register buttons, package, and install a minimal Supernote plugin.
- [Introduction](https://docs.supernote.com/en/index.md): Welcome to the official Supernote developer documentation. Learn how to build plugins for Supernote.
- [Coordinate System](https://docs.supernote.com/en/plugin-base/coordinate-system.md): EMR coordinate system vs pixel coordinate system: differences and conversion.
- [Element Operations](https://docs.supernote.com/en/plugin-base/file-op/element-op.md): Read, create, insert, modify, and replace Elements in NOTE/DOC files.
- [Lasso](https://docs.supernote.com/en/plugin-base/lasso.md): Workflow, data model, and common APIs for lasso selection (get/update lasso rectangle and elements).
- [Geometry](https://docs.supernote.com/en/plugin-base/plugin-comm/geometry.md): How to work with geometry elements in NOTE and DOC, with examples.
- [Translation](https://docs.supernote.com/en/plugin-base/plugin-doc/translations.md): Implement selection translation and full-page translation in DOC.
- [Links](https://docs.supernote.com/en/plugin-base/plugin-note/link.md)
- [TextBox](https://docs.supernote.com/en/plugin-base/plugin-note/textbox.md): TextBox usage in NOTE.
- [Title](https://docs.supernote.com/en/plugin-base/plugin-note/title.md): Create, read, and modify title elements in NOTE.
- [Plugin UI](https://docs.supernote.com/en/plugin-base/plugin-ui.md)
- [Plugin Principles](https://docs.supernote.com/en/principle.md): Understand the relationship between Plugin, PluginHost, and Plugin-enabled Apps, and how the system runs.

## OpenAPI Specs

- [openapi](https://docs.supernote.com/api-reference/openapi.json)