Packages

class ChartEvents extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: chart-events

Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ChartEvents
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ChartEvents()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val addSeries: UndefOr[Function]

    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.

    Example:

    1. Alert on add series

    Since

    1.2.0

  5. val afterPrint: UndefOr[Function]

    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.

    Example:

    1. Rescale the chart to print

    Since

    4.1.0

  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val beforePrint: UndefOr[Function]

    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.

    Example:

    1. Rescale the chart to print

    Since

    4.1.0

  8. val click: UndefOr[Function]

    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
	)
}

    Example:

    1. Alert coordinates on click. Alternatively, attach event to container

    Since

    1.2.0

  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val drilldown: UndefOr[Function]

    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>

    If a category label was clicked, which index.

    <dt>point</dt>

    The originating point.

    <dt>originalEvent</dt>

    The original browser event (usually click) that triggered the drilldown.

    <dt>points</dt>

    If a category label was clicked, this array holds all points corresponing to the category.

    <dt>seriesOptions</dt>

    Options for the new series

    </dl>

    Example:

    1. Async drilldown

    Since

    3.0.8

  11. val drillup: UndefOr[Function]

    Fires when drilling up from a drilldown series.

    Fires when drilling up from a drilldown series.

    Since

    3.0.8

  12. val drillupall: UndefOr[Function]

    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.

    Since

    4.2.4

  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  21. val load: UndefOr[Function]

    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.

    Example:

    1. Alert on chart load

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  25. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  26. val redraw: UndefOr[Function]

    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.

    Example:

    1. Alert on chart redraw

    Since

    1.2.0

  27. val render: UndefOr[Function]

    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).

    Since

    5.0.7

  28. val selection: UndefOr[Function]

    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);
}

    Example:

    1. Report on selection and reset, select a range of points through a drag selection.

  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toLocaleString(): String
    Definition Classes
    Object
  31. def toString(): String
    Definition Classes
    AnyRef → Any
  32. def valueOf(): Any
    Definition Classes
    Object
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped