Home > PCB_PrimitiveVia > get

PCB_PrimitiveVia.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 Via

Signature

public get(primitiveIds: string): Promise<IPCB_PrimitiveVia | undefined>;

Parameters

Parameter	Type	Description
primitiveIds	string	Via 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_PrimitiveVia | undefined>

Via 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 via1 = await eda.pcb_PrimitiveVia.create('', x, y, 20, 40);
const via2 = await eda.pcb_PrimitiveVia.create('', x, y + 500, 30, 60);

// 2. 传单个 ID 字符串，返回单个过孔对象
const single = await eda.pcb_PrimitiveVia.get(via1.getState_PrimitiveId());

// 3. 传 ID 数组，返回过孔对象数组
const arr = await eda.pcb_PrimitiveVia.get([via1.getState_PrimitiveId(), via2.getState_PrimitiveId()]);

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

console.log('single holeDiameter:', single.getState_HoleDiameter());
console.log('array length:', arr.length);
console.log('via2 diameter:', arr[1].getState_Diameter());