Home > PCB_PrimitiveRegion > getAllPrimitiveId

PCB_PrimitiveRegion.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 Region primitive IDs

Signature

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

Parameters

Parameter	Type	Description
layer	TPCB_LayersOfRegion	(Optional) Layer
ruleType	Array<EPCB_PrimitiveRegionRuleType>	(Optional) Region rule type. Only primitives whose rule types are all consistent will be matched
primitiveLock	boolean	(Optional) Whether it is locked

Returns

Promise<Array<string>>

Array of Region primitive IDs

Example

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