menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MapsToggleLegendSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class MapsToggleLegendSettings

    Sets and gets the options for customizing the color and width of the shape related to the legend on selecting the legend.

    Inheritance
    System.Object
    MapsToggleLegendSettings
    Namespace: Syncfusion.Blazor.Maps
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class MapsToggleLegendSettings : OwningComponentBase

    Constructors

    MapsToggleLegendSettings()

    Declaration
    public MapsToggleLegendSettings()

    Properties

    ApplyShapeSettings

    Enables or disables the property of the shape settings to be displayed while clicking the legend.

    Declaration
    public bool ApplyShapeSettings { get; set; }
    Property Value
    Type Description
    System.Boolean

    A boolean indicating whether shape settings should be applied when the legend is clicked. Defaults to true.

    Remarks

    This property determines whether clicking on a legend item should apply specific shape settings.

    ChildContent

    Sets and gets 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 representing the template content of the UI element.

    Remarks

    This property allows custom content to be rendered inside the legend toggle settings.

    Enable

    Enables or disables the legend toggle functionality.

    Declaration
    public bool Enable { get; set; }
    Property Value
    Type Description
    System.Boolean

    A boolean indicating whether the legend can be toggled. Defaults to false.

    Remarks

    This property controls whether the legend items can be toggled by user interaction.

    Fill

    Sets and gets the fill color for the shape corresponding to the selected legend.

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

    A string representing the fill color. Defaults to an empty string.

    Remarks

    This property allows customization of the shape's fill color when its legend is selected.

    Opacity

    Sets and gets the opacity for the shape corresponding to the selected legend.

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

    A double value representing the opacity. Defaults to 1.

    Remarks

    This property adjusts the transparency level of the shape when its legend is selected.

    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.

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