io.jmix.charts.model.chart

Interface FunnelChartModel<T extends FunnelChartModel>

All Superinterfaces:

ChartModel<T>, HasColors<T>, HasMargins<T>, HasStartEffect<T>, SlicedChartModel<T>

All Known Subinterfaces:

FunnelChart

All Known Implementing Classes:

FunnelChartImpl, FunnelChartModelImpl

public interface FunnelChartModel<T extends FunnelChartModel>
extends SlicedChartModel<T>

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()
T	setAngle(java.lang.Integer angle) Sets the angle of the 3D part of the chart.
T	setBalloonText(java.lang.String balloonText) Sets balloon text.
T	setBaseWidth(java.lang.String baseWidth) Sets width of a base (first slice) of a chart.
T	setDepth3D(java.lang.Integer depth3D) Sets the depth of funnel/pyramid.
T	setLabelPosition(LabelPosition labelPosition) Specifies where labels should be placed.
T	setLabelText(java.lang.String labelText) Sets label text.
T	setNeckHeight(java.lang.String neckHeight) Sets height of a funnel neck.
T	setNeckWidth(java.lang.String neckWidth) Sets width of a funnel neck.
T	setPullDistance(java.lang.String pullDistance) Sets the distance by which slice should be pulled when user clicks on it.
T	setRotate(java.lang.Boolean rotate) If rotate is set to true, the funnel will be rotated and will became a pyramid.
T	setStartX(java.lang.Integer startX) Sets initial X coordinate of slices.
T	setStartY(java.lang.Integer startY) Sets initial y coordinate of slices.
T	setValueRepresents(FunnelValueRepresentation valueRepresents) Sets the value represents.

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

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.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.HasColors

addColors, getColors, setColors

Method Detail

getBalloonText

java.lang.String getBalloonText()

Returns:

balloon text

setBalloonText

@StudioProperty(defaultValue="[[title]]:[[value]]\n[[description]]")
T setBalloonText(java.lang.String balloonText)

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]]".

Parameters:

balloonText - balloon text string

Returns:

funnel chart model

getBaseWidth

java.lang.String getBaseWidth()

Returns:

width of a base (first slice) of a chart

setBaseWidth

@StudioProperty(defaultValue="100%")
T setBaseWidth(java.lang.String baseWidth)

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%.

Parameters:

baseWidth - the base width

Returns:

funnel chart model

getLabelPosition

LabelPosition getLabelPosition()

Returns:

label position

setLabelPosition

@StudioProperty(type=ENUMERATION,
                defaultValue="CENTER")
T setLabelPosition(LabelPosition labelPosition)

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.

Parameters:

labelPosition - the label position

Returns:

funnel chart model

getLabelText

java.lang.String getLabelText()

Returns:

label text

setLabelText

@StudioProperty(defaultValue="[[title]]: [[value]]")
T setLabelText(java.lang.String labelText)

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]]".

Parameters:

labelText - label text string

Returns:

funnel chart model

getNeckHeight

java.lang.String getNeckHeight()

Returns:

height of a funnel neck

setNeckHeight

@StudioProperty(defaultValue="0")
T setNeckHeight(java.lang.String neckHeight)

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".

Parameters:

neckHeight - the neck height

Returns:

funnel chart model

getNeckWidth

java.lang.String getNeckWidth()

Returns:

width of a funnel neck

setNeckWidth

@StudioProperty(defaultValue="0")
T setNeckWidth(java.lang.String neckWidth)

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".

Parameters:

neckWidth - the neck width

Returns:

funnel chart model

getPullDistance

java.lang.String getPullDistance()

Returns:

pull distance

setPullDistance

@StudioProperty(defaultValue="30")
T setPullDistance(java.lang.String pullDistance)

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

Parameters:

pullDistance - the pull distance

Returns:

funnel chart model

getStartX

java.lang.Integer getStartX()

Returns:

initial X coordinate of slices

setStartX

@StudioProperty(defaultValue="0")
T setStartX(java.lang.Integer startX)

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.

Parameters:

startX - the start X

Returns:

funnel chart model

getStartY

java.lang.Integer getStartY()

Returns:

initial Y coordinate of slices

setStartY

@StudioProperty(defaultValue="0")
T setStartY(java.lang.Integer startY)

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.

Parameters:

startY - the start Y

Returns:

funnel chart model

getValueRepresents

FunnelValueRepresentation getValueRepresents()

Returns:

value represents

setValueRepresents

@StudioProperty(type=ENUMERATION,
                defaultValue="HEIGHT")
T setValueRepresents(FunnelValueRepresentation valueRepresents)

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.

Parameters:

valueRepresents - the value represents

Returns:

funnel chart model

getRotate

java.lang.Boolean getRotate()

Returns:

true if rotate is enabled

setRotate

@StudioProperty(defaultValue="false")
T setRotate(java.lang.Boolean rotate)

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

Parameters:

rotate - rotate option

Returns:

funnel chart model

getAngle

java.lang.Integer getAngle()

Returns:

the angle of the 3D part of the chart

setAngle

@StudioProperty(defaultValue="0")
T setAngle(java.lang.Integer angle)

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.

Parameters:

angle - the angle

Returns:

funnel chart model

getDepth3D

java.lang.Integer getDepth3D()

Returns:

the depth of funnel/pyramid

setDepth3D

@StudioProperty
T setDepth3D(java.lang.Integer depth3D)

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.

Parameters:

depth3D - the depth 3D

Returns:

funnel chart model