Home > IPCB_PrimitiveString > setState_PrimitiveLock

IPCB_PrimitiveString.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_PrimitiveString;

Parameters

Parameter	Type	Description
primitiveLock	boolean	Whether it is locked

Returns

IPCB_PrimitiveString

Text primitive object

Example

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

// 2. 在顶层丝印（3）放置一行未锁定的文本
const str = await eda.pcb_PrimitiveString.create(3, x, y, '嘉立创示例_TEXT', 'default', 45, 6, 3, 0, false, 0, false, false);
const before = str.getState_PrimitiveLock();

// 3. 异步模式锁定文本
const asyncStr = str.toAsync();
asyncStr.setState_PrimitiveLock(true);
await asyncStr.done();

// 4. 从画布重新读取，确认修改生效（保留现场供观察）
const refetched = await eda.pcb_PrimitiveString.get(str.getState_PrimitiveId());

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