Class MapsLegendSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

MapsLegendSettings

Namespace: Syncfusion.EJ2.Maps

Assembly: Syncfusion.EJ2.dll

Syntax

public class MapsLegendSettings : EJTagHelper

Constructors

MapsLegendSettings()

Declaration

public MapsLegendSettings()

Properties

Alignment

Gets or sets the alignment of the legend in maps.

Declaration

public Alignment Alignment { get; set; }

Property Value

Type	Description
Alignment	The default value is Syncfusion.EJ2.Maps.Alignment.Center

Background

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

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String	The default value is "transparent"

Border

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

Declaration

public MapsBorder Border { get; set; }

Property Value

Type	Description
MapsBorder	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

Fill

Gets or sets the color of the legend in maps.

Declaration

public string Fill { get; set; }

Property Value

Type	Description
System.String	The default value is null

Height

Gets or sets the height of the legend in maps.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String	The default value is ""

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	The default value is false

LabelDisplayMode

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

Declaration

public LabelIntersectAction LabelDisplayMode { get; set; }

Property Value

Type	Description
LabelIntersectAction	The default value is LabelIntersectAction.None

LabelPosition

Gets or sets the position of the label in legend.

Declaration

public LabelPosition LabelPosition { get; set; }

Property Value

Type	Description
LabelPosition	The default value is LabelPosition.After

Location

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

Declaration

public object Location { get; set; }

Property Value

Type	Description
System.Object	The default value is null

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	The default value is LegendMode.Default

Opacity

Gets or sets the opacity for the legend in maps.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

Orientation

Gets or sets the orientation of the legend in maps.

Declaration

public LegendArrangement Orientation { get; set; }

Property Value

Type	Description
LegendArrangement	The default value is LegendArrangement.None

Position

Gets or sets the position of the legend in maps.

Declaration

public LegendPosition Position { get; set; }

Property Value

Type	Description
LegendPosition	The default value is LegendPosition.Bottom

RemoveDuplicateLegend

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

Declaration

public bool RemoveDuplicateLegend { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Shape

Gets or sets the shape of the legend in maps.

Declaration

public LegendShape Shape { get; set; }

Property Value

Type	Description
LegendShape	The default value is LegendShape.Circle

ShapeBorder

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

Declaration

public MapsBorder ShapeBorder { get; set; }

Property Value

Type	Description
MapsBorder	The default value is null

ShapeHeight

Gets or sets the height of the shapes in legend.

Declaration

public double ShapeHeight { get; set; }

Property Value

Type	Description
System.Double	The default value is 15

ShapePadding

Gets or sets the padding for the shapes in legend.

Declaration

public double ShapePadding { get; set; }

Property Value

Type	Description
System.Double	The default value is 10

ShapeWidth

Gets or sets the width of the shapes in legend.

Declaration

public double ShapeWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 15

ShowLegendPath

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

Declaration

public string ShowLegendPath { get; set; }

Property Value

Type	Description
System.String	The default value is null

TextStyle

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

Declaration

public MapsFont TextStyle { get; set; }

Property Value

Type	Description
MapsFont	The default value is null

Title

Gets or sets the title for the legend in maps.

Declaration

public MapsCommonTitleSettings Title { get; set; }

Property Value

Type	Description
MapsCommonTitleSettings	The default value is null

TitleStyle

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

Declaration

public MapsFont TitleStyle { get; set; }

Property Value

Type	Description
MapsFont	The default value is null

ToggleLegendSettings

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 MapsToggleLegendSettings ToggleLegendSettings { get; set; }

Property Value

Type	Description
MapsToggleLegendSettings	The default value is null

ToggleVisibility

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

Declaration

public bool ToggleVisibility { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Type

Gets or sets the type of the legend in maps.

Declaration

public LegendType Type { get; set; }

Property Value

Type	Description
LegendType	The default value is LegendType.Layers

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	The default value is false

ValuePath

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

Declaration

public string ValuePath { get; set; }

Property Value

Type	Description
System.String	The default value is null

Visible

Enables or disables the visibility of the legend in maps.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Width

Gets or sets the width of the legend in maps.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is ""