Home > SCH_PrimitiveComponent > getAllPrimitiveId

SCH_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

public getAllPrimitiveId(componentType?: ESCH_PrimitiveComponentType, allSchematicPages?: boolean): Promise<Array<string>>;

Parameters

Parameter	Type	Description
componentType	ESCH_PrimitiveComponentType	(Optional) Device type
allSchematicPages	boolean	(Optional) Whether to get the devices of all schematic sheets

Returns

Promise<Array<string>>

Array of Device primitive IDs

Example

// 1. 创建一个网络标识作为查找目标（随机坐标避免重合，SCH 坐标单位 10mil）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const flag = await eda.sch_PrimitiveComponent.createNetFlag('Power', '嘉立创示例_VCC', x, y);
const flagId = flag.getState_PrimitiveId();

// 2. 不传参数，取当前图页全部器件的图元 ID
const allIds = await eda.sch_PrimitiveComponent.getAllPrimitiveId();

// 3. 传入类型 'netflag' 只取网络标识的图元 ID
const flagIds = await eda.sch_PrimitiveComponent.getAllPrimitiveId('netflag');

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

console.log('total ids:', allIds.length);
console.log('netflag ids:', flagIds.length);
console.log('marker flag found:', flagIds.includes(flagId));