Home > SCH_Document > navigateToRegion

SCH_Document.navigateToRegion() 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.

Locate to canvas region

Signature

function navigateToRegion(
	left: number,
	right: number,
	top: number,
	bottom: number,
): Promise<boolean>;

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<boolean>

Whether the operation is successful

Remarks

This API positions on the front-end canvas to the specified region;

For example: the passed-in data is {left: 0, right: 60, top: 100, bottom: -20} => navigateToRegion(0, 60, 100, -20), then the canvas will be positioned to a rectangular range centered at [30, 40] with a length of 60 in the x-axis direction and 120 in the y-axis direction;

This API does not perform zooming, but it will generate a rectangle frame indicating the positioning center and the region range;

The unit span here is 0.01inch ADD since EDA v4.2