Class MapsLegendSettingsBuilder
Inheritance
System.Object
MapsLegendSettingsBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
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)
Sets and gets the alignment for the legend in maps.
Declaration
public MapsLegendSettingsBuilder Alignment(Alignment value)
Parameters
Returns
Background(String)
Sets and gets the background color for the legend in maps.
Declaration
public MapsLegendSettingsBuilder Background(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Border(MapsBorder)
Sets and gets the options for customizing the color and width 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)
Sets and gets the color of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Fill(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Height(String)
Sets and gets 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)
Sets and gets the display mode for the label in legend.
Declaration
public MapsLegendSettingsBuilder LabelDisplayMode(LabelIntersectAction value)
Parameters
Returns
LabelPosition(LabelPosition)
Sets and gets the position of the label in legend.
Declaration
public MapsLegendSettingsBuilder LabelPosition(LabelPosition value)
Parameters
Returns
Location(Object)
Sets and gets the location of the legend, given by x and y values.
Declaration
public MapsLegendSettingsBuilder Location(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Mode(LegendMode)
Sets and gets 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)
Sets and gets the opacity for the legend in maps.
Declaration
public MapsLegendSettingsBuilder Opacity(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Orientation(LegendArrangement)
Sets and gets the orientation of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Orientation(LegendArrangement value)
Parameters
Returns
Position(LegendPosition)
Sets and gets the position of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Position(LegendPosition value)
Parameters
Returns
RemoveDuplicateLegend(Boolean)
Enables or disables to remove the duplicate legend item.
Declaration
public MapsLegendSettingsBuilder RemoveDuplicateLegend(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Shape(LegendShape)
Sets and gets the shape of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Shape(LegendShape value)
Parameters
Returns
ShapeBorder(MapsBorder)
Sets and gets the options for customizing the color and width of the border for the shape in legend.
Declaration
public MapsLegendSettingsBuilder ShapeBorder(MapsBorder value)
Parameters
Returns
ShapeBorder(Action<MapsBorderBuilder>)
Declaration
public MapsLegendSettingsBuilder ShapeBorder(Action<MapsBorderBuilder> shapeBorder)
Parameters
Returns
ShapeHeight(Double)
Sets and gets the width of the shapes in legend.
Declaration
public MapsLegendSettingsBuilder ShapeHeight(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapePadding(Double)
Sets and gets the padding for the shapes in legend.
Declaration
public MapsLegendSettingsBuilder ShapePadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapeWidth(Double)
Sets and gets the width of the shapes in legend.
Declaration
public MapsLegendSettingsBuilder ShapeWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShowLegendPath(String)
Sets and gets the path for the legend from the data source to be shown.
Declaration
public MapsLegendSettingsBuilder ShowLegendPath(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
TextStyle(MapsFont)
Sets and gets the options for customizing the text styles for the legend in maps.
Declaration
public MapsLegendSettingsBuilder TextStyle(MapsFont value)
Parameters
Returns
TextStyle(Action<MapsFontBuilder>)
Declaration
public MapsLegendSettingsBuilder TextStyle(Action<MapsFontBuilder> textStyle)
Parameters
Returns
Title(MapsCommonTitleSettings)
Sets and gets 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)
Sets and gets the options for customizing the style of the title for 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)
Sets and gets the options for customizing the color and width of the shape related to the legend on 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 for legend in maps.
Declaration
public MapsLegendSettingsBuilder ToggleVisibility(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Type(LegendType)
Sets and gets 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 value from the data source for legend.
Declaration
public MapsLegendSettingsBuilder ValuePath(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Visible(Boolean)
Enables or disables the visibility state of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Visible(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Width(String)
Sets and gets the width of the legend in maps.
Declaration
public MapsLegendSettingsBuilder Width(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
