Class ChartAnnotation
Inheritance
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartAnnotation : EJTagHelperConstructors
ChartAnnotation()
Declaration
public ChartAnnotation()Properties
Accessibility
Options to improve accessibility for chart annotation elements.
Declaration
public ChartAnnotationSettingsAccessibility Accessibility { get; set; }Property Value
| Type | Description |
|---|---|
| ChartAnnotationSettingsAccessibility | The default value is null |
Content
The content of the annotation, which also accepts the ID of the custom element.
Declaration
public string Content { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
CoordinateUnits
Specifies the coordinate units of the annotation. The options are: Pixel - Renders the annotation based on x and y pixel values. Point - Renders the annotation based on x and y axis values.
Declaration
public Units CoordinateUnits { get; set; }Property Value
| Type | Description |
|---|---|
| Units | The default value is Units.Pixel |
Description
A description for the annotation that provides additional information about its content for screen readers.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
HorizontalAlignment
Specifies the alignment of the annotation. The options are: Near - Aligns the annotation element to the left side. Far - Aligns the annotation element to the right side. Center - Aligns the annotation element to the midpoint.
Declaration
public Alignment HorizontalAlignment { get; set; }Property Value
| Type | Description |
|---|---|
| Alignment | The default value is Alignment.Center |
Region
Specifies the regions of the annotation. The options are: Chart - Renders the annotation based on chart coordinates. Series - Renders the annotation based on series coordinates.
Declaration
public Regions Region { get; set; }Property Value
| Type | Description |
|---|---|
| Regions | The default value is Regions.Chart |
VerticalAlignment
Specifies the position of the annotation. The options are Top - Aligns the annotation element to the top side. Bottom - Aligns the annotation element to the bottom side. Middle - Aligns the annotation element to the midpoint.
Declaration
public Position VerticalAlignment { get; set; }Property Value
| Type | Description |
|---|---|
| Position | The default value is Position.Middle |
X
If coordinateUnit is set to Pixel, x specifies the pixel value.
If coordinateUnit is set to Point, x specifies the axis value.
Declaration
public object X { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
XAxisName
The name of the horizontal axis associated with the annotation.
Requires the axes of the chart.
Declaration
public string XAxisName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Y
If coordinateUnit is set to Pixel, y specifies the pixel value.
If coordinateUnit is set to Point, y specifies the axis value.
Declaration
public string Y { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "0" |
YAxisName
The name of the vertical axis associated with the annotation.
Requires the axes of the chart.
Declaration
public string YAxisName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |