Class HeatMap
Inheritance
Namespace: Syncfusion.EJ2.HeatMap
Assembly: Syncfusion.EJ2.dll
Syntax
public class HeatMap : EJTagHelperConstructors
HeatMap()
Declaration
public HeatMap()Properties
AllowSelection
Enable or disable the selection of cells in heatmap.
Declaration
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
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
public string CellClick { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
CellDoubleClick
Triggers when performing the double click operation on the cells in the HeatMap.
Declaration
public string CellDoubleClick { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
CellRender
Triggers before each heatmap cell renders.
Declaration
public string CellRender { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
CellSelected
Triggers when heatmap cell gets selected.
Declaration
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.
Declaration
public HeatMapCellSettings CellSettings { get; set; }Property Value
| Type | Description |
|---|---|
| HeatMapCellSettings | The default value is null |
Created
Triggers after heatmap is completely rendered.
Declaration
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
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.
Declaration
public HeatMapData DataSourceSettings { get; set; }Property Value
| Type | Description |
|---|---|
| HeatMapData | The default value is null |
EnableHtmlSanitizer
Specifies whether to enable the rendering of untrusted HTML values in the HeatMap. If enableHtmlSanitizer set to true, the component will sanitize any suspected untrusted strings and scripts before rendering them.
Declaration
public bool EnableHtmlSanitizer { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean | The default value is false |
EnableMultiSelect
Enable or disable the multiple selection of cells in heatmap.
Declaration
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
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
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
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
public object HtmlAttributes { get; set; }Property Value
| Type |
|---|
| System.Object |
LegendRender
Triggers before the legend is rendered.
Declaration
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.
Declaration
public HeatMapLegendSettings LegendSettings { get; set; }Property Value
| Type | Description |
|---|---|
| HeatMapLegendSettings | The default value is null |
Load
Triggers before heatmap gets loaded.
Declaration
public string Load { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | The default value is null |
Loaded
Triggers after heatmap is loaded.
Declaration
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
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
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.
Declaration
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
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
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
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
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.
Declaration
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
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.
Declaration
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
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
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
public HeatMapAxis YAxis { get; set; }Property Value
| Type | Description |
|---|---|
| HeatMapAxis | The default value is null |