Blazor

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

    Show / Hide Table of Contents

    Class MapsLegendSettings

    Sets and gets the option for the customization of legend for the maps.

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

    Constructors

    MapsLegendSettings()

    Declaration
    public MapsLegendSettings()

    Properties

    Alignment

    Sets and gets the alignment for the legend in maps.

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

    Background

    Sets and gets the background color for the legend in maps.

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

    ChildContent

    Sets and gets the content of the UI element.

    Declaration
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    Fill

    Sets and gets the color of the legend in maps.

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

    Height

    Sets and gets 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

    Sets and gets the display mode for the label in legend.

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

    LabelPosition

    Sets and gets the position of the label in legend.

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

    Location

    Sets and gets the location of the legend, given by x and y values.

    Declaration
    public object Location { get; set; }
    Property Value
    Type Description
    System.Object

    Mode

    Sets and gets 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

    Sets and gets the opacity for the legend in maps.

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

    Orientation

    Sets and gets the orientation of the legend in maps.

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

    Position

    Sets and gets 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

    Sets and gets the shape of the legend in maps.

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

    ShapeHeight

    Sets and gets the width of the shapes in legend.

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

    ShapePadding

    Sets and gets the padding for the shapes in legend.

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

    ShapeWidth

    Sets and gets the width of the shapes in legend.

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

    ShowLegendPath

    Sets and gets 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

    Sets and gets the type of the legend in maps.

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

    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

    Enables or disables the visibility state of the legend in maps.

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

    Width

    Sets and gets the width of the legend in maps.

    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()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved