modifyElements - Supernote

It’s recommended to first fetch the target elements with getElements, modify their fields, and pass those same objects back in, which keeps uuid unchanged. A modification goes through two independent checks: first, the element’s uuid must still be present in the native cache — if it can’t be found, that item is silently skipped without a separate error; second, the element must already exist on the target page (the “must already exist” requirement in the description above), which is a business-level check performed by the API itself. These two checks happen in sequence and are independent of each other — a uuid that can’t be found in the cache is skipped at the earlier stage and never reaches the “does it already exist on the page” check. See Element Caching and Release for details.

static modifyElements(NOTEPath: string, page: number, elements: Element[]): Promise<APIResponse<number[]>>;

Parameters

Parameter	Type	Description
`NOTEPath`	`string`	NOTE/DOC file path
`page`	`number`	Page index (starts from `0`)
`elements`	`Element[]`	Elements to modify (must already exist)

Returns

APIResponse<number[]>: result is the list of element indices modified successfully

Example

import { PluginFileAPI, ElementType, type Element } from 'sn-plugin-lib';

/**
 * Example: fetch page elements and submit a modification.
 */
export async function exampleModifyElements() {
 const NOTEPath = '/storage/emulated/0/Note/demo.note';
 const page = 0;

 const listRes = await PluginFileAPI.getElements(page, NOTEPath);
 if (!listRes.success) {
 throw new Error(listRes.error?.message ?? 'getElements call failed');
 }

 const elements = (listRes.result ?? []) as Element[];
 const target = elements[0];
 switch (target?.type) {
 case ElementType.TYPE_STROKE: {
 target.thickness = (target.thickness ?? 200) + 100;
 if (target.stroke) {
 target.stroke.penColor = 157; // 0x9D dark gray
 }
 break;
 }
 case ElementType.TYPE_TEXT:
 case ElementType.TYPE_TEXT_DIGEST_QUOTE:
 case ElementType.TYPE_TEXT_DIGEST_CREATE: {
 if (target.textBox) {
 target.textBox.textContentFull = 'exampletext';
 target.textBox.textBold = 1;
 }
 break;
 }
 case ElementType.TYPE_TITLE: {
 if (target.title) {
 target.title.style = 1;
 }
 break;
 }
 default:
 break;
 }
 const res = await PluginFileAPI.modifyElements(NOTEPath, page, elements);
 if (!res.success) {
 throw new Error(res.error?.message ?? 'modifyElements call failed');
 }
 return res.result;
}

​Example

Example