FunnelSeries<T, D> class Null safety

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.



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.


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.
final, inherited
animationDuration double
Duration for animating the data points.
final, inherited
borderColor Color
Border color of the data points in the series.
final, inherited
borderWidth double
Border width of the data points in the series.
final, inherited
dataLabelMapper ChartIndexedValueMapper<String>?
Field in the data source, which is considered as text for the data points.
final, inherited
dataLabelSettings DataLabelSettings
Customizes the data labels in a series. Data label is a text, which displays the details about the data point.
final, inherited
dataSource List<T>?
A collection of data required for rendering the series.
final, inherited
emptyPointSettings EmptyPointSettings
Customizes the empty data points in the series.
final, inherited
enableTooltip bool
Enables or disables the tooltip for this series. Tooltip will display more details about data points when tapping the data point region.
final, inherited
explode bool
Enables or disables the explode of slices on tap.
final, inherited
explodeGesture ActivationMode
Gesture for activating the explode.
final, inherited
explodeIndex num?
Index of the slice to explode it at the initial rendering.
final, inherited
explodeOffset String
Offset of exploded slice.
final, inherited
gapRatio double
Gap ratio between the segments of funnel.
final, inherited
hashCode int
The hash code for this object.
read-only, override
height String
Height of the series.
final, inherited
initialSelectedDataIndexes List<int>
List of data indexes initially selected.
read / write, inherited
isVisible bool?
Visibility of the series.
final, inherited
key ValueKey<String>?
Key to identify a series in a collection.
final, inherited
legendIconType LegendIconType
Shape of the legend icon.
final, inherited
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.
final, inherited
name String?
Name of the series.
final, inherited
neckHeight String
Neck height of funnel.
final, inherited
neckWidth String
Neck width of funnel.
final, inherited
onCreateRenderer ChartSeriesRendererFactory<T, D>?
Used to create the renderer for custom series.
final, inherited
onPointDoubleTap ChartPointInteractionCallback?
Called when double tapped on the chart data point.
final, inherited
onPointLongPress ChartPointInteractionCallback?
Called when long pressed on the chart data point.
final, inherited
onPointTap ChartPointInteractionCallback?
Called when tapped on the chart data point.
final, inherited
onRendererCreated FunnelSeriesRendererCreatedCallback?
Triggers when the series renderer is created.
final, inherited
opacity double
Opacity of the series.
final, inherited
pointColorMapper ChartIndexedValueMapper<Color>?
Maps the field name, which will be considered as data point color.
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
selectionBehavior SelectionBehavior
Customizes the selection of series.
final, inherited
sortFieldValueMapper ChartIndexedValueMapper?
Field in the data source, which is considered for sorting the data points.
final, inherited
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.
final, inherited
textFieldMapper ChartIndexedValueMapper<String>?
Maps the field name, which will be considered as a text.
final, inherited
width String
Width of the series.
final, inherited
xValueMapper ChartIndexedValueMapper<D>?
Maps the field name, which will be considered as x-values.
final, inherited
yValueMapper ChartIndexedValueMapper<num>?
Maps the field name, which will be considered as y-values.
final, inherited


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


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