Events

This section describes events exposed by this widget.

click

Fires when the map is clicked.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

location: Object

Returns the location of the clicked point on the map (if the 'google' or 'bing' provider is used).

jQueryEvent: jQuery.Event

Returns a jQuery event that caused the action execution (if a static google provider is used).

disposing

Fires when you dispose of this component.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

markerAdded

Fires after a marker is added to the map.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

options: Object

Returns the object that defines the currently added marker in the "markers" array.

originalMarker: Object

Returns an original marker object used by the current map provider (only for 'google' and 'bing' providers).

markerRemoved

Fires after a marker is removed from the map.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

options: Object

Returns the object that defines the currently removed marker in the "markers" array.

optionChanged

Fires after an option of the component is changed.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

value: any

Specifies a new value for the option.

ready

Fires after a map is rendered.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

originalMap: Object

Returns the provider's map instance.

routeAdded

Fires after a route is added to the map.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

options: Object

Returns the object that defines the currently added route in the "routes" array.

originalMarker: Object

Returns an original route object used by the current map provider (only for 'google' and 'bing' providers).

routeRemoved

Fires after a route is removed from the map.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

options: Object

Returns the object that defines the currently removed route in the "markers" array.