The HTML target in which the map is rendered to.
A factory provider that is responsible for generating the necessary map content as required by the mapping strategy.
The third-party map view instance associated with the mapping strategy.
Adds the marker to the map view. The provided marker must be an instance type required by the current mapping strategy.
Adds an array of markers to the map view. The provided markers must be an instance type required by the current mapping strategy.
Adds the specified overlay layer to the map. The overlay must be an instance of the type required by the configured map strategy and underlying third-party mapping library.
Adds a series of overlay layers to the map. The overlays must be an instance of the type required by the configured map strategy and underlying third-party mapping library.
Adds a polygon or polyline to the map view. The provided shape must be an instance type required by the current mapping strategy.
Adds an array of polylines and/or polygons to the map view. The provided shapes must be an instance type required by the current mapping strategy.
Adds the specified map content source to the map.
Converts the specified geographical coordinate to pixel coordinates within the map view's container.
Sets the minimum visible geographical bounds for the map view so that the specified bounds are contained within the visible region with an optional inset.
Returns the geographical bounds for the visible region of the map view.
Returns the geographical center coordinate of the map view.
Returns the current zoom level of the map view.
Returns whether the listeners are registered for the specified event name.
Returns whether the element is a native map marker instance.
Returns whether the element is a native map polygon instance.
Returns whether the element is a native map polyline instance.
Returns whether the map and underlying map strategy have been fully setup and initialized.
Returns whether the element is a tile source object.
Returns whether the element is a vector source object.
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
Converts the specified pixel coordinates within the map view's container to geographical coordinates on the map.
Removes the marker from the map view. The provided marker must be an instance type required by the current mapping strategy.
Adds an array of markers from the map view. The provided markers must be an instance type required by the current mapping strategy.
Removes the specified overlay layer from the map. The overlay must be an instance of the type required by the configured map strategy and underlying third-party mapping library.
Removes a series of overlay layers from the map. The overlay must be an instance of the type required by the configured map strategy and underlying third-party mapping library.
Removes the polyline or polygon from the map view. The provided shape must be an instance type required by the current mapping strategy.
Removes an array of polylines and/or polygons from the map view. The provided shape must be an instance type required by the current mapping strategy.
Removes the specified map content source from the map.
Sets the geographical bounds for the visible region of the map view.
Sets the geographical center coordinate of the map view.
Sets the current map view using the specified center coordinate and zoom level.
Sets the zoom level of the map view.
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 mapping strategy.
Triggers the specified event so that all registered listeners will be executed with the specified parameters.
Event name to trigger
Updates an existing marker using the specified options. The provided marker must already exist on the map view and must be an instance type required by the current mapping strategy.
Generated using TypeDoc
An abstract map strategy class that provides the core functionality required for a specific mapping strategy. This class should be subclassed per each strategy instead of being instantiated directly.