Package com.storedobject.chart

Class FunnelChart

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Chart

com.storedobject.chart.AbstractChart

com.storedobject.chart.SelfPositioningChart

com.storedobject.chart.FunnelChart

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasAnimation, HasData, HasEmphasis, HasPosition

public class FunnelChart
extends SelfPositioningChart

Funnel chart.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.chart.Chart

Chart.Emphasis, Chart.Label, Chart.LabelPosition

Constructor Summary

Constructors

Constructor	Description
FunnelChart()	Constructor.
FunnelChart(AbstractDataProvider<?> itemNames, DataProvider values)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
void	fitOnLeftSide()	Fit the funnel to the left side.
void	fitOnRightSide()	Fit the funnel to the right side.
int	getSliceGap()	Get the gap between slices.
boolean	isInverted()	See if the slices are shown inverted or not.
boolean	isSorted()	By default, slices will be sorted and shown.
void	setData(DataProvider data)	Set data for the slices.
void	setInverted(boolean inverted)	Invert the view of the slices.
void	setItemNames(AbstractDataProvider<?> itemNames)	Set names of the slices.
void	setMouthSize(Size mouthSize)	Set the mouth size of the funnel.
void	setSliceGap(int sliceGap)	Set the gap between slices.
void	setSorted(boolean sorted)	Set the "sort" property for the slices.
void	setTailSize(Size size)	Set the tail size.
void	showAtCenter()	Show the funnel at the center.

Methods inherited from class com.storedobject.chart.SelfPositioningChart

getPosition, setPosition

Methods inherited from class com.storedobject.chart.AbstractChart

setData, setData, setType, validate

Methods inherited from class com.storedobject.chart.Chart

addParts, dataToEmbed, dataValue, dataValueIndex, declareData, getAnimation, getCoordinateSystem, getData, getEmphasis, getItemStyle, getLabel, getLabelName, getMarkArea, getMax, getMin, getName, getTooltip, getType, mainData, plotOn, plotOn, setAnimation, setColors, setCustomRenderer, setEmphasis, setItemStyle, setLabel, setMarkArea, setName, setTooltip, typeValue

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getRenderingIndex, getSerial, setRenderingIndex, setSerial

Constructor Details

FunnelChart

public FunnelChart()

Constructor.

FunnelChart

public FunnelChart(AbstractDataProvider<?> itemNames,
 DataProvider values)

Constructor.

Parameters:

itemNames - Item names of the slices.

values - Values of the slices.

Method Details

setItemNames

public void setItemNames(AbstractDataProvider<?> itemNames)

Set names of the slices.

Parameters:

itemNames - Item names of the slices.

setData

public void setData(DataProvider data)

Set data for the slices.

Parameters:

data - Data.

setTailSize

public void setTailSize(Size size)

Set the tail size. (Default value of tail size is zero and thus, the tail will look like a triangle).

Parameters:

size - Size of the tail to set.

isSorted

public boolean isSorted()

By default, slices will be sorted and shown.

Returns:

True if sorted, otherwise false.

setSorted

public void setSorted(boolean sorted)

Set the "sort" property for the slices.

Parameters:

sorted - True for sorted, false for not sorted.

isInverted

public boolean isInverted()

See if the slices are shown inverted or not.

Returns:

True if inverted, otherwise false.

setInverted

public void setInverted(boolean inverted)

Invert the view of the slices. (By default, the slices are sorted in descending order. By setting this to true, slices will be shown in ascending order).

Parameters:

inverted - True for inverted, false for not inverted.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class Chart

Parameters:

sb - Encoded JSON string to be appended to this.

getSliceGap

public int getSliceGap()

Get the gap between slices.

Returns:

Gap.

setSliceGap

public void setSliceGap(int sliceGap)

Set the gap between slices.

Parameters:

sliceGap - Gap in pixels.

setMouthSize

public void setMouthSize(Size mouthSize)

Set the mouth size of the funnel. (By default, the mouth size is 100%).

Parameters:

mouthSize - Mouth size to set.

fitOnLeftSide

public void fitOnLeftSide()

Fit the funnel to the left side. It will look like fitted on the left wall.

fitOnRightSide

public void fitOnRightSide()

Fit the funnel to the right side. It will look like fitted on the right wall.

showAtCenter

public void showAtCenter()

Show the funnel at the center.