Xamarin.Forms

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

    Show / Hide Table of Contents

    Class SFSeries

    Serves as a base class for all types of chart series.

    Inheritance
    System.Object
    SFSeries
    SFAccumulationSeries
    SFCartesianSeries
    SFPolarRadarSeriesBase
    SFTechnicalIndicator
    Namespace: Syncfusion.MacOS.Charts.SfChart
    Assembly: Syncfusion.SfChart.XForms.macOS.dll
    Syntax
    public abstract class SFSeries : Object

    Constructors

    SFSeries()

    Initializes a new instance of the SFSeries class with default settings.

    Declaration
    public SFSeries()

    Properties

    ActualXAxis

    Declaration
    public virtual SFAxis ActualXAxis { get; }
    Property Value
    Type Description
    SFAxis

    ActualYAxis

    Declaration
    public virtual SFAxis ActualYAxis { get; }
    Property Value
    Type Description
    SFAxis

    Alpha

    Gets or sets float value that indicates series fill color's alpha value.

    Declaration
    public float Alpha { get; set; }
    Property Value
    Type Description
    System.Single

    AnimationDuration

    Gets or sets double value that represents animation time in view.

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

    Color

    Gets or sets color which used to fill the segments in series.

    Declaration
    public NSColor Color { get; set; }
    Property Value
    Type Description
    AppKit.NSColor

    ColorModel

    Gets or sets ChartColorModel which used to modify series palette.

    Declaration
    public SFChartColorModel ColorModel { get; set; }
    Property Value
    Type Description
    SFChartColorModel

    DataCount

    Declaration
    protected int DataCount { get; set; }
    Property Value
    Type Description
    System.Int32

    DataMarker

    Gets the chart data marker labels.

    Declaration
    public SFChartDataMarker DataMarker { get; }
    Property Value
    Type Description
    SFChartDataMarker

    EnableAnimation

    Gets or sets a value indicating whether to allow series render with animation effects.

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

    This property is not supported for SFBoxAndWhiskerSeries and SFErrorBarSeries

    EnableDataPointSelection

    Gets or sets a value indicating whether to allow the segment selection of the series.

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

    EnableTooltip

    Gets or sets a value indicating whether to show tooltip of the series on touch.

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

    IsSelected

    Gets a value indicating whether the series is selected or not.

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

    ItemsSource

    Gets or sets collection of object source which is used to render series in UI.

    Declaration
    public object ItemsSource { get; set; }
    Property Value
    Type Description
    System.Object

    Label

    Gets or sets the string that used to identify the series in legend item.

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

    LayerFrame

    Gets the frame for the series.

    Declaration
    public CGRect LayerFrame { get; }
    Property Value
    Type Description
    CoreGraphics.CGRect

    LegendIcon

    Gets or sets SFChartLegendIcon which represents the series icon in legend item.

    Declaration
    public SFChartLegendIcon LegendIcon { get; set; }
    Property Value
    Type Description
    SFChartLegendIcon

    ListenPropertyChange

    Gets or sets a value indicating whether to update individual data in ItemsSource.

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

    Name

    Gets or sets string value that used to identify series in chart.

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

    Segments

    Gets the Segments collection variable declarations.

    Declaration
    public ObservableCollection<SFChartSegment> Segments { get; }
    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<SFChartSegment>

    SelectedDataPointColor

    Gets or sets the color of the selected segment of the series.

    Declaration
    public NSColor SelectedDataPointColor { get; set; }
    Property Value
    Type Description
    AppKit.NSColor

    SelectedDataPointIndex

    Gets or sets the index value of current selected data point.

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

    Visible

    Gets or sets a value indicating whether the series is visible in the chart.

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

    VisibleOnLegend

    Gets or sets a value indicating whether to display information about the series in the legend.

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

    XBindingPath

    Gets or sets IList value which used to render series in UI.

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

    XRange

    Gets the xAxis range.

    Declaration
    public DoubleRange XRange { get; }
    Property Value
    Type Description
    DoubleRange

    YRange

    Gets the yAxis range.

    Declaration
    public DoubleRange YRange { get; }
    Property Value
    Type Description
    DoubleRange

    Methods

    Animate()

    Declaration
    public void Animate()

    AnimationForSegment(SFChartSegment)

    Returns the customized animation for chart segment.

    Declaration
    protected virtual CAAnimation AnimationForSegment(SFChartSegment segment)
    Parameters
    Type Name Description
    SFChartSegment segment

    The segment.

    Returns
    Type Description
    CoreAnimation.CAAnimation

    The for segment.

    ClearUnUsedDataMarkerLabels(Int32)

    Declaration
    protected void ClearUnUsedDataMarkerLabels(int dataCount)
    Parameters
    Type Name Description
    System.Int32 dataCount

    CreateRenderer()

    Returns the renderer for the series.

    Declaration
    protected virtual SeriesRenderer CreateRenderer()
    Returns
    Type Description
    SeriesRenderer

    The

    CreateSegment()

    Declaration
    protected abstract SFChartSegment CreateSegment()
    Returns
    Type Description
    SFChartSegment

    CreateSegments()

    Declaration
    public virtual void CreateSegments()

    DataPointIndexAtPoint(CGPoint)

    Declaration
    public virtual int DataPointIndexAtPoint(CGPoint hitPoint)
    Parameters
    Type Name Description
    CoreGraphics.CGPoint hitPoint
    Returns
    Type Description
    System.Int32

    DrawConnectorLine(CGContext, Double, Double, Double, Double, NSColor, Int32)

    Declaration
    public virtual void DrawConnectorLine(CGContext context, double startX, double startY, double endX, double endY, NSColor lineColor, int index)
    Parameters
    Type Name Description
    CoreGraphics.CGContext context
    System.Double startX
    System.Double startY
    System.Double endX
    System.Double endY
    AppKit.NSColor lineColor
    System.Int32 index

    DrawInContext(CGContext)

    Declaration
    public virtual void DrawInContext(CGContext context)
    Parameters
    Type Name Description
    CoreGraphics.CGContext context

    DrawLabel(NSString, CGContext, Double, Double, Int32)

    Declaration
    public virtual void DrawLabel(NSString label, CGContext context, double pointX, double pointY, int index)
    Parameters
    Type Name Description
    Foundation.NSString label
    CoreGraphics.CGContext context
    System.Double pointX
    System.Double pointY
    System.Int32 index

    DrawLayer(CALayer, CGContext)

    Declaration
    public virtual void DrawLayer(CALayer layer, CGContext context)
    Parameters
    Type Name Description
    CoreAnimation.CALayer layer
    CoreGraphics.CGContext context

    DrawMarker(CGContext, Double, Double, Int32)

    Declaration
    public virtual void DrawMarker(CGContext context, double centerX, double centerY, int index)
    Parameters
    Type Name Description
    CoreGraphics.CGContext context
    System.Double centerX
    System.Double centerY
    System.Int32 index

    GeneratePoints(String[], IList<Double>[])

    Declaration
    protected void GeneratePoints(string[] yPaths, params IList<double>[] yValueLists)
    Parameters
    Type Name Description
    System.String[] yPaths
    System.Collections.Generic.IList<System.Double>[] yValueLists

    GetGradientEndPoint(SFChartSegment)

    Declaration
    protected virtual CGPoint GetGradientEndPoint(SFChartSegment segment)
    Parameters
    Type Name Description
    SFChartSegment segment
    Returns
    Type Description
    CoreGraphics.CGPoint

    GetGradientStartPoint(SFChartSegment)

    Declaration
    protected virtual CGPoint GetGradientStartPoint(SFChartSegment segment)
    Parameters
    Type Name Description
    SFChartSegment segment
    Returns
    Type Description
    CoreGraphics.CGPoint

    GetSelectionColor()

    Override this method to set color for selected series.

    Declaration
    protected virtual NSColor GetSelectionColor()
    Returns
    Type Description
    AppKit.NSColor

    The selection color.

    InsertDataPointAtIndex(nint)

    Declaration
    public void InsertDataPointAtIndex(nint index)
    Parameters
    Type Name Description
    System.nint index

    InvalidateRender()

    Method used to render this series alone.

    Declaration
    protected virtual void InvalidateRender()

    OnAttachedToChart()

    Called when this series added to Chart layout.

    Declaration
    protected virtual void OnAttachedToChart()

    OnBindingPathChanged()

    Declaration
    protected virtual void OnBindingPathChanged()

    OnDetachedFromChart()

    Called when this series removed to Chart layout.

    Declaration
    protected virtual void OnDetachedFromChart()

    ReloadData()

    Declaration
    public virtual void ReloadData()

    RemoveDataPointAtIndex(nint)

    Declaration
    public void RemoveDataPointAtIndex(nint index)
    Parameters
    Type Name Description
    System.nint index

    ResumeNotification()

    Processes the data that is added to the data source after the SuspendNotification is called.

    Declaration
    public void ResumeNotification()

    ScheduleUpdateArea()

    Declaration
    protected virtual void ScheduleUpdateArea()

    SeriesContainsPoint(CGPoint)

    Declaration
    public virtual bool SeriesContainsPoint(CGPoint point)
    Parameters
    Type Name Description
    CoreGraphics.CGPoint point
    Returns
    Type Description
    System.Boolean

    SetFillColor(SFChartSegment)

    Declaration
    protected virtual void SetFillColor(SFChartSegment segment)
    Parameters
    Type Name Description
    SFChartSegment segment

    SetIndividualPoint(Int32, Object, Boolean)

    Declaration
    protected virtual void SetIndividualPoint(int index, object value, bool replace)
    Parameters
    Type Name Description
    System.Int32 index
    System.Object value
    System.Boolean replace

    SetStrokeWidth(SFChartSegment)

    Declaration
    protected virtual void SetStrokeWidth(SFChartSegment segment)
    Parameters
    Type Name Description
    SFChartSegment segment

    SuspendNotification()

    Suspends the series from updating the series data till ResumeNotification is called. This is specifically used when you need to append the collection of data.

    Declaration
    public void SuspendNotification()

    Events

    DataMarkerLabelCreated

    The event is called when the data marker label is created.

    Declaration
    public event EventHandler<SFSeries.DataMarkerLabelCreatedEventArgs> DataMarkerLabelCreated
    Event Type
    Type Description
    System.EventHandler<SFSeries.DataMarkerLabelCreatedEventArgs>
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved