Home > @magiclane/maps-sdk > GemView > getHighlightArea

GemView.getHighlightArea() method

Get highlighted geographic area.

Signature:

getHighlightArea(highlightId?: number): RectangleGeographicArea | null;

Parameters

Parameter

Type

Description

highlightId

number

(Optional) An identifier for the highlight whose area is to be retrieved, with a default value of 0.

Returns:

RectangleGeographicArea | null

A RectangleGeographicArea object representing the geographic bounds of the highlighted area

Exceptions

An exception if it fails.