ASP.NET MVC - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartAnnotationBuilder - ASP.NETMVC-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ChartAnnotationBuilder

    Inheritance
    System.Object
    ControlBuilder
    ChartAnnotationBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    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.EJ2.Charts
    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

    Add()

    Declaration
    public void Add()

    Content(String)

    Content of the annotation, which accepts the id of the custom element.

    Declaration
    public ChartAnnotationBuilder Content(string content)
    Parameters
    Type Name Description
    System.String content
    Returns
    Type Description
    ChartAnnotationBuilder

    CoordinateUnits(Units)

    Specifies the coordinate units of the annotation. They are Pixel - Annotation renders based on x and y pixel value. Point - Annotation renders based on x and y axis value.

    Declaration
    public ChartAnnotationBuilder CoordinateUnits(Units coordinateUnits)
    Parameters
    Type Name Description
    Units coordinateUnits
    Returns
    Type Description
    ChartAnnotationBuilder

    Description(String)

    Information about annotation for assistive technology.

    Declaration
    public ChartAnnotationBuilder Description(string description)
    Parameters
    Type Name Description
    System.String description
    Returns
    Type Description
    ChartAnnotationBuilder

    HorizontalAlignment(Alignment)

    Specifies the alignment of the annotation. They are Near - Align the annotation element as left side. Far - Align the annotation element as right side. Center - Align the annotation element as mid point.

    Declaration
    public ChartAnnotationBuilder HorizontalAlignment(Alignment horizontalAlignment)
    Parameters
    Type Name Description
    Alignment horizontalAlignment
    Returns
    Type Description
    ChartAnnotationBuilder

    Region(Regions)

    Specifies the regions of the annotation. They are Chart - Annotation renders based on chart coordinates. Series - Annotation renders based on series coordinates.

    Declaration
    public ChartAnnotationBuilder Region(Regions region)
    Parameters
    Type Name Description
    Regions region
    Returns
    Type Description
    ChartAnnotationBuilder

    VerticalAlignment(Position)

    Specifies the position of the annotation. They are Top - Align the annotation element as top side. Bottom - Align the annotation element as bottom side. Middle - Align the annotation element as mid point.

    Declaration
    public ChartAnnotationBuilder VerticalAlignment(Position verticalAlignment)
    Parameters
    Type Name Description
    Position verticalAlignment
    Returns
    Type Description
    ChartAnnotationBuilder

    X(Object)

    if set coordinateUnit as Pixel X specifies the axis value else is specifies pixel or percentage of coordinate

    Declaration
    public ChartAnnotationBuilder X(object x)
    Parameters
    Type Name Description
    System.Object x
    Returns
    Type Description
    ChartAnnotationBuilder

    XAxisName(String)

    The name of horizontal axis associated with the annotation. It requires axes of chart.

    Declaration
    public ChartAnnotationBuilder XAxisName(string xAxisName)
    Parameters
    Type Name Description
    System.String xAxisName
    Returns
    Type Description
    ChartAnnotationBuilder

    Y(Double)

    if set coordinateUnit as Pixel Y specifies the axis value else is specifies pixel or percentage of coordinate

    Declaration
    public ChartAnnotationBuilder Y(double y)
    Parameters
    Type Name Description
    System.Double y
    Returns
    Type Description
    ChartAnnotationBuilder

    Y(String)

    if set coordinateUnit as Pixel Y specifies the axis value else is specifies pixel or percentage of coordinate

    Declaration
    public ChartAnnotationBuilder Y(string y)
    Parameters
    Type Name Description
    System.String y
    Returns
    Type Description
    ChartAnnotationBuilder

    YAxisName(String)

    The name of vertical axis associated with the annotation. It requires axes of chart.

    Declaration
    public ChartAnnotationBuilder YAxisName(string yAxisName)
    Parameters
    Type Name Description
    System.String yAxisName
    Returns
    Type Description
    ChartAnnotationBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved