Package io.jmix.charts.model.chart.impl

Class FunnelChartModelImpl

java.lang.Object

io.jmix.charts.model.AbstractChartObject

io.jmix.charts.model.chart.impl.ChartModelImpl

io.jmix.charts.model.chart.impl.AbstractChart<T>

io.jmix.charts.model.chart.impl.SlicedChartModelImpl<FunnelChartModelImpl>

io.jmix.charts.model.chart.impl.FunnelChartModelImpl

All Implemented Interfaces:

HasStartEffect<FunnelChartModelImpl>, ChartModel<FunnelChartModelImpl>, FunnelChartModel<FunnelChartModelImpl>, SlicedChartModel<FunnelChartModelImpl>, HasColors<FunnelChartModelImpl>, HasMargins<FunnelChartModelImpl>, Serializable

public class FunnelChartModelImpl
extends SlicedChartModelImpl<FunnelChartModelImpl>
implements FunnelChartModel<FunnelChartModelImpl>

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 io.jmix.charts.model.chart.impl.AbstractChart

AbstractChart.DataProviderChangeListener

Constructor Summary

Constructors

Constructor	Description
FunnelChartModelImpl()

Method Summary

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

Methods inherited from class io.jmix.charts.model.chart.impl.SlicedChartModelImpl

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 io.jmix.charts.model.chart.impl.AbstractChart

addAdditionalFields, addData, addDataProviderChangeListener, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, fireDataProviderChanged, getAccessible, getAccessibleDescription, 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, setAccessibleDescription, 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

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

Methods inherited from interface io.jmix.charts.model.chart.ChartModel

addAdditionalFields, addData, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, getAccessible, getAccessibleDescription, 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, setAccessibleDescription, 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 io.jmix.charts.model.HasColors

addColors, getColors, setColors

Methods inherited from interface io.jmix.charts.model.HasMargins

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

Methods inherited from interface io.jmix.charts.model.animation.HasStartEffect

getStartDuration, getStartEffect, setStartDuration, setStartEffect

Methods inherited from interface io.jmix.charts.model.chart.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

Constructor Details

FunnelChartModelImpl

public FunnelChartModelImpl()

Method Details

getBalloonText

public String getBalloonText()

Specified by:

getBalloonText in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

balloon text

setBalloonText

public FunnelChartModelImpl setBalloonText(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. If not set the default value is "[[title]]:[[value]]\n[[description]]".

Specified by:

setBalloonText in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

balloonText - balloon text string

Returns:

funnel chart model

getBaseWidth

public String getBaseWidth()

Specified by:

getBaseWidth in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

width of a base (first slice) of a chart

setBaseWidth

public FunnelChartModelImpl setBaseWidth(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. If not set the default value is 100%.

Specified by:

setBaseWidth in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

baseWidth - the base width

Returns:

funnel chart model

getLabelPosition

public LabelPosition getLabelPosition()

Specified by:

getLabelPosition in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

label position

setLabelPosition

public FunnelChartModelImpl 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. If not set the default value is CENTER.

Specified by:

setLabelPosition in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

labelPosition - the label position

Returns:

funnel chart model

getLabelText

public String getLabelText()

Specified by:

getLabelText in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

label text

setLabelText

public FunnelChartModelImpl setLabelText(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. If not set the default value is "[[title]]: [[value]]".

Specified by:

setLabelText in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

labelText - label text string

Returns:

funnel chart model

getNeckHeight

public String getNeckHeight()

Specified by:

getNeckHeight in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

height of a funnel neck

setNeckHeight

public FunnelChartModelImpl setNeckHeight(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. If not set the default value is "0".

Specified by:

setNeckHeight in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

neckHeight - the neck height

Returns:

funnel chart model

getNeckWidth

public String getNeckWidth()

Specified by:

getNeckWidth in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

width of a funnel neck

setNeckWidth

public FunnelChartModelImpl setNeckWidth(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. If not set the default value is "0".

Specified by:

setNeckWidth in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

neckWidth - the neck width

Returns:

funnel chart model

getPullDistance

public String getPullDistance()

Specified by:

getPullDistance in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

pull distance

setPullDistance

public FunnelChartModelImpl setPullDistance(String pullDistance)

Description copied from interface: FunnelChartModel

Sets the distance by which slice should be pulled when user clicks on it. If not set the default value is 30.

Specified by:

setPullDistance in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

pullDistance - the pull distance

Returns:

funnel chart model

getStartX

public Integer getStartX()

Specified by:

getStartX in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

initial X coordinate of slices

setStartX

public FunnelChartModelImpl setStartX(Integer startX)

Description copied from interface: FunnelChartModel

Sets initial X coordinate of slices. They will animate to the final X position from this one. If not set the default value is 0.

Specified by:

setStartX in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

startX - the start X

Returns:

funnel chart model

getStartY

public Integer getStartY()

Specified by:

getStartY in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

initial Y coordinate of slices

setStartY

public FunnelChartModelImpl setStartY(Integer startY)

Description copied from interface: FunnelChartModel

Sets initial y coordinate of slices. They will animate to the final y position from this one. If not set the default value is 0.

Specified by:

setStartY in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

startY - the start Y

Returns:

funnel chart model

getValueRepresents

public FunnelValueRepresentation getValueRepresents()

Specified by:

getValueRepresents in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

value represents

setValueRepresents

public FunnelChartModelImpl 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. If not set the default value is HEIGHT.

Specified by:

setValueRepresents in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

valueRepresents - the value represents

Returns:

funnel chart model

getRotate

public Boolean getRotate()

Specified by:

getRotate in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

true if rotate is enabled

setRotate

public FunnelChartModelImpl setRotate(Boolean rotate)

Description copied from interface: FunnelChartModel

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

Specified by:

setRotate in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

rotate - rotate option

Returns:

funnel chart model

getAngle

public Integer getAngle()

Specified by:

getAngle in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

the angle of the 3D part of the chart

setAngle

public FunnelChartModelImpl setAngle(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). If not set the default value is 0.

Specified by:

setAngle in interface FunnelChartModel<FunnelChartModelImpl>

Parameters:

angle - the angle

Returns:

funnel chart model

getDepth3D

public Integer getDepth3D()

Specified by:

getDepth3D in interface FunnelChartModel<FunnelChartModelImpl>

Returns:

the depth of funnel/pyramid

setDepth3D

public FunnelChartModelImpl setDepth3D(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<FunnelChartModelImpl>

Parameters:

depth3D - the depth 3D

Returns:

funnel chart model