Class

com.highstock.config

Series

Related Doc: 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 series object is expecting the points to be ordered from low to high. The reason for this is to increase performance. While in many cases the data is fetched from a server, it's also more convenient to sort on the server and thereby save on client resources.

    The points can be given in three ways:

    • A list 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. This option is not available for series types with more than one value per point, like area range or OHLC. Example:
      data: [0, 5, 3, 5]
      

    -

    A list 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 series with more than one value per point, like range or OHLC, the arrays will be interpreted as [x, low, high] or [x, open, high, low, close]. In these cases, the X value can be skipped altogether to make use of pointStart and pointRange.

    Example:

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

    -

    A list of object with named values. In this case the objects are point configuration objects as seen under options.point.

    Range series values are given by low and high, while candlestick/OHLC values are given by open, high, low, close.

    Example:

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

    In turbo mode, when working with series longer than turboThreshold (1000 points by default), only one- or two dimensional arrays of numbers are allowed. The first value is tested, and we assume that all the rest are defined the same way.

    Note data must be sorted by X in order for the tooltip positioning and data grouping to work.

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  13. 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().

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

    1.2.0

  15. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    Object
  17. 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 .

  18. val name: UndefOr[String]

    Permalink

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

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

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

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

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

    Permalink
    Definition Classes
    Object
  23. 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.

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

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

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

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

    Permalink

    The type of series.

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

  28. def valueOf(): Any

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. 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.

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

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