Home > PCB_PrimitiveDimension > delete

PCB_PrimitiveDimension.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 dimension

Signature

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

Parameters

Parameter	Type	Description
primitiveIds	string | IPCB_PrimitiveDimension | Array<string> | Array<IPCB_PrimitiveDimension>	Primitive ID of the dimension or the dimension 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 dim1 = await eda.pcb_PrimitiveDimension.create(
	'Length Dimension',
	[x, y, x, y - 200, x + 2000, y - 200, x + 2000, y],
	3
);
const dim2 = await eda.pcb_PrimitiveDimension.create(
	'Length Dimension',
	[x, y + 1000, x, y + 800, x + 2000, y + 800, x + 2000, y + 1000],
	3
);

// 2. 记录删除前的标注数量
const beforeCount = (await eda.pcb_PrimitiveDimension.getAll()).length;

// 3. 以 ID 数组形式批量删除两个标注
const deleted = await eda.pcb_PrimitiveDimension.delete([
	dim1.getState_PrimitiveId(),
	dim2.getState_PrimitiveId()
]);

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

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