Class CircularGaugeLegendSettings

Sets and gets the options for customizing the legend of the circular gauge.

Inheritance

System.Object

CircularGaugeLegendSettings

Namespace: Syncfusion.Blazor.CircularGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class CircularGaugeLegendSettings : OwningComponentBase

Constructors

CircularGaugeLegendSettings()

Declaration

public CircularGaugeLegendSettings()

Properties

Alignment

Gets or sets the alignment of the legend in the circular gauge.

Declaration

public Alignment Alignment { get; set; }

Property Value

Type
Alignment

Background

Gets or sets the background color of the legend in circular gauge.

Declaration

public string Background { get; set; }

Property Value

Type
System.String

ChildContent

Gets or sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

Height

Gets or sets the height of the legend in the circular gauge.

Declaration

public string Height { get; set; }

Property Value

Type
System.String

Opacity

Gets or sets the opacity of the legend.

Declaration

public double Opacity { get; set; }

Property Value

Type
System.Double

Padding

Gets or sets the options to customize the padding between legend items.

Declaration

public double Padding { get; set; }

Property Value

Type
System.Double

Position

Gets or sets the position of the legend in the circular gauge.

Declaration

public LegendPosition Position { get; set; }

Property Value

Type
LegendPosition

Shape

Gets or sets the shape of the legend in circular gauge.

Declaration

public GaugeShape Shape { get; set; }

Property Value

Type
GaugeShape

ShapeHeight

Gets or sets the height of the legend shape in circular gauge.

Declaration

public double ShapeHeight { get; set; }

Property Value

Type
System.Double

ShapePadding

Gets or sets the padding for the legend shape in circular gauge.

Declaration

public double ShapePadding { get; set; }

Property Value

Type
System.Double

ShapeWidth

Gets or sets the width of the legend shape in circular gauge.

Declaration

public double ShapeWidth { get; set; }

Property Value

Type
System.Double

ToggleVisibility

Gets or sets a value indicating whether or not to enable the ranges visibility collapses based on the legend visibility.

Declaration

public bool ToggleVisibility { get; set; }

Property Value

Type
System.Boolean

Visible

Gets or sets a value indicating whether or not to enable the visibility of the legend in circular gauge.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Width

Gets or sets the width of the legend in the circular gauge.

Declaration

public string Width { get; set; }

Property Value

Type
System.String

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.