Class WaterfallSeries

The WaterfallSeries shows that an initial value is affected by a series of intermediate positive or negative values, leading to a final value.

Inheritance

System.Object

ChartSeries

CartesianSeries

XYDataSeries

WaterfallSeries

Inherited Members

CartesianSeries.ActualXAxis

CartesianSeries.ActualYAxis

CartesianSeries.DataLabelSettings

CartesianSeries.DataLabelSettingsProperty

CartesianSeries.GetDataPoints(Double, Double, Double, Double)

CartesianSeries.GetDataPoints(Rect)

CartesianSeries.Label

CartesianSeries.LabelProperty

CartesianSeries.ShowTrackballLabel

CartesianSeries.ShowTrackballLabelProperty

CartesianSeries.TrackballLabelTemplate

CartesianSeries.TrackballLabelTemplateProperty

CartesianSeries.XAxisName

CartesianSeries.XAxisNameProperty

CartesianSeries.YAxisName

CartesianSeries.YAxisNameProperty

ChartSeries.CreateAnimation(Action<Double>)

ChartSeries.DrawDataLabel(ICanvas, Brush, String, PointF, Int32)

ChartSeries.DrawSeries(ICanvas, ReadOnlyObservableCollection<ChartSegment>, RectF)

ChartSeries.EnableAnimation

ChartSeries.EnableAnimationProperty

ChartSeries.EnableTooltip

ChartSeries.EnableTooltipProperty

ChartSeries.Fill

ChartSeries.FillProperty

ChartSeries.GetDataPointIndex(Single, Single)

ChartSeries.IsVisible

ChartSeries.IsVisibleOnLegend

ChartSeries.IsVisibleOnLegendProperty

ChartSeries.IsVisibleProperty

ChartSeries.ItemsSource

ChartSeries.ItemsSourceProperty

ChartSeries.LabelContext

ChartSeries.LabelContextProperty

ChartSeries.LabelTemplate

ChartSeries.LabelTemplateProperty

ChartSeries.LegendIcon

ChartSeries.LegendIconProperty

ChartSeries.Opacity

ChartSeries.OpacityProperty

ChartSeries.PaletteBrushes

ChartSeries.PaletteBrushesProperty

ChartSeries.SelectionBehavior

ChartSeries.SelectionBehaviorProperty

ChartSeries.ShowDataLabels

ChartSeries.ShowDataLabelsProperty

ChartSeries.TooltipTemplate

ChartSeries.TooltipTemplateProperty

ChartSeries.XBindingPath

ChartSeries.XBindingPathProperty

ChartSeries.XRange

ChartSeries.YRange

XYDataSeries.StrokeWidth

XYDataSeries.StrokeWidthProperty

XYDataSeries.YBindingPath

XYDataSeries.YBindingPathProperty

Namespace: Syncfusion.Maui.Toolkit.Charts

Assembly: Syncfusion.Maui.Toolkit.dll

Syntax

public class WaterfallSeries : XYDataSeries, IDatapointSelectionDependent, ITooltipDependent, IDataTemplateDependent, IDrawCustomLegendIcon

Remarks

To render a series, create an instance of WaterfallSeries class, and add it to the Series collection.

It provides options for Fill, PaletteBrushes, StrokeWidth, and Opacity to customize the appearance.

EnableTooltip - A tooltip displays information while tapping or mouse hovering above a segment. To display the tooltip on a chart, you need to set the EnableTooltip property as true in WaterfallSeries class, and also refer TooltipBehavior property.

Data Label - Data labels are used to display values related to a chart segment. To render the data labels, you need to set the ShowDataLabels property as true in WaterfallSeries class. To customize the chart data labels alignment, placement, and label styles, you need to create an instance of CartesianDataLabelSettings and set to the DataLabelSettings property.

Animation - To animate the series, set True to the EnableAnimation property.

Spacing - To specify the spacing between segments using the Spacing property.

Examples

    <chart:SfCartesianChart>

          <chart:SfCartesianChart.XAxes>
              <chart:CategoryAxis/>
          </chart:SfCartesianChart.XAxes>

          <chart:SfCartesianChart.YAxes>
              <chart:NumericalAxis/>
          </chart:SfCartesianChart.YAxes>

          <chart:SfCartesianChart.Series>
              <chart:WaterfallSeries
                  ItemsSource = "{Binding Sales}"
                  XBindingPath = "Department"
                  YBindingPath = "Value"/>
          </chart:SfCartesianChart.Series>  

    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();

    CategoryAxis xAxis = new CategoryAxis();
    NumericalAxis yAxis = new NumericalAxis();

    chart.XAxes.Add(xAxis);
    chart.YAxes.Add(yAxis);

    ViewModel viewModel = new ViewModel();

    WaterfallSeries series = new WaterfallSeries();
    series.ItemsSource = viewModel.Sales;
    series.XBindingPath = "Department";
    series.YBindingPath = "Value";
    chart.Series.Add(series);

    public ObservableCollection<Model> Sales { get; set; }

    public ViewModel()
    {
       Sales = new ObservableCollection<Model>();
       Sales.Add(new ChartDataModel() { Department = "Income", Value = 46 });
       Sales.Add(new ChartDataModel() { Department = "Sales", Value = -14 });
       Sales.Add(new ChartDataModel() { Department = "Research", Value = -9});
       Sales.Add(new ChartDataModel() { Department = "Revenue", Value = 15 });
       Sales.Add(new ChartDataModel() { Department = "Balance", Value = 38 , IsSummary= true });
       Sales.Add(new ChartDataModel() { Department = "Expense", Value = -13 });
       Sales.Add(new ChartDataModel() { Department = "Tax", Value = -8 });
       Sales.Add(new ChartDataModel() { Department = "Profit", Value =17,IsSummary=true });
    }

Constructors

WaterfallSeries()

Initializes a new instance of the WaterfallSeries class.

Declaration

public WaterfallSeries()

Fields

AllowAutoSumProperty

Identifies the AllowAutoSum bindable property.

Declaration

public static readonly BindableProperty AllowAutoSumProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The AllowAutoSum property determines whether the intermediate sum values in a series should be automatically calculated or not.

ConnectorLineStyleProperty

Identifies the ConnectorLineStyle bindable property.

Declaration

public static readonly BindableProperty ConnectorLineStyleProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The ConnectorLineStyle property defines the customization of the connector lines in the series.

NegativePointsBrushProperty

Identifies the NegativePointsBrush bindable property.

Declaration

public static readonly BindableProperty NegativePointsBrushProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The NegativePointsBrush property indicates the Negative segment's interior.

ShowConnectorProperty

Identifies the ShowConnectorLine bindable property.

Declaration

public static readonly BindableProperty ShowConnectorProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The ShowConnectorLine property indicates whether to enable the connector line between the segements or not.

SpacingProperty

Identifies the Spacing bindable property.

Declaration

public static readonly BindableProperty SpacingProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The Spacing property indicates spacing between the segments across the series in cluster mode.

SummaryBindingPathProperty

Identifies the SummaryBindingPath bindable property.

Declaration

public static readonly BindableProperty SummaryBindingPathProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The SummaryBindingPath property used to retrieve the sum of the previous segments.

SummaryPointsBrushProperty

Identifies the SummaryPointsBrush bindable property.

Declaration

public static readonly BindableProperty SummaryPointsBrushProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The SummaryPointsBrush property indicates the summary segment's interior.

WidthProperty

Identifies the Width bindable property.

Declaration

public static readonly BindableProperty WidthProperty

Field Value

Type
Microsoft.Maui.Controls.BindableProperty

Remarks

The Width property defines the width of each waterfall segment.

Properties

AllowAutoSum

Gets or sets a value that determines whether the intermediate sum values in a series should be automatically calculated or not.

