Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ChartAnnotation - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class ChartAnnotation

    Annotation is a user defined HTML element that can be placed on chart We can use annotations to pile up the visual elegance of the chart. Specifies the customization of annotation.

    Inheritance
    System.Object
    Syncfusion.Blazor.SfBaseComponent
    SfDataBoundComponent
    ChartAnnotation
    Inherited Members
    SfDataBoundComponent.SetDataManager<T>(Object)
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    Namespace: Syncfusion.Blazor.Charts
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class ChartAnnotation : SfDataBoundComponent

    Constructors

    ChartAnnotation()

    Declaration
    public ChartAnnotation()

    Properties

    ChildContent

    Child Content for the Chart Annotation

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    Content

    Content of the annotation, which accepts the custom element as a string.

    Declaration
    public string Content { get; set; }
    Property Value
    Type Description
    System.String

    ContentTemplate

    Content Template for the annotation

    Declaration
    public RenderFragment ContentTemplate { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    CoordinateUnits

    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 Units CoordinateUnits { get; set; }
    Property Value
    Type Description
    Units

    Description

    Information about annotation for assistive technology.

    Declaration
    public string Description { get; set; }
    Property Value
    Type Description
    System.String

    Region

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

    Declaration
    public Regions Region { get; set; }
    Property Value
    Type Description
    Regions

    X

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

    Declaration
    public object X { get; set; }
    Property Value
    Type Description
    System.Object

    XAxisName

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

    Declaration
    public string XAxisName { get; set; }
    Property Value
    Type Description
    System.String

    Y

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

    Declaration
    public string Y { get; set; }
    Property Value
    Type Description
    System.String

    YAxisName

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

    Declaration
    public string YAxisName { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnParametersSetAsync()
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved