Home > PCB_PrimitivePolyline > delete

PCB_PrimitivePolyline.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 polyline

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | IPCB_PrimitivePolyline | Array<string> | Array<IPCB_PrimitivePolyline>	Primitive ID of the polyline or the polyline 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([x, y, 'L', x + 500, y, x + 500, y + 300]);
const polygon2 = eda.pcb_MathPolygon.createPolygon([x, y + 500, 'L', x + 500, y + 500, x + 500, y + 800]);
const polyline1 = await eda.pcb_PrimitivePolyline.create('', 1, polygon1, 10, false);
const polyline2 = await eda.pcb_PrimitivePolyline.create('', 1, polygon2, 10, false);

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

// 3. 以 ID 数组形式批量删除两条折线
const deleted = await eda.pcb_PrimitivePolyline.delete([polyline1.getState_PrimitiveId(), polyline2.getState_PrimitiveId()]);

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

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