recognizeElements - Supernote

The elements you pass in are typically existing elements (with uuid) obtained from getElements/getLassoElements, etc.; uuid stays the same before and after recognition. This API requires those elements to still be present in the native cache — elements that can’t be found in the cache are silently skipped instead of causing a separate error. See Element Caching and Release for details.

static recognizeElements(elements: Object[] | null | undefined, size: { width: number; height: number }): Promise<APIResponse<string>>;

Parameters

Parameter	Type	Description
`elements`	`Object[] \| null \| undefined`	Element list (currently supports only strokes and text boxes)
`size`	`{ width: number; height: number }`	The note page size that elements are based on (pixels)

Returns

APIResponse<string>: recognized text

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;
}

​Example

Example