UWP

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class WaterfallSeries

    Show / Hide Table of Contents

    Class WaterfallSeries

    WaterfallSeries displays its positive and negative data points using a set of bars.

    Inheritance
    System.Object
    ChartSeriesBase
    ChartSeries
    AdornmentSeries
    CartesianSeries
    XyDataSeries
    WaterfallSeries
    Implements
    ICloneable
    ISupportAxes2D
    ISupportAxes
    ISegmentSelectable
    ISegmentSpacing
    Inherited Members
    XyDataSeries.YBindingPathProperty
    XyDataSeries.YBindingPath
    XyDataSeries.YValues
    CartesianSeries.TrendlinesProperty
    CartesianSeries.XAxisProperty
    CartesianSeries.YAxisProperty
    CartesianSeries.IsTransposedProperty
    CartesianSeries.ShowTrackballInfoProperty
    CartesianSeries.OnVisibleRangeChanged(VisibleRangeChangedEventArgs)
    CartesianSeries.OnYAxisChanged(ChartAxis, ChartAxis)
    CartesianSeries.OnXAxisChanged(ChartAxis, ChartAxis)
    CartesianSeries.OnApplyTemplate()
    CartesianSeries.GetDataPoints(Rect)
    CartesianSeries.GetDataPoints(Double, Double, Double, Double)
    CartesianSeries.Trendlines
    CartesianSeries.XRange
    CartesianSeries.YRange
    CartesianSeries.XAxis
    CartesianSeries.YAxis
    CartesianSeries.IsTransposed
    CartesianSeries.ShowTrackballInfo
    CartesianSeries.ISupportAxes.ActualXAxis
    CartesianSeries.ISupportAxes.ActualYAxis
    AdornmentSeries.AdornmentsInfoProperty
    AdornmentSeries.CreateAdornment(AdornmentSeries, Double, Double, Double, Double)
    AdornmentSeries.AddColumnAdornments(Double[])
    AdornmentSeries.AddAdornmentAtXY(Double, Double, Int32)
    AdornmentSeries.AddAreaAdornments(IList<Double>[])
    AdornmentSeries.ClearUnUsedAdornments(Int32)
    AdornmentSeries.AdornmentsInfo
    AdornmentSeries.AdornmentLabelCreated
    ChartSeries.StrokeProperty
    ChartSeries.StrokeThicknessProperty
    ChartSeries.GetDataPointIndex(Double, Double)
    ChartSeries.StrokeThickness
    ChartSeries.Area
    ChartSeries.Stroke
    ChartSeriesBase.SpacingProperty
    ChartSeriesBase.TooltipTemplateProperty
    ChartSeriesBase.ShowTooltipProperty
    ChartSeriesBase.ListenPropertyChangeProperty
    ChartSeriesBase.IsSeriesVisibleProperty
    ChartSeriesBase.XBindingPathProperty
    ChartSeriesBase.SortByProperty
    ChartSeriesBase.SortDirectionProperty
    ChartSeriesBase.IsSortDataProperty
    ChartSeriesBase.PaletteProperty
    ChartSeriesBase.ItemsSourceProperty
    ChartSeriesBase.TrackBallLabelTemplateProperty
    ChartSeriesBase.InteriorProperty
    ChartSeriesBase.LabelProperty
    ChartSeriesBase.LegendIconProperty
    ChartSeriesBase.LegendIconTemplateProperty
    ChartSeriesBase.VisibilityOnLegendProperty
    ChartSeriesBase.SeriesSelectionBrushProperty
    ChartSeriesBase.ColorModelProperty
    ChartSeriesBase.SegmentColorPathProperty
    ChartSeriesBase.EnableAnimationProperty
    ChartSeriesBase.AnimationDurationProperty
    ChartSeriesBase.EmptyPointValueProperty
    ChartSeriesBase.EmptyPointStyleProperty
    ChartSeriesBase.EmptyPointSymbolTemplateProperty
    ChartSeriesBase.ShowEmptyPointsProperty
    ChartSeriesBase.EmptyPointInteriorProperty
    ChartSeriesBase.Segments
    ChartSeriesBase.Timer
    ChartSeriesBase.InitialDelayTimer
    ChartSeriesBase.ChartTransformer
    ChartSeriesBase.YPaths
    ChartSeriesBase.GetSpacing(DependencyObject)
    ChartSeriesBase.SetSpacing(DependencyObject, Double)
    ChartSeriesBase.FindNearestChartPoint(Point, Double, Double, Double)
    ChartSeriesBase.CreateEmptyPointSegments(IList<Double>, List<List<Double>>, List<List<Double>>)
    ChartSeriesBase.UpdateSegments(Int32, NotifyCollectionChangedAction)
    ChartSeriesBase.GetAvailableSize()
    ChartSeriesBase.SuspendNotification()
    ChartSeriesBase.ResumeNotification()
    ChartSeriesBase.Invalidate()
    ChartSeriesBase.GetSideBySideInfo(ChartSeriesBase)
    ChartSeriesBase.Clone()
    ChartSeriesBase.OnSeriesMouseUp(Object, Point)
    ChartSeriesBase.OnSeriesMouseDown(Object, Point)
    ChartSeriesBase.SelectedIndexChanged(Int32, Int32)
    ChartSeriesBase.CreateTransformer(Size, Boolean)
    ChartSeriesBase.GetXValues()
    ChartSeriesBase.SetTooltipDuration()
    ChartSeriesBase.IsTooltipAvailable(Canvas)
    ChartSeriesBase.SetDoubleAnimation(ChartTooltip)
    ChartSeriesBase.SetIndividualDataTablePoint(Int32, Object, Boolean)
    ChartSeriesBase.ClearUnUsedSegments(Int32)
    ChartSeriesBase.OnPointerPressed(PointerRoutedEventArgs)
    ChartSeriesBase.OnPointerMoved(PointerRoutedEventArgs)
    ChartSeriesBase.OnTapped(TappedRoutedEventArgs)
    ChartSeriesBase.OnPointerExited(PointerRoutedEventArgs)
    ChartSeriesBase.OnPointerReleased(PointerRoutedEventArgs)
    ChartSeriesBase.Position(Point, ChartTooltip)
    ChartSeriesBase.UpdateArea()
    ChartSeriesBase.GetPreviousSeries(ChartSeriesBase)
    ChartSeriesBase.GeneratePoints(String[], IList<Double>[])
    ChartSeriesBase.OnDataSourceChanged(DependencyPropertyChangedEventArgs)
    ChartSeriesBase.EmptyPointValue
    ChartSeriesBase.EmptyPointStyle
    ChartSeriesBase.EmptyPointSymbolTemplate
    ChartSeriesBase.ShowEmptyPoints
    ChartSeriesBase.EmptyPointInterior
    ChartSeriesBase.DataCount
    ChartSeriesBase.IsSortData
    ChartSeriesBase.SortDirection
    ChartSeriesBase.SortBy
    ChartSeriesBase.TooltipTemplate
    ChartSeriesBase.ShowTooltip
    ChartSeriesBase.ListenPropertyChange
    ChartSeriesBase.Adornments
    ChartSeriesBase.IsSeriesVisible
    ChartSeriesBase.Palette
    ChartSeriesBase.ItemsSource
    ChartSeriesBase.TrackBallLabelTemplate
    ChartSeriesBase.Interior
    ChartSeriesBase.Label
    ChartSeriesBase.LegendIcon
    ChartSeriesBase.LegendIconTemplate
    ChartSeriesBase.VisibilityOnLegend
    ChartSeriesBase.SeriesSelectionBrush
    ChartSeriesBase.ColorModel
    ChartSeriesBase.XBindingPath
    ChartSeriesBase.SegmentColorPath
    ChartSeriesBase.EnableAnimation
    ChartSeriesBase.AnimationDuration
    ChartSeriesBase.IsLinear
    ChartSeriesBase.IsAreaTypeSeries
    ChartSeriesBase.IsBitmapSeries
    ChartSeriesBase.IsColorPathSeries
    ChartSeriesBase.IsIndexed
    ChartSeriesBase.ColorValues
    ChartSeriesBase.ActualXValues
    ChartSeriesBase.SelectedSegmentsIndexes
    ChartSeriesBase.SelectedSegments
    ChartSeriesBase.SelectedSegment
    ChartSeriesBase.ActualXAxis
    ChartSeriesBase.ActualYAxis
    ChartSeriesBase.IsStacked
    ChartSeriesBase.PropertyChanged
    Namespace: Syncfusion.UI.Xaml.Charts
    Assembly: Syncfusion.SfChart.UWP.dll
    Syntax
    public class WaterfallSeries : XyDataSeries, ICloneable, ISupportAxes2D, ISupportAxes, ISegmentSelectable, ISegmentSpacing
    Examples
          <syncfusion:WaterfallSeries ItemsSource="{Binding Data}" XBindingPath="Year" YBindingPath="Value">
          </syncfusion:WaterfallSeries>
          WaterfallSeries series1 = new WaterfallSeries();
          series1.ItemsSource = viewmodel.Data;
          series1.XBindingPath = "Year";
          series1.YBindingPath = "Value";
          chart.Series.Add(series1);

    Constructors

    WaterfallSeries()

    Declaration
    public WaterfallSeries()

    Fields

    AllowAutoSumProperty

    Using a DependencyProperty as the backing store for AllowAutoSum. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty AllowAutoSumProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    ConnectorLineStyleProperty

    Using a DependencyProperty as the backing store for ConnectorLineStyle. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty ConnectorLineStyleProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    NegativeSegmentBrushProperty

    Using a DependencyProperty as the backing store for NegativeSegmentBrush. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty NegativeSegmentBrushProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    SegmentSelectionBrushProperty

    The DependencyProperty for SegmentSelectionBrush property.

    Declaration
    public static readonly DependencyProperty SegmentSelectionBrushProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    SegmentSpacingProperty

    The DependencyProperty for SegmentSpacing property.

    Declaration
    public static readonly DependencyProperty SegmentSpacingProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    SelectedIndexProperty

    The DependencyProperty for SelectedIndex property.

    Declaration
    public static readonly DependencyProperty SelectedIndexProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    ShowConnectorProperty

    Using a DependencyProperty as the backing store for ShowConnector. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty ShowConnectorProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    SummaryBindingPathProperty

    Using a DependencyProperty as the backing store for SummaryBindingPath. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty SummaryBindingPathProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    SummarySegmentBrushProperty

    Using a DependencyProperty as the backing store for SummarySegmentBrush. This enables animation, styling, binding, etc...

    Declaration
    public static readonly DependencyProperty SummarySegmentBrushProperty
    Field Value
    Type Description
    Windows.UI.Xaml.DependencyProperty

    Properties

    AllowAutoSum

    Gets or sets a value indicating whether to auto sum.

    Declaration
    public bool AllowAutoSum { get; set; }
    Property Value
    Type Description
    System.Boolean

    ConnectorLineStyle

    Gets or sets the style value that indicates the segments connector line visual representation.

    Declaration
    public Style ConnectorLineStyle { get; set; }
    Property Value
    Type Description
    Windows.UI.Xaml.Style

    IsSideBySide

    Gets a value indicating whether this series is placed side by side.

    Declaration
    protected override bool IsSideBySide { get; }
    Property Value
    Type Description
    System.Boolean

    It returns true, if the series is placed side by side [cluster mode].

    Overrides
    ChartSeriesBase.IsSideBySide

    NegativeSegmentBrush

    Gets or sets the brush value that indicates the interior color of negative segment.

    Declaration
    public Brush NegativeSegmentBrush { get; set; }
    Property Value
    Type Description
    Windows.UI.Xaml.Media.Brush

    SegmentSelectionBrush

    Gets or sets the interior (brush) for the selected segment(s).

    Declaration
    public Brush SegmentSelectionBrush { get; set; }
    Property Value
    Type Description
    Windows.UI.Xaml.Media.Brush

    The Windows.UI.Xaml.Media.Brush value.

    SegmentSpacing

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

    Declaration
    public double SegmentSpacing { get; set; }
    Property Value
    Type Description
    System.Double

    The value ranges from 0 to 1.

    SelectedIndex

    Gets or sets the index of the selected segment.

    Declaration
    public int SelectedIndex { get; set; }
    Property Value
    Type Description
    System.Int32

    Int value represents the index of the data point(or segment) to be selected.

    ShowConnector

    Gets or sets a value indicating whether the segments connector line is visible.

    Declaration
    public bool ShowConnector { get; set; }
    Property Value
    Type Description
    System.Boolean

    SummaryBindingPath

    Gets or sets string that indicates sum segment of series.

    Declaration
    public string SummaryBindingPath { get; set; }
    Property Value
    Type Description
    System.String

    SummarySegmentBrush

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

    Declaration
    public Brush SummarySegmentBrush { get; set; }
    Property Value
    Type Description
    Windows.UI.Xaml.Media.Brush

    Methods

    CalculateSegmentSpacing(Double, Double, Double)

    Method used to calculate the segment spacing.

    Declaration
    protected double CalculateSegmentSpacing(double spacing, double Right, double Left)
    Parameters
    Type Name Description
    System.Double spacing

    Spacing

    System.Double Right

    Right

    System.Double Left

    Left

    Returns
    Type Description
    System.Double

    CloneSeries(DependencyObject)

    Returns the instance of WaterfallSeries series.

    Declaration
    protected override DependencyObject CloneSeries(DependencyObject obj)
    Parameters
    Type Name Description
    Windows.UI.Xaml.DependencyObject obj

    object

    Returns
    Type Description
    Windows.UI.Xaml.DependencyObject
    Overrides
    XyDataSeries.CloneSeries(DependencyObject)

    CreateSegment()

    Creates an instance of series segment.

    Declaration
    protected override ChartSegment CreateSegment()
    Returns
    Type Description
    ChartSegment

    Returns the instance of corresponding series segment.

    Overrides
    ChartSeries.CreateSegment()
    Remarks

    This customization is not supported for fast type series and technical indicators.

    Examples

    This sample shows how to call the CreateSegment() method to customize the line series segments.

    public class LineSeriesExt : LineSeries
    {​ 
        protected override ChartSegment CreateSegment()
        {​
            return new LineSegmentExt();
        }​
    }​
    
    public class LineSegmentExt : LineSegment
    {​
        public override UIElement CreateVisual(Size size)
        {​
            // Write your customization code here.
        }​
    
        public override void Update(IChartTransformer transformer)
        {​
            // Write your customization code here.
        }​
    }

    CreateSegments()

    Creates the segments of WaterfallSeries.

    Declaration
    public override void CreateSegments()
    Overrides
    AdornmentSeries.CreateSegments()

    GeneratePoints()

    Method for Generate Points for XYDataSeries.

    Declaration
    protected override void GeneratePoints()
    Overrides
    XyDataSeries.GeneratePoints()

    OnBindingPathChanged(DependencyPropertyChangedEventArgs)

    Declaration
    protected override void OnBindingPathChanged(DependencyPropertyChangedEventArgs args)
    Parameters
    Type Name Description
    Windows.UI.Xaml.DependencyPropertyChangedEventArgs args
    Overrides
    XyDataSeries.OnBindingPathChanged(DependencyPropertyChangedEventArgs)

    OnDataSourceChanged(IEnumerable, IEnumerable)

    Called when ItemsSource property changed.

    Declaration
    protected override void OnDataSourceChanged(IEnumerable oldValue, IEnumerable newValue)
    Parameters
    Type Name Description
    System.Collections.IEnumerable oldValue

    old value

    System.Collections.IEnumerable newValue

    new value

    Overrides
    XyDataSeries.OnDataSourceChanged(IEnumerable, IEnumerable)

    OnSegmentCreated(WaterfallSegmentCreatedEventArgs)

    Occurs when segment created for waterfall series.

    Declaration
    protected virtual void OnSegmentCreated(WaterfallSegmentCreatedEventArgs args)
    Parameters
    Type Name Description
    WaterfallSegmentCreatedEventArgs args

    WaterfallSegmentCreatedEventArgs

    SetIndividualPoint(Int32, Object, Boolean)

    Method implementation for set points to given index.

    Declaration
    protected override void SetIndividualPoint(int index, object obj, bool replace)
    Parameters
    Type Name Description
    System.Int32 index

    index

    System.Object obj

    object

    System.Boolean replace

    bool

    Overrides
    ChartSeriesBase.SetIndividualPoint(Int32, Object, Boolean)

    Events

    SegmentCreated

    Event raised while the segment have created.

    Declaration
    public event EventHandler<WaterfallSegmentCreatedEventArgs> SegmentCreated
    Event Type
    Type Description
    System.EventHandler<WaterfallSegmentCreatedEventArgs>

    Explicit Interface Implementations

    ISegmentSpacing.CalculateSegmentSpacing(Double, Double, Double)

    Declaration
    double ISegmentSpacing.CalculateSegmentSpacing(double spacing, double Right, double Left)
    Parameters
    Type Name Description
    System.Double spacing
    System.Double Right
    System.Double Left
    Returns
    Type Description
    System.Double

    Implements

    ICloneable
    ISupportAxes2D
    ISupportAxes
    ISegmentSelectable
    ISegmentSpacing

    Extension Methods

    DateTimeExtension.ToDateTime(Object)

    See Also

    ColumnSeries
    StepLineSeries
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved