Package org.zkoss.chart.plotOptions

Class FunnelPlotOptions

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.plotOptions.SeriesPlotOptions

org.zkoss.chart.plotOptions.PiePlotOptions

org.zkoss.chart.plotOptions.FunnelPlotOptions

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

Direct Known Subclasses:

Funnel3DPlotOptions, PyramidPlotOptions

public class FunnelPlotOptions
extends PiePlotOptions

An option for funnel plot

All the options in this class support DynamicalAttribute.

Author:

jumperchen, RaymondChao

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
FunnelPlotOptions()

Method Summary

Modifier and Type	Method	Description
Object	getBorderRadius()	Returns the corner radius of the border surrounding all points or series.
FunnelDataLabels	getDataLabels()	Returns the first or single option of data labels.
String	getHeight()	Returns the height of the neck, the lower part of a funnel.
String	getNeckHeight()	Returns the height of the neck, the lower part of the funnel.
String	getNeckWidth()	Returns the width of the neck, the lower part of the funnel.
String	getWidth()	Returns the width of the funnel compared to the width of the plot area, or the pixel width if it is a number.
boolean	isReversed()	Returns whether the series should be placed on the other side of the plotArea.
protected DataLabels	newDataLabels()	Internal method for subclasses to provide specific type of data labels.
void	setHeight(String height)	Sets the height of the neck, the lower part of a funnel.
void	setNeckHeight(String neckHeight)	Sets the height of the neck, the lower part of the funnel.
void	setNeckWidth(String neckWidth)	Sets the width of the neck, the lower part of the funnel.
void	setReversed(boolean reversed)	Sets whether the series should be placed on the other side of the plotArea.
void	setWidth(String width)	Sets the width of the funnel compared to the width of the plot area, or the pixel width if it is a number.

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

getBorderColor, getBorderWidth, getCenter, getColors, getDepth, getEndAngle, getFillColor, getInnerSize, getMinSize, getSize, getSlicedOffset, getStartAngle, getThickness, isIgnoreHiddenPoint, isShowInLegend, isStickyTracking, setBorderColor, setBorderColor, setBorderColor, setBorderColor, setBorderWidth, setCenter, setCenter, setColors, setColors, setDepth, setEndAngle, setFillColor, setFillColor, setFillColor, setFillColor, setIgnoreHiddenPoint, setInnerSize, setInnerSize, setMinSize, setShowInLegend, setSize, setSize, setSlicedOffset, setStartAngle, setStickyTracking, setThickness

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

addDataLabels, getAccessibility, getAnimation, getAnimationLimit, getBoostBlending, getBoostThreshold, getClassName, getColor, getColorAxis, getColorIndex, getColorKey, getConnectorWidth, getCropThreshold, getCursor, getCustom, getDashStyle, getDataLabelsList, getDataSorting, getDescription, getDragDrop, getFindNearestPointBy, getGroupPadding, getId, getIndex, getKeys, getLabel, getLegendSymbol, getLinecap, getLineWidth, getLinkedTo, getMarker, getName, 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, isSkipKeyboardNavigation, isSoftThreshold, isStacking, isVisible, setAccessibility, setAllowPointSelect, setAnimation, setAnimation, setAnimationLimit, setBoostBlending, setBoostThreshold, setBorderRadius, setBorderRadius, 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, setDescription, setDragDrop, setEnableMouseTracking, setFindNearestPointBy, setGetExtremesFromAll, setGroupPadding, setId, setIncludeInDataExport, setIndex, setKeys, setLabel, setLegendSymbol, setLinecap, setLineWidth, setLinkedTo, setMarker, setName, setNegativeColor, setNegativeColor, setNegativeColor, setNegativeColor, setOnPoint, setOpacity, setPointDescriptionFormatter, setPointInterval, setPointIntervalUnit, setPointPlacement, setPointPlacement, setPointStart, setRelativeXValue, setSelected, setShadow, setShowCheckbox, setSkipKeyboardNavigation, setSoftThreshold, setStacking, setStacking, setStates, setStep, setThreshold, setTooltip, setTurboThreshold, setVisible, 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

FunnelPlotOptions

public FunnelPlotOptions()

Method Detail

getBorderRadius

public Object getBorderRadius()

Returns the corner radius of the border surrounding all points or series. A number signifies pixels. A percentage string, like for example 50%, signifies a size relative to the series width.

Default: 0

Overrides:

getBorderRadius in class SeriesPlotOptions

Since:

11.2.0.0

newDataLabels

protected DataLabels newDataLabels()

Description copied from class: SeriesPlotOptions

Internal method for subclasses to provide specific type of data labels.

Overrides:

newDataLabels in class PiePlotOptions

getDataLabels

public FunnelDataLabels getDataLabels()

Description copied from class: SeriesPlotOptions

Returns the first or single option of data labels.

Overrides:

getDataLabels in class SeriesPlotOptions

getHeight

public String getHeight()

Returns the height of the neck, the lower part of a funnel. If it is a number it defines the pixel height, if it is a percentage string it is the percentage of the plot area height.

Default: 100%

setHeight

public void setHeight(String height)

Sets the height of the neck, the lower part of a funnel. If it is a number it defines the pixel height, if it is a percentage string it is the percentage of the plot area height.

getNeckHeight

public String getNeckHeight()

Returns the height of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area height.

Default: 25%

Overrides:

getNeckHeight in class SeriesPlotOptions

setNeckHeight

public void setNeckHeight(String neckHeight)

Sets the height of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area height.

Overrides:

setNeckHeight in class SeriesPlotOptions

getNeckWidth

public String getNeckWidth()

Returns the width of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area width.

Default: 30%

Overrides:

getNeckWidth in class SeriesPlotOptions

setNeckWidth

public void setNeckWidth(String neckWidth)

Sets the width of the neck, the lower part of the funnel. A number defines pixel width, a percentage string defines a percentage of the plot area width.

Overrides:

setNeckWidth in class SeriesPlotOptions

getWidth

public String getWidth()

Returns the width of the funnel compared to the width of the plot area, or the pixel width if it is a number.

Default: 90%

setWidth

public void setWidth(String width)

Sets the width of the funnel compared to the width of the plot area, or the pixel width if it is a number.

Overrides:

setWidth in class SeriesPlotOptions

isReversed

public boolean isReversed()

Returns whether the series should be placed on the other side of the plotArea.

Default: false.

Since:

10.2.1.0

setReversed

public void setReversed(boolean reversed)

Sets whether the series should be placed on the other side of the plotArea.

Since:

10.2.1.0