Home > SCH_PrimitiveText > delete

SCH_PrimitiveText.delete() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

删除文本

签名

function delete(primitiveIds: string | ISCH_PrimitiveText | Array<string> | Array<ISCH_PrimitiveText>): Promise<boolean>;

参数名

参数	类型	描述
primitiveIds	string | ISCH_PrimitiveText | Array<string> | Array<ISCH_PrimitiveText>	文本的图元 ID 或文本图元对象

返回值

Promise<boolean>

删除操作是否成功

示例

// 1. 创建两个待删除的测试文本（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const text1 = await eda.sch_PrimitiveText.create(x, y, '嘉立创示例_待删除A');
const text2 = await eda.sch_PrimitiveText.create(x, y + 300, '嘉立创示例_待删除B');

// 2. 记录删除前的文本数量
const beforeCount = (await eda.sch_PrimitiveText.getAll()).length;

// 3. 分别以 ID 字符串和图元对象两种形式删除两个文本
const deleted1 = await eda.sch_PrimitiveText.delete(text1.getState_PrimitiveId());
const deleted2 = await eda.sch_PrimitiveText.delete(text2);

// 4. 删除类保留现场（图元已删除，不恢复）
const afterCount = (await eda.sch_PrimitiveText.getAll()).length;

console.log('deleted by id:', deleted1);
console.log('deleted by object:', deleted2);
console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);