Home > PCB_PrimitiveVia > getAllPrimitiveId

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

Signature

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

Parameters

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

Returns

Promise<Array<string>>

Array of Via primitive IDs

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. 获取全部过孔的图元 ID
const allIds = await eda.pcb_PrimitiveVia.getAllPrimitiveId();

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

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

console.log('total via ids:', allIds.length);
console.log('demo net via ids:', netIds.length);
console.log('marker id in filtered list:', netIds.includes(viaId));