replaceElements - Supernote

For any element in elements that carries an existing uuid (e.g. an element read via getElements and reused), that uuid must still be present in the native cache, otherwise the item is silently skipped without a separate error; newly created elements (e.g. via createElement) that haven’t been inserted anywhere yet aren’t subject to this restriction. A reused element’s uuid stays the same before and after the replacement. See Element Caching and Release for details.

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

Parameters

Parameter	Type	Description
`NOTEPath`	`string`	NOTE/DOC file path
`page`	`number`	Page index (starts from `0`)
`elements`	`Element[]`	Element data array

Returns

APIResponse<boolean>: result === true indicates replacement succeeded

Example

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

/**
 * Example: read page elements and write back (replace).
 */
export async function exampleReplaceElements() {
 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 createRes = await PluginCommAPI.createElement(ElementType.TYPE_TEXT);
 if (!createRes.success) {
 throw new Error(createRes.error?.message ?? 'createElement call failed');
 }
 const textEl = createRes.result as Element;
 if (textEl.textBox) {
 textEl.textBox.textContentFull = 'Replaced content';
 textEl.textBox.fontSize = 16;
 textEl.textBox.textBold = 1;
 textEl.textBox.textAlign = 1;
 textEl.textBox.textRect = { left: 100, top: 120, right: 600, bottom: 220 };
 }

 const newElements = [textEl];
 const res = await PluginFileAPI.replaceElements(NOTEPath, page, newElements);
 if (!res.success) {
 throw new Error(res.error?.message ?? 'replaceElements call failed');
 }
 return res.result;
}

​Example

Example