Home > SCH_PrimitiveCircle > get

SCH_PrimitiveCircle.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 circle

Signature

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

Parameters

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

Returns

Promise<ISCH_PrimitiveCircle | undefined>

Circle primitive object, undefined indicates that the retrieval failed

Example

// 1. 创建两个测试圆（随机坐标避免重合，SCH 坐标单位 10mil）
const x = 2000 + Math.floor(Math.random() * 8000);
const y = 2000 + Math.floor(Math.random() * 8000);
const circle1 = await eda.sch_PrimitiveCircle.create(x, y, 100);
const circle2 = await eda.sch_PrimitiveCircle.create(x + 400, y, 150);

// 2. 传单个 ID 字符串，返回单个圆对象
const single = await eda.sch_PrimitiveCircle.get(circle1.getState_PrimitiveId());

// 3. 传 ID 数组，返回圆对象数组（任一 ID 未匹配不影响其它图元的返回）
const arr = await eda.sch_PrimitiveCircle.get([circle1.getState_PrimitiveId(), circle2.getState_PrimitiveId()]);

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

console.log('single radius:', single.getState_Radius());
console.log('array length:', arr.length);
console.log('circle2 radius:', arr[1].getState_Radius());