跳转到主要内容

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.

该接口属于 PluginNoteAPI，只能在笔记应用中调用。
static generateLayerPreviewImage(
  notePath: string,
  page: number,
  layer: number,
  imagePath: string
): Promise<APIResponse<boolean>>;
参数
参数类型说明
notePathstring笔记文件路径
pagenumber页码（从 0 开始）
layernumber图层索引。-1 表示背景图层，0 表示主图层，1~3 表示自定义图层
imagePathstring缩略图输出路径
返回

​
示例

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

/**
 * 生成图层缩略图的示例。
 */
export async function exampleGenerateLayerPreviewImage() {
  const res = await PluginNoteAPI.generateLayerPreviewImage(
    '/storage/emulated/0/Note/demo.note',
    0,
    0,
    '/storage/emulated/0/Note/out/layer-preview.png'
  );
  if (!res.success) {
    throw new Error(res.error?.message ?? 'generateLayerPreviewImage 调用失败');
  }
  return res.result;
}