Class Overlay

Store and manage overlays (popups) on the map.

Index

Constructors

Methods

addOverlay clearOverlaysByGroupId getOverlays setOverlayZindex

Constructors

constructor

new Overlay(map: Map): Overlay
Parameters
- map: Map
Returns Overlay
- Defined in overlay/overlay.ts:10

Methods

addOverlay

addOverlay(overlayGroupUid: string, overlay: Overlay): void
Add an overlay (with a group id) to the map.
Parameters
- overlayGroupUid: string
- overlay: Overlay
Returns void
- Defined in overlay/overlay.ts:15

clearOverlaysByGroupId

clearOverlaysByGroupId(overlayGroupUid: string): void
Clear from the map all existing overlays from a group.
Parameters
- overlayGroupUid: string
Returns void
- Defined in overlay/overlay.ts:33

getOverlays

getOverlays(overlayGroupUid: string): Overlay[]
Parameters
- overlayGroupUid: string
Returns Overlay[]
all overlay for a specific group.
- Defined in overlay/overlay.ts:23

`Static`setOverlayZindex

setOverlayZindex(overlay: Overlay, zIndex: number): void
Set z-index of an overlay.
Parameters
- overlay: Overlay
- zIndex: number
Returns void
Static
- Defined in overlay/overlay.ts:45