Package org.zkoss.chart.plotOptions

Class ErrorBarPlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.ColumnPlotOptions

org.zkoss.chart.plotOptions.BoxPlotOptions

org.zkoss.chart.plotOptions.ErrorBarPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class ErrorBarPlotOptions
extends BoxPlotOptions

An option for error bar 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
ErrorBarPlotOptions()

Method Summary

Modifier and Type	Method	Description
Color	getColor()	Returns the main color of the bars.
String	getLinkedTo()	Returns the parent series of the error bar.
Number	getWhiskerWidth()	Returns the line width of the whiskers, the horizontal lines marking low and high values.
boolean	isGrouping()	Returns whether to group non-stacked columns or to let them render independent of each other.
void	setColor(String color)	Sets the main color of the bars.
void	setColor(Color color)	Sets the main color of the bars.
void	setColor(LinearGradient color)	Sets the main color of the bars.
void	setColor(RadialGradient color)	Sets the main color of the bars.
void	setLinkedTo(String linkedTo)	Sets the parent series of the error bar.
void	setWhiskerWidth(Number whiskerWidth)	Sets the line width of the whiskers, the horizontal lines marking low and high values.

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

getBoxDashStyle, getFillColor, getLineWidth, getMedianColor, getMedianDashStyle, getMedianWidth, getStemColor, getStemDashStyle, getStemWidth, getWhiskerColor, getWhiskerDashStyle, getWhiskerLength, setBoxDashStyle, setFillColor, setFillColor, setFillColor, setFillColor, setLineWidth, setMedianColor, setMedianColor, setMedianColor, setMedianColor, setMedianDashStyle, setMedianWidth, setStemColor, setStemColor, setStemColor, setStemColor, setStemDashStyle, setStemWidth, setWhiskerColor, setWhiskerColor, setWhiskerColor, setWhiskerColor, setWhiskerDashStyle, setWhiskerLength, setWhiskerLength

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

getBorderColor, getBorderRadius, getBorderWidth, getColors, getCropThreshold, getEdgeColor, getEdgeWidth, getGroupPadding, getGroupZPadding, getMaxPointWidth, getMinPointLength, getPointPadding, getPointRange, getPointWidth, isCenterInCategory, isCrisp, setBorderColor, setBorderColor, setBorderColor, setBorderColor, setBorderWidth, setCenterInCategory, setColors, setColors, setCrisp, setCropThreshold, setEdgeColor, setEdgeColor, setEdgeWidth, setGrouping, setGroupPadding, setGroupZPadding, setMaxPointWidth, setMinPointLength, setPointPadding, setPointRange, setPointWidth

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

addDataLabels, getAccessibility, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCursor, getCustom, getDashStyle, getDataLabels, getDataLabelsList, getDataSorting, getDepth, getDescription, getDragDrop, getFindNearestPointBy, getId, getIndex, getKeys, getLabel, getLegendSymbol, getLinecap, getMarker, getName, getNeckHeight, getNeckWidth, getNegativeColor, getOnPoint, getOpacity, getPointDescriptionFormatter, getPointInterval, getPointIntervalUnit, getPointPlacement, getPointStart, getStacking, getStates, getStep, getThreshold, getTooltip, getTurboThreshold, getZoneAxis, getZones, isAllowPointSelect, isAnimation, isClip, isColorByPoint, isConnectEnds, isConnectNulls, isDataAsColumns, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isRelativeXValue, isSelected, isShadow, isShowCheckbox, isShowInLegend, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isStickyTracking, isVisible, newDataLabels, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, setCenter, setCenter, setClassName, setClip, setColorAxis, setColorAxis, setColorAxis, setColorByPoint, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setConnectorWidth, setCursor, setCustom, setDashStyle, setDataAsColumns, setDataLabels, setDataLabels, setDataSorting, setDepth, setDescription, setDragDrop, setEnableMouseTracking, setFindNearestPointBy, setGetExtremesFromAll, setId, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendSymbol, setLinecap, setMarker, setName, setNeckHeight, setNeckWidth, setNegativeColor, setNegativeColor, setNegativeColor, setNegativeColor, setOnPoint, setOpacity, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointPlacement, setPointStart, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setShowInLegend, 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

ErrorBarPlotOptions

public ErrorBarPlotOptions()

Method Detail

getColor

public Color getColor()

Returns the main color of the bars. This can be overridden by BoxPlotOptions.setStemColor(String) and BoxPlotOptions.setWhiskerColor(String) individually.

Default: "#000000"

Overrides:

getColor in class SeriesPlotOptions

setColor

public void setColor(Color color)

Sets the main color of the bars. This can be overridden by BoxPlotOptions.setStemColor(String) and BoxPlotOptions.setWhiskerColor(String) individually.

Default: "#000000"

Overrides:

setColor in class SeriesPlotOptions

setColor

public void setColor(String color)

Sets the main color of the bars. This can be overridden by BoxPlotOptions.setStemColor(String) and BoxPlotOptions.setWhiskerColor(String) individually.

Default: "#000000"

Overrides:

setColor in class SeriesPlotOptions

setColor

public void setColor(LinearGradient color)

Sets the main color of the bars. This can be overridden by BoxPlotOptions.setStemColor(String) and BoxPlotOptions.setWhiskerColor(String) individually.

Default: "#000000"

Overrides:

setColor in class SeriesPlotOptions

setColor

public void setColor(RadialGradient color)

Sets the main color of the bars. This can be overridden by BoxPlotOptions.setStemColor(String) and BoxPlotOptions.setWhiskerColor(String) individually.

Default: "#000000"

Overrides:

setColor in class SeriesPlotOptions

getLinkedTo

public String getLinkedTo()

Returns the parent series of the error bar. The default value links it to the previous series. Otherwise, use the id of the parent series.

Default: ":previous"

Overrides:

getLinkedTo in class SeriesPlotOptions

setLinkedTo

public void setLinkedTo(String linkedTo)

Sets the parent series of the error bar. The default value links it to the previous series. Otherwise, use the id of the parent series.

Overrides:

setLinkedTo in class SeriesPlotOptions

getWhiskerWidth

public Number getWhiskerWidth()

Returns the line width of the whiskers, the horizontal lines marking low and high values. When null, the general BoxPlotOptions.setLineWidth(Number) applies.

Overrides:

getWhiskerWidth in class BoxPlotOptions

setWhiskerWidth

public void setWhiskerWidth(Number whiskerWidth)

Sets the line width of the whiskers, the horizontal lines marking low and high values. When null, the general BoxPlotOptions.setLineWidth(Number) applies.

Overrides:

setWhiskerWidth in class BoxPlotOptions

isGrouping

public boolean isGrouping()

Returns whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.

Defaults to false.

Overrides:

isGrouping in class ColumnPlotOptions