com.haulmont.charts.gui.amcharts.model.charts

Class FunnelChart

java.lang.Object

com.haulmont.charts.gui.amcharts.model.AbstractChartObject

com.haulmont.charts.gui.amcharts.model.charts.ChartModelImpl

com.haulmont.charts.gui.amcharts.model.charts.AbstractChart<T>

com.haulmont.charts.gui.amcharts.model.charts.SlicedChart<FunnelChart>

com.haulmont.charts.gui.amcharts.model.charts.FunnelChart

All Implemented Interfaces:

ChartModel<FunnelChart>, FunnelChartModel<FunnelChart>, SlicedChartModel<FunnelChart>, HasColors<FunnelChart>, HasMargins<FunnelChart>, HasStartEffect<FunnelChart>, java.io.Serializable

public class FunnelChart
extends SlicedChart<FunnelChart>
implements FunnelChartModel<FunnelChart>

See documentation for properties of AmFunnelChart JS object.
http://docs.amcharts.com/3/javascriptcharts/AmFunnelChart

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.charts.gui.amcharts.model.charts.AbstractChart

AbstractChart.DataProviderChangeListener

Constructor Summary

Constructors

Constructor and Description
FunnelChart()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getAngle()
java.lang.String	getBalloonText()
java.lang.String	getBaseWidth()
java.lang.Integer	getDepth3D()
LabelPosition	getLabelPosition()
java.lang.String	getLabelText()
java.lang.String	getNeckHeight()
java.lang.String	getNeckWidth()
java.lang.String	getPullDistance()
java.lang.Boolean	getRotate()
java.lang.Integer	getStartX()
java.lang.Integer	getStartY()
FunnelValueRepresentation	getValueRepresents()
FunnelChart	setAngle(java.lang.Integer angle) Sets the angle of the 3D part of the chart.
FunnelChart	setBalloonText(java.lang.String balloonText) Sets balloon text.
FunnelChart	setBaseWidth(java.lang.String baseWidth) Sets width of a base (first slice) of a chart.
FunnelChart	setDepth3D(java.lang.Integer depth3D) Sets the depth of funnel/pyramid.
FunnelChart	setLabelPosition(LabelPosition labelPosition) Specifies where labels should be placed.
FunnelChart	setLabelText(java.lang.String labelText) Sets label text.
FunnelChart	setNeckHeight(java.lang.String neckHeight) Sets height of a funnel neck.
FunnelChart	setNeckWidth(java.lang.String neckWidth) Sets width of a funnel neck.
FunnelChart	setPullDistance(java.lang.String pullDistance) Sets the distance by which slice should be pulled when user clicks on it.
FunnelChart	setRotate(java.lang.Boolean rotate) If rotate is set to true, the funnel will be rotated and will became a pyramid.
FunnelChart	setStartX(java.lang.Integer startX) Sets initial X coordinate of slices.
FunnelChart	setStartY(java.lang.Integer startY) Sets initial y coordinate of slices.
FunnelChart	setValueRepresents(FunnelValueRepresentation valueRepresents) Sets the value represents.

Methods inherited from class com.haulmont.charts.gui.amcharts.model.charts.SlicedChart

