Home > PCB_Net > getNetColor

PCB_Net.getNetColor() 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 the color of the specified net

Signature

function getNetColor(net: string): Promise<IPCB_NetInfo['color'] | undefined>;

Parameters

Parameter	Type	Description
net	string	Net name

Returns

Promise<IPCB_NetInfo['color'] | undefined>

Net color, undefined is does not exist this net

Example

// 1. 创建带网络名的过孔，让 PCB 中出现可查询的网络
const via = await eda.pcb_PrimitiveVia.create('嘉立创示例_NET1', 2000, 2000, 20, 40);

// 2. 读取该网络当前的颜色
const color = await eda.pcb_Net.getNetColor('嘉立创示例_NET1');

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

console.log('netColor:', color);