Home > PCB_PrimitiveVia > modify

PCB_PrimitiveVia.modify() 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.

Modify Via

Signature

function modify(
	primitiveId: string | IPCB_PrimitiveVia,
	property: {
		net?: string;
		x?: number;
		y?: number;
		holeDiameter?: number;
		diameter?: number;
		viaType?: EPCB_PrimitiveViaType;
		designRuleBlindViaName?: string | null;
		solderMaskExpansion?: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null;
		primitiveLock?: boolean;
	},
): Promise<IPCB_PrimitiveVia | undefined>;

Parameters

Parameter	Type	Description
primitiveId	string | IPCB_PrimitiveVia	Primitive ID
property	{ net?: string; x?: number; y?: number; holeDiameter?: number; diameter?: number; viaType?: EPCB_PrimitiveViaType; designRuleBlindViaName?: string | null; solderMaskExpansion?: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null; primitiveLock?: boolean }	Modify Parameter

Returns

Promise<IPCB_PrimitiveVia | undefined>

Via primitive object

Example

// 1. 创建待修改的测试过孔：孔径 20mil、外径 40mil（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const via = await eda.pcb_PrimitiveVia.create('', x, y, 20, 40);
const viaId = via.getState_PrimitiveId();

// 2. 读取修改前的孔径与外径
const beforeHole = via.getState_HoleDiameter();
const beforeDiameter = via.getState_Diameter();

// 3. 批量修改：孔径从 20 调大到 30，外径从 40 调大到 60
await eda.pcb_PrimitiveVia.modify(viaId, { holeDiameter: 30, diameter: 60 });

// 4. modify 返回后需要重新 get() 才能读到画布上的最新值
const refreshed = await eda.pcb_PrimitiveVia.get(viaId);

// 5. 修改类保留现场，供观察修改结果
console.log('primitiveId:', viaId);
console.log('holeDiameter:', beforeHole, '→', refreshed.getState_HoleDiameter());
console.log('diameter:', beforeDiameter, '→', refreshed.getState_Diameter());