Package org.zkoss.chart.plotOptions

Class GaugePlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.GaugePlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

SolidGaugePlotOptions

public class GaugePlotOptions
extends SeriesPlotOptions

An option for gauge plot.

All the options in this class support DynamicalAttribute.

Author:

RaymondChao

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
GaugePlotOptions()

Method Summary

Modifier and Type	Method	Description
GaugeDialPlotOptions	getDial()	Returns options for the dial or arrow pointer of the gauge.
Number	getOvershoot()	Allow the dial to overshoot the end of the perimeter axis by this many degrees.
GaugePivotPlotOptions	getPivot()	Returns options for the pivot or the center point of the gauge.
boolean	getShowInLegend()	Returns whether to display this particular series or series type in the legend.
boolean	getWrap()	Deprecated. as of release 10.2.1.0, using isWrap() instead.
boolean	isWrap()	Returns when this option is true, the dial will wrap around the axes.
void	setDial(GaugeDialPlotOptions dial)	Sets options for the dial or arrow pointer of the gauge.
void	setOvershoot(Number overshoot)	Allow the dial to overshoot the end of the perimeter axis by this many degrees.
void	setPivot(GaugePivotPlotOptions pivot)	Sets options for the pivot or the center point of the gauge.
void	setShowInLegend(boolean showInLegend)	Sets whether to display this particular series or series type in the legend.
void	setWrap(boolean wrap)	Sets when this option is true, the dial will wrap around the axes.

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, getLinecap, 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, setLinecap, 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

GaugePlotOptions

public GaugePlotOptions()

Method Detail

getDial

public GaugeDialPlotOptions getDial()

Returns options for the dial or arrow pointer of the gauge.

Default: an instance of GaugeDialPlotOptions.

setDial

public void setDial(GaugeDialPlotOptions dial)

Sets options for the dial or arrow pointer of the gauge.

getOvershoot

public Number getOvershoot()

Allow the dial 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: null

Since:

10.2.1.0

setOvershoot

public void setOvershoot(Number overshoot)

Allow the dial 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: null

Since:

10.2.1.0

getPivot

public GaugePivotPlotOptions getPivot()

Returns options for the pivot or the center point of the gauge.

Default: an instance of GaugePivotPlotOptions.

setPivot

public void setPivot(GaugePivotPlotOptions pivot)

Sets options for the pivot or the center point of the gauge.

getShowInLegend

public boolean getShowInLegend()

Returns whether to display this particular series or series type in the legend. Defaults to false for gauge series.

Default: false.

setShowInLegend

public void setShowInLegend(boolean showInLegend)

Sets whether to display this particular series or series type in the legend. Defaults to false for gauge series.

Overrides:

setShowInLegend in class SeriesPlotOptions

getWrap

public boolean getWrap()

Deprecated.

as of release 10.2.1.0, using isWrap() instead.

Returns when this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.

Default: true.

isWrap

public boolean isWrap()

Returns when this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.

Default: true.

Since:

10.2.1.0

setWrap

public void setWrap(boolean wrap)

Sets when this option is true, the dial will wrap around the axes. For instance, in a full-range gauge going from 0 to 360, a value of 400 will point to 40. When wrap is false, the dial stops at 360.