Declaration

public bool AllowAutoSum { get; set; }

Property Value

Type	Description
System.Boolean	It accepts System.Boolean values, and its default value is true.

    <chart:SfCartesianChart>

    <!-- ... Eliminated for simplicity-->

          <chart:WaterfallSeries ItemsSource = "{Binding Sales}"   
                                 XBindingPath = "Department"   
                                 YBindingPath = "Value"
                                 AllowAutoSum = "False"/>
    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();
    ViewModel viewModel = new ViewModel();

    // Eliminated for simplicity

    WaterfallSeries series = new WaterfallSeries()
    {
          ItemsSource = viewModel.Sales,
          XBindingPath = "Department",
          YBindingPath = "Value",
          AllowAutoSum = "False",
    };

    chart.Series.Add(series);

ConnectorLineStyle

Gets or sets a style for connector lines, and it is often used to customize the appearance of connector lines for visual purposes.

Declaration

public ChartLineStyle ConnectorLineStyle { get; set; }

Property Value

Type	Description
ChartLineStyle	It accepts ChartLineStyle values.

Remarks

Null values are invalid.

Examples

Xaml
C#

    <chart:SfCartesianChart>

    <!-- ... Eliminated for simplicity-->

          <chart:WaterfallSeries ItemsSource = "{Binding Sales}"   
                                 XBindingPath = "Department"   
                                 YBindingPath = "Value"/>
              <chart:WaterfallSeries.ConnectorLineStyle>
                      <chart:ChartLineStyle Stroke = "Red" >
               </chart:WaterfallSeries.ConnectorLineStyle>
    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();
    ViewModel viewModel = new ViewModel();

    // Eliminated for simplicity

    WaterfallSeries series = new WaterfallSeries()
    {
          ItemsSource = viewModel.Sales,
          XBindingPath = "Department",
          YBindingPath = "Value",
    };
    series.ConnectorLineStyle = new ChartLineStyle()
    {
         Stroke = new SolidColorBrush(Colors.Red),
     }

    chart.Series.Add(series);

NegativePointsBrush

Gets or sets a brush value that indicates the Negative segment's interior.

Declaration

public Brush NegativePointsBrush { get; set; }

Property Value

Type	Description
Microsoft.Maui.Controls.Brush	It accepts Microsoft.Maui.Controls.Brush values.

Examples

Xaml
C#

    <chart:SfCartesianChart>

    <!-- ... Eliminated for simplicity-->

          <chart:WaterfallSeries ItemsSource = "{Binding Sales}"   
                                 XBindingPath = "Department"   
                                 YBindingPath = "Value"
                                 NegativePointsBrush = "Red"/>

    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();
    ViewModel viewModel = new ViewModel();

    // Eliminated for simplicity

    WaterfallSeries series = new WaterfallSeries()
    {
          ItemsSource = viewModel.Sales,
          XBindingPath = "Department",
          YBindingPath = "Value",
          NegativePointsBrush = Colors.Red,
    };

    chart.Series.Add(series);

ShowConnectorLine

Gets or sets a value indicating whether to enable the connector line between the segments or not.

Declaration

public bool ShowConnectorLine { get; set; }

Property Value

Type	Description
System.Boolean	It accepts System.Boolean values, and its default value is true.

Examples

Xaml
C#

    <chart:SfCartesianChart>

    <!-- ... Eliminated for simplicity-->

          <chart:WaterfallSeries ItemsSource = "{Binding Sales}"   
                                 XBindingPath = "Department"   
                                 YBindingPath = "Value"
                                 ShowConnectorLine = "False"/>      
    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();
    ViewModel viewModel = new ViewModel();

    // Eliminated for simplicity

    WaterfallSeries series = new WaterfallSeries()
    {
          ItemsSource = viewModel.Sales,
          XBindingPath = "Department",
          YBindingPath = "Value",
          ShowConnectorLine = "False",
    };

    chart.Series.Add(series);

