insertPageElements

static insertPageElements(
  elements: Element[],
  page: number,
  layer?: number | null
): Promise<APIResponse<boolean>>;

当该接口操作的是当前页时，请先调用 getPageDisplaySize 获取当前页面显示尺寸，不要调用 PluginFileAPI.getPageSize 获取文件页面尺寸，否则位置数据可能对不上。

传入的 elements 通常来自 createElement 或从别处读取到的既有元素，插入前后 uuid 保持不变。该接口依赖这些元素当前仍在原生缓存中，缓存中找不到的元素会被直接跳过，不会单独报错，详见 Element 缓存与释放。参数

参数	类型	说明
`elements`	`Element[]`	要插入的元素数组
`page`	`number`	页面索引，从 `0` 开始
`layer`	`number \| null`	可选图层参数。笔记文件（`.note`）不传时使用当前图层；如果是识别笔记，不管传不传都不会使用该参数，因为识别笔记只有一个图层；文档文件（`.pdf`、`.epub` 等）不管传不传都不会使用该参数，因为文档文件只有一个图层。传值时取值范围为 `0-3`

APIResponse<boolean>：result === true 表示插入成功

异常

当 elements 不是合法的元素数组时，会抛出参数校验异常
当 page 不是大于等于 0 的整数时，会抛出参数校验异常
当 layer 传值且不是 0-3 的整数时，会抛出参数校验异常

示例

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

/**
 * 向当前文件指定页面插入元素的示例。
 */
export async function exampleInsertPageElements(elements: Element[]) {
  const page = 0;
  const layer = 0;
  const res = await PluginCommAPI.insertPageElements(elements, page, layer);
  if (!res.success) {
    console.log('insertPageElements failed', res.error);
    throw new Error(res.error?.message ?? 'insertPageElements 调用失败');
  }
  console.log('insertPageElements result', res.result);
  return res.result;
}

​示例

示例