Home > SCH_PrimitivePolygon > get

SCH_PrimitivePolygon.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 Polygon

Signature

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

Parameters

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

Returns

Promise<ISCH_PrimitivePolygon | undefined>

Polygon primitive object, undefined indicates that the retrieval failed

Example

// 1. 在画布空白处创建两个测试多边形（随机坐标避免重合）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const poly1 = await eda.sch_PrimitivePolygon.create([x, y, x + 400, y, x + 400, y + 300], '#FF0000');
const poly2 = await eda.sch_PrimitivePolygon.create([x, y + 400, x + 400, y + 400, x + 200, y + 700], '#0000FF');
const id1 = poly1.getState_PrimitiveId();
const id2 = poly2.getState_PrimitiveId();

// 2. 传单个 ID 字符串，返回单个多边形对象
const single = await eda.sch_PrimitivePolygon.get(id1);

// 3. 传 ID 数组，返回多边形对象数组（任一 ID 未匹配不影响其它图元的返回）
const arr = await eda.sch_PrimitivePolygon.get([id1, id2]);

// 4. 清理测试多边形（查询类需要清理）
await eda.sch_PrimitivePolygon.delete([id1, id2]);

console.log('single primitiveType:', single.getState_PrimitiveType());
console.log('single line:', JSON.stringify(single.getState_Line()));
console.log('array length:', arr.length);
console.log('poly2 color:', arr[1].getState_Color());