JavaScript/jQuery Chart Events

This section describes events fired by this widget.

argumentAxisClick

Raised when a label on the argument axis is clicked or tapped.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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.
argument	Date \| Number \| String	The clicked label's value.

Cannot be used in themes.

Main article: onArgumentAxisClick

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

Main article: onDisposing

done

Raised when all series are ready.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

Cannot be used in themes.

Main article: onDone

drawn

Raised when the widget's rendering has finished.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

Cannot be used in themes.

Main article: onDrawn

exported

Raised after the widget is exported.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

Main article: onExported

exporting

Raised before the widget is exported.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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:

Object

Information about the event.

Object structure:

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

legendClick

Raised when a legend item is clicked or tapped.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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	Series	The series that corresponds to the clicked legend item; described in the Series section.

Cannot be used in themes.

Main article: onLegendClick

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 modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.
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	Chart	The widget's instance.
fullName	String	The path to the modified option that includes all parent options.
value	any	The modified option's new value.

Main article: onOptionChanged

pointClick

Raised when a series point is clicked or tapped.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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	Point	The clicked series point; described in the Point section.

Cannot be used in themes.

Main article: onPointClick

pointHoverChanged

Raised after the pointer enters or leaves a series point.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	Object	The widget's container.
target	Point	The series point whose hover state has been changed; described in the Point section.

Cannot be used in themes.

Main article: onPointHoverChanged

pointSelectionChanged

Raised when a series point is selected or selection is canceled.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	Object	The widget's container.
target	Point	The series point whose selection state has been changed; described in the Point section.

Cannot be used in themes.

Main article: onPointSelectionChanged

seriesClick

Raised when a series is clicked or tapped.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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	Series	The clicked series.

Cannot be used in themes.

Main article: onSeriesClick

seriesHoverChanged

Raised after the pointer enters or leaves a series.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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	Series	The series whose hover state has been changed.

Cannot be used in themes.

Main article: onSeriesHoverChanged

seriesSelectionChanged

Raised when a series is selected or selection is canceled.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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	Series	The series whose selection state has been changed.

Cannot be used in themes.

Main article: onSeriesSelectionChanged

tooltipHidden

Raised when a tooltip becomes hidden.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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	Point	The series point whose tooltip is hidden; described in the Point section.

Cannot be used in themes.

Main article: onTooltipHidden

tooltipShown

Raised when a tooltip appears.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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	Point	The series point whose tooltip is shown; described in the Point section.

Cannot be used in themes.

Main article: onTooltipShown

zoomEnd

Raised when zooming or panning ends.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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.
event	Event (jQuery or EventObject)	The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery.
rangeStart	Date \| Number	Use 'range' instead. The argument axis' start value after zooming or panning. Deprecated in favor of the range field.
rangeEnd	Date \| Number	Use 'range' instead. The argument axis' end value after zooming or panning. Deprecated in favor of the range field.
axis	Chart Axis	The zoomed/panned axis.
range	Object	The visual range when zooming or panning ends.
previousRange	Object	The visual range when zooming or panning starts.
cancel	Boolean	Allows you to cancel zooming or panning.
actionType	'zoom' \| 'pan'	Indicates whether the user has zoomed or panned the chart.
zoomFactor	Number	The zoom factor.
shift	Number	The visual range's shift from the previous position, measured in numeric values or milliseconds (for date-time axes). Positive values indicate a shift towards greater axis values; negative values indicate a shift in the opposite direction.

Cannot be used in themes.

Main article: onZoomEnd

zoomStart

Raised when zooming or panning begins.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Chart	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.
event	Event (jQuery or EventObject)	The event that caused the function's execution. It is a dxEvent or a jQuery.Event when you use jQuery.
axis	Chart Axis	The zoomed/panned axis.
range	Object	The visual range when zooming or panning starts.
cancel	Boolean	Allows you to cancel zooming or panning.
actionType	'zoom' \| 'pan'	Indicates whether the user is zooming or panning the chart.

Cannot be used in themes.

Main article: onZoomStart

General Information

.NET Subscription

Common Tools

Quality Assurance and Productivity

Desktop

Controls

Tools

Frameworks and Libraries

Web

Controls and Extensions

Tools

Maintenance Mode

Mobile

Enterprise and Analytic Tools

End-User Documentation

General Information

.NET Subscription

Common Tools

Quality Assurance and Productivity

Desktop

Controls

Tools

Frameworks and Libraries

Web

Controls and Extensions

Tools

Maintenance Mode

Mobile

Enterprise and Analytic Tools

End-User Documentation

JavaScript/jQuery Chart Events

See Also

argumentAxisClick

See Also

disposing

See Also

done

See Also

drawn

See Also

exported

See Also

exporting

See Also

fileSaving

See Also

incidentOccurred

See Also

initialized

See Also

legendClick

See Also

optionChanged

See Also

pointClick

See Also

pointHoverChanged

See Also

pointSelectionChanged

See Also

seriesClick

See Also

seriesHoverChanged

See Also

seriesSelectionChanged

See Also

tooltipHidden

See Also

tooltipShown

See Also

zoomEnd

See Also

zoomStart

See Also