Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.supernote.com/llms.txt

Use this file to discover all available pages before exploring further.

Only NOTE files support layer data.
static insertLayer(NOTEPath: string, page: number, layer: Layer): Promise<APIResponse<boolean>>;
Parameters
ParameterTypeDescription
NOTEPathstringNOTE file path
pagenumberPage index (starts from 0)
layerLayerLayer data to insert
Returns

​
Example

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

/**
 * Insert layer example.
 */
export async function exampleInsertLayer() {
 const NOTEPath = '/storage/emulated/0/Note/demo.note';
 const page = 1;
 const layer: Layer = {
 layerId: 1,
 name: 'new layer',
 isCurrentLayer: false,
 isVisible: true,
 };
 const res = await PluginFileAPI.insertLayer(NOTEPath, page, layer);
 if (!res.success) {
 throw new Error(res.error?.message ?? 'insertLayer call failed');
 }
 return res.result;
}