You must create a lasso selection before calling this API; otherwise the call fails.
Returns
APIResponse<boolean>:result === trueindicates the call succeeded
PluginCommAPI
setLassoBoxState
Set lasso box state.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Set lasso box state.
static setLassoBoxState(state: number): Promise<APIResponse<boolean>>;
| Parameter | Type | Description |
|---|---|---|
state | number | 0 show, 1 hide, 2 remove completely, 3 fully hide (including lasso elements) for custom toolbars |
APIResponse<boolean>:
result === true indicates the call succeededimport { PluginCommAPI } from 'sn-plugin-lib';
/**
* Example: set lasso box state.
*/
export async function exampleSetLassoBoxState() {
const res = await PluginCommAPI.setLassoBoxState(1);
if (!res.success) {
throw new Error(res.error?.message ?? 'setLassoBoxState call failed');
}
return res.result;
}