public class Chart extends BaseOption
General options for the chart.
Copyright (c) 2020 Powerbuilt Systems. All rights reserved.Constructor and Description |
---|
Chart() |
Modifier and Type | Method and Description |
---|---|
Color |
getPlotBackgroundColor()
The background color or gradient for the plot area.
|
Number |
getPlotBorderWidth()
The pixel width of the plot area border.
|
Boolean |
getPlotShadowAsBoolean()
Whether to apply a drop shadow to the plot area.
|
CSSObject |
getPlotShadowAsCSSObject()
Whether to apply a drop shadow to the plot area.
|
ChartType |
getType()
The default series type for the chart.
|
Chart |
setPlotBackgroundColor(Color plotBackgroundColor)
The background color or gradient for the plot area.
|
Chart |
setPlotBorderWidth(Number plotBorderWidth)
The pixel width of the plot area border.
|
Chart |
setPlotShadow(Boolean plotShadowAsBoolean)
Whether to apply a drop shadow to the plot area.
|
Chart |
setPlotShadow(CSSObject plotShadowAsCSSObject)
Whether to apply a drop shadow to the plot area.
|
Chart |
setType(ChartType type)
The default series type for the chart.
|
set_hcNulledOption
public static final Chart NULL
public Color getPlotBackgroundColor()
The background color or gradient for the plot area.
public Chart setPlotBackgroundColor(Color plotBackgroundColor)
The background color or gradient for the plot area.
plotBackgroundColor
- the value for the plotBackgroundColor optionpublic Number getPlotBorderWidth()
The pixel width of the plot area border.
public Chart setPlotBorderWidth(Number plotBorderWidth)
The pixel width of the plot area border.
plotBorderWidth
- the value for the plotBorderWidth optionpublic Boolean getPlotShadowAsBoolean()
Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. The shadow can be an object configuration containing color
, offsetX
, offsetY
, opacity
and width
.
public Chart setPlotShadow(Boolean plotShadowAsBoolean)
Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. The shadow can be an object configuration containing color
, offsetX
, offsetY
, opacity
and width
.
plotShadowAsBoolean
- the value for the plotShadowAsBoolean optionpublic CSSObject getPlotShadowAsCSSObject()
Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. The shadow can be an object configuration containing color
, offsetX
, offsetY
, opacity
and width
.
public Chart setPlotShadow(CSSObject plotShadowAsCSSObject)
Whether to apply a drop shadow to the plot area. Requires that plotBackgroundColor be set. The shadow can be an object configuration containing color
, offsetX
, offsetY
, opacity
and width
.
plotShadowAsCSSObject
- the value for the plotShadowAsCSSObject optionpublic ChartType getType()
The default series type for the chart. Can be any of the chart types listed under plotOptions and series or can be a series provided by an additional module.
In TypeScript this option has no effect in sense of typing and instead the type
option must always be set in the series.
public Chart setType(ChartType type)
The default series type for the chart. Can be any of the chart types listed under plotOptions and series or can be a series provided by an additional module.
In TypeScript this option has no effect in sense of typing and instead the type
option must always be set in the series.
type
- the value for the type optionCopyright © 2022. All rights reserved.