Class HeatMapLegendSettings
Inheritance
Namespace: Syncfusion.EJ2.HeatMap
Assembly: Syncfusion.EJ2.dll
Syntax
public class HeatMapLegendSettings : EJTagHelperConstructors
HeatMapLegendSettings()
Declaration
public HeatMapLegendSettings()Properties
Alignment
Specifies the alignment of the legend.
Declaration
public Alignment Alignment { get; set; }Property Value
| Type | Description |
|---|---|
| Alignment | The default value is Syncfusion.EJ2.HeatMap.Alignment.Center |
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }Property Value
| Type |
|---|
| Syncfusion.EJ2.MvcTemplate<System.Object> |
EnableSmartLegend
Specifies whether smart legend should be displayed or not when palette type is fixed.
Declaration
public bool EnableSmartLegend { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
Height
Sets and gets the height of the legend.
Declaration
public string Height { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
LabelDisplayType
Specifies the display mode for label for smart legend. The available display types are, All: All the labels in the legend are displayed. Edge: Labels will be displayed only at the edges of the legend. None: No labels are displayed.
Declaration
public LabelDisplayType LabelDisplayType { get; set; }Property Value
| Type | Description |
|---|---|
| LabelDisplayType | The default value is LabelDisplayType.All |
LabelFormat
Used to format the legend label.
Declaration
public string LabelFormat { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |
Position
Sets and gets the position of the legend.
Declaration
public LegendPosition Position { get; set; }Property Value
| Type | Description |
|---|---|
| LegendPosition | The default value is LegendPosition.Right |
ShowGradientPointer
Enables or disables the visibility of the gradient pointer in the gradient legend.
Declaration
public bool ShowGradientPointer { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
ShowLabel
Specifies whether the labels in the legend should be visible or not.
Declaration
public bool ShowLabel { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
TextStyle
Sets and gets the options to customize the font style of the legend label.
Declaration
public object TextStyle { get; set; }Property Value
| Type | Description |
|---|---|
| System.Object | The default value is null |
Title
Sets and gets the options to customize the title of the legend.
Declaration
public HeatMapTitle Title { get; set; }Property Value
| Type | Description |
|---|---|
| HeatMapTitle | The default value is null |
ToggleVisibility
Enables or disables the toggle visibility of heatmap cells based on legend item selection.
Declaration
public bool ToggleVisibility { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
Visible
Specifies whether the legend should be visible or not.
Declaration
public bool Visible { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is true |
Width
Sets and gets the width of the legend.
Declaration
public string Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is "" |