Home > PCB_PrimitivePour > getAllPrimitiveId

PCB_PrimitivePour.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 all Copper border primitive IDs

Signature

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

Parameters

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

Returns

Promise<Array<string>>

Array of Copper border primitive IDs

Example

// 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 pour = await eda.pcb_PrimitivePour.create('GND', 1, polygon, 'solid', false, '嘉立创示例_覆铜', 5, 10, false);
const pourId = pour.getState_PrimitiveId();

// 2. 获取全部覆铜边框的图元 ID
const allIds = await eda.pcb_PrimitivePour.getAllPrimitiveId();

// 3. 按网络和层过滤：只取 GND 网络顶层（1）覆铜边框的图元 ID
const gndTopIds = await eda.pcb_PrimitivePour.getAllPrimitiveId('GND', 1);

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

console.log('total pour ids:', allIds.length);
console.log('GND top layer pour ids:', gndTopIds.length);
console.log('marker id in GND top layer list:', gndTopIds.includes(pourId));