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