Package org.zkoss.chart.plotOptions

Class WaterfallPlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.ColumnPlotOptions

org.zkoss.chart.plotOptions.WaterfallPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class WaterfallPlotOptions
extends ColumnPlotOptions

An option for waterfall 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
WaterfallPlotOptions()

Method Summary

Modifier and Type	Method	Description
Color	getBorderColor()	Returns the color of the border of each waterfall column.
String	getDashStyle()	Returns a name for the dash style to use for the line connecting the columns of the waterfall series.
Color	getLineColor()	Returns the color of the line that connects columns in a waterfall series.
Color	getUpColor()	Returns the color of up point in a waterfall series.
void	setBorderColor(String color)	Sets the color of the border of each waterfall column.
void	setBorderColor(Color color)	Sets the color of the border of each waterfall column.
void	setBorderColor(LinearGradient color)	Sets the color of the border of each waterfall column.
void	setBorderColor(RadialGradient color)	Sets the color of the border of each waterfall column.
void	setDashStyle(String dashStyle)	Sets a name for the dash style to use for the line connecting the columns of the waterfall series.
void	setLineColor(String color)	Sets the color of the line that connects columns in a waterfall series.
void	setLineColor(Color color)	Sets the color of the line that connects columns in a waterfall series.
void	setLineColor(LinearGradient color)	Sets the color of the line that connects columns in a waterfall series.
void	setLineColor(RadialGradient color)	Sets the color of the line that connects columns in a waterfall series.
void	setUpColor(String color)	Sets the color of up point in a waterfall series.
void	setUpColor(Color color)	Sets the color of up point in a waterfall series.
void	setUpColor(LinearGradient color)	Sets the color of up point in a waterfall series.
void	setUpColor(RadialGradient color)	Sets the color of up point in a waterfall series.

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

getBorderRadius, getBorderWidth, getColors, getCropThreshold, getEdgeColor, getEdgeWidth, getGroupPadding, getGroupZPadding, getMaxPointWidth, getMinPointLength, getPointPadding, getPointRange, getPointWidth, isCenterInCategory, isCrisp, isGrouping, 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, getColor, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCursor, getCustom, getDataLabels, getDataLabelsList, getDataSorting, getDepth, getDescription, getDragDrop, getFindNearestPointBy, 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, isClip, isColorByPoint, isConnectEnds, isConnectNulls, isDataAsColumns, isEnableMouseTracking, isGetExtremesFromAll, isIncludeInDataExport, isRelativeXValue, isSelected, isShadow, isShowCheckbox, isShowInLegend, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isStickyTracking, isVisible, isZoomEnabled, newDataLabels, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, setCenter, setCenter, setClassName, setClip, setColor, setColor, setColor, setColor, setColorAxis, setColorAxis, setColorAxis, setColorByPoint, setColorIndex, setColorKey, setConnectEnds, setConnectNulls, setConnectorWidth, setCursor, setCustom, setDataAsColumns, setDataLabels, setDataLabels, setDataSorting, setDepth, setDescription, setDragDrop, setEnableMouseTracking, setFindNearestPointBy, setGetExtremesFromAll, 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, setPointStart, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setShowInLegend, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setStickyTracking, setThreshold, setTooltip, setTurboThreshold, setVisible, setWidth, setZoneAxis, setZones, setZones, setZoomEnabled

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

WaterfallPlotOptions

public WaterfallPlotOptions()

Method Detail

getBorderColor

public Color getBorderColor()

Returns the color of the border of each waterfall column.

Default: #333333

Overrides:

getBorderColor in class ColumnPlotOptions

setBorderColor

public void setBorderColor(Color color)

Sets the color of the border of each waterfall column.

Overrides:

setBorderColor in class ColumnPlotOptions

setBorderColor

public void setBorderColor(String color)

Sets the color of the border of each waterfall column.

Overrides:

setBorderColor in class ColumnPlotOptions

setBorderColor

public void setBorderColor(LinearGradient color)

Sets the color of the border of each waterfall column.

Overrides:

setBorderColor in class ColumnPlotOptions

setBorderColor

public void setBorderColor(RadialGradient color)

Sets the color of the border of each waterfall column.

Overrides:

setBorderColor in class ColumnPlotOptions

getDashStyle

public String getDashStyle()

Returns a name for the dash style to use for the line connecting the columns of the waterfall series. Possible values:

• Solid
• ShortDash
• ShortDot
• ShortDashDot
• ShortDashDotDot
• Dot
• Dash
• LongDash
• DashDot
• LongDashDot
• LongDashDotDot

Overrides:

getDashStyle in class SeriesPlotOptions

setDashStyle

public void setDashStyle(String dashStyle)

Sets a name for the dash style to use for the line connecting the columns of the waterfall series. Possible values:

• Solid
• ShortDash
• ShortDot
• ShortDashDot
• ShortDashDotDot
• Dot
• Dash
• LongDash
• DashDot
• LongDashDot
• LongDashDotDot

Overrides:

setDashStyle in class SeriesPlotOptions

getLineColor

public Color getLineColor()

Returns the color of the line that connects columns in a waterfall series.

Default: #333333

setLineColor

public void setLineColor(Color color)

Sets the color of the line that connects columns in a waterfall series.

setLineColor

public void setLineColor(String color)

Sets the color of the line that connects columns in a waterfall series.

setLineColor

public void setLineColor(LinearGradient color)

Sets the color of the line that connects columns in a waterfall series.

setLineColor

public void setLineColor(RadialGradient color)

Sets the color of the line that connects columns in a waterfall series.

getUpColor

public Color getUpColor()

Returns the color of up point in a waterfall series. series.

Default: null

setUpColor

public void setUpColor(Color color)

Sets the color of up point in a waterfall series.

setUpColor

public void setUpColor(String color)

Sets the color of up point in a waterfall series.

setUpColor

public void setUpColor(LinearGradient color)

Sets the color of up point in a waterfall series.

setUpColor

public void setUpColor(RadialGradient color)

Sets the color of up point in a waterfall series.