Home > SCH_PrimitiveComponent > delete

SCH_PrimitiveComponent.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 Device

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | ISCH_PrimitiveComponent | Array<string> | Array<ISCH_PrimitiveComponent>	Device primitive ID or Device primitive object

Returns

Promise<boolean>

Delete Whether the operation is successful

Example

// 1. 创建两个待删除的测试器件（随机坐标避免重合，SCH 坐标单位 10mil）
const devices = await eda.lib_Device.search('');
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const comp1 = await eda.sch_PrimitiveComponent.create(devices[0], x, y);
const comp2 = await eda.sch_PrimitiveComponent.create(devices[0], x + 400, y);

// 2. 记录删除前的器件数量
const beforeCount = (await eda.sch_PrimitiveComponent.getAll()).length;

// 3. 分别以 ID 字符串和图元对象两种形式删除两个器件
const deleted1 = await eda.sch_PrimitiveComponent.delete(comp1.getState_PrimitiveId());
const deleted2 = await eda.sch_PrimitiveComponent.delete(comp2);

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

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