public class Series extends BaseOption
General options for all series types.
In TypeScript the type option must always be set.
Configuration options for the series are given in three levels:
line
series are defined in plotOptions.line.Highcharts.chart('container', { plotOptions: { series: { // general options for all series }, line: { // shared options for all line series } }, series: [{ // specific options for this series instance type: 'line' }] });
Copyright (c) 2024 Powerbuilt Systems. All rights reserved.Constructor and Description |
---|
Series() |
Modifier and Type | Method and Description |
---|---|
Boolean |
getAllowPointSelect()
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
|
Cursor |
getCursorAsEnum()
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
|
String |
getCursorAsString()
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
|
DataLabels |
getDataLabels()
Options for the series data labels, appearing next to each data point.
|
List<DataLabels> |
getDataLabelsAsArrayOptions()
Options for the series data labels, appearing next to each data point.
|
DataLabels |
getDataLabelsAsArrayOptionsSingle()
Options for the series data labels, appearing next to each data point.
|
Label |
getLabel()
Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series.
|
Number |
getPointStart()
If no x values are given for the points in a series, pointStart defines on what value to start.
|
Series |
setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
|
Series |
setCursor(Cursor cursorAsEnum)
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
|
Series |
setCursor(String cursorAsString)
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
|
Series |
setDataLabels(DataLabels dataLabelsAsOptions)
Options for the series data labels, appearing next to each data point.
|
Series |
setDataLabels(List<DataLabels> dataLabelsAsArrayOptions)
Options for the series data labels, appearing next to each data point.
|
Series |
setLabel(Label label)
Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series.
|
Series |
setPointStart(Number pointStart)
If no x values are given for the points in a series, pointStart defines on what value to start.
|
set_hcNulledOption
public static final Series NULL
public Boolean getAllowPointSelect()
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
The selected points can be handled by point select and unselect events, or collectively by the getSelectedPoints function.
And alternative way of selecting points is through dragging.
public Series setAllowPointSelect(Boolean allowPointSelect)
Allow this series' points to be selected by clicking on the graphic (columns, point markers, pie slices, map areas etc).
The selected points can be handled by point select and unselect events, or collectively by the getSelectedPoints function.
And alternative way of selecting points is through dragging.
allowPointSelect
- the value for the allowPointSelect optionpublic Cursor getCursorAsEnum()
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
In styled mode, the series cursor can be set with the same classes as listed under series.color.
public Series setCursor(Cursor cursorAsEnum)
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
In styled mode, the series cursor can be set with the same classes as listed under series.color.
cursorAsEnum
- the value for the cursorAsEnum optionpublic String getCursorAsString()
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
In styled mode, the series cursor can be set with the same classes as listed under series.color.
public Series setCursor(String cursorAsString)
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.
In styled mode, the series cursor can be set with the same classes as listed under series.color.
cursorAsString
- the value for the cursorAsString optionpublic DataLabels getDataLabels()
Options for the series data labels, appearing next to each data point.
Since v6.2.0, multiple data labels can be applied to each single point by defining them as an array of configs.
In styled mode, the data labels can be styled with the .highcharts-data-label-box
and .highcharts-data-label
class names (see example).
public Series setDataLabels(DataLabels dataLabelsAsOptions)
Options for the series data labels, appearing next to each data point.
Since v6.2.0, multiple data labels can be applied to each single point by defining them as an array of configs.
In styled mode, the data labels can be styled with the .highcharts-data-label-box
and .highcharts-data-label
class names (see example).
dataLabelsAsOptions
- the value for the dataLabelsAsOptions optionpublic DataLabels getDataLabelsAsArrayOptionsSingle()
Options for the series data labels, appearing next to each data point.
Since v6.2.0, multiple data labels can be applied to each single point by defining them as an array of configs.
In styled mode, the data labels can be styled with the .highcharts-data-label-box
and .highcharts-data-label
class names (see example).
public List<DataLabels> getDataLabelsAsArrayOptions()
Options for the series data labels, appearing next to each data point.
Since v6.2.0, multiple data labels can be applied to each single point by defining them as an array of configs.
In styled mode, the data labels can be styled with the .highcharts-data-label-box
and .highcharts-data-label
class names (see example).
public Series setDataLabels(List<DataLabels> dataLabelsAsArrayOptions)
Options for the series data labels, appearing next to each data point.
Since v6.2.0, multiple data labels can be applied to each single point by defining them as an array of configs.
In styled mode, the data labels can be styled with the .highcharts-data-label-box
and .highcharts-data-label
class names (see example).
dataLabelsAsArrayOptions
- the value for the dataLabelsAsArrayOptions optionpublic Label getLabel()
Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position.
The series labels currently work with series types having a graph
or an area
.
public Series setLabel(Label label)
Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position.
The series labels currently work with series types having a graph
or an area
.
label
- the value for the label optionpublic Number getPointStart()
If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
If combined with relativeXValue
, an x value can be set on each point. The x value from the point options is multiplied by pointInterval
and added to pointStart
to produce a modified x value.
public Series setPointStart(Number pointStart)
If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.
If combined with relativeXValue
, an x value can be set on each point. The x value from the point options is multiplied by pointInterval
and added to pointStart
to produce a modified x value.
pointStart
- the value for the pointStart optionCopyright © 2024. All rights reserved.