Interface Overlays

Manages active overlays on the map.

interface Overlays {
    "[REGISTER_OVERLAY]"(overlay: Overlay): void;
    "[UNREGISTER_OVERLAY]"(overlay: Overlay): void;
    add(options: OverlayOptions): Overlay;
    clear(): void;
    getAll(): Overlay[];
}

Index

Methods

[REGISTER_OVERLAY] [UNREGISTER_OVERLAY] add clear getAll

Methods

[REGISTER_OVERLAY]

"[REGISTER_OVERLAY]"(overlay: Overlay): void
Parameters
- overlay: Overlay
Returns void
- Defined in src/packages/map/model/Overlays.ts:42

[UNREGISTER_OVERLAY]

"[UNREGISTER_OVERLAY]"(overlay: Overlay): void
Parameters
- overlay: Overlay
Returns void
- Defined in src/packages/map/model/Overlays.ts:50

add

add(options: OverlayOptions): Overlay
Add new overlay to the map. Returns the newly created overlay instance.
Parameters
- options: OverlayOptions
Returns Overlay
- Defined in src/packages/map/model/Overlays.ts:61

clear

clear(): void
Destroys all overlays.

Returns void
- Defined in src/packages/map/model/Overlays.ts:76

getAll

getAll(): Overlay[]
Returns the list of all current overlays.

Returns Overlay[]
- Defined in src/packages/map/model/Overlays.ts:69