Home > PCB_PrimitiveVia > delete

PCB_PrimitiveVia.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 Via

Signature

public delete(primitiveIds: string | IPCB_PrimitiveVia | Array<string> | Array<IPCB_PrimitiveVia>): Promise<boolean>;

Parameters

Parameter	Type	Description
primitiveIds	string | IPCB_PrimitiveVia | Array<string> | Array<IPCB_PrimitiveVia>	Via primitive ID or Via 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 via1 = await eda.pcb_PrimitiveVia.create('', x, y, 20, 40);
const via2 = await eda.pcb_PrimitiveVia.create('', x, y + 500, 20, 40);

// 2. 记录删除前的过孔数量
const beforeCount = (await eda.pcb_PrimitiveVia.getAll()).length;

// 3. 以 ID 数组形式批量删除两个过孔
const deleted = await eda.pcb_PrimitiveVia.delete([via1.getState_PrimitiveId(), via2.getState_PrimitiveId()]);

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

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