Class Background
- java.lang.Object
-
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
-
- com.vaadin.flow.component.charts.model.Background
-
- All Implemented Interfaces:
Serializable
public class Background extends AbstractConfigurationObject
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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Background()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Color
getBackgroundColor()
Color
getBorderColor()
Number
getBorderWidth()
String
getClassName()
Returns the class name of the backgroundString
getInnerRadius()
String
getOuterRadius()
BackgroundShape
getShape()
Returns current shape of the background.void
setBackgroundColor(Color backgroundColor)
Sets the background colorvoid
setBorderColor(Color borderColor)
Sets the border colorvoid
setBorderWidth(Number borderWidth)
Sets the width of the bordervoid
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.
-
-
-
Method Detail
-
getBackgroundColor
public Color getBackgroundColor()
- See Also:
setBackgroundColor(Color)
-
setBackgroundColor
public void setBackgroundColor(Color backgroundColor)
Sets the background color- Parameters:
backgroundColor
-
-
getBorderColor
public Color getBorderColor()
- See Also:
setBorderColor(Color)
-
setBorderColor
public void setBorderColor(Color borderColor)
Sets the border color- Parameters:
borderColor
-
-
getBorderWidth
public Number getBorderWidth()
- See Also:
setBorderWidth(Number)
-
setBorderWidth
public void setBorderWidth(Number borderWidth)
Sets the width of the border- Parameters:
borderWidth
-
-
getClassName
public String getClassName()
Returns the class name of the background- Returns:
- The class name of the background
- See Also:
setClassName(String)
-
setClassName
public void setClassName(String className)
The class name for this background. Defaults to highcharts-pane.- Parameters:
className
- new class name of the background
-
setOuterRadius
public void setOuterRadius(String outerRadius)
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 circularChartType.GAUGE
type charts.- Parameters:
outerRadius
-
-
getOuterRadius
public String getOuterRadius()
- See Also:
setOuterRadius(String)
-
setInnerRadius
public void setInnerRadius(String innerRadius)
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 circularChartType.GAUGE
type charts.- Parameters:
innerRadius
-
-
getInnerRadius
public String getInnerRadius()
- See Also:
setInnerRadius(String)
-
getShape
public BackgroundShape getShape()
Returns current shape of the background.- Returns:
- Current shape.
-
setShape
public void setShape(BackgroundShape shape)
Sets the current shape of the background.- Parameters:
shape
- New shape.
-
-