Package com.vaadin.flow.component.charts.model

Class Dial

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.Dial

All Implemented Interfaces:

Serializable

public class Dial
extends AbstractConfigurationObject

Options for the dial or arrow pointer of the gauge.

In styled mode, the dial is styled with the .highcharts-gauge-series .highcharts-dial rule.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Dial()

Method Summary

Modifier and Type	Method	Description
Color	getBackgroundColor()
String	getBaseLength()
Number	getBaseWidth()
Color	getBorderColor()
Number	getBorderWidth()
String	getRadius()
String	getRearLength()
Number	getTopWidth()
void	setBackgroundColor(Color backgroundColor)	The background or fill color of the gauge's dial.
void	setBaseLength(String baseLength)	The length of the dial's base part, relative to the total radius or length of the dial.
void	setBaseWidth(Number baseWidth)	The pixel width of the base of the gauge dial.
void	setBorderColor(Color borderColor)	The border color or stroke of the gauge's dial.
void	setBorderWidth(Number borderWidth)	The width of the gauge dial border in pixels.
void	setRadius(String radius)	The radius or length of the dial, in percentages relative to the radius of the gauge itself.
void	setRearLength(String rearLength)	The length of the dial's rear end, the part that extends out on the other side of the pivot.
void	setTopWidth(Number topWidth)	The width of the top of the dial, closest to the perimeter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Dial

public Dial()

Method Detail

getBackgroundColor

public Color getBackgroundColor()

See Also:

setBackgroundColor(Color)

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

The background or fill color of the gauge's dial.

Defaults to: #000000

getBaseLength

public String getBaseLength()

See Also:

setBaseLength(String)

setBaseLength

public void setBaseLength(String baseLength)

The length of the dial's base part, relative to the total radius or length of the dial.

Defaults to: 70%

getBaseWidth

public Number getBaseWidth()

See Also:

setBaseWidth(Number)

setBaseWidth

public void setBaseWidth(Number baseWidth)

The pixel width of the base of the gauge dial. The base is the part closest to the pivot, defined by baseLength.

Defaults to: 3

getBorderColor

public Color getBorderColor()

See Also:

setBorderColor(Color)

setBorderColor

public void setBorderColor(Color borderColor)

The border color or stroke of the gauge's dial. By default, the borderWidth is 0, so this must be set in addition to a custom border color.

Defaults to: #cccccc

getBorderWidth

public Number getBorderWidth()

See Also:

setBorderWidth(Number)

setBorderWidth

public void setBorderWidth(Number borderWidth)

The width of the gauge dial border in pixels.

Defaults to: 0

getRadius

public String getRadius()

See Also:

setRadius(String)

setRadius

public void setRadius(String radius)

The radius or length of the dial, in percentages relative to the radius of the gauge itself.

Defaults to: 80%

getRearLength

public String getRearLength()

See Also:

setRearLength(String)

setRearLength

public void setRearLength(String rearLength)

The length of the dial's rear end, the part that extends out on the other side of the pivot. Relative to the dial's length.

Defaults to: 10%

getTopWidth

public Number getTopWidth()

See Also:

setTopWidth(Number)

setTopWidth

public void setTopWidth(Number topWidth)

The width of the top of the dial, closest to the perimeter. The pivot narrows in from the base to the top.

Defaults to: 1