Home > PCB_PrimitiveDimension > getAll

PCB_PrimitiveDimension.getAll() 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 all dimensions

Signature

function getAll(
	layer?: TPCB_LayersOfDimension,
	primitiveLock?: boolean,
): Promise<Array<IPCB_PrimitiveDimension>>;

Parameters

Parameter	Type	Description
layer	TPCB_LayersOfDimension	(Optional) Layer
primitiveLock	boolean	(Optional) Whether it is locked

Returns

Promise<Array<IPCB_PrimitiveDimension>>

Dimension primitive object array

Example

// 1. 创建一个顶层丝印（3）测试标注作为过滤目标（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const dim = await eda.pcb_PrimitiveDimension.create(
	'Length Dimension',
	[x, y, x, y - 200, x + 2000, y - 200, x + 2000, y],
	3
);
const dimId = dim.getState_PrimitiveId();

// 2. 不带参数：获取 PCB 上全部尺寸标注
const all = await eda.pcb_PrimitiveDimension.getAll();

// 3. 按层过滤：只取顶层丝印（3）的标注
const topSilk = await eda.pcb_PrimitiveDimension.getAll(3);

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

console.log('total dimensions:', all.length);
console.log('top silkscreen dimensions:', topSilk.length);
console.log('marker dimension found:', topSilk.some(d => d.getState_PrimitiveId() === dimId));