Home > IPCB_PrimitiveRegion > setState_RegionName

IPCB_PrimitiveRegion.setState_RegionName() method

此 API 当前处于 BETA 预览状态，希望得到开发者的反馈。它的任何功能都可能在接下来的开发进程中被修改，请不要将它用于任何正式环境。

设置属性状态：区域名称

签名

function setState_RegionName(regionName?: string): IPCB_PrimitiveRegion;

参数名

参数	类型	描述
regionName	string	（可选） 区域名称

返回值

IPCB_PrimitiveRegion

区域图元对象

备注

仅当 ruleType 为 EPCB_PrimitiveRegionRuleType.FOLLOW_REGION_RULE 时有效，用于匹配区域 DRC 规则

如若 ruleType 为 EPCB_PrimitiveRegionRuleType.FOLLOW_REGION_RULE 但 regionName 为空，则系统将会自动分配名称

示例

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

// 2. 创建一个带名称的约束区域（ruleType=9 即 FOLLOW_REGION_RULE）
const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);
const region = await eda.pcb_PrimitiveRegion.create(1, polygon, [9], '嘉立创示例_旧区域名');
const before = region.getState_RegionName();

// 3. 异步模式修改区域名称
const asyncRegion = region.toAsync();
asyncRegion.setState_RegionName('嘉立创示例_电源约束区');
await asyncRegion.done();

// 4. 从图元对象读回新值（保留现场供观察）
// 注：当前版本名称修改画布侧不落（重新 get() 仍是旧名），修改在图元对象上生效
const after = region.getState_RegionName();

console.log('regionName:', before, '→', after);