Home > PCB_PrimitiveFill > delete

PCB_PrimitiveFill.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 fill

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | IPCB_PrimitiveFill | Array<string> | Array<IPCB_PrimitiveFill>	Primitive ID of the fill or the fill 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 + 1000, 500, 300, 0, 0]);
const fill1 = await eda.pcb_PrimitiveFill.create(1, polygon1, '', 0, 10, false);
const fill2 = await eda.pcb_PrimitiveFill.create(1, polygon2, '', 0, 10, false);

// 2. 记录删除前的填充数量
const beforeCount = (await eda.pcb_PrimitiveFill.getAll()).length;

// 3. 以 ID 数组形式批量删除两个填充
const deleted = await eda.pcb_PrimitiveFill.delete([
	fill1.getState_PrimitiveId(),
	fill2.getState_PrimitiveId()
]);

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

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