Home > PCB_PrimitivePour > modify

PCB_PrimitivePour.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 Copper border

Signature

function modify(
	primitiveId: string | IPCB_PrimitivePour,
	property: {
		net?: string;
		layer?: TPCB_LayersOfCopper;
		complexPolygon?: IPCB_Polygon;
		pourFillMethod?: EPCB_PrimitivePourFillMethod;
		preserveSilos?: boolean;
		pourName?: string;
		pourPriority?: number;
		lineWidth?: number;
		primitiveLock?: boolean;
	},
): Promise<IPCB_PrimitivePour | undefined>;

Parameters

Parameter	Type	Description
primitiveId	string | IPCB_PrimitivePour	Primitive ID
property	{ net?: string; layer?: TPCB_LayersOfCopper; complexPolygon?: IPCB_Polygon; pourFillMethod?: EPCB_PrimitivePourFillMethod; preserveSilos?: boolean; pourName?: string; pourPriority?: number; lineWidth?: number; primitiveLock?: boolean }	Modify Parameter

Returns

Promise<IPCB_PrimitivePour | undefined>

Copper border primitive object, undefined indicates that the modification failed

Example

// 1. 创建待修改的测试覆铜边框（随机坐标避免与画布已有覆铜重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
const pour = await eda.pcb_PrimitivePour.create('GND', 1, polygon, 'solid', false, '嘉立创示例_覆铜', 5, 10, false);
const pourId = pour.getState_PrimitiveId();

// 2. 读取修改前的层与优先级
const beforeLayer = pour.getState_Layer();
const beforePriority = pour.getState_PourPriority();

// 3. 批量修改：层从顶层（1）换到底层（2），优先级 5 → 6
await eda.pcb_PrimitivePour.modify(pourId, { layer: 2, pourPriority: 6 });

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

// 5. 修改类保留现场，供观察修改结果
console.log('primitiveId:', pourId);
console.log('layer:', beforeLayer, '→', refreshed.getState_Layer());
console.log('pourPriority:', beforePriority, '→', refreshed.getState_PourPriority());