addColors, addGradientRatio, getAccessibleLabel, getAlpha, getAlphaField, getBaseColor, getClassNameField, getColorField, getColors, getDescriptionField, getGradientRatio, getGroupedAlpha, getGroupedColor, getGroupedDescription, getGroupedPulled, getGroupedTitle, getGroupPercent, getHideLabelsPercent, getHoverAlpha, getLabelColorField, getLabelFunction, getLabelsEnabled, getLabelTickAlpha, getLabelTickColor, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxLabelWidth, getOutlineAlpha, getOutlineColor, getOutlineThickness, getPatternField, getPulledField, getPullOutDuration, getPullOutEffect, getPullOutOnlyOne, getSequencedAnimation, getShowZeroSlices, getStartAlpha, getStartDuration, getStartEffect, getTabIndex, getTitleField, getUrlField, getUrlTarget, getValueField, getVisibleInLegendField, getWiredFields, setAccessibleLabel, setAlpha, setAlphaField, setBaseColor, setClassNameField, setColorField, setColors, setDescriptionField, setGradientRatio, setGroupedAlpha, setGroupedColor, setGroupedDescription, setGroupedPulled, setGroupedTitle, setGroupPercent, setHideLabelsPercent, setHoverAlpha, setLabelColorField, setLabelFunction, setLabelsEnabled, setLabelTickAlpha, setLabelTickColor, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxLabelWidth, setOutlineAlpha, setOutlineColor, setOutlineThickness, setPatternField, setPulledField, setPullOutDuration, setPullOutEffect, setPullOutOnlyOne, setSequencedAnimation, setShowZeroSlices, setStartAlpha, setStartDuration, setStartEffect, setTabIndex, setTitleField, setUrlField, setUrlTarget, setValueField, setVisibleInLegendField

Methods inherited from class com.haulmont.charts.gui.amcharts.model.charts.AbstractChart

addAdditionalFields, addData, addDataProviderChangeListener, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, getAccessible, getAccessibleTitle, getAddClassNames, getAdditionalFields, getAllLabels, getAutoDisplay, getAutoResize, getAutoTransform, getBackgroundAlpha, getBackgroundColor, getBalloon, getBorderAlpha, getBorderColor, getClassNamePrefix, getColor, getCreditsPosition, getDataProvider, getDecimalSeparator, getDefs, getExport, getFontFamily, getFontSize, getHandDrawn, getHandDrawScatter, getHandDrawThickness, getHideBalloonTime, getLanguage, getLegend, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getType, getUsePrefixes, removeDataProviderSetListener, setAccessible, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setClassNamePrefix, setColor, setCreditsPosition, setDataProvider, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setUsePrefixes

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.charts.gui.amcharts.model.charts.SlicedChartModel

addGradientRatio, getAccessibleLabel, getAlpha, getAlphaField, getBaseColor, getClassNameField, getColorField, getDescriptionField, getGradientRatio, getGroupedAlpha, getGroupedColor, getGroupedDescription, getGroupedPulled, getGroupedTitle, getGroupPercent, getHideLabelsPercent, getHoverAlpha, getLabelColorField, getLabelFunction, getLabelsEnabled, getLabelTickAlpha, getLabelTickColor, getMaxLabelWidth, getOutlineAlpha, getOutlineColor, getOutlineThickness, getPatternField, getPulledField, getPullOutDuration, getPullOutEffect, getPullOutOnlyOne, getSequencedAnimation, getShowZeroSlices, getStartAlpha, getTabIndex, getTitleField, getUrlField, getUrlTarget, getValueField, getVisibleInLegendField, setAccessibleLabel, setAlpha, setAlphaField, setBaseColor, setClassNameField, setColorField, setDescriptionField, setGradientRatio, setGroupedAlpha, setGroupedColor, setGroupedDescription, setGroupedPulled, setGroupedTitle, setGroupPercent, setHideLabelsPercent, setHoverAlpha, setLabelColorField, setLabelFunction, setLabelsEnabled, setLabelTickAlpha, setLabelTickColor, setMaxLabelWidth, setOutlineAlpha, setOutlineColor, setOutlineThickness, setPatternField, setPulledField, setPullOutDuration, setPullOutEffect, setPullOutOnlyOne, setSequencedAnimation, setShowZeroSlices, setStartAlpha, setTabIndex, setTitleField, setUrlField, setUrlTarget, setValueField, setVisibleInLegendField

Methods inherited from interface com.haulmont.charts.gui.amcharts.model.charts.ChartModel

