Home > PCB_PrimitiveDimension > get

PCB_PrimitiveDimension.get() 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.

Get the dimension

Signature

function get(primitiveIds: string): Promise<IPCB_PrimitiveDimension | undefined>;

Parameters

Parameter	Type	Description
primitiveIds	string	Primitive ID of the dimension, which can be a string or an array of strings. If it is an array, an array is also returned

Returns

Promise<IPCB_PrimitiveDimension | undefined>

Dimension primitive object, undefined indicates that the retrieval failed

Example

// 1. 创建两个测试标注（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const dim1 = await eda.pcb_PrimitiveDimension.create(
	'Length Dimension',
	[x, y, x, y - 200, x + 2000, y - 200, x + 2000, y],
	3,
	'mm'
);
const dim2 = await eda.pcb_PrimitiveDimension.create(
	'Length Dimension',
	[x, y + 1000, x, y + 800, x + 2000, y + 800, x + 2000, y + 1000],
	3,
	'mil'
);

// 2. 传单个 ID 字符串，返回单个标注对象
const single = await eda.pcb_PrimitiveDimension.get(dim1.getState_PrimitiveId());

// 3. 传 ID 数组，返回标注对象数组
const arr = await eda.pcb_PrimitiveDimension.get([
	dim1.getState_PrimitiveId(),
	dim2.getState_PrimitiveId()
]);

// 4. 清理测试图元（查询类需要清理）
await eda.pcb_PrimitiveDimension.delete([
	dim1.getState_PrimitiveId(),
	dim2.getState_PrimitiveId()
]);

console.log('single dimensionType:', single.getState_DimensionType());
console.log('single unit:', single.getState_Unit());
console.log('array length:', arr.length);
console.log('dim2 unit:', arr[1].getState_Unit());