Home > PCB_PrimitivePour > delete

PCB_PrimitivePour.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 Copper border

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | IPCB_PrimitivePour | Array<string> | Array<IPCB_PrimitivePour>	Copper border primitive ID or Copper border 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 polygon1 = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
const polygon2 = eda.pcb_MathPolygon.createPolygon(['R', x, y + 500, 500, 300, 0, 0]);
const pour1 = await eda.pcb_PrimitivePour.create('GND', 1, polygon1, 'solid', false, '嘉立创示例_覆铜1', 5, 10, false);
const pour2 = await eda.pcb_PrimitivePour.create('GND', 1, polygon2, 'solid', false, '嘉立创示例_覆铜2', 5, 10, false);

// 2. 记录删除前的覆铜边框数量
const beforeCount = (await eda.pcb_PrimitivePour.getAll()).length;

// 3. 以 ID 数组形式批量删除两条覆铜边框
const deleted = await eda.pcb_PrimitivePour.delete([pour1.getState_PrimitiveId(), pour2.getState_PrimitiveId()]);

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

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