Class Annotations

Inheritance
System.Object
EJTagHelper
Annotations
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.DataVisualization.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class Annotations : EJTagHelper

Constructors

Annotations()

Declaration
public Annotations()

Properties

Angle

Gets or sets the angle value in annotation, to render annotation template in rotated degree based on specified angle.

Declaration
[JsonProperty("angle")]
public double Angle { get; set; }
Property Value
Type Description
System.Double
Remarks

Angle to rotate the annotation in degrees.

Content

Gets or sets the content value in annotation to render the text content as an annotation value in chart area.

Declaration
[JsonProperty("content")]
public string Content { get; set; }
Property Value
Type Description
System.String
Remarks

Text content or id of a HTML element to be displayed as annotation.

CoordinateUnit

Gets or sets the coordinate unit value in which annotations are placed relative to the chart area.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("coordinateUnit")]
public CoordinateUnit CoordinateUnit { get; set; }
Property Value
Type Description
CoordinateUnit
Remarks

Specifies how annotations have to be placed in Chart.

HorizontalAlignment

Gets or sets the horizontal alignment value in annotation to place an annotation in horizontal position.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("horizontalAlignment")]
public HorizontalAlignment HorizontalAlignment { get; set; }
Property Value
Type Description
HorizontalAlignment
Remarks

Specifies the horizontal alignment of the annotation.

Margin

Gets or sets the margin value in annotation to customize the margin positions of annotation in chart area.

Declaration
[JsonProperty("margin")]
public AnnotationMargin Margin { get; set; }
Property Value
Type Description
AnnotationMargin
Remarks

Options to customize the margin of annotation.

Opacity

Gets or sets the opacity value in annotation to customize an opacity of annotation object in chart area.

Declaration
[JsonProperty("opacity")]
public double Opacity { get; set; }
Property Value
Type Description
System.Double
Remarks

Controls the opacity of the annotation.

Region

Gets or sets the region value for annotaion which has to be rendered based on series or chart mentioned in annotation.

Declaration
[JsonProperty("region")]
[JsonConverter(typeof(StringEnumConverter))]
public Region Region { get; set; }
Property Value
Type Description
Region
Remarks

Specifies whether annotation has to be placed with respect to chart or series.

VerticalAlignment

Gets or sets the vertical alignment value in annotation to place an annotation in vertical position.

Declaration
[JsonProperty("verticalAlignment")]
[JsonConverter(typeof(StringEnumConverter))]
public VerticalAlignment VerticalAlignment { get; set; }
Property Value
Type Description
VerticalAlignment
Remarks

Specifies the vertical alignment of the annotation.

Visible

Gets or sets the visible value in annotation to control the visibility of annotation rendering in chart.

Declaration
[JsonProperty("visible")]
public bool Visible { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Controls the visibility of the annotation.

X

Gets or sets the x value in annotation, to render annotation relative to an axis based on coordinate units.

Declaration
[JsonProperty("x")]
public object X { get; set; }
Property Value
Type Description
System.Object
Remarks

Represents the horizontal offset when coordinateUnit is pixels. when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property or primary X axis when xAxisName is not provided. This property is not applicable when coordinateUnit is none.

XAxisName

Gets or sets the x axis name value in annotation, to associate annotation based on specified x axis name.

Declaration
[JsonProperty("xAxisName")]
public string XAxisName { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the horizontal axis to be used for positioning the annotation. This property is applicable only when coordinateUnit is points.

Y

Gets or sets the y value in annotation, to render annotation based on coordinate units which is relative to axis.

Declaration
[JsonProperty("y")]
public double Y { get; set; }
Property Value
Type Description
System.Double
Remarks

Represents the vertical offset when coordinateUnit is pixels. When coordinateUnit is points, it represents the y-coordinate of axis bounded with yAxisName property or primary Y axis when yAxisName is not provided. This property is not applicable when coordinateUnit is none.

YAxisName

Gets or sets the y axis name value in annotation, to associate annotation based on specified y axis name.

Declaration
[JsonProperty("yAxisName")]
public string YAxisName { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the vertical axis to be used for positioning the annotation. This property is applicable only when coordinateUnit is points.

Methods

ShouldSerializeAnnotationMargin()

Declaration
public bool ShouldSerializeAnnotationMargin()
Returns
Type Description
System.Boolean