com.hyjavacharts.model.highcharts

Class ChartOptions

java.lang.Object

com.hyjavacharts.model.common.BaseOption

com.hyjavacharts.model.highcharts.ChartOptions

All Implemented Interfaces:

Serializable

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.

Copyright (c) 2026 Powerbuilt Systems. All rights reserved.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ChartOptions	NULL

Constructor Summary

Constructors

Constructor and Description
ChartOptions()

Method Summary

Modifier and Type	Method and Description
Chart	getChart() General options for the chart.
List<Color>	getColors() Get the colors option.
Color	getColorsSingle()
Credits	getCredits() Highcharts by default puts a credits label in the lower right corner of the chart.
PlotOptions	getPlotOptions() The plotOptions is a wrapper object for config objects for each series type.
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.
List<XAxis>	getXAxis() The X axis or category axis.
XAxis	getXAxisSingle() The X axis or category axis.
ChartOptions	setChart(Chart chart) General options for the chart.
ChartOptions	setColors(List<Color> colors) Set the colors option.
ChartOptions	setCredits(Credits credits) Highcharts by default puts a credits label in the lower right corner of the chart.
ChartOptions	setPlotOptions(PlotOptions plotOptions) The plotOptions is a wrapper object for config objects for each series type.
ChartOptions	setSeries(List<Series> series) Series options for specific data and the data itself.
ChartOptions	setTitle(Title title) The chart's main title.
ChartOptions	setXAxis(List<XAxis> xAxis) The X axis or category axis.

Methods inherited from class com.hyjavacharts.model.common.BaseOption

set_hcNulledOption

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NULL

public static final ChartOptions NULL

Constructor Detail

ChartOptions

public ChartOptions()

Method Detail

getChart

public Chart getChart()

General options for the chart.

Returns:

the chart option.

setChart

public ChartOptions setChart(Chart chart)

General options for the chart.

Parameters:

chart - the value for the chart option.

Returns:

the ChartOptions object.

getColorsSingle

public Color getColorsSingle()

Returns:

the first element in ArrayList colors

getColors

public List<Color> getColors()

Get the colors option.

Returns:

the colors option.

setColors

public ChartOptions setColors(List<Color> colors)

Set the colors option.

Parameters:

colors - the value for the colors option.

Returns:

the ChartOptions object.

getCredits

public Credits getCredits()

Highcharts by default puts a credits label in the lower right corner of the chart. This can be changed using these options.

Returns:

the credits option.

setCredits

public ChartOptions setCredits(Credits credits)

Highcharts by default puts a credits label in the lower right corner of the chart. This can be changed using these options.

Parameters:

credits - the value for the credits option.

Returns:

the ChartOptions object.

getPlotOptions

public PlotOptions getPlotOptions()

The plotOptions is a wrapper object for config objects for each series type. The config objects for each series can also be overridden for each series item as given in the series array.

Configuration options for the series are given in three levels. Options for all series in a chart are given in the plotOptions.series object. Then options for all series of a specific type are given in the plotOptions of that type, for example plotOptions.line. Next, options for one single series are given in the series array.

Returns:

the plotOptions option.

setPlotOptions

public ChartOptions setPlotOptions(PlotOptions plotOptions)

The plotOptions is a wrapper object for config objects for each series type. The config objects for each series can also be overridden for each series item as given in the series array.

Configuration options for the series are given in three levels. Options for all series in a chart are given in the plotOptions.series object. Then options for all series of a specific type are given in the plotOptions of that type, for example plotOptions.line. Next, options for one single series are given in the series array.

Parameters:

plotOptions - the value for the plotOptions option.

Returns:

the ChartOptions object.

getSeriesSingle

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

Returns:

the first element in ArrayList series

getSeries

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.

Returns:

the series option.

setSeries

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.

Parameters:

series - the value for the series option.

Returns:

the ChartOptions object.

getTitle

public Title getTitle()

The chart's main title.

Returns:

the title option.

setTitle

public ChartOptions setTitle(Title title)

The chart's main title.

Parameters:

title - the value for the title option.

Returns:

the ChartOptions object.

getXAxisSingle

public XAxis getXAxisSingle()

The X axis or category axis. Normally this is the horizontal axis, though if the chart is inverted this is the vertical axis. In case of multiple axes, the xAxis node is an array of configuration objects.

See the Axis class for programmatic access to the axis.

Returns:

the first element in ArrayList xAxis

getXAxis

public List<XAxis> getXAxis()

The X axis or category axis. Normally this is the horizontal axis, though if the chart is inverted this is the vertical axis. In case of multiple axes, the xAxis node is an array of configuration objects.

See the Axis class for programmatic access to the axis.

Returns:

the xAxis option.

setXAxis

public ChartOptions setXAxis(List<XAxis> xAxis)

The X axis or category axis. Normally this is the horizontal axis, though if the chart is inverted this is the vertical axis. In case of multiple axes, the xAxis node is an array of configuration objects.

See the Axis class for programmatic access to the axis.

Parameters:

xAxis - the value for the xAxis option.

Returns:

the ChartOptions object.