public class HighchartOptions extends Object
The HighchartOptions class can be used as an alternative to the Highchart class.
Global and chart options are configured separately by using the GlobalOptions and ChartOptions classes outside of the Highchart class.
Global options can be configured once and will apply to multiple charts. Global options are optional.
This class handles chart theming and generates JSON for GlobalOptions, ChartOptions and any model class.
The GlobalOptions class maps directly to the Highcharts global options in the Highcharts API.
Global options are added to your web page using Highcharts.setOptions({GlobalOptions});
The ChartOptions class maps directly to the Highcharts chart options in the Highcharts API.
Chart options are added to your web page using Highcharts.chart({ChartOptions});
All Highchart global options can be set from the GlobalOptions class.
All Highchart chart options can be set from the ChartOptions class.
Refer to the HyJavaCharts documentation for examples on how to use this class.
Constructor and Description |
---|
HighchartOptions() |
Modifier and Type | Method and Description |
---|---|
Theme |
getTheme()
Get the theme object for the chartOptions.
|
HighchartOptions |
setTheme(Theme theme,
ChartOptions chartOptions)
Sets the theme for the chartOptions.
|
String |
toJs(ChartOptions chartOptions)
Converts chart options to JSON.
|
String |
toJs(GlobalOptions globalOptions)
Converts global options to JSON.
|
String |
toJs(Object object)
Converts any model class to JSON.
|
public String toJs(GlobalOptions globalOptions)
globalOptions
- the global options object.public String toJs(ChartOptions chartOptions)
chartOptions
- the chart options object.public String toJs(Object object)
object
- the model class.public Theme getTheme()
public HighchartOptions setTheme(Theme theme, ChartOptions chartOptions)
theme
- The theme selected for the chartOptions.chartOptions
- The chartOptions to apply the theme.Copyright © 2024. All rights reserved.