Home > PCB_PrimitiveImage > modify

PCB_PrimitiveImage.modify() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

修改图像

签名

function modify(
	primitiveId: string | IPCB_PrimitiveImage,
	property: {
		x?: number;
		y?: number;
		layer?: TPCB_LayersOfImage;
		width?: number;
		height?: number;
		rotation?: number;
		horizonMirror?: boolean;
		primitiveLock?: boolean;
	},
): Promise<IPCB_PrimitiveImage | undefined>;

参数名

参数	类型	描述
primitiveId	string | IPCB_PrimitiveImage	图元 ID
property	{ x?: number; y?: number; layer?: TPCB_LayersOfImage; width?: number; height?: number; rotation?: number; horizonMirror?: boolean; primitiveLock?: boolean }	修改参数

返回值

Promise<IPCB_PrimitiveImage | undefined>

图像图元对象

示例

// 1. 创建待修改的测试图像（随机坐标避免与画布已有图像重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
const image = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
const imageId = image.getState_PrimitiveId();

// 2. 读取修改前的层与旋转角度
const beforeLayer = image.getState_Layer();
const beforeRotation = image.getState_Rotation();

// 3. 批量修改：顶层铜层（1）→ 顶层丝印（3），旋转 0° → 90°
await eda.pcb_PrimitiveImage.modify(imageId, { layer: 3, rotation: 90 });

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

// 5. 修改类保留现场，供观察修改结果
console.log('primitiveId:', imageId);
console.log('layer:', beforeLayer, '→', refreshed.getState_Layer());
console.log('rotation:', beforeRotation, '→', refreshed.getState_Rotation());