Class CircularGaugeAxis
Represents settings for customizing an axis of the circular gauge.
Inherited Members
Namespace: Syncfusion.Blazor.CircularGauge
Assembly: Syncfusion.Blazor.dll
Syntax
public class CircularGaugeAxis : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Constructors
CircularGaugeAxis()
Declaration
public CircularGaugeAxis()
Properties
Background
Gets or sets the content to be rendered within the UI component.
Declaration
[Parameter]
public string Background { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A 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
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
| Type | Description |
|---|---|
| RenderFragment | A 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
[Parameter]
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
[Parameter]
public double EndAngle { get; set; }
Property Value
| Type | Description |
|---|---|
| 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
[Parameter]
public bool HideIntersectingLabel { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
Remarks
Helps maintain label clarity by preventing text overlap.
Maximum
Gets or sets the maximum value of the axis.
Declaration
[Parameter]
public double Maximum { get; set; }
Property Value
| Type | Description |
|---|---|
| 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
[Parameter]
public double Minimum { get; set; }
Property Value
| Type | Description |
|---|---|
| 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
[Parameter]
public string Radius { get; set; }
Property Value
| Type | Description |
|---|---|
| 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
[Parameter]
public double RangeGap { get; set; }
Property Value
| Type | Description |
|---|---|
| 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
[Parameter]
public int RoundingPlaces { get; set; }
Property Value
| Type | Description |
|---|---|
| int | 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
[Parameter]
public bool ShowLastLabel { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
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
[Parameter]
public bool StartAndEndRangeGap { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
Remarks
Provides visual separation at the axis start and end points.
StartAngle
Gets or sets the start angle of the axis.
Declaration
[Parameter]
public double StartAngle { get; set; }
Property Value
| Type | Description |
|---|---|
| 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 |
|---|---|---|
| RenderTreeBuilder | __builder |
Overrides
Dispose(bool)
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 |
|---|---|---|
| bool | disposing |
Overrides
OnInitializedAsync()
OnInitializedAsync method is called when the component has received its initial parameters.
Declaration
protected override Task OnInitializedAsync()
Returns
| Type | Description |
|---|---|
| Task | Task representing the asynchronous operation. |
Overrides
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 |
|---|---|
| Task | Task representing the asynchronous operation. |