Chart Common Events
This section describes events that are supported by all charts.
Chart Click
This event is fired when a certain chart section (outside of its plot, axes, legend and titles that have their own click events) is clicked.
Event name: chartClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Plot Click
This event is fired when chart's plot is clicked.
Event name: plotClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Legend Item Click
This event is fired when a chart's legend item is clicked.
Event name: legendItemClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Dataset Index | datasetIndex | Integer | Index of a dataset the legend item corresponds to. |
Series Key | seriesKey | String | Key of a series the legend item corresponds to. |
Title Click
This event is fired when a chart's title is clicked.
Event name: titleClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Axis Click
This event is fired when a chart's axis is clicked.
Event name: axisClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Domain Axis Index | domainAxisIndex | Integer | Index of the clicked domain axis or null if a range axis was clicked. |
Range Axis Index | rangeAxisIndex | Integer | Index of the clicked range axis or null if a domain axis was clicked. |
Category Label Click
This event is fired when a category chart's item label is clicked. It is only available for category charts.
Event name: categoryLabelClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Key | key | String | Dataset key of the clicked category. |
Category Item Click
This event is fired when a category chart's item is clicked. It is only available for category charts.
Event name: categoryItemClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Dataset Index | datasetIndex | Integer | Index of the dataset the clicked item belongs to. |
Row Key | rowKey | String | Dataset key of the clicked row. |
Column Key | columnKey | String | Dataset key of the clicked column. |
XY Item Click
This event is fired when an XY chart's item is clicked. It is only available for XY charts.
Event name: xyItemClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Dataset Index | datasetIndex | Integer | Index of the dataset the clicked item belongs to. |
Series | series | Integer | Index of the series the clicked item belongs to. |
Item | item | Integer | Index of the clicked item. |
Pie Section Click
This event is fired when a pie chart's section is clicked. It is only available for pie charts.
Event name: pieSectionClick
Event fields: this event has all fields of a regular mouse event. Additionally, it defines the following fields:
Field | Name | Type | Description |
Tooltip Text | toolTipText | String | Contains a tooltip of the clicked section of a chart. |
Area | area | Data Table | A shape of a clicked chart area. See Shape for details. |
Pie Index | pieIndex | Integer | Index of the pie the clicked item belongs to. |
Section Index | sectionIndex | Integer | Index of the clicked section. |
Section Key | sectionKey | String | Key of the clicked section. |
Dataset Updated
Event is fired each time chart gets a new data set.
Event name: datasetUpdated
Event fields: No fields.
Was this page helpful?