Package org.zkoss.chart.plotOptions

Class DumbbellPlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.DumbbellPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

LollipopPlotOptions

public class DumbbellPlotOptions
extends SeriesPlotOptions

An options for dumbbell plot.

All the options in this class support DynamicalAttribute.

Since:

10.2.1.0

Author:

jumperchen

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
DumbbellPlotOptions()

Method Summary

Modifier and Type	Method	Description
String	getConnectorColor()	Returns the color of the line that connects the dumbbell point's values.
Number	getConnectorWidth()	Returns the pixel width of the line that connects the dumbbell point's values.
Color	getLineColor()	Returns a separate color for the graph line.
Color	getLowColor()	Returns color of the start markers in a dumbbell graph.
LowMarker	getLowMarker()	Returns options for the lower markers of the dumbbell-like series.
Color	getNegativeFillColor()	Returns a separate color for the negative part of the area.
Number	getPointPadding()	Returns the padding between each column or bar, in x axis units.
void	setConnectorColor(String connectorColor)	Sets the color of the line that connects the dumbbell point's values.
void	setConnectorWidth(Number connectorWidth)	Sets the pixel width of the line that connects the dumbbell point's values.
void	setLineColor(String color)	Sets a separate color for the graph line.
void	setLineColor(Color color)	Sets a separate color for the graph line.
void	setLineColor(LinearGradient color)	Sets a separate color for the graph line.
void	setLineColor(RadialGradient color)	Sets a separate color for the graph line.
void	setLowColor(String color)	Sets color of the start markers in a dumbbell graph.
void	setLowColor(Color color)	Sets color of the start markers in a dumbbell graph.
void	setLowColor(LinearGradient color)	Sets color of the start markers in a dumbbell graph.
void	setLowColor(RadialGradient color)	Sets color of the start markers in a dumbbell graph.
void	setLowMarker(LowMarker lowMarker)	Sets options for the lower markers of the dumbbell-like series.
void	setNegativeFillColor(String color)	Sets a separate color for the negative part of the area.
void	setNegativeFillColor(Color color)	Sets a separate color for the negative part of the area.
void	setNegativeFillColor(LinearGradient color)	Sets a separate color for the negative part of the area.
void	setNegativeFillColor(RadialGradient color)	Sets a separate color for the negative part of the area.
void	setPointPadding(Number pointPadding)	Sets the padding between each column or bar, in x axis units.

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

addDataLabels, getAccessibility, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getBorderRadius, getBorderWidth, getClassName, getColor, getColorAxis, getColorIndex, getColorKey, 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, 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, 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

DumbbellPlotOptions

public DumbbellPlotOptions()

Method Detail

getConnectorColor

public String getConnectorColor()

Returns the color of the line that connects the dumbbell point's values. By default it is the series' color.

Defaults to null.

setConnectorColor

public void setConnectorColor(String connectorColor)

Sets the color of the line that connects the dumbbell point's values. By default it is the series' color.

Defaults to null.

getConnectorWidth

public Number getConnectorWidth()

Returns the pixel width of the line that connects the dumbbell point's values.

Default: 1

Overrides:

getConnectorWidth in class SeriesPlotOptions

setConnectorWidth

public void setConnectorWidth(Number connectorWidth)

Sets the pixel width of the line that connects the dumbbell point's values.

Default: 1

Overrides:

setConnectorWidth in class SeriesPlotOptions

getLineColor

public Color getLineColor()

Returns a separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.

Default: null.

setLineColor

public void setLineColor(Color color)

Sets a separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.

setLineColor

public void setLineColor(String color)

Sets a separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.

setLineColor

public void setLineColor(LinearGradient color)

Sets a separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.

setLineColor

public void setLineColor(RadialGradient color)

Sets a separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.

getLowColor

public Color getLowColor()

Returns color of the start markers in a dumbbell graph.

Default: "#333333".

setLowColor

public void setLowColor(Color color)

Sets color of the start markers in a dumbbell graph.

Default: "#333333".

setLowColor

public void setLowColor(String color)

Sets color of the start markers in a dumbbell graph.

Default: "#333333".

setLowColor

public void setLowColor(LinearGradient color)

Sets color of the start markers in a dumbbell graph.

Default: "#333333".

setLowColor

public void setLowColor(RadialGradient color)

Sets color of the start markers in a dumbbell graph.

Default: "#333333".

getLowMarker

public LowMarker getLowMarker()

Returns options for the lower markers of the dumbbell-like series. When lowMarker is not defined, options inherit form the marker.

Since:

11.2.0.0

setLowMarker

public void setLowMarker(LowMarker lowMarker)

Sets options for the lower markers of the dumbbell-like series. When lowMarker is not defined, options inherit form the marker.

Since:

11.2.0.0

getNegativeFillColor

public Color getNegativeFillColor()

Returns a separate color for the negative part of the area.

Default: null.

setNegativeFillColor

public void setNegativeFillColor(Color color)

Sets a separate color for the negative part of the area.

Default: null.

setNegativeFillColor

public void setNegativeFillColor(String color)

Sets a separate color for the negative part of the area.

Default: null.

setNegativeFillColor

public void setNegativeFillColor(LinearGradient color)

Sets a separate color for the negative part of the area.

Default: null.

setNegativeFillColor

public void setNegativeFillColor(RadialGradient color)

Sets a separate color for the negative part of the area.

Default: null.

getPointPadding

public Number getPointPadding()

Returns the padding between each column or bar, in x axis units. Default: 0.1

setPointPadding

public void setPointPadding(Number pointPadding)

Sets the padding between each column or bar, in x axis units.