AbstractProtected Optional_Protected Optional_Protected_Protected_Protected Optional_Get the cursor screen position. The coordinates are relative to the parent view screen
The current screen coordinates (Xy) of the cursor, relative to the view's parent screen.
Get access to MapViewExtensions
A MapViewExtensions object, providing additional functionalities and extensions specific to the MapView.
Get the map ID.
Get the pointer ID.
The current viewport of the map view.
Fields RectType.x and RectType.y are 0 as they are measured from the top left corner of the map view. Fields RectType.width and RectType.height are the width and height of the map view in physical pixels.
To get the associated RectangleGeographicArea, use the appropriate coordinate transformation method.
The current viewport.
Activate highlight
The landmarks to be highlighted
Options for highlight activation.
OptionalhighlightId?: number | nullThe highlighted collection id (optional). If a highlighted collection with this id already exists, it will be replaced
Highlighted collections will be displayed in ascending order sorted by highlightId
OptionalrenderSettings?: HighlightRenderSettingsSpecifies the way the provided landmarks are displayed on the map
Adds a GeoJSON data buffer as a marker collection.
The GeoJSON data buffer to be added as a marker collection.
The name of the marker collection.
The created marker collections
Set the map north-up oriented.
Optionalanimation: GemAnimationSpecifies the animation to be used by the operation.
Make a screen region capture of the current map in JPEG format.
No cursor or on-screen information is included. On Android it includes the cursor and any on-screen information.
An image of the map shown on the screen.
Center the view on the given WGS area
Geographic area
Options for centering.
Optionalanimation?: GemAnimation | nullSpecifies the animation to be used by the operation.
OptionalscreenPosition?: Point | nullScreen position where the coordinates should project (default uses the specified cursor coordinates). The coordinates are relative to the parent view screen.
OptionalzoomLevel?: numberZoom level. When -1 is used, the zoom level is automatically selected so that the entire area is visible on the map.
Center the WGS coordinates on the specified screen coordinates.
Coordinates to center on.
Options for centering.
Optionalanimation?: GemAnimationSpecifies the animation to be used by the operation.
OptionalmapAngle?: numberMap rotation angle in the range 0.0 - 360.0 degrees (use Infinity for automatic selection).
OptionalscreenPosition?: PointScreen position where the coordinates should project (default uses the specified cursor coordinates). The coordinates are relative to the parent view screen.
OptionalslippyZoomLevel?: numberSlippy zoom level (use -1.0 for automatic selection).
OptionalviewAngle?: numberMap view angle in the range -90.0 - 90.0 degrees (use Infinity for automatic selection).
OptionalzoomLevel?: numberZoom level (use -1 for automatic selection).
Center on the routes visible on the map.
Options for centering.
Optionalanimation?: GemAnimation | nullSpecifies the animation to be used by the operation.
OptionaldisplayMode?: RouteDisplayMode | nullRoute display mode.
OptionalscreenRect?: RectType<number> | nullScreen viewport rectangle where routes should be centered. The coordinates are relative to view parent screen.
Center on the given route.
The zoom level is automatically selected so that the entire route is visible on the map.
Route to be shown.
Options for centering.
Optionalanimation?: GemAnimationSpecifies the animation to be used by the operation.
OptionalscreenRect?: RectType<number>Screen rectangle where area should be centered. The coordinates are relative to view parent screen.
Center on the given routes collection.
All routes from the list will be visible on the map. The zoom level is automatically selected.
Options for centering.
Optionalanimation?: GemAnimation | nullSpecifies the animation to be used by the operation.
OptionaldisplayMode?: RouteDisplayModeRoute display mode.
Optionalroutes?: Route[]Route list to be shown. If no routes are provided then centering is done on the visible routes from MapViewRoutesCollection.
OptionalscreenRect?: RectType<number> | nullScreen viewport rectangle where routes should be centered. The coordinates are relative to view parent screen.
Center on the given traffic event.
RouteTrafficEvent to be shown.
Options for centering.
Optionalanimation?: GemAnimationSpecifies the animation to be used by the operation.
Optionalrectangle?: RectType<number>Screen rectangle where area should be centered. The coordinates are relative to view parent screen.
OptionalviewAngle?: numberSpecifies the map pitch angle.
OptionalzoomLevel?: numberZoom level (use -1 for automatic selection).
Retrieve the list of landmarks under the cursor location.
Use setCursorScreenPosition to set the cursor location.
A list of Landmark objects under the cursor. If no landmarks are found, the list will be empty.
Retrieves a reference to a list of markers under the current cursor location.
Use setCursorScreenPosition to set the cursor location.
A list of MarkerMatch objects under the cursor. If no markers are found, the list will be empty.
Retrieve the list of overlay items under the cursor location.
Use setCursorScreenPosition to set the cursor location.
A list of OverlayItem objects under the cursor. If no overlay items are found, the list will be empty.
Retrieve the list of overlay items under the cursor location filtered by overlay type.
Use setCursorScreenPosition to set the cursor location.
The overlay id to filter the overlay items.
A list of OverlayItem objects under the cursor filtered by the given overlay type. If no overlay items are found, the list will be empty.
Retrieve the list of routes under the cursor location.
Use setCursorScreenPosition to set the cursor location.
A list of Route objects under the cursor. If no routes are found, the list will be empty.
Retrieve the list of streets under the cursor location.
Use setCursorScreenPosition to set the cursor location.
A list of Street objects under the cursor. If no streets are found, the list will be empty.
Cleans up any resources.
Allows the user to draw markers on the map using touch gestures.
Panning/zooming the map is deactivated.
OptionalrenderSettings: MarkerCollectionRenderSettingsRender settings for the draw markers
Get highlighted geographic area.
An identifier for the highlight whose area is to be retrieved, with a default value of 0.
A RectangleGeographicArea object representing the geographic bounds of the highlighted area
Retrieve the set of landmarks on the specified coordinates.
This is a quick synchronous reverse geocoding method.
Reference Coordinates for this operation.
A Landmark list containing the nearest locations to the specified coordinates. If no landmarks are found, the list will be empty.
Method called when an event is triggered from the native side.
Should not be called by the user.
The event data.
Handle a touch event.
The pointer index of the touch event.
The type of touch event (0 = down, 1 = move, 2 = up, 3 = cancel).
The x-coordinate of the touch event.
The y-coordinate of the touch event.
GemError.success if successful, or other error codes.
Highlight the hovered map label under the given screen coordinates.
To turn off the hover highlight, call this function with a (0, 0) screen position.
A recommended usage is to call highlightHoveredMapLabel(..., selectMapObject = false) to check if a label is hovered
(and possibly update the tracking device cursor shape, etc.), and if the cursor position is stationary for a reasonable time period
(e.g., 500 ms), call highlightHoveredMapLabel(..., selectMapObject = true) to retrieve the hovered map object data.
The hovered screen point.
If true and a label is hovered, map objects attached to the label are returned via IMapViewListener.onHoveredMapLabelHighlighted. If false, no call to onHoveredMapLabelHighlighted is issued.
GemError.success if successful, GemError.notFound if no label was found, GemError.activation if the map is invalid, GemError.noMemory if memory could not be allocated for the highlighted object, GemError.inUse if another operation is in progress, or another GemError code if an error occurs.
Returns true if the camera is following the current real/simulated position in default auto-zoom mode and false otherwise.
True if the map is in the default auto-zoom follow position mode, false if it has been manually adjusted or is not in follow position mode.
Returns true if the camera is following the current real/simulated position from a fixed relative position adjusted by user input and false otherwise.
True if the follow position mode has been manually adjusted by the user, false if it remains in its default state.
Called when the cursor selection is updated with landmarks.
The selected landmarks.
Called when the cursor selection is updated with routes.
The selected routes.
Called when a double touch is detected.
The position of the double touch.
Called when the follow position state changes.
The new follow position state.
Called when a long press is detected.
The position of the long press.
Called when the map angle is updated.
The new map angle.
Called when a marker is rendered.
The marker data.
Called when a pinch swipe gesture is detected.
The center position in pixels.
The zooming speed in mm/sec.
The rotating speed in mm/sec.
Called when a pointer is pressed down.
The pointer identifier.
The position of the pointer.
Called when a pointer moves.
The pointer identifier.
The position of the pointer.
Called when a pointer is released.
The pointer identifier.
The position of the pointer.
Called when the map scale is rendered.
The scale width.
The scale value.
The scale units.
Called when the map style is set.
The style id.
The style path.
Whether the style was set via API.
Called when a swipe gesture is detected.
The horizontal distance.
The vertical distance.
The swipe speed in mm/sec.
Called when the map view is touched.
The position of the touch event.
Called when the follow position state is modified by a touch handler.
The new follow position state.
Called when two double touches are detected.
The position of the touches.
Called when the view is rendered.
The render data.
ProtectedregisterInternalProtectedregisterRegister a callback for marker render events. Can only be called from inherited classes.
The callback to invoke when a marker is rendered.
Register a touch callback.
OptionaltouchCallback: (pos: Point) => voidThe touch callback to register.
ProtectedregisterRegister a callback for view rendered events. Can only be called from inherited classes.
The callback to invoke when the view is rendered.
InternalRestore following position from a manually adjusted mode (camera position fixed relative to the current/simulated position) to default auto-zoom mode.
Optionalanimation: GemAnimationSpecifies the animation to be used by the operation.
Set the cursor screen position.
Use this function to trigger a map view selection (POI, landmark, overlay, route, path, marker) at the given screen coordinates. The current view selection can be queried via cursorSelectionRoutes, cursorSelectionLandmarks, cursorSelectionStreets, cursorSelectionOverlayItems, cursorSelectionMarkers methods.
position relative to the parent screen. The coordinates are relative to the parent view screen
Set a new zoom level based on slippy tile level. When 'follow position' is active, the current position will be used as the reference point for the operation. Otherwise, the screen center will be used. The zoom level may be between 0 and MaxSlippyZoomLevel.
Zoom level
Options for zooming.
Optionalduration?: numberThe animation duration in milliseconds (0 means no animation).
OptionalscreenPosition?: Point | nullScreen coordinates on which the map should stay centered. The coordinates are relative to the parent view screen.
The previous zoom level.
Set a new zoom level centered on the specified screen position.
This may be between 0 and maxZoomLevel
Zoom level
Options for zooming.
Optionalduration?: numberThe animation duration in milliseconds (0 means no animation).
OptionalscreenPosition?: Point | nullScreen coordinates on which the map should stay centered. The coordinates are relative to the parent view screen.
On success, the previous zoom level. On error, the error code.
Start following the current position.
Requires automatic map rendering. Disables the cursor if it is enabled.
Options for following position.
Optionalanimation?: GemAnimationSpecifies the animation to be used by the operation.
OptionalviewAngle?: numberMap view angle. Default is Infinity meaning use default specified.
OptionalzoomLevel?: numberZoom level where the animation stops. (Use -1 for automatic selection)
Convert a screen(x, y) coordinate to a WGS(lon, lat) coordinate.
Screen coordinate. The coordinates are relative to the parent view screen
WGS 84 coordinates of the given screen coordinate
Convert a list of WGS84 coordinates to screen coordinates.
list of WGS Coordinates
The screen coordinates relative to view parent screen
Convert a WGS84 coordinate to a screen coordinate.
WGS Coordinates
The screen coordinates relative to view parent screen
Abstract class representing a GemView. Implements EventHandler and IMapViewListener.