React PolarChart Events

This section describes events fired by this widget.

See Also

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
argument

Date

|

Number

|

String

The clicked label's value.

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.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if you use Knockout.

Cannot be used in themes.

Main article: onArgumentAxisClick

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

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.

Main article: onDisposing

See Also

done

Raised when all series are ready.

Type:

Event

Function parameters:
e:

Object

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.

Cannot be used in themes.

Main article: onDone

See Also

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

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.

Cannot be used in themes.

Main article: onDrawn

See Also

exported

Raised after the widget is exported.

Type:

Event

Function parameters:
e:

Object

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.

Main article: onExported

See Also

exporting

Raised before the widget is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

Allows you to prevent exporting.

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 which the widget is about to be exported.

format

String

The resulting file format. One of PNG, PDF, JPEG, SVG and GIF.

model

Object

The model data. Available only if you use Knockout.

Main article: onExporting

See Also

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
cancel

Boolean

Allows you to prevent file saving.

component

PolarChart

The widget's instance.

data

BLOB

Exported data as a BLOB.

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'

Main article: onFileSaving

See Also

incidentOccurred

Raised when an error or warning occurs.

Type:

Event

Function parameters:
e:

Object

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

See Also

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

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.

Main article: onInitialized

See Also

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

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.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if you use Knockout.

target

Series

The series that corresponds to the clicked legend item; described in the Series section.

Cannot be used in themes.

Main article: onLegendClick

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model

Object

The model data. Available only if you use Knockout.

fullName

String

The path to the modified option that includes all parent options.

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.

name

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.

value any

The modified option's new value.

Main article: onOptionChanged

See Also

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

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.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if you use Knockout.

target

Point

The clicked series point; described in the Point section.

Cannot be used in themes.

Main article: onPointClick

See Also

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

See Also

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

See Also

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

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.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

model

Object

The model data. Available only if you use Knockout.

target

Series

The clicked series; described in the Series section.

Cannot be used in themes.

Main article: onSeriesClick

See Also

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

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

See Also

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

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

See Also

tooltipHidden

Raised when a tooltip becomes hidden.

Type:

Event

Function parameters:
e:

Object

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

|

Chart Annotation

| any

The series point whose tooltip is hidden; described in the Point section.

Cannot be used in themes.

Main article: onTooltipHidden

See Also

tooltipShown

Raised when a tooltip appears.

Type:

Event

Function parameters:
e:

Object

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

|

Chart Annotation

| any

The series point whose tooltip is shown; described in the Point section.

Cannot be used in themes.

Main article: onTooltipShown

See Also