Home > SCH_PrimitiveComponent > getAllPrimitiveId

SCH_PrimitiveComponent.getAllPrimitiveId() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

获取所有器件的图元 ID

签名

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

参数名

参数	类型	描述
componentType	ESCH_PrimitiveComponentType	（可选） 器件类型
allSchematicPages	boolean	（可选） 是否获取所有原理图图页的器件

返回值

Promise<Array<string>>

器件的图元 ID 数组

示例

// 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));