Home > IPCB_PrimitiveRegion > setState_PrimitiveLock

IPCB_PrimitiveRegion.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_PrimitiveRegion;

Parameters

Parameter	Type	Description
primitiveLock	boolean	Whether it is locked

Returns

IPCB_PrimitiveRegion

Region primitive object

Example

// 1. 生成本次运行专用的坐标，避免与之前保留的测试图元重合
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);

// 2. 创建一个未锁定的矩形区域
const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
const region = await eda.pcb_PrimitiveRegion.create(1, polygon);
const before = region.getState_PrimitiveLock();

// 3. 切换异步模式并锁定区域
const asyncRegion = region.toAsync();
asyncRegion.setState_PrimitiveLock(true);
await asyncRegion.done();

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

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