Class MapsLegendSettingsBuilder
Inheritance
System.Object
MapsLegendSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class MapsLegendSettingsBuilder : ControlBuilder
Constructors
MapsLegendSettingsBuilder()
Declaration
public MapsLegendSettingsBuilder()
MapsLegendSettingsBuilder(MapsLegendSettings)
Declaration
public MapsLegendSettingsBuilder(MapsLegendSettings model)
Parameters
Methods
Alignment(Alignment)
Gets or sets the alignment of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Alignment(Alignment value)
Parameters
Returns
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
Border(MapsBorder)
Gets or sets the options for customizing the style properties of the legend border.
Declaration
public MapsLegendSettingsBuilder Border(MapsBorder value)
Parameters
Returns
Border(Action<MapsBorderBuilder>)
Declaration
public MapsLegendSettingsBuilder Border(Action<MapsBorderBuilder> border)
Parameters
Returns
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
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
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
LabelDisplayMode(LabelIntersectAction)
Gets or sets the action to perform when the legend item text intersects with others.
Declaration
public MapsLegendSettingsBuilder LabelDisplayMode(LabelIntersectAction value)
Parameters
Returns
LabelPosition(LabelPosition)
Gets or sets the position of the label in legend.
Declaration
public MapsLegendSettingsBuilder LabelPosition(LabelPosition value)
Parameters
Returns
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
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
Returns
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
Orientation(LegendArrangement)
Gets or sets the orientation of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Orientation(LegendArrangement value)
Parameters
Returns
Position(LegendPosition)
Gets or sets the position of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Position(LegendPosition value)
Parameters
Returns
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
Shape(LegendShape)
Gets or sets the shape of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Shape(LegendShape value)
Parameters
Returns
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
Returns
ShapeBorder(Action<MapsBorderBuilder>)
Declaration
public MapsLegendSettingsBuilder ShapeBorder(Action<MapsBorderBuilder> shapeBorder)
Parameters
Returns
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
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
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
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
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
Returns
TextStyle(Action<MapsFontBuilder>)
Declaration
public MapsLegendSettingsBuilder TextStyle(Action<MapsFontBuilder> textStyle)
Parameters
Returns
Title(MapsCommonTitleSettings)
Gets or sets the title for the legend in maps.
Declaration
public MapsLegendSettingsBuilder Title(MapsCommonTitleSettings value)
Parameters
Returns
Title(Action<MapsCommonTitleSettingsBuilder>)
Declaration
public MapsLegendSettingsBuilder Title(Action<MapsCommonTitleSettingsBuilder> title)
Parameters
Returns
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
Returns
TitleStyle(Action<MapsFontBuilder>)
Declaration
public MapsLegendSettingsBuilder TitleStyle(Action<MapsFontBuilder> titleStyle)
Parameters
Returns
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
Returns
ToggleLegendSettings(Action<MapsToggleLegendSettingsBuilder>)
Declaration
public MapsLegendSettingsBuilder ToggleLegendSettings(Action<MapsToggleLegendSettingsBuilder> toggleLegendSettings)
Parameters
Returns
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(LegendType)
Gets or sets the type of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Type(LegendType value)
Parameters
Returns
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
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
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
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
