Class ChartAnnotationBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
ChartAnnotationBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartAnnotationBuilder : ControlBuilder
Constructors
ChartAnnotationBuilder()
Declaration
public ChartAnnotationBuilder()
ChartAnnotationBuilder(List<ChartAnnotation>)
Declaration
public ChartAnnotationBuilder(List<ChartAnnotation> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<ChartAnnotation> |
collection |
|
Methods
Accessibility(ChartAnnotationSettingsAccessibility)
Options to improve accessibility for chart annotation elements.
Declaration
public ChartAnnotationBuilder Accessibility(ChartAnnotationSettingsAccessibility accessibility)
Parameters
Returns
Accessibility(Action<ChartAccessibilityBuilder>)
Declaration
public ChartAnnotationBuilder Accessibility(Action<ChartAccessibilityBuilder> accessibility)
Parameters
Returns
Add()
Declaration
Content(String)
The content of the annotation, which also accepts the ID of the custom element.
Declaration
public ChartAnnotationBuilder Content(string content)
Parameters
| Type |
Name |
Description |
| System.String |
content |
|
Returns
CoordinateUnits(Units)
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 ChartAnnotationBuilder CoordinateUnits(Units coordinateUnits)
Parameters
| Type |
Name |
Description |
| Units |
coordinateUnits |
|
Returns
Description(String)
A description for the annotation that provides additional information about its content for screen readers.
Declaration
public ChartAnnotationBuilder Description(string description)
Parameters
| Type |
Name |
Description |
| System.String |
description |
|
Returns
HorizontalAlignment(Alignment)
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 ChartAnnotationBuilder HorizontalAlignment(Alignment horizontalAlignment)
Parameters
| Type |
Name |
Description |
| Alignment |
horizontalAlignment |
|
Returns
Region(Regions)
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 ChartAnnotationBuilder Region(Regions region)
Parameters
| Type |
Name |
Description |
| Regions |
region |
|
Returns
VerticalAlignment(Position)
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 ChartAnnotationBuilder VerticalAlignment(Position verticalAlignment)
Parameters
| Type |
Name |
Description |
| Position |
verticalAlignment |
|
Returns
X(Object)
If coordinateUnit is set to Pixel, x specifies the pixel value.
If coordinateUnit is set to Point, x specifies the axis value.
Declaration
public ChartAnnotationBuilder X(object x)
Parameters
| Type |
Name |
Description |
| System.Object |
x |
|
Returns
XAxisName(String)
The name of the horizontal axis associated with the annotation.
Requires the axes of the chart.
Declaration
public ChartAnnotationBuilder XAxisName(string xAxisName)
Parameters
| Type |
Name |
Description |
| System.String |
xAxisName |
|
Returns
Y(Double)
If coordinateUnit is set to Pixel, y specifies the pixel value.
If coordinateUnit is set to Point, y specifies the axis value.
Declaration
public ChartAnnotationBuilder Y(double y)
Parameters
| Type |
Name |
Description |
| System.Double |
y |
|
Returns
Y(String)
If coordinateUnit is set to Pixel, y specifies the pixel value.
If coordinateUnit is set to Point, y specifies the axis value.
Declaration
public ChartAnnotationBuilder Y(string y)
Parameters
| Type |
Name |
Description |
| System.String |
y |
|
Returns
YAxisName(String)
The name of the vertical axis associated with the annotation.
Requires the axes of the chart.
Declaration
public ChartAnnotationBuilder YAxisName(string yAxisName)
Parameters
| Type |
Name |
Description |
| System.String |
yAxisName |
|
Returns
