Package org.zkoss.chart.plotOptions

Class SolidGaugePlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.GaugePlotOptions

org.zkoss.chart.plotOptions.SolidGaugePlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class SolidGaugePlotOptions
extends GaugePlotOptions

An option for solid gauge plot.

All the options in this class support DynamicalAttribute.

Author:

hanhsu

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
SolidGaugePlotOptions()

Method Summary

Modifier and Type	Method	Description
Object	getInnerRadius()	Returns the inner radius for points in a solid gauge.
String	getLinecap()	Returns whether the strokes of the solid gauge should be round or square.
Number	getOvershoot()	Allow the gauge to overshoot the end of the perimeter axis by this many degrees.
Object	getRadius()	Returns the outer radius for points in a solid gauge.
boolean	isRounded()	Returns whether to draw rounded edges on the gauge.
void	setInnerRadius(Number innerRadius)	Sets the inner radius for points in a solid gauge.
void	setInnerRadius(String innerRadius)	Sets the inner radius for points in a solid gauge.
void	setLinecap(String linecap)	Sets whether the strokes of the solid gauge should be round or square.
void	setOvershoot(Number overshoot)	Allow the gauge to overshoot the end of the perimeter axis by this many degrees.
void	setRadius(Number radius)	Sets the outer radius for points in a solid gauge.
void	setRadius(String radius)	Sets the outer radius for points in a solid gauge.
void	setRounded(boolean rounded)	Sets whether to draw rounded edges on the gauge.

Methods inherited from class org.zkoss.chart.plotOptions.GaugePlotOptions

getDial, getPivot, getShowInLegend, getWrap, isWrap, setDial, setPivot, setShowInLegend, setWrap

Methods inherited from class org.zkoss.chart.plotOptions.SeriesPlotOptions

addDataLabels, getAccessibility, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getBorderRadius, getBorderWidth, getClassName, getColor, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCropThreshold, getCursor, getCustom, getDashStyle, getDataLabels, getDataLabelsList, getDataSorting, getDepth, getDescription, getDragDrop, getFindNearestPointBy, getGroupPadding, getId, getIndex, getKeys, getLabel, getLegendSymbol, getLineWidth, getLinkedTo, getMarker, getName, getNeckHeight, getNeckWidth, getNegativeColor, getOnPoint, getOpacity, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getStacking, getStates, getStep, getThreshold, getTooltip, getTurboThreshold, getZoneAxis, getZones, isAllowPointSelect, isAnimation, isCenterInCategory, isClip, isColorByPoint, isConnectEnds, isConnectNulls, isCrisp, isDataAsColumns, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isRelativeXValue, isSelected, isShadow, isShowCheckbox, isShowInLegend, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isStickyTracking, isVisible, newDataLabels, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, setBorderWidth, setCenter, setCenter, setCenterInCategory, setClassName, setClip, setColor, setColor, setColor, setColor, setColorAxis, setColorAxis, setColorAxis, setColorByPoint, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setConnectorWidth, setCrisp, setCropThreshold, setCursor, setCustom, setDashStyle, setDataAsColumns, setDataLabels, setDataLabels, setDataSorting, setDepth, setDescription, setDragDrop, setEnableMouseTracking, setFindNearestPointBy, setGetExtremesFromAll, setGroupPadding, setId, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendSymbol, setLineWidth, setLinkedTo, setMarker, setName, setNeckHeight, setNeckWidth, setNegativeColor, setNegativeColor, setNegativeColor, setNegativeColor, setOnPoint, setOpacity, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointPlacement, setPointStart, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setStickyTracking, setThreshold, setTooltip, setTurboThreshold, setVisible, setWidth, setZoneAxis, setZones, setZones

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

Methods inherited from interface org.zkoss.chart.OptionDataListener

onChange

Constructor Detail

SolidGaugePlotOptions

public SolidGaugePlotOptions()

Method Detail

getInnerRadius

public Object getInnerRadius()

Returns the inner radius for points in a solid gauge. Can be given as a number (pixels) or percentage string.

Default: 60

Since:

7.2.1.0

setInnerRadius

public void setInnerRadius(Number innerRadius)

Sets the inner radius for points in a solid gauge. Can be given as a number (pixels).

Since:

7.2.1.0

setInnerRadius

public void setInnerRadius(String innerRadius)

Sets the inner radius for points in a solid gauge. Can be given as a percentage string.

Since:

7.2.1.0

getLinecap

public String getLinecap()

Returns whether the strokes of the solid gauge should be round or square.

Default: "round"

Overrides:

getLinecap in class SeriesPlotOptions

Since:

7.2.1.0

setLinecap

public void setLinecap(String linecap)

Sets whether the strokes of the solid gauge should be round or square.

Overrides:

setLinecap in class SeriesPlotOptions

Since:

7.2.1.0

getOvershoot

public Number getOvershoot()

Allow the gauge to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0 to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis when this option is set to 5.

Default: 0

Overrides:

getOvershoot in class GaugePlotOptions

Since:

7.2.1.0

setOvershoot

public void setOvershoot(Number overshoot)

Allow the gauge to overshoot the end of the perimeter axis by this many degrees. Say if the gauge axis goes from 0 to 60, a value of 100, or 1000, will show 5 degrees beyond the end of the axis when this option is set to 5.

Overrides:

setOvershoot in class GaugePlotOptions

Since:

7.2.1.0

getRadius

public Object getRadius()

Returns the outer radius for points in a solid gauge. Can be given as a number (pixels) or percentage string.

Default: 100

Since:

7.2.1.0

setRadius

public void setRadius(Number radius)

Sets the outer radius for points in a solid gauge. Can be given as a number (pixels).

Since:

7.2.1.0

setRadius

public void setRadius(String radius)

Sets the outer radius for points in a solid gauge. Can be given as a percentage string.

Since:

7.2.1.0

isRounded

public boolean isRounded()

Returns whether to draw rounded edges on the gauge.

Default: false

Since:

7.2.1.0

setRounded

public void setRounded(boolean rounded)

Sets whether to draw rounded edges on the gauge.

Since:

7.2.1.0