Initializes a map instance with the specified target and configuration object.
Either the HTMLElement where you want your map view to be rendered, or
an existing map object instance that pertains to one of the supported third-party mapping
libraries. If a map object instance if provided, then that instance will be used for
rendering weather data instead of the library creating a new instance.
Updates the map timeline and all active map content sources on the map.
Configuration and style manager for the map content sources and associated layers.
Returns whether the current map units are set to metric.
Returns the layer metadata info instance.
Returns the underlying third-party map object instance associated with the current map strategy.
Returns the configured options for the map.
Returns the current map strategy being used.
Returns the map's animation timeline.
Adds an AMP layer to the map for the specified layer code.
Adds a series of AMP layers for the specified array of layer codes.
Adds the map content source associated with a map module.
Adds a new map content source for the specified layer code.
Updates the layer's zIndex order by bringing it to the top of the layer stack. This only affects tile and image layers.
Instantiates and returns a new map content source instance based on the specified type and configuration options.
Disables auto-updating of map data.
Enables auto-updating of map data on regular intervals based on the specified number of seconds.
Sets the map bounds to contain the specified geographical bounds with optional padding insets.
Returns the geographical bounds for the visible map region.
Returns the map's center coordinate.
Returns the map content source associated with the specified key, if any.
Returns the map content source associated with the specified identifier, if any.
Returns the map content source associated with the specified layer code, if any.
Returns the current map zoom level.
Returns whether the listeners are registered for the specified event name.
Returns whether a data source exists on the map for the specified key.
Returns whether the map is ready, meaning the underlying map view and events have been fully setup and initialized.
Removes a registered listener function for the specified event.
Name of the event to remove the listener for.
Handler function to remove so it won't be executed next time the event is triggered.
Registers a listener function to be executed each time an event occurs
Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.
Handler function to be called when the event occurs
Registers a listener function to be executed the first time an event occurs.
Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.
Handler function to be called when the event occurs
Removes all active data sources from the map.
Removes an AMP layer from the map for the specified layer code.
Removes an AMP layer from the map for the specified identifier.
Removes a series of AMP layers associated with the specified array of layer codes.
Removes the map content source associated with the specified layer code.
Updates the layer's zIndex order by sending it to the bottom of the layer stack. This only affects tile and image layers.
Sets the map bounds to contain the specified geographical bounds.
Sets the map's center coordinate.
Updates the layer's zIndex order. This only affects tile and image layers.
Sets the units to display on the map.
Map content sources that display measurement values should observe the change:unit event and update their content on the map accordingly.
Sets the map's center coordinate and zoom level.
Sets the map zoom level.
Presents a callout bubble on the map from the specified target. The target can either be an
Coordinate object or a native marker object for the current mapping strategy.
You can provide native options to configure the callout via the opts parameter, which is
a configuration object as supported by the strategy's mapping library.
Triggers the specified event so that all registered listeners will be executed with the specified parameters.
Event name to trigger
Generated using TypeDoc
An
InteractiveMapobject provides an abstract interface for displaying weather-related data on an interactive map view using one of the supported third-party mapping libraries.{MapStrategyDataSource}