Home > PCB_PrimitiveRegion > getAll

PCB_PrimitiveRegion.getAll() 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

Signature

public getAll(layer?: TPCB_LayersOfRegion, ruleType?: Array<EPCB_PrimitiveRegionRuleType>, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveRegion>>;

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<IPCB_PrimitiveRegion>>

Array of Region primitive objects

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], '嘉立创示例_过滤目标');
const regionId = region.getState_PrimitiveId();

// 2. 不带参数：获取 PCB 上全部区域
const all = await eda.pcb_PrimitiveRegion.getAll();

// 3. 按层过滤：只取顶层（1）的区域
const topLayer = await eda.pcb_PrimitiveRegion.getAll(1);

// 4. 按规则类型过滤：只取规则为 [2]（禁止元件）的区域，要求规则完全一致
const noComponents = await eda.pcb_PrimitiveRegion.getAll(undefined, [2]);

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

console.log('total regions:', all.length);
console.log('top layer regions:', topLayer.length);
console.log('no-component regions:', noComponents.length);
console.log('marker region found:', noComponents.some(r => r.getState_PrimitiveId() === regionId));