Home > SCH_PrimitiveWire > delete

SCH_PrimitiveWire.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 Wire

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | ISCH_PrimitiveWire | Array<string> | Array<ISCH_PrimitiveWire>	Wire primitive ID or Wire primitive object

Returns

Promise<boolean>

Delete Whether the operation is successful

Example

// 1. 创建两条待删除的测试导线（随机坐标避免重合，SCH 坐标单位 10mil）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const wire1 = await eda.sch_PrimitiveWire.create([x, y, x + 400, y], 'SIG_A');
const wire2 = await eda.sch_PrimitiveWire.create([x, y + 200, x + 400, y + 200], 'SIG_B');

// 2. 记录删除前的导线数量
const beforeCount = (await eda.sch_PrimitiveWire.getAll()).length;

// 3. 分别以 ID 字符串和图元对象两种形式删除两条导线
const deleted1 = await eda.sch_PrimitiveWire.delete(wire1.getState_PrimitiveId());
const deleted2 = await eda.sch_PrimitiveWire.delete(wire2);

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

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