Home > PCB_PrimitiveComponent > getAllPrimitiveId

PCB_PrimitiveComponent.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 Device primitive IDs

Signature

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

Parameters

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

Returns

Promise<Array<string>>

Array of Device primitive IDs

Example

// 1. 放置一个测试器件作为过滤参照：
// 按立创编号从系统库精确反查器件，返回项不含 libraryUuid，需补上才能用于 create
const devices = await eda.lib_Device.searchByProperties({ supplierId: 'C1523' }, undefined, undefined, undefined, 5, 1);
const sysLibUuid = await eda.lib_LibrariesList.getSystemLibraryUuid();
const comp = await eda.pcb_PrimitiveComponent.create({ libraryUuid: sysLibUuid, uuid: devices[0].uuid }, 1, 5000, 5000);
const compId = comp.getState_PrimitiveId();

// 2. 不带参数：获取全部器件的图元 ID
const allIds = await eda.pcb_PrimitiveComponent.getAllPrimitiveId();

// 3. 按层过滤：只取顶层（1）器件的图元 ID
const topIds = await eda.pcb_PrimitiveComponent.getAllPrimitiveId(1);

// 4. 清理测试器件
await eda.pcb_PrimitiveComponent.delete([compId]);

console.log('total ids:', allIds.length);
console.log('top layer ids:', topIds.length);
console.log('fixture included:', allIds.includes(compId));
console.log('firstId:', allIds[0]);