lassoElements - Supernote

This API creates or updates the current lasso selection using a rectangle (pixel coordinates). After calling it successfully, you can call other lasso-related APIs (for example getLassoRect() / getLassoElements()). The input rect must stay within the page size: left and top can be 0, and right and bottom can be equal to the maximum page size, but they must not exceed the page bounds. Get the page size through PluginFileAPI.getPageSize.

static lassoElements(rect: Rect): Promise<APIResponse<boolean>>;

Parameters

Parameter	Type	Description
`rect`	`Rect`	Selection rectangle (pixel coordinates). The rectangle must stay within the page size. `left/top` can be `0`, and `right/bottom` can be equal to the maximum page size

Returns

APIResponse<boolean>: result === true indicates the lasso selection was created successfully

Example

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

export async function exampleLassoElements() {
 const rect = { left: 100, top: 120, right: 600, bottom: 400 };
 const res = await PluginCommAPI.lassoElements(rect);
 if (!res.success) {
 throw new Error(res.error?.message ?? 'lassoElements call failed');
 }
 return res.result;
}

​Example

Example