Class CircularGaugeAxisLabelStyle

Defines the options to configure the style of the axis labels in the circular gauge component.

Inheritance

System.Object

CircularGaugeAxisLabelStyle

Namespace: Syncfusion.Blazor.CircularGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class CircularGaugeAxisLabelStyle : OwningComponentBase

Constructors

CircularGaugeAxisLabelStyle()

Declaration

public CircularGaugeAxisLabelStyle()

Properties

AutoAngle

Gets or sets a value indicating whether the labels are rotated along the axis in the circular gauge component.

Declaration

public bool AutoAngle { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean indicating rotation state. Default is false.

Remarks

Enabling this option allows labels to be positioned at an angle consistent with the axis.

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 of the UI element.

Remarks

This property allows specifying custom content inside the UI element.

Format

Gets or sets the format for the axis label.

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String	A System.String representing the format for the axis label. Default is String.Empty.

Remarks

Supports global string formats such as 'C', 'n1', 'P', and custom formats like '{value}°C'.

HiddenLabel

Gets or sets the label option that determines when a label is hidden if an axis completes a circle.

Declaration

public HiddenLabel HiddenLabel { get; set; }

Property Value

Type	Description
HiddenLabel	A HiddenLabel enumeration value specifying label visibility. Default is None.

Remarks

Useful for managing label overlap in circular axes.

Offset

Gets or sets the offset distance for the labels from the axis in the circular gauge.

Declaration

public double Offset { get; set; }

Property Value

Type	Description
System.Double	A System.Double representing the offset. Default is 0.

Remarks

Use this property to adjust the distance of labels from the axis.

Position

Gets or sets the position type to arrange labels along the axis.

Declaration

public Position Position { get; set; }

Property Value

Type	Description
Position	A Position value indicating the label position. Default is Inside.

Remarks

Determines whether labels are positioned inside or outside the axis.

ShouldMaintainPadding

Gets or sets a value indicating whether to maintain default padding for axis labels.

Declaration

public bool ShouldMaintainPadding { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean value indicating if default padding is maintained. Default is true.

Remarks

When true, default padding is maintained between axis labels and their environment.

UseRangeColor

Gets or sets a value indicating whether to use range colors for axis labels.

Declaration

public bool UseRangeColor { get; set; }

Property Value

Type	Description
System.Boolean	A System.Boolean that indicates if range colors are used. Default is false.

Remarks

Range-based coloring can be used to reflect value ranges via label coloring.

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.