Home > PCB_PrimitivePad > getAllPrimitiveId

PCB_PrimitivePad.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 Pad primitive IDs

Signature

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

Parameters

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

Returns

Promise<Array<string>>

Array of Pad primitive IDs

Example

// 1. 创建一个顶层测试焊盘作为查找目标（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const pad = await eda.pcb_PrimitivePad.create(1, '1', x, y, 0, ['ELLIPSE', 60, 60], '', null, 0, 0, 0, false, 0);
const padId = pad.getState_PrimitiveId();

// 2. 获取全部焊盘的图元 ID
const allIds = await eda.pcb_PrimitivePad.getAllPrimitiveId();

// 3. 按层过滤：只取顶层（1）焊盘的图元 ID
const topLayerIds = await eda.pcb_PrimitivePad.getAllPrimitiveId(1);

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

console.log('total pad ids:', allIds.length);
console.log('top layer pad ids:', topLayerIds.length);
console.log('marker id in top layer list:', topLayerIds.includes(padId));