Home > PCB_PrimitiveFill > getAllPrimitiveId

PCB_PrimitiveFill.getAllPrimitiveId() 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.

Get the primitive IDs of all fills

Signature

function getAllPrimitiveId(
	layer?: TPCB_LayersOfFill,
	net?: string,
	primitiveLock?: boolean,
): Promise<Array<string>>;

Parameters

Parameter	Type	Description
layer	TPCB_LayersOfFill	(Optional) Layer
net	string	(Optional) Net name
primitiveLock	boolean	(Optional) Whether it is locked

Returns

Promise<Array<string>>

Array of fill primitive IDs

Example

// 1. 创建一个顶层铜层（1）测试填充作为查找目标（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
const fill = await eda.pcb_PrimitiveFill.create(1, polygon, '', 0, 10, false);
const fillId = fill.getState_PrimitiveId();

// 2. 获取全部填充的图元 ID
const allIds = await eda.pcb_PrimitiveFill.getAllPrimitiveId();

// 3. 按层过滤：只取顶层铜层（1）填充的图元 ID
const topCopperIds = await eda.pcb_PrimitiveFill.getAllPrimitiveId(1);

// 4. 清理测试图元（查询类需要清理）
await eda.pcb_PrimitiveFill.delete([fillId]);

console.log('total fill ids:', allIds.length);
console.log('top copper fill ids:', topCopperIds.length);
console.log('marker id in top copper list:', topCopperIds.includes(fillId));