Initializes and returns a map source module instance configured with the specified options if provided.
Aeris account associated with the module.
Application the module was initialized with.
Data associated with the module.
If the module loads remote data when added to a map, this value will return the data that was last returned by the remote request.
Map data source created for the module.
Sets the module's map data source.
Parent module group the module belongs to, if any.
Sets the parent module group.
Module identifier.
Application map instance.
Returns the module's configuration options.
Returns the application controls configuration.
Returns whether the listeners are registered for the specified event name.
Returns the configuration for the info panel content view.
Initializes the module with the specified Aeris account and application.
Returns the legend configuration.
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
Called when the module's map content source has been added to the map.
Called when the module's map content source has loaded data.
Called when the module has been initialized with an application.
Called when a marker associated with the module's map content source is clicked on the map.
Called when the module's map content source is removed from the map.
Called when a polygon or polyline associated with the module's map content source is clicked on the map.
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
Shows the map info panel using the specified title and data for the configured view associated with the module.
Returns the map content source configuration.
Triggers the specified event so that all registered listeners will be executed with the specified parameters.
Event name to trigger
Generated using TypeDoc
A map source module is a container for providing all of the required configuration and functionality needed for rendering and controlling a map content source on an interactive map application.
A module can be a direct instance of
MapSourceModule, in which case a configuration object must be provided when instantiating the instance. Or, a module can be provided as a subclass ofMapSourceModule, in which case the subclass can override the necessary properties and methods of the parent class to provide the necessary configuration and functionality.Regardless which implementation method is used, a module must return a valid map content source from the
source()method.{IMapSourceModule}