Callbacks in Flutter Funnel Chart (SfFunnelChart)

11 Apr 202221 minutes to read

The below Callbacks are for Funnel chart.

onLegendItemRender

Triggers when the legend item is rendering. Here, you can customize the legend’s text, and shape. The onLegendItemRender Callback contains the following arguments.

  • text - specifies the content of the legend.
  • pointIndex - specifies the current point index that is applicable for Funnel chart type alone.
  • seriesIndex - specifies the current series index.
  • legendIconType - specifies the shape of the legend.
  • color - to get and set the color of the legend icon.
@override
    Widget build(BuildContext context) {
    
      return Scaffold(
        body: Center(
          child: SfFunnelChart(
            legend: Legend(isVisible: true),
            onLegendItemRender: (LegendRenderArgs args){
              args.text = 'Legend Text';
              args.legendIconType = LegendIconType.diamond;
            }
          )
        )
      );
    }

onTooltipRender

Triggers while tooltip is rendering. Here, you can customize the text, header, x and y-positions. The onTooltipRender Callback contains the following arguments.

  • text - specifies the content of the tooltip.
  • header - specifies the header content of the tooltip.
  • locationX - specifies the x position of tooltip.
  • locationY - specifies the y position of tooltip.
  • seriesIndex - specifies the current series index.
  • dataPoints - holds the data point collection.
  • pointIndex - specifies the current point index.
  • viewportPointIndex - to get the viewport index value of the tapped data label.
late TooltipBehavior _tooltipBehavior;

    @override
    void initState(){
        _tooltipBehavior = TooltipBehavior(enable: true);
      super.initState();
    }

    @override
    Widget build(BuildContext context) {
    
      return Scaffold(
        body: Center(
          child: SfFunnelChart(
            onTooltipRender: (TooltipArgs args){
              args.text = 'Custom Text';
            },
            tooltipBehavior: _tooltipBehavior,
          )
        )
      );
    }

onDataLabelRender

Triggers when data label is rendering. Text and text styles such as color, font size, and font weight can be customized. The onDataLabelRender Callback contains the following arguments.

  • text - specifies the content of the data label.
  • textStyle - used to change the text color, size, font family, font style, and font weight.
  • pointIndex - specifies the current point index.
  • seriesRenderer - specifies current series.
  • viewportPointIndex - to get the viewport index value of the tapped data label.
@override
    Widget build(BuildContext context) {
    
      return Scaffold(
        body: Center(
          child: SfFunnelChart(
            onDataLabelRender:(DataLabelRenderArgs args){
              args.text = 'Data label';
            },
            series: FunnelSeries<ChartData, String>(
              dataLabelSettings: DataLabelSettings(
                  isVisible: true
              )
            )
          )
        )
      );
    }

onLegendTapped

Triggers when tapping the legend item. The onLegendTapped Callback contains the following arguments.

  • seriesIndex - specifies the current series index.
  • pointIndex - specifies the current point index that is applicable for Funnel series.
  • series - specifies the current series.
@override
    Widget build(BuildContext context) {
    
      return Scaffold(
        body: Center(
          child: SfFunnelChart(
            onLegendTapped: (LegendTapArgs args) {
              print(args.seriesIndex);
            },
            legend: Legend(isVisible: true)
        )
      );
    }

onSelectionChanged

Triggers while selection changes. Here you can customize the selectedColor, unselectedColor, selectedBorderColor, selectedBorderWidth, unselectedBorderColor, and unselectedBorderWidth properties. The onSelectionChanged Callback contains the following arguments.

late SelectionBehavior _selectionBehavior;

    @override
    void initState(){
      _selectionBehavior = SelectionBehavior(
               enable: true);              
      super.initState();
    }

    @override
    Widget build(BuildContext context) {
    
      return Scaffold(
        body: Center(
          child: SfFunnelChart(
          onSelectionChanged: (SelectionArgs args){
              args.selectedColor = Colors.red;
              args.unselectedColor = Colors.lightGreen;
            },
            series: FunnelSeries<ChartData, String>(
                selectionBehavior: _selectionBehavior
            )
          )
        )
      );
    }

onDataLabelTapped

Triggers when tapping on the data label of the data point in the series. The onDataLabelTapped Callback contains the following arguments.

  • position - specifies the position of the tapped data label in logical pixels.
  • seriesIndex - Specifies the series index of the tapped data label
  • pointIndex - Specifies the point index of the tapped data label.
  • text - Specifies the content of the tapped data label.
  • dataLabelSettings - to get the data label customization options specified in that particular series.
  • viewportPointIndex - to get the viewport index value of the tapped data label.

Note: This callback will not be called, when the builder is specified for data label (data label template). For this case, custom widget specified in the DataLabelSettings.builder property can be wrapped using the GestureDetector and this functionality can be achieved in the application level.

Widget build(BuildContext context) {
      return Container(
        child: SfFunnelChart(
          onDatalabelTapped: (DataLabelTapArgs args) {
            print(args.seriesIndex);                 
          },
          series: FunnelSeries<Sample, DateTime>(
              dataSource: sample,
              xValueMapper: (Sample data, _) => data.x,
              yValueMapper: (Sample data, _) => data.y,
              dataLabelSettings: DataLabelSettings(
                isVisible: true),
          )
        )
      );
    }

onPointTap

Triggers when tapping on the series point. The onPointTap callback contains the following arguments.

@override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: SfFunnelChart(
            series: FunnelSeries<Sample, DateTime>(
                onPointTap: (ChartPointDetails details) {
                  print(details.pointIndex);
                  print(details.seriesIndex);
                }
              )
          )
        )
      );
    }

