Class ChartAnnotation

Serves as a base class for all types of annotations such as text, shape, and view; the annotations can be added to the chart.

Inheritance

System.Object

ChartAnnotation

ShapeAnnotation

TextAnnotation

ViewAnnotation

Namespace: Syncfusion.SfChart.XForms

Assembly: Syncfusion.SfChart.XForms.dll

Syntax

public abstract class ChartAnnotation : Element, IThemeElement

Constructors

ChartAnnotation()

Initializes a new instance of the ChartAnnotation class.

Declaration

public ChartAnnotation()

Fields

CoordinateUnitProperty

Gets or sets the ChartCoordinateUnit enum that represents whether annotation is draw on pixel co-ordinates or axis co-ordinates. This is a bindable property.

Declaration

public static readonly BindableProperty CoordinateUnitProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

IsVisibleProperty

Gets or sets the value that indicates whether the ChartAnnotation is visible in the chart. This is a bindable property.

Declaration

public static readonly BindableProperty IsVisibleProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

X1Property

Gets or sets the Date time or double that represents x1 position of ChartAnnotation . This is a bindable property.

Declaration

public static readonly BindableProperty X1Property

Field Value

Type	Description
Xamarin.Forms.BindableProperty

XAxisNameProperty

Declaration

public static readonly BindableProperty XAxisNameProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

Y1Property

Gets or sets the double that represents y1 position of ChartAnnotation. This is a bindable property.

Declaration

public static readonly BindableProperty Y1Property

Field Value

Type	Description
Xamarin.Forms.BindableProperty

YAxisNameProperty

Declaration

public static readonly BindableProperty YAxisNameProperty

Field Value

Type	Description
Xamarin.Forms.BindableProperty

Properties

Chart

Gets the SfChart for the ChartAnnotation.

Declaration

public SfChart Chart { get; }

Property Value

Type	Description
SfChart	This property take SfChart instance as value.

CoordinateUnit

Gets or sets the ChartCoordinateUnit enum that represents whether annotation is draw on pixel co-ordinates or axis co-ordinates. This is a bindable property.

Declaration

public ChartCoordinateUnit CoordinateUnit { get; set; }

Property Value

Type	Description
ChartCoordinateUnit	This property takes the CoordinateUnit value.

IsVisible

Gets or sets a value indicating whether the ChartAnnotation is visible in the chart. This is a bindable property.

Declaration

public bool IsVisible { get; set; }

Property Value

Type	Description
System.Boolean	This property takes the boolean value.

X1

Gets or sets the date time or double that represents x1 position of ChartAnnotation. This is a bindable property.

Declaration

public object X1 { get; set; }

Property Value

Type	Description
System.Object	This property takes the object value.

XAxisName

Declaration

public string XAxisName { get; set; }

Property Value

Type	Description
System.String

Y1

Gets or sets the double that represents y1 position of ChartAnnotation. This is a bindable property.

Declaration

public double Y1 { get; set; }

Property Value

Type	Description
System.Double	This property takes the double value.

YAxisName

Declaration

public string YAxisName { get; set; }

Property Value

Type	Description
System.String

Methods

OnTouchDown(Single, Single)

The method is called when the ChartAnnotation is touched.

Declaration

protected virtual void OnTouchDown(float pointX, float pointY)

Parameters

Type	Name	Description
System.Single	pointX	point x.
System.Single	pointY	point y.

OnTouchMove(Single, Single)

The method is called when move the touch over the ChartAnnotation.

Declaration

protected virtual void OnTouchMove(float pointX, float pointY)

Parameters

Type	Name	Description
System.Single	pointX	point x.
System.Single	pointY	point y.

OnTouchUp(Single, Single)

The method is called when release touch in ChartAnnotation.

Declaration

protected virtual void OnTouchUp(float pointX, float pointY)

Parameters

Type	Name	Description
System.Single	pointX	point x.
System.Single	pointY	point y.