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 multiple 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
CellClick(String)
Triggers when click the heat map cell.
Declaration
public HeatMapBuilder CellClick(string cellClick)
Parameters
Type |
Name |
Description |
System.String |
cellClick |
|
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 multiple cells gets selected.
Declaration
public HeatMapBuilder CellSelected(string cellSelected)
Parameters
Type |
Name |
Description |
System.String |
cellSelected |
|
Returns
CellSettings(HeatMapCellSettings)
Options to customize the heat map cell
{% 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 heat map 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)
Specifies the datasource for the heat map.
Declaration
public HeatMapBuilder DataSource(object dataSource)
Parameters
Type |
Name |
Description |
System.Object |
dataSource |
|
Returns
DataSourceSettings(HeatMapData)
Specifies the datasource settings for heat map.
{% 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
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)
The height of the heatmap as a string accepts input as both like '100px' or '100%'.
If specified as '100%, heatmap renders to the full height of its parent element.
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)
Options for customizing the legend of the heat map
{% 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 heat map load.
{% 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)
Options to customize left, right, top and bottom margins of the heat map.
Declaration
public HeatMapBuilder Margin(HeatMapMargin margin)
Parameters
Returns
Margin(Action<HeatMapMarginBuilder>)
Declaration
public HeatMapBuilder Margin(Action<HeatMapMarginBuilder> margin)
Parameters
Returns
PaletteSettings(HeatMapPaletteSettings)
Options for customizing the cell color of the heat map
{% 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 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
public HeatMapBuilder RenderingMode(DrawType renderingMode)
Parameters
Type |
Name |
Description |
DrawType |
renderingMode |
|
Returns
Resized(String)
Triggers after resizing of Heatmap.
Declaration
public HeatMapBuilder Resized(string resized)
Parameters
Type |
Name |
Description |
System.String |
resized |
|
Returns
Enable or disable the tool tip for heatmap
Declaration
public HeatMapBuilder ShowTooltip(bool showTooltip = true)
Parameters
Type |
Name |
Description |
System.Boolean |
showTooltip |
|
Returns
Theme(HeatMapTheme)
Specifies the theme for heatmap.
Declaration
public HeatMapBuilder Theme(HeatMapTheme theme)
Parameters
Returns
TitleSettings(HeatMapTitle)
Title of heat map
{% 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 when click the heat map cell.
{% codeBlock src='heatmap/tooltipRender/index.md' %}{% endcodeBlock %}
Declaration
public HeatMapBuilder TooltipRender(string tooltipRender)
Parameters
Type |
Name |
Description |
System.String |
tooltipRender |
|
Returns
Options for customizing the ToolTipSettings property of the heat map
{% 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)
The width of the heatmap as a string accepts input as both like '100px' or '100%'.
If specified as '100%, heatmap renders to the full width of its parent element.
Declaration
public HeatMapBuilder Width(string width)
Parameters
Type |
Name |
Description |
System.String |
width |
|
Returns
XAxis(HeatMapAxis)
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)
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