onPointDoubleTap

Triggers when double-tap the series point. The onPointDoubleTap callback contains the following arguments.

@override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: SfFunnelChart(
              series: FunnelSeries<Sample, DateTime>(
                onPointDoubleTap: (ChartPointDetails details) {
                  print(details.pointIndex);
                  print(details.seriesIndex);
                }
              )
          )
        )
      );
    }

onPointLongPress

Triggers when long press on the series point. The onPointLongPress callback contains the following arguments.

@override
    Widget build(BuildContext context) {
      return Scaffold(
        body: Center(
          child: SfFunnelChart(
              series: FunnelSeries<Sample, DateTime>(
                onPointLongPress: (ChartPointDetails details) {
                  print(details.pointIndex);
                  print(details.seriesIndex);
                }
              )
          )
        )
      );
    }

onChartTouchInteractionUp

Triggers when tapped or clicked on the chart area. You can get the tapped region using the position argument.

@override
    Widget build(BuildContext context) {
      return Container(
            child: SfFunnelChart(
                onChartTouchInteractionUp: (ChartTouchInteractionArgs args){
                  print(args.position.dx.toString());
                  print(args.position.dy.toString());
                }
            )
        );
    }

onChartTouchInteractionMove

Triggers when touched or clicked and moved on the chart area. You can get the tapped region using the position argument.

@override
    Widget build(BuildContext context) {
        return Container(
            child: SfFunnelChart(
                onChartTouchInteractionMove: (ChartTouchInteractionArgs args){
                  print(args.position.dx.toString());
                  print(args.position.dy.toString());
                }
            )
        );
    }

onChartTouchInteractionDown

Triggers when touched or clicked on the chart area. You can get the tapped region using the position argument.

@override
    Widget build(BuildContext context) {
        return Container(
          child: SfFunnelChart(
                onChartTouchInteractionDown: (ChartTouchInteractionArgs args){
                  print(args.position.dx.toString());
                  print(args.position.dy.toString());
                }
            )
        );
    }

onRendererCreated

Triggers when the series renderer is created. This callback can be used to obtain the FunnelSeriesController instance, which is used to access the the public methods in the series.

//Initialize the series controller
    FunnelSeriesController? funnelSeriesController;
    
    final List<ChartData> chartData = <ChartData>[
      ChartData(1, 24),
      ChartData(2, 20),
      ChartData(3, 23),
      ChartData(4, 57),
      ChartData(5, 30),
      ChartData(6, 41),
    ];

    return Column(children: <Widget>[
      Container(
          child: SfFunnelChart(
        series: FunnelSeries<ChartData, dynamic>(
          dataSource: chartData,
          xValueMapper: (ChartData data, _) => data.x,
          yValueMapper: (ChartData data, _) => data.y,
          onRendererCreated: (FunnelSeriesController controller) {
            funnelSeriesController = controller;
          },
        ),
      )),
      Container(
          child: ElevatedButton(
              onPressed: () {
                //Removed a point from data source
                chartData.removeAt(0);
                //Added a point to the data source
                chartData.add(ChartData(3, 23));
                //Here accessed the public method of the series.
                funnelSeriesController!.updateDataSource(
                  addedDataIndexes: <int>[chartData.length - 1],
                  removedDataIndexes: <int>[0],
                );
              },
              child: Container(
                child: Text('Add a point'),
                )
              )
            )
          ]
        );
      }
    }

    class ChartData {
      ChartData(this.x, this.y);
      final num x;
      final double? y;
    }