Class LinearGaugeAxis

Defines the annotation element for an axis in linear gauge component.

Inheritance

System.Object

LinearGaugeAxis

Namespace: Syncfusion.Blazor.LinearGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class LinearGaugeAxis : OwningComponentBase

Remarks

The LinearGaugeAxis class defines properties and methods for configuring an axis in a linear gauge, including its scale, orientation, tick marks, and labels. It serves as a fundamental component for presenting numerical data in linear form within the gauge.

Constructors

LinearGaugeAxis()

Declaration

public LinearGaugeAxis()

Properties

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 encapsulating the child content for customizing the axis.

Remarks

This property allows embedding elements or components to further customize the appearance of the axis.

IsInversed

Gets or sets a value indicating whether or not to inverse the axis.

Declaration

public bool IsInversed { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value specifying whether the axis direction is reversed. Default is false.

Remarks

Inversing the axis can be useful for changing the orientation of scale representation in the gauge.

Maximum

Gets or sets the maximum value for the axis.

Declaration

public double Maximum { get; set; }

Property Value

Type	Description
System.Double	A System.Double specifying the upper bound of the axis range. Default is 100.

Remarks

This property defines the maximum limit of values displayed on the axis.

Minimum

Gets or sets the minimum value for the axis.

Declaration

public double Minimum { get; set; }

Property Value

Type	Description
System.Double	A System.Double specifying the lower bound of the axis range.

Remarks

This property defines the minimum limit of values displayed on the axis.

OpposedPosition

Gets or sets a value indicating whether or not to enable the opposed position of the axis in the linear gauge..

Declaration

public bool OpposedPosition { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value specifying whether the axis should be displayed on the opposite side. Default is false.

Remarks

Opposed position can be used to align the axis on the opposite side of the default configuration.

ShowLastLabel

Gets or sets a value indicating whether or not to show the last label in the linear gauge axis.

Declaration

public bool ShowLastLabel { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that specifies whether the last label should be shown. Default is false.

Remarks

Showing the last label is helpful when you want to provide clear indicators for endpoints of the scale.

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.