Home > IPCB_PrimitiveAttribute > setState_Key

IPCB_PrimitiveAttribute.setState_Key() 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: Key

Signature

function setState_Key(key: string): IPCB_PrimitiveAttribute;

Parameters

Parameter	Type	Description
key	string	Key

Returns

IPCB_PrimitiveAttribute

Attribute primitive object

Example

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

// 2. 放置测试器件并取出 Designator（编号）属性
const devices = await eda.lib_Device.search('C0402');
const comp = await eda.pcb_PrimitiveComponent.create(devices[0], 1, x, y);
const attrIds = await eda.pcb_PrimitiveAttribute.getAllPrimitiveId(comp.getState_PrimitiveId());
const attrs = await eda.pcb_PrimitiveAttribute.get(attrIds);
const designator = attrs.find(a => a.getState_Key() === 'Designator');

// 3. 读取修改前的属性名
const before = designator.getState_Key();

// 4. 切换异步模式重命名属性并提交
const asyncAttr = designator.toAsync();
asyncAttr.setState_Key('Ref');
await asyncAttr.done();

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

console.log('key:', before, '→', refetched.getState_Key());