Home > @magiclane/maps-sdk > GemMap > highlightHoveredMapLabel

GemMap.highlightHoveredMapLabel() method

Highlight the hovered map label under the given screen coordinates.

To turn off the hover highlight call the function with (0, 0) screen position

A recommended implementation is to call highlightHoveredMapLabel(..., selectMapObjects = false) to check if a label is hovered (and eventually update tracking device cursor shape etc) and if the cursor position is stationary for a reasonable time period (e.g. 500 ms) call highlightHoveredMapLabel(..., selectMapObjects = true) to retrieve the hovered map object data

Signature:

highlightHoveredMapLabel(screenPosition: Point, input?: {
        selectMapObject?: boolean;
    }): GemError;

Parameters

Returns:

GemError

• 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 - Other GemError codes if other errors occur

Exceptions

An exception if the operation fails