Class SankeyChartLegendSettings
Inheritance
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class SankeyChartLegendSettings : EJTagHelperConstructors
SankeyChartLegendSettings()
Declaration
public SankeyChartLegendSettings()Properties
Background
Background color of the legend.
Declaration
public string Background { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "transparent" |
Border
Options for customizing the border of the legend.
Declaration
public SankeyLegendBorder Border { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyLegendBorder | 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> |
EnableHighlight
Enables or disables highlighting of legend items on interaction.
Declaration
public bool EnableHighlight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
Height
Specifies the height of the legend.
Declaration
public string Height { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
IsInversed
Specifies whether the legend layout should be inverted.
Declaration
public bool IsInversed { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
ItemPadding
Padding between legend items.
Declaration
public double ItemPadding { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is Double.NaN |
Location
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
positionmust be set toCustomfor this feature to work.
Declaration
public SankeyLocation Location { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyLocation | The default value is null |
Margin
Options to configure the margins around the component.
Declaration
public SankeyLegendMargin Margin { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyLegendMargin | The default value is null |
Opacity
Opacity of the legend container.
Declaration
public double Opacity { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 1 |
Padding
Padding around the legend container.
Declaration
public double Padding { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 8 |
Position
Specifies the position of the legend in the chart.
Declaration
public LegendPosition Position { get; set; }Property Value
| Type | Description |
|---|---|
| LegendPosition | The default value is LegendPosition.Auto |
Reverse
Specifies whether the legend items should be displayed in reverse order.
Declaration
public bool Reverse { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
ShapeHeight
Size of the legend shape (icon).
Declaration
public double ShapeHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 10 |
ShapePadding
Padding between the legend shape and its text.
Declaration
public double ShapePadding { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 8 |
ShapeWidth
Size of the legend shape (icon).
Declaration
public double ShapeWidth { get; set; }Property Value
| Type | Description |
|---|---|
| System.Double | The default value is 10 |
TextStyle
Defines the text styling options applied to legend labels in the Sankey diagram.
Declaration
public SankeyFont TextStyle { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyFont | The default value is null |
Title
Title text for the legend.
Declaration
public string Title { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
TitleStyle
Defines the font styling used for rendering the legend title in the Sankey diagram.
Declaration
public SankeyLegendTitleStyle TitleStyle { get; set; }Property Value
| Type | Description |
|---|---|
| SankeyLegendTitleStyle | The default value is null |
Visible
Enables or disables the legend display.
Declaration
public bool Visible { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
Width
Specifies the width of the legend.
Declaration
public string Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |