JavaScript/jQuery Map Events

This section describes events fired by this widget.

click

Fires when the map is clicked.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
location	Object	The clicked point's location on the map (if the 'google' or 'bing' provider is used).
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution (if a static google provider is used). Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.

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

disposing

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

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if you use Knockout.

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onInitialized

markerAdded

Fires after a marker is added to the map.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
options	Object	The added marker's data.
originalMarker	Object	The original marker that the current map provider uses (only for 'google' and 'bing' providers).

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

markerRemoved

Fires after a marker is removed from the map.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
options	Object	The removed marker's data.

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

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Object	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

ready

Fires after a map is rendered.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
originalMap	Object	The current provider's map data.

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

routeAdded

Fires after a route is added to the map.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
options	Object	The added route's data.
originalRoute	Object	The original route that the current map provider uses (only for 'google' and 'bing' providers).

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

routeRemoved

Fires after a route is removed from the map.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The model data. Available only if Knockout is used.
options	Object	The removed route's data.

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

JavaScript/jQuery Map Events

See Also

click

See Also

disposing

See Also

initialized

See Also

markerAdded

See Also

markerRemoved

See Also

optionChanged

See Also

ready

See Also

routeAdded

See Also

routeRemoved

See Also