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.

static generateNotePng(params: {
 NOTEPath: string;
 page: number;
 times: number;
 pngPath: string;
 type: number;
}): Promise<APIResponse<boolean>>;
Parameters
ParameterTypeDescription
params.notePathstringNOTE file path
params.pagenumberPage index (starts from 0)
params.timesnumberImage scale factor (usually 1 or 2)
params.pngPathstringOutput PNG path (must end with .png)
params.typenumberOutput type: 0 transparent background, 1 white background
Returns

​
Example

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

/**
 * Generate page PNG example.
 */
export async function exampleGenerateNotePng() {
 const res = await PluginFileAPI.generateNotePng({
 NOTEPath: '/storage/emulated/0/Note/demo.note',
 page: 1,
 times: 1,
 pngPath: '/storage/emulated/0/Note/out/page.png',
 type: 1,
 });

 if (!res.success) {
 throw new Error(res.error?.message ?? 'generateNotePng call failed');
 }
 return res.result;
}