menu

ASP.NET Core - EJ2

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MapsLegendSettingsBuilder - API Reference

    Show / Hide Table of Contents

    Class MapsLegendSettingsBuilder

    Inheritance
    System.Object
    ControlBuilder
    MapsLegendSettingsBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    Namespace: Syncfusion.EJ2.Maps
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class MapsLegendSettingsBuilder : ControlBuilder

    Constructors

    MapsLegendSettingsBuilder()

    Declaration
    public MapsLegendSettingsBuilder()

    MapsLegendSettingsBuilder(MapsLegendSettings)

    Declaration
    public MapsLegendSettingsBuilder(MapsLegendSettings model)
    Parameters
    Type Name Description
    MapsLegendSettings model

    Methods

    Alignment(Alignment)

    Gets or sets the alignment of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Alignment(Alignment value)
    Parameters
    Type Name Description
    Alignment value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Background(String)

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

    Declaration
    public MapsLegendSettingsBuilder Background(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Border(MapsBorder)

    Gets or sets the options for customizing the style properties of the legend border.

    Declaration
    public MapsLegendSettingsBuilder Border(MapsBorder value)
    Parameters
    Type Name Description
    MapsBorder value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Border(Action<MapsBorderBuilder>)

    Declaration
    public MapsLegendSettingsBuilder Border(Action<MapsBorderBuilder> border)
    Parameters
    Type Name Description
    System.Action<MapsBorderBuilder> border
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Fill(String)

    Gets or sets the color of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Fill(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Height(String)

    Gets or sets the height of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Height(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    InvertedPointer(Boolean)

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

    Declaration
    public MapsLegendSettingsBuilder InvertedPointer(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    LabelDisplayMode(LabelIntersectAction)

    Gets or sets the action to perform when the legend item text intersects with others.

    Declaration
    public MapsLegendSettingsBuilder LabelDisplayMode(LabelIntersectAction value)
    Parameters
    Type Name Description
    LabelIntersectAction value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    LabelPosition(LabelPosition)

    Gets or sets the position of the label in legend.

    Declaration
    public MapsLegendSettingsBuilder LabelPosition(LabelPosition value)
    Parameters
    Type Name Description
    LabelPosition value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Location(Object)

    Gets or sets the location of the legend in pixels when the legend position is set as Float.

    Declaration
    public MapsLegendSettingsBuilder Location(object value)
    Parameters
    Type Name Description
    System.Object value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Mode(LegendMode)

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

    Declaration
    public MapsLegendSettingsBuilder Mode(LegendMode value)
    Parameters
    Type Name Description
    LegendMode value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Opacity(Double)

    Gets or sets the opacity for the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Opacity(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Orientation(LegendArrangement)

    Gets or sets the orientation of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Orientation(LegendArrangement value)
    Parameters
    Type Name Description
    LegendArrangement value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Position(LegendPosition)

    Gets or sets the position of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Position(LegendPosition value)
    Parameters
    Type Name Description
    LegendPosition value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    RemoveDuplicateLegend(Boolean)

    Enables or disables the ability to remove the duplicate legend item.

    Declaration
    public MapsLegendSettingsBuilder RemoveDuplicateLegend(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Shape(LegendShape)

    Gets or sets the shape of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Shape(LegendShape value)
    Parameters
    Type Name Description
    LegendShape value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ShapeBorder(MapsBorder)

    Gets or sets the options for customizing the style properties of the border of the shapes of the legend items.

    Declaration
    public MapsLegendSettingsBuilder ShapeBorder(MapsBorder value)
    Parameters
    Type Name Description
    MapsBorder value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ShapeBorder(Action<MapsBorderBuilder>)

    Declaration
    public MapsLegendSettingsBuilder ShapeBorder(Action<MapsBorderBuilder> shapeBorder)
    Parameters
    Type Name Description
    System.Action<MapsBorderBuilder> shapeBorder
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ShapeHeight(Double)

    Gets or sets the height of the shapes in legend.

    Declaration
    public MapsLegendSettingsBuilder ShapeHeight(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ShapePadding(Double)

    Gets or sets the padding for the shapes in legend.

    Declaration
    public MapsLegendSettingsBuilder ShapePadding(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ShapeWidth(Double)

    Gets or sets the width of the shapes in legend.

    Declaration
    public MapsLegendSettingsBuilder ShapeWidth(double value)
    Parameters
    Type Name Description
    System.Double value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ShowLegendPath(String)

    Gets or sets the field name from the data source which is used to provide visibility state for each legend item.

    Declaration
    public MapsLegendSettingsBuilder ShowLegendPath(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    TextStyle(MapsFont)

    Gets or sets the options for customizing the text styles of the legend item text in maps.

    Declaration
    public MapsLegendSettingsBuilder TextStyle(MapsFont value)
    Parameters
    Type Name Description
    MapsFont value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    TextStyle(Action<MapsFontBuilder>)

    Declaration
    public MapsLegendSettingsBuilder TextStyle(Action<MapsFontBuilder> textStyle)
    Parameters
    Type Name Description
    System.Action<MapsFontBuilder> textStyle
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Title(MapsCommonTitleSettings)

    Gets or sets the title for the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Title(MapsCommonTitleSettings value)
    Parameters
    Type Name Description
    MapsCommonTitleSettings value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Title(Action<MapsCommonTitleSettingsBuilder>)

    Declaration
    public MapsLegendSettingsBuilder Title(Action<MapsCommonTitleSettingsBuilder> title)
    Parameters
    Type Name Description
    System.Action<MapsCommonTitleSettingsBuilder> title
    Returns
    Type Description
    MapsLegendSettingsBuilder

    TitleStyle(MapsFont)

    Gets or sets the options for customizing the style of the title of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder TitleStyle(MapsFont value)
    Parameters
    Type Name Description
    MapsFont value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    TitleStyle(Action<MapsFontBuilder>)

    Declaration
    public MapsLegendSettingsBuilder TitleStyle(Action<MapsFontBuilder> titleStyle)
    Parameters
    Type Name Description
    System.Action<MapsFontBuilder> titleStyle
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ToggleLegendSettings(MapsToggleLegendSettings)

    Gets or sets the options for customizing the color and border width of the shape related to the legend when selecting the legend.

    Declaration
    public MapsLegendSettingsBuilder ToggleLegendSettings(MapsToggleLegendSettings value)
    Parameters
    Type Name Description
    MapsToggleLegendSettings value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ToggleLegendSettings(Action<MapsToggleLegendSettingsBuilder>)

    Declaration
    public MapsLegendSettingsBuilder ToggleLegendSettings(Action<MapsToggleLegendSettingsBuilder> toggleLegendSettings)
    Parameters
    Type Name Description
    System.Action<MapsToggleLegendSettingsBuilder> toggleLegendSettings
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ToggleVisibility(Boolean)

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

    Declaration
    public MapsLegendSettingsBuilder ToggleVisibility(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Type(LegendType)

    Gets or sets the type of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Type(LegendType value)
    Parameters
    Type Name Description
    LegendType value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    UseMarkerShape(Boolean)

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

    Declaration
    public MapsLegendSettingsBuilder UseMarkerShape(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    ValuePath(String)

    Set and gets the field name from the data source to display the legend item text.

    Declaration
    public MapsLegendSettingsBuilder ValuePath(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Visible(Boolean)

    Enables or disables the visibility of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Visible(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    MapsLegendSettingsBuilder

    Width(String)

    Gets or sets the width of the legend in maps.

    Declaration
    public MapsLegendSettingsBuilder Width(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    MapsLegendSettingsBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved