Class HeatMap

Inheritance

System.Object

TagHelper

EJTagHelper

HeatMap

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 HeatMap : EJTagHelper

Constructors

HeatMap()

Declaration

public HeatMap()

Properties

AllowSelection

Enable or disable the selection of cells in heatmap. {% codeBlock src='heatmap/allowSelection/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("allowSelection")]
public bool AllowSelection { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

BackgroundColor

Specifies the background color of the entire heatmap.

Declaration

[HtmlAttributeName("backgroundColor")]
public string BackgroundColor { get; set; }

Property Value

Type	Description
System.String	The default value is null

CellClick

Triggers when clicking on the heatmap cell.

Declaration

[HtmlAttributeName("cellClick")]
public string CellClick { get; set; }

Property Value

Type	Description
System.String	The default value is null

CellRender

Triggers before each heatmap cell renders. {% codeBlock src='heatmap/cellRender/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("cellRender")]
public string CellRender { get; set; }

Property Value

Type	Description
System.String	The default value is null

CellSelected

Triggers when heatmap cell gets selected.

Declaration

[HtmlAttributeName("cellSelected")]
public string CellSelected { get; set; }

Property Value

Type	Description
System.String	The default value is null

CellSettings

Sets and gets the options to customize the heatmap cells. {% codeBlock src='heatmap/cellSettings/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("cellSettings")]
public HeatMapCellSettings CellSettings { get; set; }

Property Value

Type	Description
HeatMapCellSettings	The default value is null

Created

Triggers after heatmap is completely rendered.

Declaration

[HtmlAttributeName("created")]
public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

DataSource

Sets and gets the data to visualize in the heatmap.

Declaration

[HtmlAttributeName("dataSource")]
public object DataSource { get; set; }

Property Value

Type	Description
System.Object	The default value is null

DataSourceSettings

Sets and gets the options to customize the data mapping for the data in the heatmap. {% codeBlock src='heatmap/dataSourceSettings/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("dataSourceSettings")]
public HeatMapData DataSourceSettings { get; set; }

Property Value

Type	Description
HeatMapData	The default value is null

EnableMultiSelect

Enable or disable the multiple selection of cells in heatmap.

Declaration

[HtmlAttributeName("enableMultiSelect")]
public bool EnableMultiSelect { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

[HtmlAttributeName("enablePersistence")]
public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

[HtmlAttributeName("enableRtl")]
public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Height

Sets and gets the height of the heatmap. The height of the heatmap accepts pixel or percentage values given in string format.

Declaration

[HtmlAttributeName("height")]
public string Height { get; set; }

Property Value

Type	Description
System.String	The default value is null

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

[HtmlAttributeName("htmlAttributes")]
public object HtmlAttributes { get; set; }

Property Value

Type	Description
System.Object

LegendRender

Triggers before the legend is rendered. {% codeBlock src='heatmap/legendRender/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("legendRender")]
public string LegendRender { get; set; }

Property Value

Type	Description
System.String	The default value is null

LegendSettings

Sets and gets the options for customizing the legend of the heatmap. {% codeBlock src='heatmap/legendSettings/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("legendSettings")]
public HeatMapLegendSettings LegendSettings { get; set; }

Property Value

Type	Description
HeatMapLegendSettings	The default value is null

Load

Triggers before heatmap gets loaded. {% codeBlock src='heatmap/load/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("load")]
public string Load { get; set; }

Property Value

Type	Description
System.String	The default value is null

Loaded

Triggers after heatmap is loaded.

Declaration

[HtmlAttributeName("loaded")]
public string Loaded { get; set; }

Property Value

Type	Description
System.String	The default value is null

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

[HtmlAttributeName("locale")]
public string Locale { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Margin

Sets and gets the options to customize left, right, top and bottom margins of the heatmap.

Declaration

[HtmlAttributeName("margin")]
public HeatMapMargin Margin { get; set; }

Property Value

Type	Description
HeatMapMargin	The default value is null

PaletteSettings

Sets and gets the options for customizing the cell color of the heatmap. {% codeBlock src='heatmap/paletteSettings/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("paletteSettings")]
public HeatMapPaletteSettings PaletteSettings { get; set; }

Property Value

Type	Description
HeatMapPaletteSettings	The default value is null

RenderingMode

Specifies the rendering mode of heatmap. The following are the available rendering modes. SVG - Heatmap is rendered using SVG element. Canvas - Heatmap is rendered using Canvas element. Auto - Automatically switches the rendering mode based on number of records in the data source.

Declaration

[HtmlAttributeName("renderingMode")]
public DrawType RenderingMode { get; set; }

Property Value

Type	Description
DrawType	The default value is DrawType.SVG

Resized

Triggers to notify the resize of the heatmap when the window is resized.

Declaration

[HtmlAttributeName("resized")]
public string Resized { get; set; }

Property Value

Type	Description
System.String	The default value is null

ShowTooltip

Enable or disable the visibility of the tooltip for heatmap.

Declaration

[HtmlAttributeName("showTooltip")]
public bool ShowTooltip { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Theme

Sets and gets the theme styles supported for heatmap. When the theme is set, the styles associated with the theme will be set in the heatmap.

Declaration

[HtmlAttributeName("theme")]
public HeatMapTheme Theme { get; set; }

Property Value

Type	Description
HeatMapTheme	The default value is HeatMapTheme.Material

TitleSettings

Sets and gets the options to customize the title of the heatmap. {% codeBlock src='heatmap/titleSettings/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("titleSettings")]
public HeatMapTitle TitleSettings { get; set; }

Property Value

Type	Description
HeatMapTitle	The default value is null

TooltipRender

Triggers before the tooltip of the heatmap is rendered on the heatmap cell.

Declaration

[HtmlAttributeName("tooltipRender")]
public string TooltipRender { get; set; }

Property Value

Type	Description
System.String	The default value is null

TooltipSettings

Sets and gets the options for customizing the tooltip of the heatmap. {% codeBlock src='heatmap/tooltipSettings/index.md' %}{% endcodeBlock %}

Declaration

[HtmlAttributeName("tooltipSettings")]
public HeatMapTooltipSettings TooltipSettings { get; set; }

Property Value

Type	Description
HeatMapTooltipSettings	The default value is null

Width

Sets and gets the width of the heatmap. The width of the heatmap accepts pixel or percentage values given in string format.

Declaration

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

Property Value

Type	Description
System.String	The default value is null

XAxis

Sets and gets the options to configure the horizontal axis.

Declaration

[HtmlAttributeName("xAxis")]
public HeatMapAxis XAxis { get; set; }

Property Value

Type	Description
HeatMapAxis	The default value is null

YAxis

Sets and gets the options to configure the vertical axis.

Declaration

[HtmlAttributeName("yAxis")]
public HeatMapAxis YAxis { get; set; }

Property Value

Type	Description
HeatMapAxis	The default value is null