The page you are viewing does not exist in version 14.1. This link will take you to the Overview page.

13.2

The page you are viewing does not exist in version 13.2. This link will take you to the Overview page.

13.1

The page you are viewing does not exist in version 13.1. This link will take you to the Overview page.

Events

This section describes events exposed by this widget.

To handle events, use one of the following methods.

Attach a handler to a widget option
Assign a callback function to the widget option that takes on a handler for the required event. The events that can be handled within the widget's configuration object are listed in the Configuration section. All these events have names starting with on.

To access the required series, use the getAllSeries(), getSeriesByName(seriesName) or getSeriesByPos(seriesIndex() method of the chart instance. The accessed series object allows you to access the required point and then access the point's label. The API of the Series, Point and Label objects is detailed in the Chart Elements Reference section.

To perform custom actions when the chart is drawn, handle the drawn event of the chart.

For more information about handling widget events, see the Handle Events topic.

When implementing a handling function for this event, you can access information about the occurred incident using the target field of the function's argument. This information includes the following.

id
Contains the ID of the incident. The full list of IDs can be found in the Errors and Warnings section.

type
Contains the type of the incident. This field equals 'error' for errors or 'warning' for warnings.

args
Contains the argument of the incident's message. The content of this field varies greatly, depending on the incident. For example, it may contain the name of the data source field that was not specified correctly, or the name of the option that was not set properly.

text
Contains the text passed to the browser console. This text includes the content of the args field, if there is any.

widget
Contains the name of the widget that produced the error or warning.

version
Contains the currently used version of the ChartJS library.

For more information about handling widget events, see the Handle Events topic.

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 to which the clicked legend item belongs. To learn about series' members you can use, refer to the description of the Series object.

NOTE: A click on the legend causes the seriesClick event to fire after the legendClick event. To prevent this behavior, assign true to the jQueryEvent.cancel field of the object passed to the legendClick event handler as the argument.

For more information about handling widget events, see the Handle Events topic.

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's members that you can use, refer to the description of the Point object.

NOTE: A click on a series point causes the seriesClick event to fire after the pointClick event. To prevent this behavior, assign true to the jQueryEvent.cancel field of the object passed to the pointClick event handler as the argument.

For more information about handling widget events, see the Handle Events topic.

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.

For more information about handling widget events, see the Handle Events topic.

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.

For more information about handling widget events, see the Handle Events topic.

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. To learn about series members that you can use, refer to the description of the Series object.

NOTE: The seriesClick also fires when a user clicks a series point or a legend item, but only if it is not canceled in the pointClick and legendClick event handlers.

For more information about handling widget events, see the Handle Events topic.

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 whose hover state has been changed. To identify whether this series was hovered over or hovered out, call its isHovered() method. To discover series' fields and methods you can use, refer to the Series class description.

For more information about handling widget events, see the Handle Events topic.

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 whose selection state has been changed. To identify whether this series was selected or deselected, call its isSelected() method. To discover series' fields and methods, refer to the Series class description.

For more information about handling widget events, see the Handle Events topic.

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.

For more information about handling widget events, see the Handle Events topic.

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.

For more information about handling widget events, see the Handle Events topic.