Home > SCH_Document > getPrimitivesInRegion

SCH_Document.getPrimitivesInRegion() 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 primitives in the region

Signature

function getPrimitivesInRegion(
	left: number,
	right: number,
	top: number,
	bottom: number,
): Promise<Array<ISCH_Primitive>>;

Parameters

Parameter	Type	Description
left	number	First X coordinate of the rectangle
right	number	Second X coordinate of the rectangle
top	number	First Y coordinate of the rectangle
bottom	number	Second Y coordinate of the rectangle

Returns

Promise<Array<ISCH_Primitive>>

All primitives in the region

Remarks

This API only returns primitives that are completely contained in the region. If a primitive is partially outside the region, it will be ignored ADD since EDA v4.2