Home > SCH_PrimitiveText > delete

SCH_PrimitiveText.delete() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Delete Text

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | ISCH_PrimitiveText | Array<string> | Array<ISCH_PrimitiveText>	Text primitive ID or Text primitive object

Returns

Promise<boolean>

Delete Whether the operation is successful

Example

// 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);