Home > SCH_Document > getPrimitiveAtPoint

SCH_Document.getPrimitiveAtPoint() 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 primitive at the coordinate point

Signature

function getPrimitiveAtPoint(x: number, y: number): Promise<ISCH_Primitive | undefined>;

Parameters

Parameter	Type	Description
x	number	Coordinate point X
y	number	Coordinate point Y

Returns

Promise<ISCH_Primitive | undefined>

The primitive at the coordinate point. If no primitive can be found at the coordinate point, undefined will be returned

Remarks

This operation is similar to clicking with the mouse on the front end; it will get the primitive at the specified coordinate point ADD since EDA v4.2