Initializes the basemap API.
The map viewer
The map controller
The basemap option properties, passed in from map config
OptionalactiveThe active basemap
The basemap options passed from the map config
The basemap creation configuration list
Indicates if the basemap has been created successfully
OptionaldefaultThe default extent
OptionaldefaultThe default origin
OptionaldefaultThe default resolutions
OptionaloverviewThe overview map basemap
OptionaloverviewThe overview map control
StaticDEFAULT_The maximum delay to wait before we warn about the basemap taking a long time
Clears the basemap layers from the map.
Creates the core basemap and adds the layers to it.
The basemap options
Optionalprojection: TypeValidMapProjectionCodes
Optional projection code
Optionallanguage: TypeDisplayLanguage
Optional display language
A promise that resolves with the core basemap
Creates the layers for the overview map.
The array of base layers for the overview map
Gets the visibility state of the overview map control.
True if the overview map control is visible, false otherwise
Gets or creates the overview map control.
The OpenLayers map instance
The toggle button element for the overview map
The overview map control
Loads the default basemap that was passed in the map config.
Optionalprojection: TypeValidMapProjectionCodes
Optional projection code
Optionallanguage: TypeDisplayLanguage
Optional display language
Unregisters a basemap changed event callback.
The callback to stop being called whenever the event is emitted
Unregisters a basemap error event callback.
The callback to stop being called whenever the event is emitted
Unregisters an overview map control visibility changed event callback.
The callback to stop being called whenever the event is emitted
Registers a basemap changed event callback.
The callback to be executed whenever the event is emitted
Registers a basemap error event callback.
The callback to be executed whenever the event is emitted
Registers a one-shot overview map control visibility changed event handler that resolves a promise.
Optionalfilter: (event: OverviewMapControlVisibilityChangedEvent) => boolean
Optional filter predicate to skip non-matching events without unsubscribing
A promise that resolves with the overview map control visibility changed event
Registers an overview map control visibility changed event callback.
The callback to be executed whenever the event is emitted
Refreshes the basemap layers
Sets the current basemap and updates the basemap layers on the map.
The basemap to set as active
Creates and sets the overview map basemap.
A promise that resolves when the overview map basemap has been created and set
Sets the visibility of the overview map control.
The OpenLayers map instance
Whether the overview map control should be visible
Waits until the overview map visibility matches the expected state.
Sync-checks first, then subscribes to the visibility-changed event until the condition is met.
The expected visibility state to wait for
A promise that resolves once the visibility matches the expected state
A class to get a Basemap for a define projection and language. For the moment, a list maps are available and can be filtered by projection (currently only WM and LCC projections are listed, in case other projections needed, they need to be added to the list).