Class MapsLegendSettings

Gets or sets the option for the customization of legend for the maps.

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

Constructors

MapsLegendSettings()

Declaration
public MapsLegendSettings()

Properties

Alignment

Gets or sets the alignment for the legend in maps.

Declaration
public Alignment Alignment { get; set; }
Property Value
Type Description
Alignment

Background

Gets or sets the background color for the legend in maps.

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

Fill

Gets or sets the color of the legend in maps.

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

Height

Gets or sets the height of the legend in maps.

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

InvertedPointer

Enables or disables the visibility of the inverted pointer in interactive legend in maps.

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

LabelDisplayMode

Gets or sets the display mode for the label in legend.

Declaration
public LabelIntersectAction LabelDisplayMode { get; set; }
Property Value
Type Description
LabelIntersectAction

LabelPosition

Gets or sets the position of the label in legend.

Declaration
public LabelPosition LabelPosition { get; set; }
Property Value
Type Description
LabelPosition

Mode

Gets or sets the mode of the legend in maps. The modes available are default and interactive modes.

Declaration
public LegendMode Mode { get; set; }
Property Value
Type Description
LegendMode

Opacity

Gets or sets the opacity for the legend in maps.

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

Orientation

Gets or sets the orientation of the legend in maps.

Declaration
public LegendArrangement Orientation { get; set; }
Property Value
Type Description
LegendArrangement

Position

Gets or sets the position of the legend in maps.

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

RemoveDuplicateLegend

Enables or disables to remove the duplicate legend item.

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

Shape

Gets or sets the shape of the legend in maps.

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

ShapeHeight

Gets or sets the width of the shapes in legend.

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

ShapePadding

Gets or sets the padding for the shapes in legend.

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

ShapeWidth

Gets or sets the width of the shapes in legend.

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

ShowLegendPath

Gets or sets the path for the legend from the data source to be shown.

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

ToggleVisibility

Enables or disables the toggle visibility for legend in maps.

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

Type

Gets or sets the type of the legend in maps.

Declaration
public LegendType Type { get; set; }
Property Value
Type Description
LegendType

UseMarkerShape

Enables or disables to render the legend item based on the shapes from the data source of markers.

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

ValuePath

Set and gets the value from the data source for legend.

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

Visible

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

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

Width

Gets or sets the width of the legend in maps.

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

X

Gets or sets the horizontal position of the legend when the position of the legend is set as Float type.

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

Y

Gets or sets the vertical position of the legend when the position of the legend is set as Float type.

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

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.