React VectorMap Events

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. 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.
target	Area	The Area object.

Cannot be used in themes.

Main article: onAreaClick

areaSelectionChanged

Use the onSelectionChanged event instead.

Raised when an area is selected or the selection is canceled.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
target	Area	The selected/deselected area; described in the Area section.

Cannot be used in themes.

Main article: onAreaSelectionChanged

centerChanged

Raised each time the center coordinates are changed.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
center	Array<Number>	The updated geographical coordinates of the center.

Cannot be used in themes.

Main article: onCenterChanged

click

Raised when any location on the map is clicked or tapped.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field.
event	Event (jQuery or EventObject)	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.
target	Layer Element	The Layer Element object (if available).

Cannot be used in themes.

Main article: onClick

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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.

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

drawn

Raised when the widget's rendering has finished.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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 you use Knockout.

Cannot be used in themes.

Main article: onDrawn

exported

Raised after the widget is exported.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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 you use Knockout.

Main article: onExported

exporting

Raised before the widget is exported.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
fileName	String	The name of the file to which the widget is about to be exported.
cancel	Boolean	Allows you to prevent exporting.
format	String	The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.

Main article: onExporting

fileSaving

Raised before a file with exported widget is saved to the user's local storage.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
fileName	String	The name of the file to be saved.
format	String	The format of the file to be saved. Possible Values: 'PNG' \| 'PDF' \| 'JPEG' \| 'SVG' \| 'GIF'
data	BLOB	Exported data as a BLOB.
cancel	Boolean	Allows you to prevent file saving.

Main article: onFileSaving

incidentOccurred

Raised when an error or warning occurs.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
target	any	Information on the occurred incident.

Main article: onIncidentOccurred

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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

markerClick

Use the onClick event instead.

Raised when a marker is clicked or tapped.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
jQueryEvent	jQuery.Event	Use 'event' instead. The jQuery event that caused the handler execution. 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.
target	Marker	The Marker object.

Cannot be used in themes.

Main article: onMarkerClick

markerSelectionChanged

Use the onSelectionChanged event instead.

Raised when an marker is selected or the selection is canceled.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
target	Marker	The selected/deselected marker; described in the Marker section.

Cannot be used in themes.

Main article: onMarkerSelectionChanged

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:

e:

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	VectorMap	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

Main article: onOptionChanged

selectionChanged

Raised when a layer element is selected or the selection is canceled.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
target	Layer Element	The selected/deselected layer element; described in the Layer Element section.

Cannot be used in themes.

Main article: onSelectionChanged

tooltipHidden

Raised when a tooltip becomes hidden.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
target	Layer Element	The layer element whose tooltip is hidden; described in the Layer Element section.

Cannot be used in themes.

Main article: onTooltipHidden

tooltipShown

Raised when a tooltip appears.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	VectorMap	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 you use Knockout.
target	Layer Element	The layer element whose tooltip is shown; described in the Layer Element section.

Cannot be used in themes.

Main article: onTooltipShown

zoomFactorChanged

Raised each time the zoom factor is changed.

Type:

Event

Function parameters:

e: