modifyElements - Supernote

调用前建议先用 getElements 拿到目标元素再修改字段后传入，这样能保证 uuid 不变。修改会经过两层校验：一是元素的 uuid 必须还在原生缓存中，找不到会被直接跳过、不会单独报错；二是该元素必须已经存在于目标页面（即接口描述里”必须是已存在的数据”），这一层是接口本身的业务校验。两层是独立的先后关系——uuid 在缓存里找不到会在更早阶段被跳过，根本走不到”是否已存在于页面”这一步，详见 Element 缓存与释放。

static modifyElements(notePath: string, page: number, elements: Element[]): Promise<APIResponse<number[]>>;

参数

参数	类型	说明
`notePath`	`string`	笔记/文档文件路径
`page`	`number`	页面索引（从 0 开始）
`elements`	`Element[]`	需要修改的元素数组（必须已存在）

APIResponse<number[]>：result 为修改成功的元素索引列表

示例

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

/**
 * 拉取页面元素并提交修改的示例。
 */
export async function exampleModifyElements() {
  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 调用失败');
  }

  const elements = (listRes.result ?? []) as Element[];
  const target = elements[0];
  switch (target?.type) {
    case ElementType.TYPE_STROKE: {
      target.thickness = (target.thickness ?? 200) + 100;
      if (target.stroke) {
        target.stroke.penColor = 157; // 0x9D 深灰
      }
      break;
    }
    case ElementType.TYPE_TEXT:
    case ElementType.TYPE_TEXT_DIGEST_QUOTE:
    case ElementType.TYPE_TEXT_DIGEST_CREATE: {
      if (target.textBox) {
        target.textBox.textContentFull = '示例文本';
        target.textBox.textBold = 1;
      }
      break;
    }
    case ElementType.TYPE_TITLE: {
      if (target.title) {
        target.title.style = 1;
      }
      break;
    }
    default:
      break;
  }
  const res = await PluginFileAPI.modifyElements(notePath, page, elements);
  if (!res.success) {
    throw new Error(res.error?.message ?? 'modifyElements 调用失败');
  }
  return res.result;
}

​示例

示例