Home > PCB_PrimitiveString > getAll

PCB_PrimitiveString.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 Text

Signature

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

Parameters

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

Returns

Promise<Array<IPCB_PrimitiveString>>

Array of Text primitive objects

Example

// 1. 创建一个顶层丝印（3）测试文本作为过滤目标（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 100000);
const y = 2000 + Math.floor(Math.random() * 100000);
const text = await eda.pcb_PrimitiveString.create(3, x, y, '嘉立创示例_过滤目标', 'default', 45, 6, 3, 0, false, 0, false, false);
const textId = text.getState_PrimitiveId();

// 2. 不带参数：获取 PCB 上全部文本
const all = await eda.pcb_PrimitiveString.getAll();

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

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

console.log('total strings:', all.length);
console.log('top silkscreen strings:', topSilk.length);
console.log('marker string found:', topSilk.some(s => s.getState_PrimitiveId() === textId));