Home > PCB_PrimitiveRegion > delete

PCB_PrimitiveRegion.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 Region

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | IPCB_PrimitiveRegion | Array<string> | Array<IPCB_PrimitiveRegion>	Region primitive ID or Region 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 region1 = await eda.pcb_PrimitiveRegion.create(1, polygon1, [2], '嘉立创示例_删除A');
const region2 = await eda.pcb_PrimitiveRegion.create(1, polygon2, [5], '嘉立创示例_删除B');

// 2. 记录删除前的区域数量
const beforeCount = (await eda.pcb_PrimitiveRegion.getAll()).length;

// 3. 以 ID 数组形式批量删除两个区域
const deleted = await eda.pcb_PrimitiveRegion.delete([region1.getState_PrimitiveId(), region2.getState_PrimitiveId()]);

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

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