addAdditionalFields, addData, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, getAccessible, getAccessibleTitle, getAddClassNames, getAdditionalFields, getAllLabels, getAutoDisplay, getAutoResize, getAutoTransform, getBackgroundAlpha, getBackgroundColor, getBalloon, getBorderAlpha, getBorderColor, getClassNamePrefix, getColor, getCreditsPosition, getDataProvider, getDecimalSeparator, getDefs, getExport, getFontFamily, getFontSize, getHandDrawn, getHandDrawScatter, getHandDrawThickness, getHideBalloonTime, getLanguage, getLegend, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getUsePrefixes, setAccessible, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setClassNamePrefix, setColor, setCreditsPosition, setDataProvider, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setUsePrefixes

Methods inherited from interface com.haulmont.charts.gui.amcharts.model.HasMargins

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

Methods inherited from interface com.haulmont.charts.gui.amcharts.model.HasStartEffect

getStartDuration, getStartEffect, setStartDuration, setStartEffect

Methods inherited from interface com.haulmont.charts.gui.amcharts.model.HasColors

addColors, getColors, setColors

Constructor Detail

FunnelChart

public FunnelChart()

Method Detail

getBalloonText

public java.lang.String getBalloonText()

Specified by:

getBalloonText in interface FunnelChartModel<FunnelChart>

Returns:

balloon text

setBalloonText

public FunnelChart setBalloonText(java.lang.String balloonText)

Description copied from interface: FunnelChartModel

Sets balloon text. The following tags can be used: [[value]], [[title]], [[percents]], [[description]]. Also can be used fields in the chart such as titleField, valueField etc. Fields that not used in the chart can be added by using additionalFields. HTML tags can also be used.

Specified by:

setBalloonText in interface FunnelChartModel<FunnelChart>

Parameters:

balloonText - balloon text string

getBaseWidth

public java.lang.String getBaseWidth()

Specified by:

getBaseWidth in interface FunnelChartModel<FunnelChart>

Returns:

width of a base (first slice) of a chart

setBaseWidth

public FunnelChart setBaseWidth(java.lang.String baseWidth)

Description copied from interface: FunnelChartModel

Sets width of a base (first slice) of a chart. 100% means it will occupy all available space.

Specified by:

setBaseWidth in interface FunnelChartModel<FunnelChart>

Parameters:

baseWidth - the base width

getLabelPosition

public LabelPosition getLabelPosition()

Specified by:

getLabelPosition in interface FunnelChartModel<FunnelChart>

Returns:

label position

setLabelPosition

public FunnelChart setLabelPosition(LabelPosition labelPosition)

Description copied from interface: FunnelChartModel

Specifies where labels should be placed. Allowed values are left, center, right. If you set left or right, you should increase left or right margin in order labels to be visible.

Specified by:

setLabelPosition in interface FunnelChartModel<FunnelChart>

Parameters:

labelPosition - the label position

getLabelText

public java.lang.String getLabelText()

Specified by:

getLabelText in interface FunnelChartModel<FunnelChart>

Returns:

label text

setLabelText

public FunnelChart setLabelText(java.lang.String labelText)

Description copied from interface: FunnelChartModel

Sets label text. The following tags can be used: [[value]], [[title]], [[percents]], [[description]]. Also can be used fields in the chart such as titleField, valueField etc. Fields that not used in the chart can be added by using additionalFields.

Specified by:

setLabelText in interface FunnelChartModel<FunnelChart>

Parameters:

labelText - label text string

getNeckHeight

public java.lang.String getNeckHeight()

Specified by:

getNeckHeight in interface FunnelChartModel<FunnelChart>

Returns:

height of a funnel neck

setNeckHeight

public FunnelChart setNeckHeight(java.lang.String neckHeight)

Description copied from interface: FunnelChartModel

Sets height of a funnel neck. If default value, zero is used, the funnel won't have neck at all, which will make it look like pyramid.

Specified by:

setNeckHeight in interface FunnelChartModel<FunnelChart>

Parameters:

neckHeight - the neck height

getNeckWidth

public java.lang.String getNeckWidth()

Specified by:

getNeckWidth in interface FunnelChartModel<FunnelChart>

Returns:

