Class CircularGaugeAnnotation

Represents the annotation element for an axis in the circular gauge component.

Inheritance

System.Object

CircularGaugeAnnotation

Namespace: Syncfusion.Blazor.CircularGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class CircularGaugeAnnotation : OwningComponentBase

Constructors

CircularGaugeAnnotation()

Declaration

public CircularGaugeAnnotation()

Properties

Angle

Gets or sets the angle for the annotation with respect to the axis in the circular gauge component.

Declaration

public double Angle { get; set; }

Property Value

Type	Description
System.Double	A double representing the angle in degrees. The default value is 90.

Remarks

This property specifies the angle position of the annotation relative to the axis.

AutoAngle

Gets or sets a value indicating whether the annotation rotation along the axis is enabled.

Declaration

public bool AutoAngle { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true enables automatic rotation; otherwise, false.

Remarks

When enabled, the annotation will rotate automatically based on its position on the circular gauge.

ChildContent

Gets or sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment representing the child content to be rendered inside this component.

Remarks

This allows you to specify custom UI content for the annotation within the circular gauge.

Content

Gets or sets the content of the annotation.

Declaration

public string Content { get; set; }

Property Value

Type	Description
System.String	A string representing the textual content of the annotation.

Remarks

This is used for embedding text or descriptive content within the annotation.

ContentTemplate

Gets or sets the content of the annotation.

Declaration

public RenderFragment ContentTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment representing a template for the annotation content.

Remarks

This template allows for a flexible layout and content within the annotation.

Description

Gets or sets the information about the annotation for assistive technologies.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	A descriptive string for screen readers and other assistive technologies.

Remarks

This property enhances accessibility by providing additional context to users with disabilities.

Radius

Gets or sets the radius for the annotation with respect to the axis in the circular gauge component.

Declaration

public string Radius { get; set; }

Property Value

Type	Description
System.String	A string representing the radius, typically in percentage. The default value is "50%".

Remarks

Specifies the position of the annotation relative to the gauge's center.

ZIndex

Gets or sets the z-index of an annotation in an axis in the circular gauge component.

Declaration

public string ZIndex { get; set; }

Property Value

Type	Description
System.String	A string representing the z-index. The default value is "-1".

Remarks

This value determines the stacking order of the annotation within the gauge.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Disposes the property values during the destroy of the component that is hold up for the execution of the component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

OnInitializedAsync method is called when the component has received its initial parameters.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task representing the asynchronous operation.

OnParametersSetAsync()

OnParametersSetAsync is a lifecycle method that is invoked when the component has received parameters, and the incoming values have been assigned to the properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task representing the asynchronous operation.