Class/Object

com.highcharts.config

Series

Related Docs: object Series | package config

Permalink

class Series extends Object

Annotations
@RawJSType() @ScalaJSDefined()
Note

JavaScript name: series

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

Instance Constructors

  1. new Series()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. val data: UndefOr[Array[|[|[Object, Array[Any]], Double]]]

    Permalink

    An array of data points for the series.

    An array of data points for the series. The points can be given in three ways:

    • An array of numerical values. In this case, the numerical values will be interpreted as y values, and x values will be automatically calculated, either starting at 0 and incrementing by 1, or from pointStart and pointInterval given in the plotOptions. If the axis is has categories, these will be used. This option is not available for range series. Example:
      data: [0, 5, 3, 5]
      

    -

    An array of arrays with two values. In this case, the first value is the x value and the second is the y value. If the first value is a string, it is applied as the name of the point, and the x value is incremented following the above rules.

    For range series, the arrays will be interpreted as [x, low, high]. In this cases, the X value can be skipped altogether to make use of pointStart and pointRange.

    Example:

    data: [[5, 2], [6, 3], [8, 2]]
    

    -

    An array of objects with named values. In this case the objects are point configuration objects as seen below.

    Range series values are given by low and high.

    Example:

    data: [{
    	name: 'Point 1',
    	color: '#00FF00',
    	y: 0
    }, {
    	name: 'Point 2',
    	color: '#FF00FF',
    	y: 5
    }]
    

    Note that line series and derived types like spline and area, require data to be sorted by X because it interpolates mouse coordinates for the tooltip. Column and scatter series, where each point has its own mouse event, does not require sorting.

  7. val dataParser: UndefOr[Function]

    Permalink

    This method is deprecated as of version 2.0.

    This method is deprecated as of version 2.0. Instead, use options preprocessing as described in the docs.

  8. val dataURL: UndefOr[String]

    Permalink

    This method is deprecated as of version 2.0.

    This method is deprecated as of version 2.0. Instead, load the data using jQuery.ajax and use options preprocessing as described in the docs.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. val id: UndefOr[String]

    Permalink

    An id for the series.

    An id for the series. This can be used after render time to get a pointer to the series object through chart.get().

    Since

    1.2.0

  16. val index: UndefOr[Double]

    Permalink

    The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.

    The index of the series in the chart, affecting the internal index in the chart.series array, the visible Z index as well as the order in the legend.

    Since

    2.3.0

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  19. val legendIndex: UndefOr[Double]

    Permalink

    The sequential index of the series in the legend.

    The sequential index of the series in the legend.

    Try it: Legend in opposite order .

  20. val name: UndefOr[String]

    Permalink

    The name of the series as shown in the legend, tooltip etc.

    The name of the series as shown in the legend, tooltip etc.

    Example:
    1. Series name

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  25. val stack: UndefOr[String]

    Permalink

    This option allows grouping series in a stacked chart.

    This option allows grouping series in a stacked chart. The stack option can be a string or a number or anything else, as long as the grouped series' stack options match each other.

    Since

    2.1

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  28. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  29. val type: UndefOr[String]

    Permalink

    The type of series.

    The type of series. Can be one of area, areaspline, bar, column, line, pie, scatter or spline. From version 2.3, arearange, areasplinerange and columnrange are supported with the highcharts-more.js component.

  30. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. val xAxis: UndefOr[|[Double, String]]

    Permalink

    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to.

    When using dual or multiple x axes, this number defines which xAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the xAxis array, with 0 being the first.

  35. val yAxis: UndefOr[|[Double, String]]

    Permalink

    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to.

    When using dual or multiple y axes, this number defines which yAxis the particular series is connected to. It refers to either the axis id or the index of the axis in the yAxis array, with 0 being the first.

  36. val zIndex: UndefOr[Double]

    Permalink

    Define the visual z index of the series.

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped