Home > IPCB_PrimitivePour > setState_PrimitiveLock

IPCB_PrimitivePour.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_PrimitivePour;

Parameters

Parameter	Type	Description
primitiveLock	boolean	Whether it is locked

Returns

IPCB_PrimitivePour

Copper border 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 pour = await eda.pcb_PrimitivePour.create('', 1, polygon, 'solid', false, '嘉立创示例_改锁定', 5, 10, false);
const before = pour.getState_PrimitiveLock();

// 3. 异步模式锁定图元
const asyncPour = pour.toAsync();
asyncPour.setState_PrimitiveLock(true);
await asyncPour.done();

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

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