React PieChart Events

This section describes events fired by this widget.

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

Object

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.

done

Raised when all series are ready.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name

Type

Description

component

Object

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

Object

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.

exported

Raised after data from the widget is exported.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name

Type

Description

component

Object

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.

exporting

Raised before data from the widget is exported.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

fileSaving

Raised before a file with exported data is saved on the user's local storage.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

incidentOccurred

Raised when an error or warning appears in the widget.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

Object

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

Fires when an item on the chart legend is clicked.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	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	String \| Number	The argument of the point(s) corresponding to the clicked legend item.
points	Array<Point>	The Point object(s).

Cannot be used in themes.

You can subscribe to this event using the onLegendClick option or the on(eventName, eventHandler) method.

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

pointClick

Fires when a user clicks 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	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.

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 series point. To learn about point members that you can use, refer to the description of the Point object. To get the parent series of the point, use the target.series field of the object passed to the handler as its parameter.

pointHoverChanged

Fires when the hover state of a series point has been changed.

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.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose hover state has been changed. To identify whether this point was hovered over or hovered out, call its isHovered() method. To discover point fields and methods, refer to the Point class description.

pointSelectionChanged

Fires when the selection state of a series point has been changed.

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.

When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose selection state has been changed. To identify whether this point was selected or deselected, call its isSelected() method. To discover point fields and methods, refer to the Point class description.

tooltipHidden

Fires when a point's tooltip becomes hidden.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

The point's tooltip becomes invisible when a user hovers the mouse cursor over another series point. In addition, you can hide a tooltip in code, using the hideTooltip() method of the chart or point.

When a tooltip is made hidden, you can perform specific actions by handling the tooltipHidden event. When implementing a handling function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose tooltip becomes hidden.

tooltipShown

Fires when a point's tooltip appears.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

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

The point's tooltip appears when a user hovers the mouse cursor over the point. In addition, you can show a tooltip in code, using the showTooltip() method of the chart or point.

When a tooltip appears, you can perform specific actions by handling the tooltipShown event. To do this, implement a handling function and assign it to the onTooltipShown option. When implementing this function, use the object passed to it as its parameter. Among the fields of this object, you can find the series point whose tooltip appears.

React PieChart Events

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

tooltipHidden

See Also

tooltipShown

See Also