JavaScript/jQuery Map Events
This section describes events fired by this widget.
click
Raised when any location on the map is clicked.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| location |
The clicked point's location on the map (if the "google" or "bing" provider is used). |
|
| jQueryEvent |
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. |
disposing
Raised before the widget is disposed of.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if you use Knockout. |
Main article: onDisposing
See Also
initialized
Raised only once, after the widget is initialized.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
Main article: onInitialized
See Also
markerAdded
Raised when a marker is created on the map.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| options |
The added marker's data. |
|
| originalMarker |
The original marker that the current map provider uses (only for "google" and "bing" providers). |
Main article: onMarkerAdded
See Also
markerRemoved
Raised when a marker is removed from the map.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| options |
The removed marker's data. |
Main article: onMarkerRemoved
See Also
optionChanged
Raised after a widget option is changed.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| name |
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into. |
|
| model |
The model data. Available only if you use Knockout. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| component |
The widget's instance. |
|
| fullName |
The path to the modified option that includes all parent options. |
|
| value | any |
The modified option's new value. |
Main article: onOptionChanged
See Also
ready
Raised when the map is ready.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| originalMap |
The current provider's map data. |
routeAdded
Raised when a route is created on the map.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| options |
The added route's data. |
|
| originalRoute |
The original route that the current map provider uses (only for "google" and "bing" providers). |
Main article: onRouteAdded
See Also
routeRemoved
Raised when a route is removed from the map.
Event
Information about the event.
| Name | Type | Description |
|---|---|---|
| component |
The widget's instance. |
|
| element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
| model |
The model data. Available only if Knockout is used. |
|
| options |
The removed route's data. |
Main article: onRouteRemoved