Package org.zkoss.chart.plotOptions

Class AreaPlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.AreaPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

AreaRangePlotOptions, AreaSplinePlotOptions

public class AreaPlotOptions
extends SeriesPlotOptions

An options for area plot

All the options in this class support DynamicalAttribute.

Author:

RaymondChao, jumperchen

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
AreaPlotOptions()

Method Summary

Modifier and Type	Method	Description
Color	getFillColor()	Returns fill color or gradient for the area.
Number	getFillOpacity()	Returns fill opacity for the area.
Color	getLineColor()	Returns a separate color for the graph line.
Color	getNegativeFillColor()	Returns a separate color for the negative part of the area.
boolean	getTrackByArea()	Returns whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.
void	setFillColor(String color)	Sets fill color or gradient for the area.
void	setFillColor(Color color)	Sets fill color or gradient for the area.
void	setFillColor(LinearGradient color)	Sets fill color or gradient for the area.
void	setFillColor(RadialGradient color)	Sets fill color or gradient for the area.
void	setFillOpacity(Number fillOpacity)	Sets fill opacity for the area.
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	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	setTrackByArea(boolean trackByArea)	Sets whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.

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

AreaPlotOptions

public AreaPlotOptions()

Method Detail

getFillColor

public Color getFillColor()

Returns fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.

Default: null.

setFillColor

public void setFillColor(Color color)

Sets fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.

setFillColor

public void setFillColor(String color)

Sets fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.

setFillColor

public void setFillColor(LinearGradient color)

Sets fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.

setFillColor

public void setFillColor(RadialGradient color)

Sets fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.

getFillOpacity

public Number getFillOpacity()

Returns fill opacity for the area.

Default: 0.75.

setFillOpacity

public void setFillOpacity(Number fillOpacity)

Sets fill opacity for the area.

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.

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.

setNegativeFillColor

public void setNegativeFillColor(String color)

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

setNegativeFillColor

public void setNegativeFillColor(LinearGradient color)

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

setNegativeFillColor

public void setNegativeFillColor(RadialGradient color)

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

getTrackByArea

public boolean getTrackByArea()

Returns whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.

Default: false.

setTrackByArea

public void setTrackByArea(boolean trackByArea)

Sets whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.