FunnelSeries<T, D> class

Renders Funnel series.

The FunnelSeries is the SfFunnelChart Type series. To render a funnel chart, create an instance of FunnelSeries, and add it to the series property of SfFunnelChart.

Provides options to customize the opacity, borderWidth, borderColor and pointColorMapper of the funnel segments.

Inheritance
Implemented types

Constructors

FunnelSeries({ValueKey<String>? key, ChartSeriesRendererFactory<T, D>? onCreateRenderer, FunnelSeriesRendererCreatedCallback? onRendererCreated, ChartPointInteractionCallback? onPointTap, ChartPointInteractionCallback? onPointDoubleTap, ChartPointInteractionCallback? onPointLongPress, List<T>? dataSource, ChartValueMapper<T, D>? xValueMapper, ChartValueMapper<T, num>? yValueMapper, ChartValueMapper<T, Color>? pointColorMapper, ChartValueMapper<T, String>? textFieldMapper, String? name, String? neckWidth, String? neckHeight, String? height, String? width, double? gapRatio, LegendIconType? legendIconType, EmptyPointSettings? emptyPointSettings, DataLabelSettings? dataLabelSettings, double? animationDuration, double? animationDelay, double? opacity, Color? borderColor, double? borderWidth, bool? explode, ActivationMode? explodeGesture, String? explodeOffset, SelectionBehavior? selectionBehavior, num? explodeIndex, List<int>? initialSelectedDataIndexes})
Creating an argument constructor of FunnelSeries class.

Properties

animationDelay double
Delay duration of the series animation.It takes a millisecond value as input. By default, the series will get animated for the specified duration. If animationDelay is specified, then the series will begin to animate after the specified duration.
finalinherited
animationDuration double
Duration for animating the data points.
finalinherited
borderColor Color
Border color of the data points in the series.
finalinherited
borderWidth double
Border width of the data points in the series.
finalinherited
dataLabelMapper ChartIndexedValueMapper<String>?
Field in the data source, which is considered as text for the data points.
finalinherited
dataLabelSettings DataLabelSettings
Customizes the data labels in a series. Data label is a text, which displays the details about the data point.
finalinherited
dataSource List<T>?
A collection of data required for rendering the series.
finalinherited
emptyPointSettings EmptyPointSettings
Customizes the empty data points in the series.
finalinherited
enableTooltip bool
Enables or disables the tooltip for this series. Tooltip will display more details about data points when tapping the data point region.
finalinherited
explode bool
Enables or disables the explode of slices on tap.
finalinherited
explodeGesture ActivationMode
Gesture for activating the explode.
finalinherited
explodeIndex num?
Index of the slice to explode it at the initial rendering.
finalinherited
explodeOffset String
Offset of exploded slice.
finalinherited
gapRatio double
Gap ratio between the segments of funnel.
finalinherited
hashCode int
The hash code for this object.
no setteroverride
height String
Height of the series.
finalinherited
initialSelectedDataIndexes List<int>
List of data indexes initially selected.
getter/setter pairinherited
isVisible bool?
Visibility of the series.
finalinherited
key ValueKey<String>?
Key to identify a series in a collection.
finalinherited
legendIconType LegendIconType
Shape of the legend icon.
finalinherited
legendItemText String?
Text to be displayed in legend. By default, the series name will be displayed in the legend. You can change this by setting values to this property.
finalinherited
name String?
Name of the series.
finalinherited
neckHeight String
Neck height of funnel.
finalinherited
neckWidth String
Neck width of funnel.
finalinherited
onCreateRenderer ChartSeriesRendererFactory<T, D>?
Used to create the renderer for custom series.
finalinherited
onPointDoubleTap ChartPointInteractionCallback?
Called when double tapped on the chart data point.
finalinherited
onPointLongPress ChartPointInteractionCallback?
Called when long pressed on the chart data point.
finalinherited
onPointTap ChartPointInteractionCallback?
Called when tapped on the chart data point.
finalinherited
onRendererCreated FunnelSeriesRendererCreatedCallback?
Triggers when the series renderer is created.
finalinherited
opacity double
Opacity of the series.
finalinherited
pointColorMapper ChartIndexedValueMapper<Color>?
Maps the field name, which will be considered as data point color.
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
selectionBehavior SelectionBehavior
Customizes the selection of series.
finalinherited
sortFieldValueMapper ChartIndexedValueMapper?
Field in the data source, which is considered for sorting the data points.
finalinherited
sortingOrder SortingOrder?
The data points in the series can be sorted in ascending or descending order. The data points will be rendered in the specified order if it is set to none.
finalinherited
textFieldMapper ChartIndexedValueMapper<String>?
Maps the field name, which will be considered as a text.
finalinherited
width String
Width of the series.
finalinherited
xValueMapper ChartIndexedValueMapper<D>?
Maps the field name, which will be considered as x-values.
finalinherited
yValueMapper ChartIndexedValueMapper<num>?
Maps the field name, which will be considered as y-values.
finalinherited

Methods

calculateEmptyPointValue(int pointIndex, dynamic currentPoint, dynamic seriesRenderer) → void
To calculate empty point values if null values are provided.
inherited
createRenderer(FunnelSeries<T, D> series) FunnelSeriesRenderer
Create the funnel series renderer.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
override