Home > IPCB_PrimitiveImage > setState_PrimitiveLock

IPCB_PrimitiveImage.setState_PrimitiveLock() 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.

Set the property state: whether it is locked

Signature

function setState_PrimitiveLock(primitiveLock: boolean): IPCB_PrimitiveImage;

Parameters

Parameter	Type	Description
primitiveLock	boolean	Whether it is locked

Returns

IPCB_PrimitiveImage

Image primitive object

Example

// 1. 生成本次运行专用的坐标，创建一个未锁定的顶层图像
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const complexPolygon = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
const image = await eda.pcb_PrimitiveImage.create(x, y, complexPolygon, 1, 400, 300, 0, false, false);
const before = image.getState_PrimitiveLock();

// 2. 异步模式锁定图像
const asyncImage = image.toAsync();
asyncImage.setState_PrimitiveLock(true);
await asyncImage.done();

// 3. 从画布重新读取，确认锁定已生效（保留现场供观察）
const refetched = await eda.pcb_PrimitiveImage.get(image.getState_PrimitiveId());

console.log('primitiveLock:', before, '→', refetched.getState_PrimitiveLock());