Home > PCB_PrimitiveLine > delete

PCB_PrimitiveLine.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 the line

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | IPCB_PrimitiveLine | Array<string> | Array<IPCB_PrimitiveLine>	Primitive ID of the line or the line primitive object

Returns

Promise<boolean>

Delete Whether the operation is successful

Example

// 1. 创建两条待删除的测试直线（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const line1 = await eda.pcb_PrimitiveLine.create('', 1, x, y, x + 600, y, 10, false);
const line2 = await eda.pcb_PrimitiveLine.create('', 1, x, y + 500, x + 600, y + 500, 10, false);

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

// 3. 以 ID 数组形式批量删除两条直线
const deleted = await eda.pcb_PrimitiveLine.delete([line1.getState_PrimitiveId(), line2.getState_PrimitiveId()]);

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

console.log('deleted:', deleted);
console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);