public class HIOptions extends HIFoundation
Modifier and Type | Field and Description |
---|---|
java.util.HashMap<java.lang.String,java.lang.Object> |
additionalOptions
Additional options that are not listed above but are accepted by API
|
Constructor and Description |
---|
HIOptions() |
Modifier and Type | Method and Description |
---|---|
HIAccessibility |
getAccessibility() |
java.util.ArrayList<HIAnnotations> |
getAnnotations() |
HIBoost |
getBoost() |
HICaption |
getCaption() |
HIChart |
getChart() |
java.util.ArrayList<HIColorAxis> |
getColorAxis() |
java.util.ArrayList<java.lang.String> |
getColors() |
HICredits |
getCredits() |
HIData |
getData() |
HIDefs |
getDefs() |
HIDrilldown |
getDrilldown() |
HIExporting |
getExporting() |
HILegend |
getLegend() |
HILoading |
getLoading() |
HINavigation |
getNavigation() |
HINoData |
getNoData() |
HIPane |
getPane() |
java.util.HashMap<java.lang.String,java.lang.Object> |
getParams() |
HIPlotOptions |
getPlotOptions() |
HIResponsive |
getResponsive() |
java.util.ArrayList<HISeries> |
getSeries() |
HISonification |
getSonification() |
HISubtitle |
getSubtitle() |
HITime |
getTime() |
HITitle |
getTitle() |
HITooltip |
getTooltip() |
java.util.ArrayList<HIXAxis> |
getXAxis() |
java.util.ArrayList<HIYAxis> |
getYAxis() |
java.util.ArrayList<HIZAxis> |
getZAxis() |
void |
setAccessibility(HIAccessibility accessibility)
Options for configuring accessibility for the chart.
|
void |
setAnnotations(java.util.ArrayList<HIAnnotations> annotations)
A basic type of an annotation.
|
void |
setBoost(HIBoost boost)
Options for the Boost module.
|
void |
setCaption(HICaption caption)
The chart's caption, which will render below the chart and will be part of exported charts.
|
void |
setChart(HIChart chart)
General options for the chart.
|
void |
setColorAxis(java.util.ArrayList<HIColorAxis> colorAxis)
A color axis for series.
|
void |
setColors(java.util.ArrayList<java.lang.String> colors)
An array containing the default colors for the chart's series.
|
void |
setCredits(HICredits credits)
Highchart by default puts a credits label in the lower right corner of the chart.
|
void |
setData(HIData data)
The Data module provides a simplified interface for adding data to a chart from sources like CVS, HTML tables or grid views.
|
void |
setDefs(HIDefs defs)
Options for configuring markers for annotations.
|
void |
setDrilldown(HIDrilldown drilldown)
Options for drill down, the concept of inspecting increasingly high resolution data through clicking on chart items like columns or pie slices.
|
void |
setExporting(HIExporting exporting)
Options for the exporting module.
|
void |
setLegend(HILegend legend)
The legend is a box containing a symbol and name for each series item or point item in the chart.
|
void |
setLoading(HILoading loading)
The loading options control the appearance of the loading screen that covers the plot area on chart operations.
|
void |
setNavigation(HINavigation navigation)
A collection of options for buttons and menus appearing in the exporting module or in Stock Tools.
|
void |
setNoData(HINoData noData)
Options for displaying a message like "No data to display".
|
void |
setPane(HIPane pane)
The pane serves as a container for axes and backgrounds for circular gauges and polar charts.
|
void |
setPlotOptions(HIPlotOptions plotOptions)
The plotOptions is a wrapper object for config objects for each series type.
|
void |
setResponsive(HIResponsive responsive)
Allows setting a set of rules to apply for different screen or chart sizes.
|
void |
setSeries(java.util.ArrayList<HISeries> series)
General options for all series types.
|
void |
setSonification(HISonification sonification)
Options for configuring sonification and audio charts.
|
void |
setSubtitle(HISubtitle subtitle)
The chart's subtitle.
|
void |
setTime(HITime time)
Time options that can apply globally or to individual charts.
|
void |
setTitle(HITitle title)
The chart's main title.
|
void |
setTooltip(HITooltip tooltip)
Options for the tooltip that appears when the user hovers over a series or point.
|
void |
setXAxis(java.util.ArrayList<HIXAxis> xAxis)
The X axis or category axis.
|
void |
setYAxis(java.util.ArrayList<HIYAxis> yAxis)
The Y axis or value axis.
|
void |
setZAxis(java.util.ArrayList<HIZAxis> zAxis)
The Z axis or depth axis for 3D plots.
|
public java.util.HashMap<java.lang.String,java.lang.Object> additionalOptions
public HIAccessibility getAccessibility()
public java.util.ArrayList<HIAnnotations> getAnnotations()
public HIBoost getBoost()
public HICaption getCaption()
public HIChart getChart()
public java.util.ArrayList<HIColorAxis> getColorAxis()
public java.util.ArrayList<java.lang.String> getColors()
public HICredits getCredits()
public HIData getData()
public HIDefs getDefs()
public HIDrilldown getDrilldown()
public HIExporting getExporting()
public HILegend getLegend()
public HILoading getLoading()
public HINavigation getNavigation()
public HINoData getNoData()
public HIPane getPane()
public java.util.HashMap<java.lang.String,java.lang.Object> getParams()
getParams
in class HIFoundation
public HIPlotOptions getPlotOptions()
public HIResponsive getResponsive()
public java.util.ArrayList<HISeries> getSeries()
public HISonification getSonification()
public HISubtitle getSubtitle()
public HITime getTime()
public HITitle getTitle()
public HITooltip getTooltip()
public java.util.ArrayList<HIXAxis> getXAxis()
public java.util.ArrayList<HIYAxis> getYAxis()
public java.util.ArrayList<HIZAxis> getZAxis()
public void setAccessibility(HIAccessibility accessibility)
public void setAnnotations(java.util.ArrayList<HIAnnotations> annotations)
public void setBoost(HIBoost boost)
public void setCaption(HICaption caption)
public void setChart(HIChart chart)
public void setColorAxis(java.util.ArrayList<HIColorAxis> colorAxis)
public void setColors(java.util.ArrayList<java.lang.String> colors)
public void setCredits(HICredits credits)
public void setData(HIData data)
public void setDefs(HIDefs defs)
public void setDrilldown(HIDrilldown drilldown)
public void setExporting(HIExporting exporting)
public void setLegend(HILegend legend)
public void setLoading(HILoading loading)
public void setNavigation(HINavigation navigation)
public void setNoData(HINoData noData)
public void setPane(HIPane pane)
public void setPlotOptions(HIPlotOptions plotOptions)
public void setResponsive(HIResponsive responsive)
public void setSeries(java.util.ArrayList<HISeries> series)
public void setSonification(HISonification sonification)
public void setSubtitle(HISubtitle subtitle)
public void setTime(HITime time)
public void setTitle(HITitle title)
public void setTooltip(HITooltip tooltip)
public void setXAxis(java.util.ArrayList<HIXAxis> xAxis)
public void setYAxis(java.util.ArrayList<HIYAxis> yAxis)
public void setZAxis(java.util.ArrayList<HIZAxis> zAxis)