HIEvents Class Reference

Fires when the checkbox next to the point name in the legend is clicked. One parameter, event, is passed to the function. The state of the checkbox is found by event.checked. The checked item is found by event.item. Return false to prevent the default action which is to toggle the select state of the series.

Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by selecting an area in the chart. One parameter, event, is passed to the function, containing common event information. The new user set minimum and maximum values can be found by event.min and event.max. These reflect the axis minimum and maximum in data values. When an axis is zoomed all the way out from the “Reset zoom” button, event.min and event.max are null, and the new extremes are set based on this.dataMin and this.dataMax.

An event fired after the breaks have rendered.

An event fired when a point is outside a break after zoom.

An event fired when a break from this axis occurs on a point.

An event fired when a point falls inside a break from this axis.

As opposed to the setExtremes event, this event fires after the final min and max values are computed and corrected for minRange. Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by selecting an area in the chart. One parameter, event, is passed to the function, containing common event information. The new user set minimum and maximum values can be found by event.min and event.max. These reflect the axis minimum and maximum in axis values. The actual data extremes are found in event.dataMin and event.dataMax.

Mouse over event on a plot band.

Mouse out event on the corner of a plot band.

Click event on a plot band.

Mouse move event on a plot band.

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, containing common event information. 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 a fullscreen is opened through the context menu item, or the Chart.fullscreen.open method.

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, containing common event information. The default action for the selection event is to zoom the chart to the selected area. It can be prevented by calling event.preventDefault() or return false. 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. js 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); }

Fires after initial load of the chart (directly after the load event), and after each redraw (directly after the redraw event).

Fires when a series is added to the chart after load time, using the addSeries method. One parameter, event, is passed to the function, containing common event information. Through event.options you can access the series options that were passed to the addSeries method. Returning false prevents the series from being added.

Fires when a fullscreen is closed through the context menu item, or a fullscreen is closed on the Escape button click, or the Chart.fullscreen.close method.

Fires when drilling up from a drilldown series.

Fires before a chart is printed through the context menu item or the Chart.print method.

In a chart with multiple drilldown series, this event fires after all the series have been drilled up.

Callback that fires while exporting data. This allows the modification of data rows before processed into the final format.

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: - category: If a category label was clicked, which index. - originalEvent: The original browser event (usually click) that triggered the drilldown. - point: The originating point. - points: If a category label was clicked, this array holds all points corresponding to the category. - seriesOptions: Options for the new series.

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, containing common event information.

Fires after a chart is printed through the context menu item or the Chart.print method.

Fires when the point is unselected either programmatically or following a click on the point. One parameter, event, is passed to the function. Returning false cancels the operation.

Callback that fires when the point is dropped. The parameters passed are the same as for drag. To stop the default drop action, return false. See drag and drop options.

Fires when the point is updated programmatically through the .update() method. One parameter, event, is passed to the function. The new point options can be accessed through event.options. Returning false cancels the operation.

Fires when the point is removed using the .remove() method. One parameter, event, is passed to the function. Returning false cancels the operation.

Callback that fires while dragging a point. The mouse event is passed in as parameter. The original data can be accessed from e.origin, and the new point values can be accessed from e.newPoints. If there is only a single point being updated, it can be accessed from e.newPoint for simplicity, and its ID can be accessed from e.newPointId. The this context is the point being dragged. To stop the default drag action, return false. See drag and drop options.

Fires when the mouse leaves the area close to the point. One parameter, event, is passed to the function, containing common event information.

Fires when the mouse enters the area close to the point. One parameter, event, is passed to the function, containing common event information. Returning false cancels the default behavior, which is to show a tooltip for the point.

Fires when the point is selected either programmatically or following a click on the point. One parameter, event, is passed to the function. Returning false cancels the operation.

Callback that fires when starting to drag a point. The mouse event object is passed in as an argument. If a drag handle is used, e.updateProp is set to the data property being dragged. The this context is the point. See drag and drop options.

Fires when the cluster point is clicked and drillToCluster is enabled. One parameter, event, is passed to the function. The default action is to zoom to the cluster points range. This can be prevented by calling event.preventDefault().

Fires after the simulation is ended and the layout is stable.

Fires on a request for change of root node for the tree, before the update is made. An event object is passed to the function, containing additional properties newRootId, previousRootId, redraw and trigger.

A closePopup event. Fired when Popup should be hidden, for example when clicking on an annotation again.

Event fired on a button click.

A showPopup event. Fired when selecting for example an annotation.

Event fired when button state should change, for example after adding an annotation.

Called on pause, cancel, or if play is completed. A context object is passed to the function, with properties chart, timeline and pointsPlayed. pointsPlayed is an array of Point objects, referencing data points that were related to the audio events played.

Called before updating the sonification. A context object is passed to the function, with properties chart and timeline.

Called on play. A context object is passed to the function, with properties chart and timeline.

Called when finished playing a series. A context object is passed to the function, with properties series and timeline.

Called when attempting to play an adjacent point or series, and there is none. By default a percussive sound is played. A context object is passed to the function, with properties chart, timeline, and attemptedNext. attemptedNext is a boolean property that is true if the boundary hit was from trying to play the next series/point, and false if it was from trying to play the previous.

Called after updating the sonification. A context object is passed to the function, with properties chart and timeline.

Called immediately when a play is requested. A context object is passed to the function, with properties chart and timeline.

Called on the beginning of playing a series. A context object is passed to the function, with properties series and timeline.

Called when play is completed. A context object is passed to the function, with properties chart, timeline and pointsPlayed. pointsPlayed is an array of Point objects, referencing data points that were related to the audio events played.

Fires when the legend item belonging to the colorAxis is clicked. One parameter, event, is passed to the function.

Fires when the series is hidden after chart generation time, either by clicking the legend item or by calling .hide().

Fires when the series is shown after chart generation time, either by clicking the legend item or by calling .show().

Fires after the series has finished its initial animation, or in case animation is disabled, immediately as the series is displayed.

Event callback when annotation is added to the chart.