com.vaadin.flow.component.charts.model.
Class Background
All Implemented Interfaces:
An object, or array of objects, for backgrounds. Sub options include backgroundColor (which can be solid or gradient), innerWidth, outerWidth, borderWidth, borderColor.
These configuration options apply only to polar and angular gauges trough the Pane-configuration object.
See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the class name of the background
getShape()
Returns current shape of the background.
void
setBackgroundColor
(Color backgroundColor) Sets the background color
void
setBorderColor
(Color borderColor) Sets the border color
void
setBorderWidth
(Number borderWidth) Sets the width of the border
void
setClassName
(String className) The class name for this background.
void
setInnerRadius
(String innerRadius) Sets the inner radius of the circular shaped background using a string representation of a percentage, e.g.
void
setOuterRadius
(String outerRadius) Sets the outer radius of the circular shaped background using a string representation of a percentage, e.g.
void
setShape
(BackgroundShape shape) Sets the current shape of the background.
-
Constructor Details
-
Background
public Background()
-
-
Method Details
-
getBackgroundColor
See Also:
-
setBackgroundColor
Sets the background color
Parameters:
backgroundColor
- -
getBorderColor
See Also:
-
setBorderColor
Sets the border color
Parameters:
borderColor
- -
getBorderWidth
See Also:
-
setBorderWidth
Sets the width of the border
Parameters:
borderWidth
- -
getClassName
Returns the class name of the background
Returns:
The class name of the background
See Also:
-
setClassName
The class name for this background. Defaults to highcharts-pane.
Parameters:
className
- new class name of the background -
setOuterRadius
Sets the outer radius of the circular shaped background using a string representation of a percentage, e.g. "110%". The percentage is relative to the radius of the chart. This is applicable only to circular
ChartType.GAUGE
type charts.Parameters:
outerRadius
- -
getOuterRadius
See Also:
-
setInnerRadius
Sets the inner radius of the circular shaped background using a string representation of a percentage, e.g. "110%". The percentage is relative to the radius of the chart. This is applicable only to circular
ChartType.GAUGE
type charts.Parameters:
innerRadius
- -
getInnerRadius
See Also:
-
getShape
Returns current shape of the background.
Returns:
Current shape.
-
setShape
Sets the current shape of the background.
Parameters:
shape
- New shape.
-