ChartEvents
Related Docs:
object ChartEvents
| package config
Fires when a series is added to the chart after load time, using the addSeries method.
Fires when a series is added to the chart after load time, using the addSeries method. One parameter, event, is passed to the function. This contains common event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. Through event.options you can access the series options that was passed to the addSeries method. Returning false prevents the series from being added.
1.2.0
Fires after a chart is printed through the context menu item or the Chart.print method.
Fires after a chart is printed through the context menu item or the Chart.print method. Requires the exporting module.
4.1.0
Fires before a chart is printed through the context menu item or the Chart.print method.
Fires before a chart is printed through the context menu item or the Chart.print method. Requires the exporting module.
4.1.0
Fires when clicking on the plot background.
Fires when clicking on the plot background. One parameter, event, is passed to the function. This contains common event information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
Information on the clicked spot can be found through event.xAxis and event.yAxis, which are arrays containing the axes of each dimension and each axis' value at the clicked spot. The primary axes are event.xAxis[0] and event.yAxis[0]. Remember the unit of a datetime axis is milliseconds since 1970-01-01 00:00:00.
click: function(e) {
console.log(
Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', e.xAxis[0].value),
e.yAxis[0].value
)
}
1.2.0
Fires when a drilldown point is clicked, before the new series is added.
Fires when a drilldown point is clicked, before the new series is added. This event is also utilized for async drilldown, where the seriesOptions are not added by option, but rather loaded async. Note that when clicking a category label to trigger multiple series drilldown, one drilldown event is triggered per point in the category.
Event arguments:
<dl>
<dt>category</dt>
<dt>point</dt>
<dt>originalEvent</dt>
<dt>points</dt>
<dt>seriesOptions</dt>
</dl>
3.0.8
Fires when drilling up from a drilldown series.
Fires when drilling up from a drilldown series.
3.0.8
In a chart with multiple drilldown series, this event fires after all the series have been drilled up.
In a chart with multiple drilldown series, this event fires after all the series have been drilled up.
4.2.4
Fires when the chart is finished loading.
Fires when the chart is finished loading. Since v4.2.2, it also waits for images to be loaded, for example from point markers. One parameter, event, is passed to the function. This contains common event information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
There is also a second parameter to the chart constructor where a callback function can be passed to be executed on chart.load.
Fires when the chart is redrawn, either after a call to chart.redraw() or after an axis, series or point is modified with the redraw option set to true.
Fires when the chart is redrawn, either after a call to chart.redraw() or after an axis, series or point is modified with the redraw option set to true. One parameter, event, is passed to the function. This contains common event information based on jQuery or MooTools depending on which library is used as the base for Highcharts.
1.2.0
Fires after initial load of the chart (directly after the load event), and after each redraw (directly after the redraw event).
Fires after initial load of the chart (directly after the load event), and after each redraw (directly after the redraw event).
5.0.7
Fires when an area of the chart has been selected.
Fires when an area of the chart has been selected. Selection is enabled by setting the chart's zoomType. One parameter, event, is passed to the function. This contains common event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. The default action for the selection event is to zoom the chart to the selected area. It can be prevented by calling event.preventDefault().
Information on the selected area can be found through event.xAxis and event.yAxis, which are arrays containing the axes of each dimension and each axis' min and max values. The primary axes are event.xAxis[0] and event.yAxis[0]. Remember the unit of a datetime axis is milliseconds since 1970-01-01 00:00:00.
selection: function(event) {
// log the min and max of the primary, datetime x-axis
console.log(
Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', event.xAxis[0].min),
Highcharts.dateFormat('%Y-%m-%d %H:%M:%S', event.xAxis[0].max)
);
// log the min and max of the y axis
console.log(event.yAxis[0].min, event.yAxis[0].max);
}
JavaScript name:
chart-events