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
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
MapsToggleLegendSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Maps
Assembly: Syncfusion.Blazor.dll
Syntax
public class MapsToggleLegendSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

MapsToggleLegendSettings()

Declaration
public MapsToggleLegendSettings()

Properties

ApplyShapeSettings

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

Declaration
[Parameter]
public bool ApplyShapeSettings { get; set; }
Property Value
Type Description
bool

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
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
RenderFragment

A 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
[Parameter]
public bool Enable { get; set; }
Property Value
Type Description
bool

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
[Parameter]
public string Fill { get; set; }
Property Value
Type Description
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
[Parameter]
public double Opacity { get; set; }
Property Value
Type Description
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
RenderTreeBuilder __builder
Overrides

Dispose(bool)

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
bool disposing
Overrides

OnInitializedAsync()

OnInitializedAsync method is called when the component has received its initial parameters.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

Task representing the asynchronous operation.
Overrides

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
Task

Task representing the asynchronous operation.
Overrides

Implements