java.lang.Object
- org.zkoss.chart.Optionable
- - org.zkoss.chart.plotOptions.GaugeDialPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware
```
public class GaugeDialPlotOptions
extends Optionable
```
An option for gauge dial plot for Point.getDial() and GaugePlotOptions.getDial() to use.
All the options in this class support DynamicalAttribute.

Author:

jumperchen, RaymondChao

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.zkoss.chart.Optionable
  NOT_NULL_VALUE, options

Constructor Summary

Constructors
Constructor Description

GaugeDialPlotOptions()

Method Summary

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

Methods inherited from class org.zkoss.chart.Optionable
addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GaugeDialPlotOptions
```
public GaugeDialPlotOptions()
```
- Method Detail
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    Returns the background or fill color of the gauge's dial.
    Default: "black".
  - setBackgroundColor
```
public void setBackgroundColor(Color color)
```
    Sets the background or fill color of the gauge's dial.
  - setBackgroundColor
```
public void setBackgroundColor(String color)
```
    Sets the background or fill color of the gauge's dial.
  - setBackgroundColor
```
public void setBackgroundColor(LinearGradient color)
```
    Sets the background or fill color of the gauge's dial.
  - setBackgroundColor
```
public void setBackgroundColor(RadialGradient color)
```
    Sets the background or fill color of the gauge's dial.
  - getBaseLength
```
public String getBaseLength()
```
    Returns the length of the dial's base part, relative to the total radius or length of the dial.
    Default: 70%.
  - setBaseLength
```
public void setBaseLength(String baseLength)
```
    Sets the length of the dial's base part, relative to the total radius or length of the dial.
  - getBaseWidth
```
public Number getBaseWidth()
```
    Returns the pixel width of the base of the gauge dial. The base is the part closest to the pivot, defined by baseLength.
    Default: 3.
  - setBaseWidth
```
public void setBaseWidth(Number baseWidth)
```
    Sets the pixel width of the base of the gauge dial. The base is the part closest to the pivot, defined by baseLength.
  - getBorderColor
```
public Color getBorderColor()
```
    Returns 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.
    Default: "silver".
  - setBorderColor
```
public void setBorderColor(Color color)
```
    Sets 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.
  - setBorderColor
```
public void setBorderColor(String color)
```
    Sets 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.
  - setBorderColor
```
public void setBorderColor(LinearGradient color)
```
    Sets 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.
  - stBorderColor
```
public void stBorderColor(RadialGradient color)
```
    Sets 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.
  - getBorderWidth
```
public Number getBorderWidth()
```
    Returns the width of the gauge dial border in pixels.
    Default: 0.
  - setBorderWidth
```
public void setBorderWidth(Number borderWidth)
```
    Sets the width of the gauge dial border in pixels.
  - getRadius
```
public String getRadius()
```
    Returns the radius or length of the dial, in percentages relative to the radius of the gauge itself.
    Default: 80%.
  - setRadius
```
public void setRadius(String radius)
```
    Sets the radius or length of the dial, in percentages relative to the radius of the gauge itself.
  - getRearLength
```
public String getRearLength()
```
    Returns 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.
    Default: 10%.
  - setRearLength
```
public void setRearLength(String rearLength)
```
    Sets 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.
  - getTopWidth
```
public Number getTopWidth()
```
    Returns the width of the top of the dial, closest to the perimeter. The pivot narrows in from the base to the top.
    Default: 1.
  - setTopWidth
```
public void setTopWidth(Number topWidth)
```
    Sets the width of the top of the dial, closest to the perimeter. The pivot narrows in from the base to the top.

Class GaugeDialPlotOptions

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

Constructor Summary

Method Summary

Methods inherited from class org.zkoss.chart.Optionable

Methods inherited from class java.lang.Object

Constructor Detail

GaugeDialPlotOptions

Method Detail

getBackgroundColor

setBackgroundColor

setBackgroundColor

setBackgroundColor

setBackgroundColor

getBaseLength

setBaseLength

getBaseWidth

setBaseWidth

getBorderColor

setBorderColor

setBorderColor

setBorderColor

stBorderColor

getBorderWidth

setBorderWidth

getRadius

setRadius

getRearLength

setRearLength

getTopWidth

setTopWidth