Class LinearGaugeAxisLabelStyle
Defines the style of the axis label in the linear gauge component. This class provides customizable properties to determine the appearance of axis labels.
Inheritance
Namespace: Syncfusion.Blazor.LinearGauge
Assembly: Syncfusion.Blazor.dll
Syntax
public class LinearGaugeAxisLabelStyle : OwningComponentBaseConstructors
LinearGaugeAxisLabelStyle()
Declaration
public LinearGaugeAxisLabelStyle()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 that contains child content defining the element's UI. |
Remarks
This is typically used to specify custom content within the axis label style.
Format
Gets or sets the format for the axis label. This property accepts any global format string like 'C', 'n1', 'P', etc. Also accepts placeholders like '{value}°C', where 'value' represents the axis label, e.g., 20°C.
Declaration
public string Format { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | A System.String specifying the format applied to the axis label values. |
Remarks
Format helps in rendering the axis labels with specific formats such as currency, percentage, or any custom format.
Offset
Gets or sets the value to position the axis labels in linear gauge.
Declaration
public double Offset { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | A System.Double representing the offset of the axis labels from their default position. |
Remarks
Offset allows customization of the position of the labels on the gauge axis, providing a way to fine-tune label placement.
Position
Gets or sets the position of the axis label in linear gauge.
Declaration
public Position Position { get; set; }Property Value
| Type | Description |
|---|---|
| Position | A Position enumeration value specifying the label position, with a default of |
Remarks
This property controls whether labels are positioned inside or outside the gauge.
UseRangeColor
Gets or sets a value indicating whether or not to use the range color to the labels.
Declaration
public bool UseRangeColor { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | A System.Boolean indicating if the label should use the associated range color. |
Remarks
When set to true, labels will be colored according to the color of the range they belong to.
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. |