Class HeatMapBuilder
Inheritance
System.Object
HeatMapBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class HeatMapBuilder : ControlBuilder
Constructors
HeatMapBuilder()
Declaration
HeatMapBuilder(HeatMap)
Declaration
public HeatMapBuilder(HeatMap model)
Parameters
Type |
Name |
Description |
HeatMap |
model |
|
Fields
model
Declaration
Field Value
Properties
HtmlAttr
Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type |
Description |
System.Collections.Generic.IDictionary<System.String, System.Object> |
|
ID
Declaration
public string ID { get; set; }
Property Value
Type |
Description |
System.String |
|
Output
Declaration
public override TextWriter Output { get; set; }
Property Value
Type |
Description |
System.IO.TextWriter |
|
Overrides
Methods
AllowSelection(Boolean)
Enable or disable the selection of cells in heatmap.
{% codeBlock src='heatmap/allowSelection/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder AllowSelection(bool allowSelection = true)
Parameters
Type |
Name |
Description |
System.Boolean |
allowSelection |
|
Returns
BackgroundColor(String)
Specifies the background color of the entire heatmap.
Declaration
public HeatMapBuilder BackgroundColor(string backgroundColor)
Parameters
Type |
Name |
Description |
System.String |
backgroundColor |
|
Returns
CellClick(String)
Triggers when clicking on the heatmap cell.
Declaration
public HeatMapBuilder CellClick(string cellClick)
Parameters
Type |
Name |
Description |
System.String |
cellClick |
|
Returns
CellDoubleClick(String)
Triggers when performing the double click operation on the cells in the HeatMap.
Declaration
public HeatMapBuilder CellDoubleClick(string cellDoubleClick)
Parameters
Type |
Name |
Description |
System.String |
cellDoubleClick |
|
Returns
CellRender(String)
Triggers before each heatmap cell renders.
{% codeBlock src='heatmap/cellRender/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder CellRender(string cellRender)
Parameters
Type |
Name |
Description |
System.String |
cellRender |
|
Returns
CellSelected(String)
Triggers when heatmap cell gets selected.
Declaration
public HeatMapBuilder CellSelected(string cellSelected)
Parameters
Type |
Name |
Description |
System.String |
cellSelected |
|
Returns
CellSettings(HeatMapCellSettings)
Sets and gets the options to customize the heatmap cells.
{% codeBlock src='heatmap/cellSettings/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder CellSettings(HeatMapCellSettings cellSettings)
Parameters
Returns
CellSettings(Action<HeatMapCellSettingsBuilder>)
Declaration
public HeatMapBuilder CellSettings(Action<HeatMapCellSettingsBuilder> cellSettings)
Parameters
Returns
Created(String)
Triggers after heatmap is completely rendered.
Declaration
public HeatMapBuilder Created(string created)
Parameters
Type |
Name |
Description |
System.String |
created |
|
Returns
DataSource(Action<DataManagerBuilder>)
Declaration
public HeatMapBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Returns
DataSource(Object)
Sets and gets the data to visualize in the heatmap.
Declaration
public HeatMapBuilder DataSource(object dataSource)
Parameters
Type |
Name |
Description |
System.Object |
dataSource |
|
Returns
DataSourceSettings(HeatMapData)
Sets and gets the options to customize the data mapping for the data in the heatmap.
{% codeBlock src='heatmap/dataSourceSettings/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder DataSourceSettings(HeatMapData dataSourceSettings)
Parameters
Returns
DataSourceSettings(Action<HeatMapDataBuilder>)
Declaration
public HeatMapBuilder DataSourceSettings(Action<HeatMapDataBuilder> dataSourceSettings)
Parameters
Returns
EnableMultiSelect(Boolean)
Enable or disable the multiple selection of cells in heatmap.
Declaration
public HeatMapBuilder EnableMultiSelect(bool enableMultiSelect = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableMultiSelect |
|
Returns
EnablePersistence(Boolean)
Enable or disable persisting component's state between page reloads.
Declaration
public HeatMapBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enablePersistence |
|
Returns
EnableRtl(Boolean)
Enable or disable rendering component in right to left direction.
Declaration
public HeatMapBuilder EnableRtl(bool enableRtl = true)
Parameters
Type |
Name |
Description |
System.Boolean |
enableRtl |
|
Returns
Height(String)
Sets and gets the height of the heatmap. The height of the heatmap accepts pixel or percentage values given in string format.
Declaration
public HeatMapBuilder Height(string height)
Parameters
Type |
Name |
Description |
System.String |
height |
|
Returns
HtmlAttributes(Object)
Allows additional HTML attributes such as title, name, etc., and
accepts n number of attributes in a key-value pair format.
Declaration
public HeatMapBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type |
Name |
Description |
System.Object |
htmlAttributes |
|
Returns
LegendRender(String)
Triggers before the legend is rendered.
{% codeBlock src='heatmap/legendRender/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder LegendRender(string legendRender)
Parameters
Type |
Name |
Description |
System.String |
legendRender |
|
Returns
LegendSettings(HeatMapLegendSettings)
Sets and gets the options for customizing the legend of the heatmap.
{% codeBlock src='heatmap/legendSettings/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder LegendSettings(HeatMapLegendSettings legendSettings)
Parameters
Returns
LegendSettings(Action<HeatMapLegendSettingsBuilder>)
Declaration
public HeatMapBuilder LegendSettings(Action<HeatMapLegendSettingsBuilder> legendSettings)
Parameters
Returns
Load(String)
Triggers before heatmap gets loaded.
{% codeBlock src='heatmap/load/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder Load(string load)
Parameters
Type |
Name |
Description |
System.String |
load |
|
Returns
Loaded(String)
Triggers after heatmap is loaded.
Declaration
public HeatMapBuilder Loaded(string loaded)
Parameters
Type |
Name |
Description |
System.String |
loaded |
|
Returns
Locale(String)
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public HeatMapBuilder Locale(string locale)
Parameters
Type |
Name |
Description |
System.String |
locale |
|
Returns
Margin(HeatMapMargin)
Sets and gets the options to customize left, right, top and bottom margins of the heatmap.
Declaration
public HeatMapBuilder Margin(HeatMapMargin margin)
Parameters
Returns
Margin(Action<HeatMapMarginBuilder>)
Declaration
public HeatMapBuilder Margin(Action<HeatMapMarginBuilder> margin)
Parameters
Returns
PaletteSettings(HeatMapPaletteSettings)
Sets and gets the options for customizing the cell color of the heatmap.
{% codeBlock src='heatmap/paletteSettings/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder PaletteSettings(HeatMapPaletteSettings paletteSettings)
Parameters
Returns
PaletteSettings(Action<HeatMapPaletteSettingsBuilder>)
Declaration
public HeatMapBuilder PaletteSettings(Action<HeatMapPaletteSettingsBuilder> paletteSettings)
Parameters
Returns
Render()
Declaration
public HtmlString Render()
Returns
Type |
Description |
Microsoft.AspNetCore.Html.HtmlString |
|
RenderingMode(DrawType)
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 HeatMapBuilder RenderingMode(DrawType renderingMode)
Parameters
Type |
Name |
Description |
DrawType |
renderingMode |
|
Returns
Resized(String)
Triggers to notify the resize of the heatmap when the window is resized.
Declaration
public HeatMapBuilder Resized(string resized)
Parameters
Type |
Name |
Description |
System.String |
resized |
|
Returns
Enable or disable the visibility of the tooltip for heatmap.
Declaration
public HeatMapBuilder ShowTooltip(bool showTooltip = true)
Parameters
Type |
Name |
Description |
System.Boolean |
showTooltip |
|
Returns
Theme(HeatMapTheme)
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 HeatMapBuilder Theme(HeatMapTheme theme)
Parameters
Returns
TitleSettings(HeatMapTitle)
Sets and gets the options to customize the title of the heatmap.
{% codeBlock src='heatmap/titleSettings/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder TitleSettings(HeatMapTitle titleSettings)
Parameters
Returns
TitleSettings(Action<HeatMapTitleBuilder>)
Declaration
public HeatMapBuilder TitleSettings(Action<HeatMapTitleBuilder> titleSettings)
Parameters
Returns
Triggers before the tooltip of the heatmap is rendered on the heatmap cell.
Declaration
public HeatMapBuilder TooltipRender(string tooltipRender)
Parameters
Type |
Name |
Description |
System.String |
tooltipRender |
|
Returns
Sets and gets the options for customizing the tooltip of the heatmap.
{% codeBlock src='heatmap/tooltipSettings/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder TooltipSettings(HeatMapTooltipSettings tooltipSettings)
Parameters
Returns
Declaration
public HeatMapBuilder TooltipSettings(Action<HeatMapTooltipSettingsBuilder> tooltipSettings)
Parameters
Returns
Width(String)
Sets and gets the width of the heatmap. The width of the heatmap accepts pixel or percentage values given in string format.
Declaration
public HeatMapBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns
XAxis(HeatMapAxis)
Sets and gets the options to configure the horizontal axis.
Declaration
public HeatMapBuilder XAxis(HeatMapAxis xAxis)
Parameters
Returns
XAxis(Action<HeatMapAxisBuilder>)
Declaration
public HeatMapBuilder XAxis(Action<HeatMapAxisBuilder> xAxis)
Parameters
Returns
YAxis(HeatMapAxis)
Sets and gets the options to configure the vertical axis.
Declaration
public HeatMapBuilder YAxis(HeatMapAxis yAxis)
Parameters
Returns
YAxis(Action<HeatMapAxisBuilder>)
Declaration
public HeatMapBuilder YAxis(Action<HeatMapAxisBuilder> yAxis)
Parameters
Returns