Class HeatMap

Inheritance
System.Object
TagHelper
EJTagHelper
HeatMap
Inherited Members
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 multiple cells in heatmap {% codeBlock src='heatmap/allowSelection/index.md' %}{% endcodeBlock %}

Declaration
[HtmlAttributeName("allowSelection")]
public bool AllowSelection { get; set; }
Property Value
Type Description
System.Boolean

CellClick

Triggers when click the heat map cell.

Declaration
[HtmlAttributeName("cellClick")]
public string CellClick { get; set; }
Property Value
Type Description
System.String

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

CellSelected

Triggers when multiple cells gets selected.

Declaration
[HtmlAttributeName("cellSelected")]
public string CellSelected { get; set; }
Property Value
Type Description
System.String

CellSettings

Options to customize the heat map cell {% codeBlock src='heatmap/cellSettings/index.md' %}{% endcodeBlock %}

Declaration
[HtmlAttributeName("cellSettings")]
public HeatMapCellSettings CellSettings { get; set; }
Property Value
Type Description
HeatMapCellSettings

ClassName

Declaration
protected override string ClassName { get; }
Property Value
Type Description
System.String
Overrides

Created

Triggers after heat map rendered.

Declaration
[HtmlAttributeName("created")]
public string Created { get; set; }
Property Value
Type Description
System.String

DataSource

Specifies the datasource for the heat map.

Declaration
[HtmlAttributeName("dataSource")]
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DataSourceSettings

Specifies the datasource settings for heat map. {% codeBlock src='heatmap/dataSourceSettings/index.md' %}{% endcodeBlock %}

Declaration
[HtmlAttributeName("dataSourceSettings")]
public HeatMapData DataSourceSettings { get; set; }
Property Value
Type Description
HeatMapData

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

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

Height

The height of the heatmap accepts pixel values given in string format.

Declaration
[HtmlAttributeName("height")]
public string Height { get; set; }
Property Value
Type Description
System.String

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

IsFor

Declaration
protected override bool IsFor { get; }
Property Value
Type Description
System.Boolean
Overrides

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

LegendSettings

Options for customizing the legend of the heat map {% codeBlock src='heatmap/legendSettings/index.md' %}{% endcodeBlock %}

Declaration
[HtmlAttributeName("legendSettings")]
public HeatMapLegendSettings LegendSettings { get; set; }
Property Value
Type Description
HeatMapLegendSettings

Load

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

Declaration
[HtmlAttributeName("load")]
public string Load { get; set; }
Property Value
Type Description
System.String

Loaded

Triggers after heatmap is loaded.

Declaration
[HtmlAttributeName("loaded")]
public string Loaded { get; set; }
Property Value
Type Description
System.String

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

Margin

Options to customize left, right, top and bottom margins of the heat map.

Declaration
[HtmlAttributeName("margin")]
public HeatMapMargin Margin { get; set; }
Property Value
Type Description
HeatMapMargin

NameSpace

Declaration
protected override string NameSpace { get; }
Property Value
Type Description
System.String
Overrides

PaletteSettings

Options for customizing the cell color of the heat map {% codeBlock src='heatmap/paletteSettings/index.md' %}{% endcodeBlock %}

Declaration
[HtmlAttributeName("paletteSettings")]
public HeatMapPaletteSettings PaletteSettings { get; set; }
Property Value
Type Description
HeatMapPaletteSettings

RenderingMode

Specifies the rendering mode of heat map. SVG - Heat map is render using SVG draw mode. Canvas - Heat map is render using Canvas draw mode. Auto - Automatically switch the draw mode based on number of records in data source.

Declaration
[HtmlAttributeName("renderingMode")]
public DrawType RenderingMode { get; set; }
Property Value
Type Description
DrawType

Resized

Triggers after resizing of Heatmap.

Declaration
[HtmlAttributeName("resized")]
public string Resized { get; set; }
Property Value
Type Description
System.String

ShowTooltip

Enable or disable the tool tip for heatmap

Declaration
[HtmlAttributeName("showTooltip")]
public bool ShowTooltip { get; set; }
Property Value
Type Description
System.Boolean

TagName

Declaration
protected override string TagName { get; }
Property Value
Type Description
System.String
Overrides

Theme

Specifies the theme for heatmap.

Declaration
[HtmlAttributeName("theme")]
public HeatMapTheme Theme { get; set; }
Property Value
Type Description
HeatMapTheme

TitleSettings

Title of heat map {% codeBlock src='heatmap/titleSettings/index.md' %}{% endcodeBlock %}

Declaration
[HtmlAttributeName("titleSettings")]
public HeatMapTitle TitleSettings { get; set; }
Property Value
Type Description
HeatMapTitle

TooltipRender

Triggers when click the heat map cell.

Declaration
[HtmlAttributeName("tooltipRender")]
public string TooltipRender { get; set; }
Property Value
Type Description
System.String

TooltipSettings

Options for customizing the ToolTipSettings property of the heat map {% codeBlock src='heatmap/tooltipSettings/index.md' %}{% endcodeBlock %}

Declaration
[HtmlAttributeName("tooltipSettings")]
public HeatMapTooltipSettings TooltipSettings { get; set; }
Property Value
Type Description
HeatMapTooltipSettings

Width

The width of the heatmap as a string accepts input as both like '100px' or '100%'.

Declaration
[HtmlAttributeName("width")]
public string Width { get; set; }
Property Value
Type Description
System.String

XAxis

Options to configure the horizontal axis.

Declaration
[HtmlAttributeName("xAxis")]
public HeatMapAxis XAxis { get; set; }
Property Value
Type Description
HeatMapAxis

YAxis

Options to configure the vertical axis.

Declaration
[HtmlAttributeName("yAxis")]
public HeatMapAxis YAxis { get; set; }
Property Value
Type Description
HeatMapAxis