Events
This section describes events fired by this widget.
areaClick
Use the onClick instead.
Fires when a user clicks an area.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
The Area object.
When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the clicked area. An object that represents this area has fields and methods documented in the Area class description.
See Also
areaSelectionChanged
Use the onSelectionChanged instead.
Fires when a user selects/deselects an area.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The selected/deselected area; described in the Area section.
When implementing a handling function, use the object passed to it as the parameter. Among the fields of this object, you can find the selected/deselected area. An object that represents this area has fields and methods documented in the Area class description.
To identify whether an area has been selected or deselected, call its selected() method. Pass true or false to this method to select or deselect the area.
See Also
centerChanged
Fires when the coordinates of the map center are changed.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The updated geographical coordinates of the center.
If you need to perform specific actions when the coordinates of the map center are changed, implement a function that handles the centerChanged event. This function will be called every time a user moves the map or when the center is being changed in code by calling the center(centerCoordinates) or viewport(viewportCoordinates) method. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the updated center coordinates.
See Also
click
Fires when a user clicks on any place on the map.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution extended by the x and y fields. It is a dxEvent or a jQuery.Event when you use jQuery.
The Layer Element object (if available).
When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the object that represents the jQuery event extended by the following fields.
- x
Contains the X coordinate of the clicked point. - y
Contains the Y coordinate of the clicked point.
See Also
disposing
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
Event
Information about the event.
The widget instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
drawn
Raised when the widget's rendering has finished.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
exported
Raised after data from the widget is exported.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
exporting
Raised before data from the widget is exported.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The name of the file to which the widget is about to be exported.
Allows you to prevent exporting.
The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.
fileSaving
Raised before a file with exported data is saved on the user's local storage.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The name of the file to be saved.
The format of the file to be saved.
Possible Values: 'PNG' | 'PDF' | 'JPEG' | 'SVG' | 'GIF'
Exported data as a BLOB.
Allows you to prevent file saving.
incidentOccurred
Raised when an error or warning appears in the widget.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
Information on the occurred incident.
Main article: onIncidentOccurred
See Also
initialized
Raised only once, after the widget is initialized.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
Main article: onInitialized
See Also
markerClick
Use the onClick instead.
Fires when a user clicks a marker.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The jQuery event that caused the handler execution. Deprecated in favor of the event field.
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery.
The Marker object.
When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the clicked marker. An object that represents this marker has fields and methods documented in the Marker class description.
See Also
markerSelectionChanged
Use the onSelectionChanged instead.
Fires when a user selects/deselects a marker.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The selected/deselected marker; described in the Marker section.
When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the selected/deselected marker. An object that represents this marker has fields and methods documented in the Marker class description.
To identify whether a marker has been selected or deselected, call its selected() method. Pass true or false to this method to select or deselect the marker.
See Also
optionChanged
Raised after a widget option is changed.
Event
Information about the event.
The widget's instance.
The option's short name.
The option's full name.
The option's new value.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
selectionChanged
Fires when a user selects/deselects a layer element.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The selected/deselected layer element; described in the Layer Element section.
When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the selected/deselected layer element. An object that represents this element has fields and methods documented in the Layer Element class description.
To identify whether a layer element has been selected or deselected, call its selected() method. Pass true or false to this method to select or deselect the marker.
tooltipHidden
Fires when a tooltip of an area or marker becomes hidden.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The layer element whose tooltip is hidden; described in the Layer Element section.
The tooltip becomes invisible when a user hovers the mouse cursor over another marker/area or moves it outside the widget.
When a tooltip is made hidden, you can perform specific actions by handling this event. To do this, implement a handling function and assign it to the onTooltipHidden option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the area or marker whose tooltip becomes hidden.
See Also
tooltipShown
Fires when a tooltip of an area or marker appears.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The layer element whose tooltip is shown; described in the Layer Element section.
The tooltip appears when a user hovers the mouse cursor over a marker or area.
When a tooltip appears, you can perform specific actions by handling this event. To do this, implement a handling function and assign it to the onTooltipShown option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the area or marker whose tooltip appears.
See Also
zoomFactorChanged
Fires when the map zoom factor is changed.
Event
Information about the event.
The widget's instance.
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
The model data. Available only if you use Knockout.
The updated zoom factor.
If you need to perform specific actions when the map zoom factor is changed, implement a function that handles the zoomFactorChanged event. This function will be called every time a user zooms the map or when the zoom factor is changed in code by calling the zoomFactor(zoomFactor) or viewport(viewportCoordinates) method. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the updated zoom factor.