Home > PCB_PrimitiveFill > modify

PCB_PrimitiveFill.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 the fill

Signature

function modify(
	primitiveId: string | IPCB_PrimitiveFill,
	property: {
		layer?: TPCB_LayersOfFill;
		complexPolygon?: IPCB_Polygon;
		net?: string;
		fillMode?: EPCB_PrimitiveFillMode;
		lineWidth?: number;
		primitiveLock?: boolean;
	},
): Promise<IPCB_PrimitiveFill | undefined>;

Parameters

Parameter	Type	Description
primitiveId	string | IPCB_PrimitiveFill	Primitive ID
property	{ layer?: TPCB_LayersOfFill; complexPolygon?: IPCB_Polygon; net?: string; fillMode?: EPCB_PrimitiveFillMode; lineWidth?: number; primitiveLock?: boolean }	Modify Parameter

Returns

Promise<IPCB_PrimitiveFill | undefined>

Fill 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 fill = await eda.pcb_PrimitiveFill.create(1, polygon, '', 0, 10, false);
const fillId = fill.getState_PrimitiveId();

// 2. 读取修改前的层与锁定状态
const beforeLayer = fill.getState_Layer();
const beforeLock = fill.getState_PrimitiveLock();

// 3. 批量修改：顶层铜层（1）→ 底层铜层（2），未锁定 → 锁定
await eda.pcb_PrimitiveFill.modify(fillId, { layer: 2, primitiveLock: true });

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

// 5. 修改类保留现场，供观察修改结果
console.log('primitiveId:', fillId);
console.log('layer:', beforeLayer, '→', refreshed.getState_Layer());
console.log('primitiveLock:', beforeLock, '→', refreshed.getState_PrimitiveLock());