Home > PCB_PrimitiveRegion > get

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

Signature

function get(primitiveIds: string): Promise<IPCB_PrimitiveRegion | undefined>;

Parameters

Parameter	Type	Description
primitiveIds	string	Region primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned

Returns

Promise<IPCB_PrimitiveRegion | undefined>

Region primitive object, undefined indicates that the retrieval failed

Example

// 1. 创建两个测试区域（随机坐标避免重合），分别用不同规则便于区分
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const polygon1 = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
const polygon2 = eda.pcb_MathPolygon.createPolygon(['R', x, y + 500, 500, 300, 0, 0]);
const region1 = await eda.pcb_PrimitiveRegion.create(1, polygon1, [2], '嘉立创示例_区域A');
const region2 = await eda.pcb_PrimitiveRegion.create(1, polygon2, [5], '嘉立创示例_区域B');

// 2. 传单个 ID 字符串，返回单个区域对象
const single = await eda.pcb_PrimitiveRegion.get(region1.getState_PrimitiveId());

// 3. 传 ID 数组，返回区域对象数组
const arr = await eda.pcb_PrimitiveRegion.get([region1.getState_PrimitiveId(), region2.getState_PrimitiveId()]);

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

console.log('single ruleType:', single.getState_RuleType());
console.log('array length:', arr.length);
console.log('region2 ruleType:', arr[1].getState_RuleType());