Home > PCB_PrimitiveRegion > create

PCB_PrimitiveRegion.create() 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.

Create Region

Signature

function create(
	layer: TPCB_LayersOfRegion,
	complexPolygon: IPCB_Polygon,
	ruleType?: Array<EPCB_PrimitiveRegionRuleType>,
	regionName?: string,
	lineWidth?: number,
	primitiveLock?: boolean,
): Promise<IPCB_PrimitiveRegion | undefined>;

Parameters

Parameter	Type	Description
layer	TPCB_LayersOfRegion	Layer
complexPolygon	IPCB_Polygon	Complex polygon object
ruleType	Array<EPCB_PrimitiveRegionRuleType>	(Optional) Region rule type
regionName	string	(Optional) Region name
lineWidth	number	(Optional) Line width
primitiveLock	boolean	(Optional) Whether it is locked

Returns

Promise<IPCB_PrimitiveRegion | undefined>

Region primitive object

Example

// 1. 生成随机起点坐标，避免与画布上已有的区域重合
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);

// 2. 用 pcb_MathPolygon.createPolygon 构造矩形边界：宽 500、高 300
const polygon = eda.pcb_MathPolygon.createPolygon(['R', x, y, 500, 300, 0, 0]);

// 3. 在顶层铜层创建禁止区域：规则 [2, 5] 即禁止元件 + 禁止布线，线宽 10mil，不锁定
const region = await eda.pcb_PrimitiveRegion.create(1, polygon, [2, 5], '嘉立创示例_禁布区', 10, false);

// 4. 创建类保留现场，不删除图元
console.log('primitiveId:', region.getState_PrimitiveId());
console.log('primitiveType:', region.getState_PrimitiveType());
console.log('layer:', region.getState_Layer());
console.log('ruleType:', region.getState_RuleType());
console.log('regionName:', region.getState_RegionName());