Class HeatMapLegendSettings

Inheritance

System.Object

TagHelper

EJTagHelper

HeatMapLegendSettings

Inherited Members

EJTagHelper.GetList()

EJTagHelper.GetSerializedProperties()

EJTagHelper.GetScriptString()

EJTagHelper.GetHtmlAttrString(IDictionary<String, Object>)

EJTagHelper.TagName

EJTagHelper.Id

EJTagHelper.NameSpace

EJTagHelper.ClassName

EJTagHelper.IsFor

EJTagHelper.IsChild

EJTagHelper.IsComplex

EJTagHelper.IsCollection

EJTagHelper.ParentPropertyName

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()

Namespace: Syncfusion.EJ2.HeatMap

Assembly: Syncfusion.EJ2.dll

Syntax

public class HeatMapLegendSettings : EJTagHelper

Constructors

HeatMapLegendSettings()

Declaration

public HeatMapLegendSettings()

Properties

Alignment

Specifies the alignment of the legend.

Declaration

[HtmlAttributeName("alignment")]
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	Description
MvcTemplate<System.Object>

EnableSmartLegend

Specifies whether smart legend should be displayed or not when palette type is fixed.

Declaration

[HtmlAttributeName("enableSmartLegend")]
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

[HtmlAttributeName("height")]
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

[HtmlAttributeName("labelDisplayType")]
public LabelDisplayType LabelDisplayType { get; set; }

Property Value

Type	Description
LabelDisplayType	The default value is LabelDisplayType.All

LabelFormat

Used to format the legend label.

Declaration

[HtmlAttributeName("labelFormat")]
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

[HtmlAttributeName("position")]
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

[HtmlAttributeName("showGradientPointer")]
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

[HtmlAttributeName("showLabel")]
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

[HtmlAttributeName("textStyle")]
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

[HtmlAttributeName("title")]
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

[HtmlAttributeName("toggleVisibility")]
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

[HtmlAttributeName("visible")]
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

[HtmlAttributeName("width")]
public string Width { get; set; }

Property Value

Type	Description
System.String	The default value is ""