All docs
V20.1
20.1
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

WaterfallRelativeValueOptions Class

Stores settings for a waterfall chart that displays relative data values.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v20.1.dll

Declaration

public class WaterfallRelativeValueOptions :
    WaterfallValueOptionsBase
Public Class WaterfallRelativeValueOptions
    Inherits WaterfallValueOptionsBase

Remarks

Use the WaterfallRelativeValueOptions when the chart data source stores differences between absolute values.

For a chart with relative data, you can add a start bar with a given value and label. To do this, cast the ValueOptions property to WaterfallRelativeValueOptions. Then, specify the StartBarValue and StartBarLabel properties.

If the data source stores absolute data values, use the WaterfallAbsoluteValueOptions class instead of WaterfallRelativeValueOptions.

Examples

This example shows how to create a chart with a data series of the waterfall view.

  • Add a series to a chart.
  • Specify the series data members.
  • Use the WaterfallSeriesView object to configure the series view options.
  • Specify value options. If data source stores value differences, use the WaterfallRelativeValueOptions. Use the WaterfallAbsoluteValueOptions class if the data source stores absolute data values.

    private void Form1_Load(object sender, EventArgs e) {
        chartControl1.DataSource = LoadDataTableFromXml("../../Data/carbon.xml", "CarbonContribution");
        Series series = new Series("Carbon Balance", ViewType.Waterfall);
        series.SetDataMembers("Year", "Contribution");
        series.ArgumentScaleType = ScaleType.Qualitative;
        chartControl1.Series.Add(series);
        ((WaterfallSeriesLabel)series.Label).Position = WaterfallSeriesLabelPosition.OutsideEnd;
        series.LabelsVisibility = DevExpress.Utils.DefaultBoolean.True;
        WaterfallSeriesView view = series.View as WaterfallSeriesView;
        if (view != null) {
            view.RisingBarColor = Color.FromArgb(218, 88, 89);
            view.FallingBarColor = Color.FromArgb(146, 206, 181);
            view.SubtotalBarColor = Color.Gray;
            view.TotalBarColor = Color.DarkGray;
            view.StartBarColor = Color.LightGray;
            view.ConnectorColor = Color.Black;
            view.ConnectorStyle.Thickness = 1;
            WaterfallRelativeValueOptions valueOptions = view.ValueOptions as WaterfallRelativeValueOptions;
            if (valueOptions != null) {
                valueOptions.StartBarLabel = "1989";
                valueOptions.StartBarValue = 2766D;
                valueOptions.ShowTotal = true;
                valueOptions.TotalLabel = "2018";
                valueOptions.Subtotals.Add(new Subtotal { PointIndex = 16, Label= "February 16, 2005" });
            }
        }  
    }
    

Inheritance

Object
ChartElement
WaterfallValueOptionsBase
WaterfallRelativeValueOptions
See Also