Class TreeMapLegendSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
TreeMapLegendSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeMapLegendSettingsBuilder : ControlBuilder
Constructors
TreeMapLegendSettingsBuilder()
Declaration
public TreeMapLegendSettingsBuilder()
TreeMapLegendSettingsBuilder(TreeMapLegendSettings)
Declaration
public TreeMapLegendSettingsBuilder(TreeMapLegendSettings model)
Parameters
Methods
Alignment(Alignment)
Sets and gets the alignment of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Alignment(Alignment value)
Parameters
Returns
Background(String)
Sets and gets the background color of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Background(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Border(TreeMapBorder)
Sets and gets the options for customizing the color and width of the border of the legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Border(TreeMapBorder value)
Parameters
Returns
Border(Action<TreeMapBorderBuilder>)
Declaration
public TreeMapLegendSettingsBuilder Border(Action<TreeMapBorderBuilder> border)
Parameters
Returns
Fill(String)
Sets and gets the shape color of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Fill(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Height(String)
Sets and gets the height of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Height(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
ImageUrl(String)
Sets and gets the URL path of the legend shapes that is set as image.
Declaration
public TreeMapLegendSettingsBuilder ImageUrl(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
InvertedPointer(Boolean)
Enables or disables the pointer for interactive legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder InvertedPointer(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
LabelDisplayMode(LabelIntersectAction)
Sets and gets the action of legend item text when they intersect with each other.
Declaration
public TreeMapLegendSettingsBuilder LabelDisplayMode(LabelIntersectAction value)
Parameters
Returns
LabelPosition(LabelPlacement)
Sets and gets the label position for interactive legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder LabelPosition(LabelPlacement value)
Parameters
Returns
Location(Object)
Sets and gets the location to place the legend in a custom location in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Location(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
Mode(LegendMode)
Sets and gets the mode of legend in the treemap. The modes available are default and interactive modes.
Declaration
public TreeMapLegendSettingsBuilder Mode(LegendMode value)
Parameters
Returns
Opacity(Double)
Sets and gets the opacity of the legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Opacity(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Orientation(LegendOrientation)
Sets and gets the orientation of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Orientation(LegendOrientation value)
Parameters
Returns
Position(LegendPosition)
Sets and gets the position of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Position(LegendPosition value)
Parameters
Returns
RemoveDuplicateLegend(Boolean)
Enables or disables to remove the duplicate legend item.
Declaration
public TreeMapLegendSettingsBuilder RemoveDuplicateLegend(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Shape(LegendShape)
Sets and gets the shape of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Shape(LegendShape value)
Parameters
Returns
ShapeBorder(TreeMapBorder)
Sets and gets the options for customizing the color and width of the border of the legend shape in the treemap.
Declaration
public TreeMapLegendSettingsBuilder ShapeBorder(TreeMapBorder value)
Parameters
Returns
ShapeBorder(Action<TreeMapBorderBuilder>)
Declaration
public TreeMapLegendSettingsBuilder ShapeBorder(Action<TreeMapBorderBuilder> shapeBorder)
Parameters
Returns
ShapeHeight(Double)
Sets and gets the height of the shapes of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder ShapeHeight(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapePadding(Double)
Sets and gets the shape padding of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder ShapePadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapeWidth(Double)
Sets and gets the width of the shapes in legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder ShapeWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShowLegendPath(String)
Sets and gets the value path from the data source for the visibility state of the legend item in the treemap.
Declaration
public TreeMapLegendSettingsBuilder ShowLegendPath(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
TextStyle(TreeMapFont)
Sets and gets the options to customize the text style of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder TextStyle(TreeMapFont value)
Parameters
Returns
TextStyle(Action<TreeMapFontBuilder>)
Declaration
public TreeMapLegendSettingsBuilder TextStyle(Action<TreeMapFontBuilder> textStyle)
Parameters
Returns
Title(TreeMapCommonTitleSettings)
Sets and gets the options to customize the title of the legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Title(TreeMapCommonTitleSettings value)
Parameters
Returns
Title(Action<TreeMapCommonTitleSettingsBuilder>)
Declaration
public TreeMapLegendSettingsBuilder Title(Action<TreeMapCommonTitleSettingsBuilder> title)
Parameters
Returns
TitleStyle(TreeMapFont)
Sets and gets the options to customize the text style of the legend item text in the treemap.
Declaration
public TreeMapLegendSettingsBuilder TitleStyle(TreeMapFont value)
Parameters
Returns
TitleStyle(Action<TreeMapFontBuilder>)
Declaration
public TreeMapLegendSettingsBuilder TitleStyle(Action<TreeMapFontBuilder> titleStyle)
Parameters
Returns
ValuePath(String)
Sets and gets the value path from the data source to render legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder ValuePath(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Visible(Boolean)
Enables or disables the visibility of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Visible(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Width(String)
Sets and gets the width of legend in the treemap.
Declaration
public TreeMapLegendSettingsBuilder Width(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
