Events

This section describes events fired by this widget.

See Also

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. Available only in the Knockout approach.
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).

Instead, you can use the onClick option to handle the event.

See Also

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
The model data. Available only if you use Knockout.

Main article: onDisposing

See Also

initialized

Raised only once, after the widget is initialized.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.

Main article: onInitialized

See Also

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. Available only in the Knockout approach.
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).

Instead, you can use the onMarkerAdded option to handle the event.

See Also

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. Available only in the Knockout approach.
options: Object
Returns the object that defines the currently removed marker in the "markers" array.

Instead, you can use the onMarkerRemoved option to handle the event.

See Also

optionChanged

Raised after an option of the widget is changed.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
The widget instance.
name: String
A short name of the option whose value has been changed.
fullName: String
A full name of the option whose value has been changed; contains a full hierarchy of the option.
value: any
A new value for the option.
element: jQuery
The widget's container.
model: Object
The model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

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. Available only in the Knockout approach.
originalMap: Object
Returns the provider's map instance.

Instead, you can use the onReady option to handle the event.

See Also

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. Available only in the Knockout approach.
options: Object
Returns the object that defines the currently added route in the "routes" array.
originalRoute: Object
Returns an original route object used by the current map provider (only for 'google' and 'bing' providers).

Instead, you can use the onRouteAdded option to handle the event.

See Also

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. Available only in the Knockout approach.
options: Object
Returns the object that defines the currently removed route in the "markers" array.

Instead, you can use the onRouteRemoved option to handle the event.

See Also