Class FunnelSeries
java.lang.Object
io.jmix.chartsflowui.kit.component.model.ChartObservableObject
io.jmix.chartsflowui.kit.component.model.series.AbstractSeries<T>
io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries<FunnelSeries>
io.jmix.chartsflowui.kit.component.model.series.FunnelSeries
- All Implemented Interfaces:
HasPosition<FunnelSeries>
,Serializable
public class FunnelSeries
extends AbstractAxisAwareSeries<FunnelSeries>
implements HasPosition<FunnelSeries>
A funnel chart is a graphical representation that resembles the shape of a funnel where each segment
gets progressively narrower. The segments are arranged vertically to showcase a hierarchy.
More detailed information is provided in the documentation.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Base component for funnel elements.static class
Component to configure the blur state.static class
Component to configure the emphasis state.static class
The visual guideline style of label.static class
Component to configure the selection state.static enum
Data sorting type.Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries
AbstractAxisAwareSeries.SeriesLayoutType
Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractSeries
AbstractSeries.LabelLayout, AbstractSeries.Tooltip
Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
ChartObservableObject.ObjectChangeEvent
-
Field Summary
Modifier and TypeFieldDescriptionprotected Boolean
protected Integer
protected Integer
protected String
protected Integer
protected FunnelSeries.Blur
protected String
protected FunnelSeries.Emphasis
protected Align
protected Integer
protected String
protected ItemStyle
protected FunnelSeries.LabelLine
protected String
protected Integer
protected String
protected Integer
protected String
protected Orientation
protected String
protected FunnelSeries.Select
protected FunnelSeries.SortType
protected JsFunction
protected String
protected String
Fields inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries
datasetIndex, encode, legendHoverLink, markArea, markLine, markPoint, seriesLayoutBy
Fields inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractSeries
animationDelay, animationDuration, animationEasing, colorBy, dataGroupId, id, label, labelLayout, name, selectedMode, silent, tooltip, type, z, zLevel
Fields inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
children, dirty, listener
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetBlur()
getGap()
getLeft()
getMax()
getMin()
getRight()
getSort()
getTop()
getWidth()
void
setAnimation
(Boolean animation) void
setAnimationDelayUpdate
(Integer animationDelayUpdate) void
setAnimationDurationUpdate
(Integer animationDurationUpdate) void
setAnimationEasingUpdate
(String animationEasingUpdate) void
setAnimationThreshold
(Integer animationThreshold) void
setBlur
(FunnelSeries.Blur blur) void
Sets a distance between component and the bottom side of the container.
Possible values are: A pixel value like"20"
.void
setEmphasis
(FunnelSeries.Emphasis emphasis) void
setFunnelAlign
(Align funnelAlign) void
void
void
setItemStyle
(ItemStyle itemStyle) void
setLabelLine
(FunnelSeries.LabelLine labelLine) void
Sets a distance between component and the left side of the container.
Possible values are: A pixel value like"20"
.void
void
setMaxSize
(String maxSize) void
void
setMinSize
(String minSize) void
setOrientation
(Orientation orientation) void
Sets a distance between component and the right side of the container.
Possible values are: A pixel value like"20"
.void
setSelect
(FunnelSeries.Select select) void
setSort
(FunnelSeries.SortType sort) void
setSortFunction
(JsFunction sortFunction) void
setSortFunction
(String sortFunction) void
Sets a distance between component and the top side of the container.
Possible values are: A pixel value like"20"
.void
withAnimation
(Boolean animation) withAnimationDelayUpdate
(Integer animationDelayUpdate) withAnimationDurationUpdate
(Integer animationDurationUpdate) withAnimationEasingUpdate
(String animationEasingUpdate) withAnimationThreshold
(Integer animationThreshold) withBlur
(FunnelSeries.Blur blur) withEmphasis
(FunnelSeries.Emphasis emphasis) withFunnelAlign
(Align funnelAlign) withHeight
(String height) withItemStyle
(ItemStyle itemStyle) withLabelLine
(FunnelSeries.LabelLine labelLine) withMaxSize
(String maxSize) withMinSize
(String minSize) withOrientation
(Orientation orientation) withSelect
(FunnelSeries.Select select) withSortFunction
(JsFunction sortFunction) withSortFunction
(String sortFunction) Methods inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries
getDatasetIndex, getEncode, getLegendHoverLink, getMarkArea, getMarkLine, getMarkPoint, getSeriesLayoutBy, setDatasetIndex, setEncode, setLegendHoverLink, setMarkArea, setMarkLine, setMarkPoint, setSeriesLayoutBy, withDatasetIndex, withEncode, withLegendHoverLink, withMarkArea, withMarkLine, withMarkPoint, withSeriesLayoutBy
Methods inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractSeries
getAnimationDelay, getAnimationDuration, getAnimationEasing, getColorBy, getDataGroupId, getId, getLabel, getLabelLayout, getName, getSelectedMode, getSilent, getTooltip, getType, getZ, getZLevel, setAnimationDelay, setAnimationDuration, setAnimationEasing, setColorBy, setDataGroupId, setId, setLabel, setLabelLayout, setName, setSelectedMode, setSilent, setTooltip, setType, setZ, setZLevel, withAnimationDelay, withAnimationDuration, withAnimationEasing, withColorBy, withDataGroupId, withId, withLabel, withLabelLayout, withName, withSelectedMode, withSilent, withTooltip, withType, withZ, withZLevel
Methods inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
addChild, fireChangeEvent, getChildren, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setChartObjectChangeListener, unmarkDirtyInDepth
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasPosition
withBottom, withLeft, withRight, withTop
-
Field Details
-
max
-
min
-
minSize
-
maxSize
-
orientation
-
sort
-
sortFunction
-
gap
-
funnelAlign
-
labelLine
-
itemStyle
-
emphasis
-
blur
-
select
-
left
-
top
-
right
-
bottom
-
width
-
height
-
animation
-
animationThreshold
-
animationDurationUpdate
-
animationEasingUpdate
-
animationDelayUpdate
-
-
Constructor Details
-
FunnelSeries
public FunnelSeries()
-
-
Method Details
-
getMax
-
setMax
-
getMin
-
setMin
-
getMinSize
-
setMinSize
-
getMaxSize
-
setMaxSize
-
getOrientation
-
getSort
-
setSort
-
getSortFunction
-
setSortFunction
-
getGap
-
setGap
-
getFunnelAlign
-
getItemStyle
-
getLabelLine
-
setLabelLine
-
getEmphasis
-
setEmphasis
-
getBlur
-
setBlur
-
getSelect
-
setSelect
-
getLeft
- Specified by:
getLeft
in interfaceHasPosition<FunnelSeries>
- Returns:
- distance between component and the left side of the container
-
setLeft
Description copied from interface:HasPosition
Sets a distance between component and the left side of the container.
Possible values are:-
A pixel value like
"20"
. -
Percentage value relative to container width like
"20%"
. -
Predefined values like
"left"
,"center"
,"right"
.
- Specified by:
setLeft
in interfaceHasPosition<FunnelSeries>
- Parameters:
left
- distance to set
-
A pixel value like
-
getTop
- Specified by:
getTop
in interfaceHasPosition<FunnelSeries>
- Returns:
- distance between component and the top side of the container
-
setTop
Description copied from interface:HasPosition
Sets a distance between component and the top side of the container.
Possible values are:-
A pixel value like
"20"
. -
Percentage value relative to container width like
"20%"
. -
Predefined values like
"top"
,"middle"
,"bottom"
.
- Specified by:
setTop
in interfaceHasPosition<FunnelSeries>
- Parameters:
top
- distance to set
-
A pixel value like
-
getRight
- Specified by:
getRight
in interfaceHasPosition<FunnelSeries>
- Returns:
- distance between component and the right side of the container
-
setRight
Description copied from interface:HasPosition
Sets a distance between component and the right side of the container.
Possible values are:-
A pixel value like
"20"
. -
Percentage value relative to container width like
"20%"
.
- Specified by:
setRight
in interfaceHasPosition<FunnelSeries>
- Parameters:
right
- distance to set
-
A pixel value like
-
getBottom
- Specified by:
getBottom
in interfaceHasPosition<FunnelSeries>
- Returns:
- distance between component and the bottom side of the container
-
setBottom
Description copied from interface:HasPosition
Sets a distance between component and the bottom side of the container.
Possible values are:-
A pixel value like
"20"
. -
Percentage value relative to container width like
"20%"
.
- Specified by:
setBottom
in interfaceHasPosition<FunnelSeries>
- Parameters:
bottom
- distance to set
-
A pixel value like
-
getWidth
-
setWidth
-
getHeight
-
setHeight
-
getAnimation
-
setAnimation
-
getAnimationThreshold
-
setAnimationThreshold
-
getAnimationDurationUpdate
-
setAnimationDurationUpdate
-
getAnimationEasingUpdate
-
setAnimationEasingUpdate
-
getAnimationDelayUpdate
-
setAnimationDelayUpdate
-
withMax
-
withMin
-
withMinSize
-
withMaxSize
-
withSort
-
withSortFunction
-
withGap
-
withLabelLine
-
withEmphasis
-
withBlur
-
withSelect
-
withWidth
-
withHeight
-
withAnimation
-
withAnimationThreshold
-
withAnimationDurationUpdate
-
withAnimationEasingUpdate
-
withAnimationDelayUpdate
-