@magiclane/maps-sdk
↑↓ Navigate ⏎ Open Esc Close

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

GemView.activateHighlight() method

Activate highlight

Signature:

activateHighlight(landmarks: Landmark[], input?: {
        renderSettings?: HighlightRenderSettings;
        highlightId?: number | null;
    }): void;

Parameters

Parameter

Type

Description

landmarks

Landmark[]

The landmarks to be highlighted

{ renderSettings, highlightId, }

(not declared)

(Optional)

input

{ renderSettings?: HighlightRenderSettings; highlightId?: number | null; }

(Optional)

input properties:

Returns:

void

Exceptions

An exception if it fails.