Spacing

Gets or sets the spacing between the segments across the series in cluster mode.

Declaration

public double Spacing { get; set; }

Property Value

Type	Description
System.Double	It accepts System.Double values and its default value is 0d

Examples

Xaml
C#

    <chart:SfCartesianChart>

    <!-- ... Eliminated for simplicity-->

          <chart:WaterfallSeries ItemsSource = "{Binding Sales}"   
                                 XBindingPath = "Department"   
                                 YBindingPath = "Value"
                                 Spacing = "0.5"/>

    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();
    ViewModel viewModel = new ViewModel();

    // Eliminated for simplicity

    WaterfallSeries series = new WaterfallSeries()
    {
          ItemsSource = viewModel.Sales,
          XBindingPath = "Department",
          YBindingPath = "Value",
          Spacing = 0.5,
    };

    chart.Series.Add(series);

SummaryBindingPath

Gets or sets a string value that indicates the sum of previous segments.

Declaration

public string SummaryBindingPath { get; set; }

Property Value

Type	Description
System.String	It accepts System.String values, and its default value is `string.Empty`.

Examples

Xaml
C#

    <chart:SfCartesianChart>

    <!-- ... Eliminated for simplicity-->

          <chart:WaterfallSeries ItemsSource = "{Binding Sales}"   
                                 XBindingPath = "Department"   
                                 YBindingPath = "Value"
                                 SummaryBindingPath = "IsSummary"/>
    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();
    ViewModel viewModel = new ViewModel();

    // Eliminated for simplicity

    WaterfallSeries series = new WaterfallSeries()
    {
          ItemsSource = viewModel.Sales,
          XBindingPath = "Department",
          YBindingPath = "Value",
          SummaryBindingPath = "IsSummary",
    };

    chart.Series.Add(series);

SummaryPointsBrush

Gets or sets a brush value that indicates the summary segment's interior.

Declaration

public Brush SummaryPointsBrush { get; set; }

Property Value

Type	Description
Microsoft.Maui.Controls.Brush	It accepts Microsoft.Maui.Controls.Brush values.

Examples

Xaml
C#

    <chart:SfCartesianChart>

    <!-- ... Eliminated for simplicity-->

          <chart:WaterfallSeries ItemsSource = "{Binding Sales}"   
                                 XBindingPath = "Department"   
                                 YBindingPath = "Value"
                                 SummaryPointsBrush = "Blue"/>

    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();
    ViewModel viewModel = new ViewModel();

    // Eliminated for simplicity

    WaterfallSeries series = new WaterfallSeries()
    {
          ItemsSource = viewModel.Sales,
          XBindingPath = "Department",
          YBindingPath = "Value",
          SummaryPointsBrush = Colors.Blue,
    };

    chart.Series.Add(series);

Width

Gets or sets the width of each segment.

Declaration

public double Width { get; set; }

Property Value

Type	Description
System.Double	It accepts System.Double values between 0 to 1 and its default value is 0.8

Examples

Xaml
C#

    <chart:SfCartesianChart>

    <!-- ... Eliminated for simplicity-->

          <chart:WaterfallSeries ItemsSource = "{Binding Sales}"   
                                 XBindingPath = "Department"   
                                 YBindingPath = "Value"
                                 Width = "1"/>

    </chart:SfCartesianChart>

    SfCartesianChart chart = new SfCartesianChart();
    ViewModel viewModel = new ViewModel();

    // Eliminated for simplicity

    WaterfallSeries series = new WaterfallSeries()
    {
          ItemsSource = viewModel.Sales,
          XBindingPath = "Department",
          YBindingPath = "Value",
          Width = 1,
    };

    chart.Series.Add(series);

Methods

CreateSegment()

Creates and initializes a new chart segment for the chart.

Declaration

protected override ChartSegment CreateSegment()

Returns

Type
ChartSegment

Overrides

ChartSeries.CreateSegment()