class Series extends Object
- Annotations
- @RawJSType() @ScalaJSDefined()
- Note
JavaScript name:
series
- Alphabetic
- By Inheritance
- Series
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Series()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
data: UndefOr[Array[|[|[Object, Array[Any]], Double]]]
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
pointStartandpointIntervalgiven 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 ofpointStartandpointRange.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
lowandhigh, while candlestick/OHLC values are given byopen,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.
- 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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
val
id: UndefOr[String]
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(). -
val
index: UndefOr[Double]
The index of the series in the chart, affecting the internal index in the
chart.seriesarray, 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.seriesarray, the visible Z index as well as the order in the legend.- Since
1.2.0
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
-
val
legendIndex: UndefOr[Double]
The sequential index of the series in the legend.
The sequential index of the series in the legend.
Try it: Legend in opposite order .
-
val
name: UndefOr[String]
The name of the series as shown in the legend, tooltip etc.
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
def
propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
-
val
stack: UndefOr[String]
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.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toLocaleString(): String
- Definition Classes
- Object
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
val
type: UndefOr[String]
The type of series.
The type of series. Can be one of
area,areaspline,bar,column,line,pie,scatter,spline,candlestickorohlc. From version 1.1.7,arearange,areasplinerangeandcolumnrangeare supported with the highcharts-more.js component. -
def
valueOf(): Any
- Definition Classes
- Object
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
xAxis: UndefOr[|[Double, String]]
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.
-
val
yAxis: UndefOr[|[Double, String]]
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.
-
val
zIndex: UndefOr[Double]
Define the visual z index of the series.
Define the visual z index of the series.