menu

Xamarin.Forms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class CandleSeries - Xamarin.Forms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class CandleSeries

    To render a candle chart, create an instance of CandleSeries class and add it to Series collection property and set the required properties.

    Inheritance
    System.Object
    ChartSeries
    CartesianSeries
    FinancialSeriesBase
    HiLoOpenCloseSeries
    CandleSeries
    Inherited Members
    CartesianSeries.GetDataPoints(Double, Double, Double, Double)
    CartesianSeries.GetDataPoints(Rectangle)
    CartesianSeries.IsTransposed
    CartesianSeries.IsTransposedProperty
    CartesianSeries.OnBindingContextChanged()
    CartesianSeries.OnParentSet()
    CartesianSeries.ShowTrackballInfo
    CartesianSeries.ShowTrackballInfoProperty
    CartesianSeries.TrackballLabelTemplate
    CartesianSeries.TrackballLabelTemplateProperty
    CartesianSeries.Trendlines
    CartesianSeries.TrendlinesProperty
    CartesianSeries.XAxis
    CartesianSeries.XAxisProperty
    CartesianSeries.YAxis
    CartesianSeries.YAxisProperty
    ChartSeries.Animate()
    ChartSeries.AnimationDuration
    ChartSeries.AnimationDurationProperty
    ChartSeries.Color
    ChartSeries.ColorModel
    ChartSeries.ColorModelProperty
    ChartSeries.ColorProperty
    ChartSeries.DataMarker
    ChartSeries.DataMarkerLabelCreated
    ChartSeries.DataMarkerProperty
    ChartSeries.EnableAnimation
    ChartSeries.EnableAnimationProperty
    ChartSeries.EnableDataPointSelection
    ChartSeries.EnableDataPointSelectionProperty
    ChartSeries.EnableTooltip
    ChartSeries.EnableTooltipProperty
    ChartSeries.GetDataPointIndex(Single, Single)
    ChartSeries.IsSelected
    ChartSeries.IsVisible
    ChartSeries.IsVisibleOnLegend
    ChartSeries.IsVisibleOnLegendProperty
    ChartSeries.IsVisibleProperty
    ChartSeries.ItemsSource
    ChartSeries.ItemsSourceProperty
    ChartSeries.Label
    ChartSeries.LabelProperty
    ChartSeries.LegendIcon
    ChartSeries.LegendIconProperty
    ChartSeries.ListenPropertyChange
    ChartSeries.ListenPropertyChangeProperty
    ChartSeries.Opacity
    ChartSeries.OpacityProperty
    ChartSeries.ResumeNotification()
    ChartSeries.SelectedDataPointColor
    ChartSeries.SelectedDataPointColorProperty
    ChartSeries.SelectedDataPointIndex
    ChartSeries.SelectedDataPointIndexProperty
    ChartSeries.StrokeWidth
    ChartSeries.StrokeWidthProperty
    ChartSeries.SuspendNotification()
    ChartSeries.TooltipTemplate
    ChartSeries.TooltipTemplateProperty
    ChartSeries.XBindingPath
    ChartSeries.XBindingPathProperty
    FinancialSeriesBase.BearFillColor
    FinancialSeriesBase.BearFillColorProperty
    FinancialSeriesBase.BullFillColor
    FinancialSeriesBase.BullFillColorProperty
    FinancialSeriesBase.Close
    FinancialSeriesBase.CloseProperty
    FinancialSeriesBase.GetChartDataPoints()
    FinancialSeriesBase.High
    FinancialSeriesBase.HighProperty
    FinancialSeriesBase.Low
    FinancialSeriesBase.LowProperty
    FinancialSeriesBase.Name
    FinancialSeriesBase.NameProperty
    FinancialSeriesBase.Open
    FinancialSeriesBase.OpenProperty
    HiLoOpenCloseSeries.Spacing
    HiLoOpenCloseSeries.SpacingProperty
    HiLoOpenCloseSeries.Width
    HiLoOpenCloseSeries.WidthProperty
    Namespace: Syncfusion.SfChart.XForms
    Assembly: Syncfusion.SfChart.XForms.dll
    Syntax
    public class CandleSeries : HiLoOpenCloseSeries, IThemeElement
    Remarks

    CandleSeries requires ItemsSource, XBindingPath, High, Low, Open and Close properties to be set to render the chart. This series also requires x-axis and y-axis to be explicitly set either using PrimaryAxis and SecondaryAxis or XAxis and YAxis.

    Examples
    SfChart chart = new SfChart();
    chart.PrimaryAxis = new NumericalAxis();
    chart.SecondaryAxis = new NumericalAxis();
    CandleSeries candleSeries = new CandleSeries();
    ObservableCollection<ChartDataPoint> Data = new ObservableCollection<ChartDataPoint>
    {
      new ChartDataPoint(1, 30,35,20,25),
      new ChartDataPoint(2, 90,100,10,20),
      new ChartDataPoint(3, 20,90,10,80),
      new ChartDataPoint(5, 10,0,80,70)
    };
    series.ItemsSource = Data;
    chart.Series.Add(candleSeries);

    Constructors

    CandleSeries()

    Declaration
    public CandleSeries()

    Fields

    EnableSolidCandlesProperty

    Gets or sets a value that indicates whether the solid candles have to be enabled. This is a bindable property.

    Declaration
    public static readonly BindableProperty EnableSolidCandlesProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    StrokeColorProperty

    Gets or sets the stroke color to customize the appearance of CandleSeries. This is a bindable property.

    Declaration
    public static readonly BindableProperty StrokeColorProperty
    Field Value
    Type
    Xamarin.Forms.BindableProperty

    Properties

    EnableSolidCandles

    Gets or sets a value indicating whether to enable solid candles. This is a bindable property.

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

    This property takes the bool value.

    StrokeColor

    Gets or sets the stroke color to customize the appearance of CandleSeries. This is a bindable property.

    Declaration
    public Color StrokeColor { get; set; }
    Property Value
    Type Description
    Xamarin.Forms.Color

    This property takes the Xamarin.Forms.Color value.

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