width of a funnel neck

setNeckWidth

public FunnelChart setNeckWidth(java.lang.String neckWidth)

Description copied from interface: FunnelChartModel

Sets width of a funnel neck. If default value, zero is used, the funnel won't have neck at all, which will make it look like pyramid.

Specified by:

setNeckWidth in interface FunnelChartModel<FunnelChart>

Parameters:

neckWidth - the neck width

getPullDistance

public java.lang.String getPullDistance()

Specified by:

getPullDistance in interface FunnelChartModel<FunnelChart>

Returns:

pull distance

setPullDistance

public FunnelChart setPullDistance(java.lang.String pullDistance)

Description copied from interface: FunnelChartModel

Sets the distance by which slice should be pulled when user clicks on it.

Specified by:

setPullDistance in interface FunnelChartModel<FunnelChart>

Parameters:

pullDistance - the pull distance

getStartX

public java.lang.Integer getStartX()

Specified by:

getStartX in interface FunnelChartModel<FunnelChart>

Returns:

initial X coordinate of slices

setStartX

public FunnelChart setStartX(java.lang.Integer startX)

Description copied from interface: FunnelChartModel

Sets initial X coordinate of slices. They will animate to the final X position from this one.

Specified by:

setStartX in interface FunnelChartModel<FunnelChart>

Parameters:

startX - the start X

getStartY

public java.lang.Integer getStartY()

Specified by:

getStartY in interface FunnelChartModel<FunnelChart>

Returns:

initial Y coordinate of slices

setStartY

public FunnelChart setStartY(java.lang.Integer startY)

Description copied from interface: FunnelChartModel

Sets initial y coordinate of slices. They will animate to the final y position from this one.

Specified by:

setStartY in interface FunnelChartModel<FunnelChart>

Parameters:

startY - the start Y

getValueRepresents

public FunnelValueRepresentation getValueRepresents()

Specified by:

getValueRepresents in interface FunnelChartModel<FunnelChart>

Returns:

value represents

setValueRepresents

public FunnelChart setValueRepresents(FunnelValueRepresentation valueRepresents)

Description copied from interface: FunnelChartModel

Sets the value represents. By default, the height of a slice represents it's value. Set this property to "area" if you want the area of a slice to represent value.

Specified by:

setValueRepresents in interface FunnelChartModel<FunnelChart>

Parameters:

valueRepresents - the value represents

getRotate

public java.lang.Boolean getRotate()

Specified by:

getRotate in interface FunnelChartModel<FunnelChart>

Returns:

true if rotate is enabled

setRotate

public FunnelChart setRotate(java.lang.Boolean rotate)

Description copied from interface: FunnelChartModel

If rotate is set to true, the funnel will be rotated and will became a pyramid.

Specified by:

setRotate in interface FunnelChartModel<FunnelChart>

Parameters:

rotate - rotate option

getAngle

public java.lang.Integer getAngle()

Specified by:

getAngle in interface FunnelChartModel<FunnelChart>

Returns:

the angle of the 3D part of the chart

setAngle

public FunnelChart setAngle(java.lang.Integer angle)

Description copied from interface: FunnelChartModel

Sets the angle of the 3D part of the chart. This creates a 3D effect (if the depth3D is greater than 0).

Specified by:

setAngle in interface FunnelChartModel<FunnelChart>

Parameters:

angle - the angle

getDepth3D

public java.lang.Integer getDepth3D()

Specified by:

getDepth3D in interface FunnelChartModel<FunnelChart>

Returns:

the depth of funnel/pyramid

setDepth3D

public FunnelChart setDepth3D(java.lang.Integer depth3D)

Description copied from interface: FunnelChartModel

Sets the depth of funnel/pyramid. Set angle to greater than 0 value in order this to work. Note, neckHeight/neckWidth will become 0 if you set these properties to bigger than 0 values.

Specified by:

setDepth3D in interface FunnelChartModel<FunnelChart>

Parameters:

depth3D - the depth 3D