Package org.zkoss.chart.plotOptions

Class WindBarbPlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.ColumnPlotOptions

org.zkoss.chart.plotOptions.WindBarbPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class WindBarbPlotOptions
extends ColumnPlotOptions

An option for windbarb plot

All the options in this class support DynamicalAttribute.

Since:

7.2.1.0

Author:

rudyhuang

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
WindBarbPlotOptions()

Method Summary

Modifier and Type	Method	Description
WindBarbDataGrouping	getDataGrouping()	Returns the data grouping options for the wind barbs, if any.
String	getOnSeries()	Returns the id of another series in the chart that the wind barbs are projected on.
Number	getVectorLength()	Returns the pixel length of the stems.
Number	getXOffset()	Returns horizontal offset from the cartesian position, in pixels.
Number	getYOffset()	Returns vertical offset from the cartesian position, in pixels.
void	setDataGrouping(WindBarbDataGrouping dataGrouping)	Sets the data grouping options for the wind barbs.
void	setOnSeries(String onSeries)	Sets the id of another series in the chart that the wind barbs are projected on.
void	setVectorLength(Number vectorLength)	Sets the pixel length of the stems.
void	setXOffset(Number xOffset)	Sets horizontal offset from the cartesian position, in pixels.
void	setYOffset(Number yOffset)	Sets vertical offset from the cartesian position, in pixels.

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, isGrouping, 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, getColor, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCursor, getCustom, getDashStyle, 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, 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, setDashStyle, 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, 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

WindBarbPlotOptions

public WindBarbPlotOptions()

Method Detail

getDataGrouping

public WindBarbDataGrouping getDataGrouping()

Returns the data grouping options for the wind barbs, if any. Otherwise, create a new one.

setDataGrouping

public void setDataGrouping(WindBarbDataGrouping dataGrouping)

Sets the data grouping options for the wind barbs.

getOnSeries

public String getOnSeries()

Returns the id of another series in the chart that the wind barbs are projected on. When null, the wind symbols are drawn on the X axis, but offset up or down by the yOffset setting.

Default: null

setOnSeries

public void setOnSeries(String onSeries)

Sets the id of another series in the chart that the wind barbs are projected on. When null, the wind symbols are drawn on the X axis, but offset up or down by the yOffset setting.

getVectorLength

public Number getVectorLength()

Returns the pixel length of the stems.

Default: 20

setVectorLength

public void setVectorLength(Number vectorLength)

Sets the pixel length of the stems.

getXOffset

public Number getXOffset()

Returns horizontal offset from the cartesian position, in pixels. When the chart is inverted, this option allows translation like yOffset in non inverted charts.

Default: 0

setXOffset

public void setXOffset(Number xOffset)

Sets horizontal offset from the cartesian position, in pixels. When the chart is inverted, this option allows translation like yOffset in non inverted charts.

getYOffset

public Number getYOffset()

Returns vertical offset from the cartesian position, in pixels. The default value makes sure the symbols don't overlap the X axis when onSeries is null, and that they don't overlap the linked series when onSeries is given.

Default: -20

setYOffset

public void setYOffset(Number yOffset)

Sets vertical offset from the cartesian position, in pixels. The default value makes sure the symbols don't overlap the X axis when onSeries is null, and that they don't overlap the linked series when onSeries is given.