Class SankeyChartLegendSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
SankeyChartLegendSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class SankeyChartLegendSettingsBuilder : ControlBuilder
Constructors
SankeyChartLegendSettingsBuilder()
Declaration
public SankeyChartLegendSettingsBuilder()
SankeyChartLegendSettingsBuilder(SankeyChartLegendSettings)
Declaration
public SankeyChartLegendSettingsBuilder(SankeyChartLegendSettings model)
Parameters
Methods
Background(String)
Background color of the legend.
Declaration
public SankeyChartLegendSettingsBuilder Background(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
Border(SankeyLegendBorder)
Options for customizing the border of the legend.
Declaration
public SankeyChartLegendSettingsBuilder Border(SankeyLegendBorder value)
Parameters
Returns
Border(Action<SankeyBorderBuilder>)
Declaration
public SankeyChartLegendSettingsBuilder Border(Action<SankeyBorderBuilder> border)
Parameters
Returns
EnableHighlight(Boolean)
Enables or disables highlighting of legend items on interaction.
Declaration
public SankeyChartLegendSettingsBuilder EnableHighlight(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Height(String)
Specifies the height of the legend.
Declaration
public SankeyChartLegendSettingsBuilder Height(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
IsInversed(Boolean)
Specifies whether the legend layout should be inverted.
Declaration
public SankeyChartLegendSettingsBuilder IsInversed(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ItemPadding(Double)
Padding between legend items.
Declaration
public SankeyChartLegendSettingsBuilder ItemPadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Location(SankeyLocation)
Specifies the location of the legend relative to the Sankey chart.
If x is 20, the legend moves 20 pixels to the right of the Sankey chart.
Note that the position must be set to Custom for this feature to work.
Declaration
public SankeyChartLegendSettingsBuilder Location(SankeyLocation value)
Parameters
Returns
Location(Action<SankeyLocationBuilder>)
Declaration
public SankeyChartLegendSettingsBuilder Location(Action<SankeyLocationBuilder> location)
Parameters
Returns
Margin(SankeyLegendMargin)
Options to configure the margins around the component.
Declaration
public SankeyChartLegendSettingsBuilder Margin(SankeyLegendMargin value)
Parameters
Returns
Margin(Action<SankeyMarginBuilder>)
Declaration
public SankeyChartLegendSettingsBuilder Margin(Action<SankeyMarginBuilder> margin)
Parameters
Returns
Opacity(Double)
Opacity of the legend container.
Declaration
public SankeyChartLegendSettingsBuilder Opacity(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Padding(Double)
Padding around the legend container.
Declaration
public SankeyChartLegendSettingsBuilder Padding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Position(LegendPosition)
Specifies the position of the legend in the chart.
Declaration
public SankeyChartLegendSettingsBuilder Position(LegendPosition value)
Parameters
Returns
Reverse(Boolean)
Specifies whether the legend items should be displayed in reverse order.
Declaration
public SankeyChartLegendSettingsBuilder Reverse(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ShapeHeight(Double)
Size of the legend shape (icon).
Declaration
public SankeyChartLegendSettingsBuilder ShapeHeight(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapePadding(Double)
Padding between the legend shape and its text.
Declaration
public SankeyChartLegendSettingsBuilder ShapePadding(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ShapeWidth(Double)
Size of the legend shape (icon).
Declaration
public SankeyChartLegendSettingsBuilder ShapeWidth(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
TextStyle(SankeyFont)
Defines the text styling options applied to legend labels in the Sankey diagram.
Declaration
public SankeyChartLegendSettingsBuilder TextStyle(SankeyFont value)
Parameters
Returns
TextStyle(Action<SankeyFontBuilder>)
Declaration
public SankeyChartLegendSettingsBuilder TextStyle(Action<SankeyFontBuilder> textStyle)
Parameters
Returns
Title(String)
Title text for the legend.
Declaration
public SankeyChartLegendSettingsBuilder Title(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns
TitleStyle(SankeyLegendTitleStyle)
Defines the font styling used for rendering the legend title in the Sankey diagram.
Declaration
public SankeyChartLegendSettingsBuilder TitleStyle(SankeyLegendTitleStyle value)
Parameters
Returns
TitleStyle(Action<SankeyFontBuilder>)
Declaration
public SankeyChartLegendSettingsBuilder TitleStyle(Action<SankeyFontBuilder> titleStyle)
Parameters
Returns
Visible(Boolean)
Enables or disables the legend display.
Declaration
public SankeyChartLegendSettingsBuilder Visible(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Width(String)
Specifies the width of the legend.
Declaration
public SankeyChartLegendSettingsBuilder Width(string value)
Parameters
| Type |
Name |
Description |
| System.String |
value |
|
Returns