Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.supernote.com/llms.txt

Use this file to discover all available pages before exploring further.

static recognizeElements(elements: Object[] | null | undefined, size: { width: number; height: number }): Promise<APIResponse<string>>;
Parameters
ParameterTypeDescription
elementsObject[] | null | undefinedElement list (currently supports only strokes and text boxes)
size{ width: number; height: number }The note page size that elements are based on (pixels)
Returns

​
Example

import { PluginCommAPI } from 'sn-plugin-lib';

export async function exampleRecognizeElements(elements, size) {
 const res = await PluginCommAPI.recognizeElements(elements, size);
 if (!res.success) {
 throw new Error(res.error?.message ?? 'recognizeElements call failed');
 }
 return res.result;
}