React PolarChart Events

Information about the event.

Object structure:

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

Information about the event.

Object structure:

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

done

Raised when all series are ready.

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: onDone

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	PolarChart	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	PolarChart	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	PolarChart	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

legendClick

Raised when a legend item is clicked or tapped.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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

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

Main article: onOptionChanged

pointClick

Raised when a series point is clicked or tapped.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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

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.

Name

Type

Description

component

The widget's instance.

element

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 the selection is canceled.

Type:

Event

Function parameters:

e:

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.

Name

Type

Description

component

The widget's instance.

element

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:

Information about the event.

Object structure:

Name	Type	Description
component	PolarChart	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; described in the Series section.

Cannot be used in themes.

Main article: onSeriesClick

seriesHoverChanged

Raised after the pointer enters or leaves a series.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PolarChart	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; described in the Series section.

Cannot be used in themes.

Main article: onSeriesHoverChanged

seriesSelectionChanged

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

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PolarChart	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; described in the Series section.

Cannot be used in themes.

Main article: onSeriesSelectionChanged

tooltipHidden

Raised when a tooltip becomes hidden.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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