Home > PCB_PrimitiveRegion > getAllPrimitiveId

PCB_PrimitiveRegion.getAllPrimitiveId() method

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

获取所有区域的图元 ID

签名

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

参数名

参数	类型	描述
layer	TPCB_LayersOfRegion	（可选） 层
ruleType	Array<EPCB_PrimitiveRegionRuleType>	（可选） 区域规则类型，只会匹配所有规则类型均一致的图元
primitiveLock	boolean	（可选） 是否锁定

返回值

Promise<Array<string>>

区域的图元 ID 数组

示例

// 1. 创建一个顶层测试区域作为查找目标：规则 [2] 即禁止元件（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
const region = await eda.pcb_PrimitiveRegion.create(1, polygon, [2], '嘉立创示例_ID查找目标');
const regionId = region.getState_PrimitiveId();

// 2. 获取全部区域的图元 ID
const allIds = await eda.pcb_PrimitiveRegion.getAllPrimitiveId();

// 3. 按层 + 规则类型过滤：只取顶层（1）禁止元件（[2]）区域的图元 ID
const filteredIds = await eda.pcb_PrimitiveRegion.getAllPrimitiveId(1, [2]);

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

console.log('total region ids:', allIds.length);
console.log('filtered region ids:', filteredIds.length);
console.log('marker id in filtered list:', filteredIds.includes(regionId));