Events

This section describes events exposed by this widget.

To handle events, use one of the following methods.

areaClick

Fires when a user clicks an area.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Area
The clicked area.
Cannot be used in themes.

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.

For more information about handling widget events, see the Handle Events topic.

areaSelectionChanged

Fires when a user selects/deselects an area.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
target: Area
The selected/deselected area.
Cannot be used in themes.

When implementing a handling function, use the object passed to it as the parameter. Among 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.

For more information about handling widget events, see the Handle Events topic.

centerChanged

Fires when the coordinates of the map center are changed.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
center: Array
The updated geographical coordinates of the center.
Cannot be used in themes.

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.

For more information about handling widget events, see the Handle Events topic.

click

Fires when a user clicks on any place on the map.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event extended by the x and y fields.
Cannot be used in themes.

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.

NOTE: The coordinates are calculated relatively to the client area, i.e., the widget container. To convert them into map coordinates, use the convertCoordinates(x,y) method.

For more information about handling widget events, see the Handle Events topic.

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.

drawn

Fires when the widget has finished drawing itself.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
The widget instance.
element: Object
The widget's container.
Cannot be used in themes.

To learn how to handle widget events, see the Handle Events topic.

incidentOccurred

Fires when an error or warning appears in a widget.

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

When implementing a handling function for this event, you can access information about the occurred incident using the target field of the function's argument. This information includes the following.

  • id
    Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.
  • type
    Contains the type of the incident. This field equals 'error' for errors or 'warning' for warnings.
  • args
    Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.
  • text
    Contains the text passed to the browser console. This text includes the content of the args field, if there is any.
  • widget
    Contains the name of the widget that produced the error or warning.
  • version
    Contains the currently used version of the ChartJS library.

For more information about handling widget events, see the Handle Events topic.

markerClick

Fires when a user clicks a marker.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
jQueryEvent: jQuery.Event
The jQuery event.
target: Marker
The clicked marker.
Cannot be used in themes.

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.

For more information about handling widget events, see the Handle Events topic.

markerSelectionChanged

Fires when a user selects/deselects a marker.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
target: Marker
The selected/deselected area.
Cannot be used in themes.

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.

For more information about handling widget events, see the Handle Events topic.

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.

zoomFactorChanged

Fires when the map zoom factor is changed.

Event Handler Argument:
Information about the event.
Object structure:
component: Object
element: Object
The widget's container.
zoomFactor: Number
The updated zoom factor.
Cannot be used in themes.

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.

For more information about handling widget events, see the Handle Events topic.