Home > IPCB_PrimitivePad > setState_PrimitiveLock

IPCB_PrimitivePad.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_PrimitivePad;

Parameters

Parameter	Type	Description
primitiveLock	boolean	Whether it is locked

Returns

IPCB_PrimitivePad

Pad primitive object

Example

// 1. 生成本次运行专用的坐标，创建一个未锁定的贴片焊盘
const x = 3000 + Math.floor(Math.random() * 100000);
const pad = await eda.pcb_PrimitivePad.create(1, '1', x, 3000, 0, ['ELLIPSE', 60, 60], '', null, 0, 0, 0, false, 0);
const before = pad.getState_PrimitiveLock();

// 2. 异步模式下锁定焊盘并提交
const a = pad.toAsync();
a.setState_PrimitiveLock(true);
await a.done();

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

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