Home > PCB_PrimitiveVia > getAll

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

Signature

public getAll(net?: string, primitiveLock?: boolean): Promise<Array<IPCB_PrimitiveVia>>;

Parameters

Parameter	Type	Description
net	string	(Optional) Net name
primitiveLock	boolean	(Optional) Whether it is locked

Returns

Promise<Array<IPCB_PrimitiveVia>>

Array of Via primitive objects

Example

// 1. 创建一个挂网络的测试过孔作为过滤目标（网络不存在会自动创建，随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const via = await eda.pcb_PrimitiveVia.create('嘉立创示例_NET1', x, y, 20, 40);
const viaId = via.getState_PrimitiveId();

// 2. 不带参数：获取 PCB 上全部过孔
const all = await eda.pcb_PrimitiveVia.getAll();

// 3. 按网络过滤：只取挂在该网络下的过孔
const netVias = await eda.pcb_PrimitiveVia.getAll('嘉立创示例_NET1');

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

console.log('total vias:', all.length);
console.log('vias on demo net:', netVias.length);
console.log('marker via found:', netVias.some(v => v.getState_PrimitiveId() === viaId));