Home > PCB_PrimitiveImage > getAll

PCB_PrimitiveImage.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 Image

Signature

function getAll(
	layer?: TPCB_LayersOfImage,
	primitiveLock?: boolean,
): Promise<Array<IPCB_PrimitiveImage>>;

Parameters

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

Returns

Promise<Array<IPCB_PrimitiveImage>>

Array of Image primitive objects

Example

// 1. 创建一个顶层铜层（1）测试图像作为过滤目标（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const cp = eda.pcb_MathPolygon.createComplexPolygon([0, 0, 'L', 200, 0, 200, 150, 0, 150]);
const image = await eda.pcb_PrimitiveImage.create(x, y, cp, 1, 400, 300, 0, false, false);
const imageId = image.getState_PrimitiveId();

// 2. 不带参数：获取 PCB 上全部图像
const all = await eda.pcb_PrimitiveImage.getAll();

// 3. 按层过滤：只取顶层铜层（1）的图像
const topCopper = await eda.pcb_PrimitiveImage.getAll(1);

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

console.log('total images:', all.length);
console.log('top copper images:', topCopper.length);
console.log('marker image found:', topCopper.some(i => i.getState_PrimitiveId() === imageId));