ConfigApi static class
LayerApi static class
Load plugins API
Utilities object
Creates a new map in a given div id.
GV The div MUST NOT have a geoview-map class or a warning will be shown when initMapDivFromFunctionCall is called. If is present, the div will be created with a default config.
Id of the div to create map in (becomes the mapId)
Config passed in from the function call (string or url of a config path)
OptionaldivHeight: number
Optional height of the div to inject the map in (mandatory if the map reloads)
Optional flag to wait for the map to be ready before resolving the promise
A promise that resolves with the MapViewer (after the onMapReady is triggered) which will be created from the configuration
Creates a new map in a given div id.
GV The div MUST NOT have a geoview-map class or a warning will be shown when initMapDivFromFunctionCall is called. If is present, the div will be created with a default config.
Id of the div to create map in (becomes the mapId)
Config passed in from the function call (string or url of a config path)
OptionaldivHeight: number
Optional height of the div to inject the map in (mandatory if the map reloads)
A promise that resolves with the MapViewer (after the onMapReady is triggered) which will be created from the configuration
Deletes a map viewer instance by its ID and unmounts it from the DOM - for React.
The unique identifier of the map to delete
True if we want to delete div from the page
A promise that resolves when the map viewer is deleted
Gets a map viewer instance by its ID.
The unique identifier of the map to retrieve
The map viewer instance if found
Asynchronously gets a map viewer instance by its ID.
The unique identifier of the map to retrieve
A promise that resolves with the map viewer instance when/if found
Gets the list of all map IDs currently in the collection.
Array of map IDs
Returns true if a map id is already registered.
The unique identifier of the map to retrieve
True if map exist
Unregisters a map viewer set event callback.
The callback to stop being called whenever the event is emitted
Returns a promise that resolves the next time the map viewer set event fires.
Optionalfilter: (event: MapViewerSetEvent) => boolean
Optional filter to only resolve when the event matches
A promise that resolves with the event payload when a map viewer is set
Registers a map viewer set event callback.
The callback to be executed whenever the event is emitted
The callback delegate that was registered
Reload a map from a config object stored in store, or provided. It first removes then recreates the map.
The unique identifier of the map to reload
OptionalmapConfig: TypeMapFeaturesConfig | TypeMapFeaturesInstance
Optional map config to use for reload
A promise that resolves with the MapViewer which will be created once reloaded
Reload a map from a config object created using current map state. It first removes then recreates the map.
The unique identifier of the map to reload
Indicates if geocore layer names should be kept as is or returned to defaults. Set to false after a language change to update the layer names with the new language
A promise that resolves with the MapViewer which will be created once reloaded
Sets a map viewer in maps.
ID of the map
The viewer to be added
Waits for a specific map viewer to be set via the onMapViewerSet event.
The unique identifier of the map to wait for
A promise that resolves with the map viewer instance once it is set
Class used to handle api calls (events, functions etc...).