Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class CircularGaugeLegendSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class CircularGaugeLegendSettings

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

    Inheritance
    System.Object
    SfBaseComponent
    CircularGaugeLegendSettings
    Inherited Members
    SfBaseComponent.OnAfterRenderAsync(Boolean)
    SfBaseComponent.Dispose()
    SfBaseComponent.Dispose(Boolean)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    Namespace: Syncfusion.Blazor.CircularGauge
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class CircularGaugeLegendSettings : SfBaseComponent

    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 Description
    Alignment

    Background

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

    Declaration
    public string Background { get; set; }
    Property Value
    Type Description
    System.String

    ChildContent

    Gets or sets the content of the UI element.

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    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 Description
    System.String

    Opacity

    Gets or sets the opacity of the legend.

    Declaration
    public double Opacity { get; set; }
    Property Value
    Type Description
    System.Double

    Padding

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

    Declaration
    public double Padding { get; set; }
    Property Value
    Type Description
    System.Double

    Position

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

    Declaration
    public LegendPosition Position { get; set; }
    Property Value
    Type Description
    LegendPosition

    Shape

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

    Declaration
    public GaugeShape Shape { get; set; }
    Property Value
    Type Description
    GaugeShape

    ShapeHeight

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

    Declaration
    public double ShapeHeight { get; set; }
    Property Value
    Type Description
    System.Double

    ShapePadding

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

    Declaration
    public double ShapePadding { get; set; }
    Property Value
    Type Description
    System.Double

    ShapeWidth

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

    Declaration
    public double ShapeWidth { get; set; }
    Property Value
    Type Description
    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 Description
    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 Description
    System.Boolean

    Width

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

    Declaration
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    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.

    Overrides
    SfBaseComponent.OnInitializedAsync()

    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.

    Back to top Generated by DocFX
    Copyright © 2001 - 2022 Syncfusion Inc. All Rights Reserved