public class ChartOptions extends BaseOption
The ChartOptions class maps directly to the Highcharts chart options in the Highcharts API.
All Highchart chart options will be set from this class.
Modifier and Type | Field and Description |
---|---|
static ChartOptions |
NULL |
Constructor and Description |
---|
ChartOptions() |
Modifier and Type | Method and Description |
---|---|
Chart |
getChart()
General options for the chart.
|
List<Color> |
getColors() |
Color |
getColorsSingle() |
RangeSelector |
getRangeSelector()
The range selector is a tool for selecting ranges to display within the chart.
|
List<Series> |
getSeries()
Series options for specific data and the data itself.
|
Series |
getSeriesSingle()
Series options for specific data and the data itself.
|
Title |
getTitle()
The chart's main title.
|
ChartOptions |
setChart(Chart chart)
General options for the chart.
|
ChartOptions |
setColors(List<Color> colors) |
ChartOptions |
setRangeSelector(RangeSelector rangeSelector)
The range selector is a tool for selecting ranges to display within the chart.
|
ChartOptions |
setSeries(List<Series> series)
Series options for specific data and the data itself.
|
ChartOptions |
setTitle(Title title)
The chart's main title.
|
set_hcNulledOption
public static final ChartOptions NULL
public Chart getChart()
General options for the chart.
public ChartOptions setChart(Chart chart)
General options for the chart.
chart
- the value for the chart optionpublic Color getColorsSingle()
public ChartOptions setColors(List<Color> colors)
colors
- the value for the colors optionpublic RangeSelector getRangeSelector()
The range selector is a tool for selecting ranges to display within the chart. It provides buttons to select preconfigured ranges in the chart, like 1 day, 1 week, 1 month etc. It also provides input boxes where min and max dates can be manually input.
public ChartOptions setRangeSelector(RangeSelector rangeSelector)
The range selector is a tool for selecting ranges to display within the chart. It provides buttons to select preconfigured ranges in the chart, like 1 day, 1 week, 1 month etc. It also provides input boxes where min and max dates can be manually input.
rangeSelector
- the value for the rangeSelector optionpublic Series getSeriesSingle()
Series options for specific data and the data itself. In TypeScript you have to cast the series options to specific series types, to get all possible options for a series.
public List<Series> getSeries()
Series options for specific data and the data itself. In TypeScript you have to cast the series options to specific series types, to get all possible options for a series.
public ChartOptions setSeries(List<Series> series)
Series options for specific data and the data itself. In TypeScript you have to cast the series options to specific series types, to get all possible options for a series.
series
- the value for the series optionpublic Title getTitle()
The chart's main title.
public ChartOptions setTitle(Title title)
The chart's main title.
title
- the value for the title optionCopyright © 2023. All rights reserved.