Home > PCB_PrimitiveObject > getAllPrimitiveId

PCB_PrimitiveObject.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 Binary embedded object primitive IDs

Signature

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

Parameters

Parameter	Type	Description
layer	TPCB_LayersOfObject	(Optional) Layer
primitiveLock	boolean	(Optional) Whether it is locked

Returns

Promise<Array<string>>

Array of Binary embedded object primitive IDs

Example

// 1. 创建一个顶层丝印（3）测试对象作为查找目标（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const binaryData = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAAECAIAAAAmkwkpAAAAEElEQVR4nGP4z8AARwzEcQCukw/x0F8jngAAAABJRU5ErkJggg==';
const obj = await eda.pcb_PrimitiveObject.create(3, x, y, binaryData, 400, 300, 0, false, 'logo.png', false);
const objId = obj.getState_PrimitiveId();

// 2. 获取全部内嵌对象的图元 ID
const allIds = await eda.pcb_PrimitiveObject.getAllPrimitiveId();

// 3. 按层过滤：只取顶层丝印（3）内嵌对象的图元 ID
const topSilkIds = await eda.pcb_PrimitiveObject.getAllPrimitiveId(3);

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

console.log('total object ids:', allIds.length);
console.log('top silkscreen object ids:', topSilkIds.length);
console.log('marker id in top silkscreen list:', topSilkIds.includes(objId));