public class Chart extends BaseOption
General options for the chart.
Copyright (c) 2019 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.
|
Color |
plotBackgroundColor()
The background color or gradient for the plot area.
|
Chart |
plotBackgroundColor(Color plotBackgroundColor)
The background color or gradient for the plot area.
|
Number |
plotBorderWidth()
The pixel width of the plot area border.
|
Chart |
plotBorderWidth(Number plotBorderWidth)
The pixel width of the plot area border.
|
Boolean |
plotShadowAsBoolean()
Whether to apply a drop shadow to the plot area.
|
Chart |
plotShadowAsBoolean(Boolean plotShadowAsBoolean)
Whether to apply a drop shadow to the plot area.
|
CSSObject |
plotShadowAsCSSObject()
Whether to apply a drop shadow to the plot area.
|
Chart |
plotShadowAsCSSObject(CSSObject plotShadowAsCSSObject)
Whether to apply a drop shadow to the plot area.
|
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 |
setPlotShadowAsBoolean(Boolean plotShadowAsBoolean)
Whether to apply a drop shadow to the plot area.
|
Chart |
setPlotShadowAsCSSObject(CSSObject plotShadowAsCSSObject)
Whether to apply a drop shadow to the plot area.
|
Chart |
setType(ChartType type)
The default series type for the chart.
|
ChartType |
type()
The default series type for the chart.
|
Chart |
type(ChartType type)
The default series type for the chart.
|
set_hcNulledOption
public Color plotBackgroundColor()
The background color or gradient for the plot area.
public Chart plotBackgroundColor(Color plotBackgroundColor)
The background color or gradient for the plot area.
plotBackgroundColor
- the value for the plotBackgroundColor optionpublic 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 plotBorderWidth()
The pixel width of the plot area border.
public Chart plotBorderWidth(Number plotBorderWidth)
The pixel width of the plot area border.
plotBorderWidth
- the value for the plotBorderWidth 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 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
.
public Chart plotShadowAsBoolean(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 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 setPlotShadowAsBoolean(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 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
.
public Chart plotShadowAsCSSObject(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 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 setPlotShadowAsCSSObject(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 type()
The default series type for the chart. Can be any of the chart types listed under plotOptions.
public Chart type(ChartType type)
The default series type for the chart. Can be any of the chart types listed under plotOptions.
type
- the value for the type optionpublic ChartType getType()
The default series type for the chart. Can be any of the chart types listed under plotOptions.
public Chart setType(ChartType type)
The default series type for the chart. Can be any of the chart types listed under plotOptions.
type
- the value for the type optionCopyright © 2022. All rights reserved.