WaterfallAbsoluteValueOptions Class

Stores settings for a waterfall chart that is plotted based on absolute data source values.

Namespace: DevExpress.Xpf.Charts

Assembly: DevExpress.Xpf.Charts.v19.2.dll

Declaration

C#

public class WaterfallAbsoluteValueOptions :
    WaterfallValueOptionsBase

VB.NET

Public Class WaterfallAbsoluteValueOptions
    Inherits WaterfallValueOptionsBase

Remarks

Use the WaterfallAbsoluteValueOptions when the chart data source stores absolute values. In this case, the chart control automatically calculates differences between neighbor data point values and displays them as rising and falling bars.

Example

This example shows how to create a waterfall chart based on absolute values.

• Create a ChartControl and specify its ChartControl.Diagram property to a SimpleDiagram2D object. Note that the ChartControl.Diagram is a content property. You can declare a diagram in XAML directly after a chart control’s declaration without wrapping it in opening and closing ChartControl.Diagram tags.

• Add a WaterfallSeries2D object to the Diagram.Series collection. Note that the Diagram.Series is a content property. You can declare series in XAML directly after a diagram’s declaration without wrapping them in opening and closing Diagram.Series tags.

• Use the following properties to bind the series to data:

  • Series.DataSource - Specifies the series’s data source.
  • Series.ArgumentDataMember - Defines the data member that provides the series’s arguments.
  • Series.ValueDataMember - Specifies the data member that provides the series’s values.

• Use the WaterfallSeries2D.ValueOptions property to set value options. If data source stores value differences, use the WaterfallRelativeValueOptions. Use the WaterfallAbsoluteValueOptions class if the data source stores absolute data values.

Markup

XAML

<Window
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WatefallChart"
        xmlns:dxc="http://schemas.devexpress.com/winfx/2008/xaml/charts" x:Class="WatefallChart.MainWindow"
        mc:Ignorable="d"
        Title="MainWindow" Height="600" Width="800">
    <Grid>
        <dxc:ChartControl Height="315" Width="560">
            <dxc:ChartControl.Legends>
                <dxc:Legend Visible="False"/>
            </dxc:ChartControl.Legends>
            <dxc:XYDiagram2D>
                <dxc:WaterfallSeries2D.ValueOptions>
                    <dxc:WaterfallAbsoluteValueOptions ShowTotal="True"
                                                       TotalLabel="Total">
                        <dxc:WaterfallAbsoluteValueOptions.Subtotals>
                            <dxc:Subtotal PointIndex="2" Label="Subtotal"/>
                        </dxc:WaterfallAbsoluteValueOptions.Subtotals>
                    </dxc:WaterfallAbsoluteValueOptions>
                </dxc:WaterfallSeries2D.ValueOptions>
                <dxc:WaterfallSeries2D DisplayName="Waterfall" 
                                       DataSource="{Binding}"
                                       ArgumentScaleType="Qualitative"
                                       ArgumentDataMember="Argument"
                                       ValueDataMember="Value" 
                                       CrosshairLabelPattern="{}{VABS}">
                </dxc:WaterfallSeries2D>
            </dxc:XYDiagram2D>
        </dxc:ChartControl>
    </Grid>
</Window>

Code-behind:

C#

using System.Collections.Generic;
using System.Windows;

namespace WatefallChart {
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
            this.DataContext = DataLoader.GetDataPoints();
        }
    }
    class DataLoader {
        public static List<DataPoint> GetDataPoints() {
            List<DataPoint> list = new List<DataPoint> {
                new DataPoint("November", 20),
                new DataPoint("December", 10),
                new DataPoint("January", -15),
                new DataPoint("February", 10),
                new DataPoint("March", -10)
            };
            return list;
        }
    }
    public class DataPoint {
        public string Argument { get; private set; }
        public double Value { get; private set; }
        public DataPoint(string arg, double val) {
            Argument = arg;
            Value = val;
        }
    }
}

VB.NET

Imports System.Collections.Generic
Imports System.Windows
Namespace WatefallChart
    Public Partial Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            Me.DataContext = DataLoader.GetDataPoints()
        End Sub
    End Class
    Class DataLoader
        Public Shared Function GetDataPoints() As List(Of DataPoint)
            Dim list As List(Of DataPoint) = New List(Of DataPoint) From {
                New DataPoint("November", 20),
                New DataPoint("December", 10),
                New DataPoint("January", -15),
                New DataPoint("February", 10),
                New DataPoint("March", -10)
            }
            Return list
        End Function
    End Class
    Public Class DataPoint
        Public Property Argument As String
        Public Property Value As Double
        Public Sub New(ByVal arg As String, ByVal val As Double)
            Argument = arg
            Value = val
        End Sub
    End Class
End Namespace

Inheritance

Object

DispatcherObject

DependencyObject

Freezable

ChartDependencyObject

WaterfallValueOptionsBase

WaterfallAbsoluteValueOptions