Class CandleSeries

CandleSeries is used primarily to analyze price movements of a stcock market over a period of time.

Inheritance
System.Object
ChartSeriesBase
ChartSeries
AdornmentSeries
CartesianSeries
FinancialSeriesBase
CandleSeries
Inherited Members
Namespace: Syncfusion.UI.Xaml.Charts
Assembly: Syncfusion.SfChart.UWP.dll
Syntax
public class CandleSeries : FinancialSeriesBase, ICloneable, ISupportAxes2D, ISupportAxes, ISegmentSpacing, ISegmentSelectable
Remarks

Each data point contains four values namely open, high, low, close. Typically, the high and low values are connected using a vertical straight line, whereas the region between open and close values are connected using a vertical column segment.

Examples
      <syncfusion:CandleSeries ItemsSource="{Binding Data}" XBindingPath="Year" High="High" Open="Open" Close="Close" Low="Low">
      </syncfusion:CandleSeries>
      CandleSeries series1 = new CandleSeries();
      series1.ItemsSource = viewmodel.Data;
      series1.XBindingPath = "Year";
      series1.High="High";
      series1.Low="Low";
      series1.Open="Open";
      series1.Close="Close";
      chart.Series.Add(series1);

Constructors

CandleSeries()

Declaration
public CandleSeries()

Fields

SegmentSelectionBrushProperty

The DependencyProperty for SegmentSelectionBrush property.

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

SegmentSpacingProperty

The DependencyProperty for SegmentSpacing property.

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

SelectedIndexProperty

The DependencyProperty for SelectedIndex property.

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

Properties

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

SegmentSelectionBrush

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

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

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 and its default value is -1.

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
System.Double

CloneSeries(DependencyObject)

Returns the instance of CandleSeries series.

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

object
Returns
Type
Windows.UI.Xaml.DependencyObject
Overrides

CreateSegment()

Creates an instance of series segment.

Declaration
protected override ChartSegment CreateSegment()
Returns
Type Description
ChartSegment

Returns the instance of corresponding series segment.
Overrides
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 CandleSeries.

Declaration
public override void CreateSegments()
Overrides

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
System.Double

Implements

Extension Methods

See Also