Class CircularGaugeAxis

Represents settings for customizing an axis of the circular gauge.

Inheritance

System.Object

CircularGaugeAxis

Namespace: Syncfusion.Blazor.CircularGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class CircularGaugeAxis : OwningComponentBase

Constructors

CircularGaugeAxis()

Declaration

public CircularGaugeAxis()

Properties

Background

Gets or sets the content to be rendered within the UI component.

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String	A Microsoft.AspNetCore.Components.RenderFragment specifying the children elements for this component.

Remarks

This property allows integration of custom UI content within the axis configuration.

ChildContent

Gets or sets the content to be rendered within the UI component.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment specifying the children elements for this component.

Remarks

This property allows integration of custom UI content within the axis configuration.

Direction

Gets or sets the direction of the axis.

Declaration

public GaugeDirection Direction { get; set; }

Property Value

Type	Description
GaugeDirection	A GaugeDirection value indicating the direction of the axis, with default as ClockWise.

Remarks

This property helps define whether the axis is displayed in a ClockWise or AntiClockWise manner.

EndAngle

Gets or sets the end angle of the axis.

Declaration

public double EndAngle { get; set; }

Property Value

Type	Description
System.Double	A double representing the end angle of the axis, with default value of 160.

Remarks

Defines the point where the axis completes its sweep in the gauge.

HideIntersectingLabel

Gets or sets whether intersecting labels are hidden.

Declaration

public bool HideIntersectingLabel { get; set; }

Property Value

Type	Description
System.Boolean	true if intersecting labels should be hidden; otherwise, false.

Remarks

Helps maintain label clarity by preventing text overlap.

Maximum

Gets or sets the maximum value of the axis.

Declaration

public double Maximum { get; set; }

Property Value

Type	Description
System.Double	A double representing the maximum axis value.

Remarks

This defines the upper bound of the axis scale.

Minimum

Gets or sets the minimum value of the axis.

Declaration

public double Minimum { get; set; }

Property Value

Type	Description
System.Double	A double representing the minimum axis value.

Remarks

This defines the lower bound of the axis scale.

Radius

Gets or sets the radius of the axis.

Declaration

public string Radius { get; set; }

Property Value

Type	Description
System.String	A string representing the radius in percentage or absolute units.

Remarks

Adjusts how far the axis extends from the center.

RangeGap

Gets or sets the gap between ranges on the axis.

Declaration

public double RangeGap { get; set; }

Property Value

Type	Description
System.Double	A double representing the gap between ranges.

Remarks

Helps visually separate distinct value ranges on the axis.

RoundingPlaces

Gets or sets rounding precision for axis labels.

Declaration

public int RoundingPlaces { get; set; }

Property Value

Type	Description
System.Int32	An integer indicating decimal places for label rounding.

Remarks

Controls numeric precision displayed on axis labels.

ShowLastLabel

Gets or sets whether the last label of the axis is shown.

Declaration

public bool ShowLastLabel { get; set; }

Property Value

Type	Description
System.Boolean	true if the last label should be shown; otherwise, false.

Remarks

This is useful for displaying terminal label positions on the axis.

StartAndEndRangeGap

Gets or sets whether to enable start and end gaps between ranges and the axis.

Declaration

public bool StartAndEndRangeGap { get; set; }

Property Value

Type	Description
System.Boolean	true to enable gaps; otherwise, false.

Remarks

Provides visual separation at the axis start and end points.

StartAngle

Gets or sets the start angle of the axis.

Declaration

public double StartAngle { get; set; }

Property Value

Type	Description
System.Double	A double representing the start angle of the axis, with default value 200.

Remarks

Defines the initial point of axis sweep in 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.