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: Array<string>): Promise<Array<ISCH_PrimitiveCircle>>;

Parameters

Parameter	Type	Description
primitiveIds	Array<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<Array<ISCH_PrimitiveCircle>>

Circle primitive object; an empty array indicates that the retrieval failed

Remarks

If multiple primitive IDs are passed in, a primitive ID that is not matched will not affect the return of other primitives; that is, fewer primitive objects than the number of primitive IDs passed in may be returned.