public class SeriesColumn extends Series
A column
series. If the type option is not specified, it is inherited from chart.type.
In TypeScript the type option must always be set.
Configuration options for the series are given in three levels:
column
series are defined in plotOptions.column.Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, column: { // shared options for all column series } }, series: [{ // specific options for this series instance type: 'column' }] });
Copyright (c) 2021 Powerbuilt Systems. All rights reserved.Modifier and Type | Field and Description |
---|---|
static SeriesColumn |
NULL |
Constructor and Description |
---|
SeriesColumn() |
Modifier and Type | Method and Description |
---|---|
List<Data> |
getDataAsArrayObject()
An array of data points for the series.
|
Data |
getDataAsArrayObjectSingle()
An array of data points for the series.
|
General |
getDataAsJsValue()
An array of data points for the series.
|
DataGrouping |
getDataGrouping()
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.
|
String |
getName()
The name of the series as shown in the legend, tooltip etc.
|
SeriesType |
getType()
The type of series, for example
line or column . |
SeriesColumn |
setData(General dataAsJsValue)
An array of data points for the series.
|
SeriesColumn |
setData(List<Data> dataAsArrayObject)
An array of data points for the series.
|
SeriesColumn |
setDataGrouping(DataGrouping dataGrouping)
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.
|
SeriesColumn |
setName(String name)
The name of the series as shown in the legend, tooltip etc.
|
SeriesColumn |
setType(SeriesType type)
The type of series, for example
line or column . |
set_hcNulledOption
public static final SeriesColumn NULL
public Data getDataAsArrayObjectSingle()
An array of data points for the series. For the column
series type, points can be given in the following ways:
An array of numerical values. In this case, the numerical values will be interpreted as y
options. The x
values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart
and pointInterval
given in the series options. If the axis has categories, these will be used. Example:
data: [0, 5, 3, 5]
An array of arrays with 2 values. In this case, the values correspond to x,y
. If the first value is a string, it is applied as the name of the point, and the x
value is inferred.
data: [ [0, 6], [1, 2], [2, 6] ]
An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
data: [{ x: 1, y: 9, name: "Point2", color: "#00FF00" }, { x: 1, y: 6, name: "Point1", color: "#FF00FF" }]
public List<Data> getDataAsArrayObject()
An array of data points for the series. For the column
series type, points can be given in the following ways:
An array of numerical values. In this case, the numerical values will be interpreted as y
options. The x
values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart
and pointInterval
given in the series options. If the axis has categories, these will be used. Example:
data: [0, 5, 3, 5]
An array of arrays with 2 values. In this case, the values correspond to x,y
. If the first value is a string, it is applied as the name of the point, and the x
value is inferred.
data: [ [0, 6], [1, 2], [2, 6] ]
An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
data: [{ x: 1, y: 9, name: "Point2", color: "#00FF00" }, { x: 1, y: 6, name: "Point1", color: "#FF00FF" }]
public SeriesColumn setData(List<Data> dataAsArrayObject)
An array of data points for the series. For the column
series type, points can be given in the following ways:
An array of numerical values. In this case, the numerical values will be interpreted as y
options. The x
values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart
and pointInterval
given in the series options. If the axis has categories, these will be used. Example:
data: [0, 5, 3, 5]
An array of arrays with 2 values. In this case, the values correspond to x,y
. If the first value is a string, it is applied as the name of the point, and the x
value is inferred.
data: [ [0, 6], [1, 2], [2, 6] ]
An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
data: [{ x: 1, y: 9, name: "Point2", color: "#00FF00" }, { x: 1, y: 6, name: "Point1", color: "#FF00FF" }]
dataAsArrayObject
- the value for the dataAsArrayObject optionpublic General getDataAsJsValue()
An array of data points for the series. For the column
series type, points can be given in the following ways:
An array of numerical values. In this case, the numerical values will be interpreted as y
options. The x
values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart
and pointInterval
given in the series options. If the axis has categories, these will be used. Example:
data: [0, 5, 3, 5]
An array of arrays with 2 values. In this case, the values correspond to x,y
. If the first value is a string, it is applied as the name of the point, and the x
value is inferred.
data: [ [0, 6], [1, 2], [2, 6] ]
An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
data: [{ x: 1, y: 9, name: "Point2", color: "#00FF00" }, { x: 1, y: 6, name: "Point1", color: "#FF00FF" }]
public SeriesColumn setData(General dataAsJsValue)
An array of data points for the series. For the column
series type, points can be given in the following ways:
An array of numerical values. In this case, the numerical values will be interpreted as y
options. The x
values will be automatically calculated, either starting at 0 and incremented by 1, or from pointStart
and pointInterval
given in the series options. If the axis has categories, these will be used. Example:
data: [0, 5, 3, 5]
An array of arrays with 2 values. In this case, the values correspond to x,y
. If the first value is a string, it is applied as the name of the point, and the x
value is inferred.
data: [ [0, 6], [1, 2], [2, 6] ]
An array of objects with named values. The following snippet shows only a few settings, see the complete options set below. If the total number of data points exceeds the series' turboThreshold, this option is not available.
data: [{ x: 1, y: 9, name: "Point2", color: "#00FF00" }, { x: 1, y: 6, name: "Point1", color: "#FF00FF" }]
dataAsJsValue
- the value for the dataAsJsValue optionpublic DataGrouping getDataGrouping()
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the groupPixelWidth
option.
If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup. If point options other than the data itself are set, for example name
or color
or custom properties, the grouping logic doesn't know how to group it. In this case the options of the first point instance are copied over to the group point. This can be altered through a custom approximation
callback function.
public SeriesColumn setDataGrouping(DataGrouping dataGrouping)
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the groupPixelWidth
option.
If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup. If point options other than the data itself are set, for example name
or color
or custom properties, the grouping logic doesn't know how to group it. In this case the options of the first point instance are copied over to the group point. This can be altered through a custom approximation
callback function.
dataGrouping
- the value for the dataGrouping optionpublic String getName()
The name of the series as shown in the legend, tooltip etc.
public SeriesColumn setName(String name)
The name of the series as shown in the legend, tooltip etc.
name
- the value for the name optionpublic SeriesType getType()
The type of series, for example line
or column
. By default, the series type is inherited from chart.type, so unless the chart is a combination of series types, there is no need to set it on the series level.
public SeriesColumn setType(SeriesType type)
The type of series, for example line
or column
. By default, the series type is inherited from chart.type, so unless the chart is a combination of series types, there is no need to set it on the series level.
type
- the value for the type optionCopyright © 2022. All rights reserved.