Event listeners for the chart.

These options should be set with set setChartEvent method

Parameters:
  • string $name: The name of the event, Can be click, load, redraw, selection See documentation for more details
  • string $jscode: The javascript code associated with this event

API Tags:
Return: instance
Access: public

Example. Alert coordinates onclick

$chart = new jqChart();

$onclick = "function(event) {
    alert ('x: '+ event.xAxis[0].value +', y: '+ event.yAxis[0].value);
}";

$chart->setChartEvent("click", $onclick);
...

Option name Type Default
addSeries JS Function null
Fires when a series is added to the chart after load time, using the addSeries method. The this keyword refers to the chart object itself. One parameter, event, is passed to the function. This contains common event information based on jQuery. Through event.options you can access the series options that was passed to the addSeries method. Returning false prevents the series from being added.
click JS Function null
Fires when clicking on the plot background. The this keyword refers to the chart object itself. 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
)
}
load JS Function null
Fires when the chart is finished loading. The this keyword refers to the chart object itself. One parameter, event, is passed to the function. This contains common event information based on jQuery.
redraw JS Function null
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. The this keyword refers to the chart object itself. One parameter, event, is passed to the function. This contains common event information based on jQuery
selection JS Function
Fires when an area of the chart has been selected. Selection is enabled by setting the chart's zoomType. The this keyword refers to the chart object itself. One parameter, event, is passed to the function. This contains common event information based on jQuery. 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);
}