Class HeatMapBuilder

Inheritance

System.Object

ControlBuilder

HeatMapBuilder

Inherited Members

ControlBuilder.Context

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 HeatMapBuilder : ControlBuilder

Constructors

HeatMapBuilder()

Declaration

public HeatMapBuilder()

HeatMapBuilder(HeatMap)

Declaration

public HeatMapBuilder(HeatMap model)

Parameters

Type	Name	Description
HeatMap	model

Fields

model

Declaration

public HeatMap model

Field Value

Type	Description
HeatMap

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

ControlBuilder.Output

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

Type	Description
HeatMapBuilder

BackgroundColor(String)

Specifies the background color of the entire heatmap.

Declaration

public HeatMapBuilder BackgroundColor(string backgroundColor)

Parameters

Type	Name	Description
System.String	backgroundColor

Returns

Type	Description
HeatMapBuilder

CellClick(String)

Triggers when clicking on the heatmap cell.

Declaration

public HeatMapBuilder CellClick(string cellClick)

Parameters

Type	Name	Description
System.String	cellClick

Returns

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

CellSelected(String)

Triggers when heatmap cell gets selected.

Declaration

public HeatMapBuilder CellSelected(string cellSelected)

Parameters

Type	Name	Description
System.String	cellSelected

Returns

Type	Description
HeatMapBuilder

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

Type	Name	Description
HeatMapCellSettings	cellSettings

Returns

Type	Description
HeatMapBuilder

CellSettings(Action<HeatMapCellSettingsBuilder>)

Declaration

public HeatMapBuilder CellSettings(Action<HeatMapCellSettingsBuilder> cellSettings)

Parameters

Type	Name	Description
System.Action<HeatMapCellSettingsBuilder>	cellSettings

Returns

Type	Description
HeatMapBuilder

Created(String)

Triggers after heatmap is completely rendered.

Declaration

public HeatMapBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
HeatMapBuilder

DataSource(Action<DataManagerBuilder>)

Declaration

public HeatMapBuilder DataSource(Action<DataManagerBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataManagerBuilder>	dataSource

Returns

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

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

Type	Name	Description
HeatMapData	dataSourceSettings

Returns

Type	Description
HeatMapBuilder

DataSourceSettings(Action<HeatMapDataBuilder>)

Declaration

public HeatMapBuilder DataSourceSettings(Action<HeatMapDataBuilder> dataSourceSettings)

Parameters

Type	Name	Description
System.Action<HeatMapDataBuilder>	dataSourceSettings

Returns

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

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

Type	Name	Description
HeatMapLegendSettings	legendSettings

Returns

Type	Description
HeatMapBuilder

LegendSettings(Action<HeatMapLegendSettingsBuilder>)

Declaration

public HeatMapBuilder LegendSettings(Action<HeatMapLegendSettingsBuilder> legendSettings)

Parameters

Type	Name	Description
System.Action<HeatMapLegendSettingsBuilder>	legendSettings

Returns

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

Loaded(String)

Triggers after heatmap is loaded.

Declaration

public HeatMapBuilder Loaded(string loaded)

Parameters

Type	Name	Description
System.String	loaded

Returns

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

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

Type	Name	Description
HeatMapMargin	margin

Returns

Type	Description
HeatMapBuilder

Margin(Action<HeatMapMarginBuilder>)

Declaration

public HeatMapBuilder Margin(Action<HeatMapMarginBuilder> margin)

Parameters

Type	Name	Description
System.Action<HeatMapMarginBuilder>	margin

Returns

Type	Description
HeatMapBuilder

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

Type	Name	Description
HeatMapPaletteSettings	paletteSettings

Returns

Type	Description
HeatMapBuilder

PaletteSettings(Action<HeatMapPaletteSettingsBuilder>)

Declaration

public HeatMapBuilder PaletteSettings(Action<HeatMapPaletteSettingsBuilder> paletteSettings)

Parameters

Type	Name	Description
System.Action<HeatMapPaletteSettingsBuilder>	paletteSettings

Returns

Type	Description
HeatMapBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
System.Web.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

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

ShowTooltip(Boolean)

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

Type	Description
HeatMapBuilder

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

Type	Name	Description
HeatMapTheme	theme

Returns

Type	Description
HeatMapBuilder

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

Type	Name	Description
HeatMapTitle	titleSettings

Returns

Type	Description
HeatMapBuilder

TitleSettings(Action<HeatMapTitleBuilder>)

Declaration

public HeatMapBuilder TitleSettings(Action<HeatMapTitleBuilder> titleSettings)

Parameters

Type	Name	Description
System.Action<HeatMapTitleBuilder>	titleSettings

Returns

Type	Description
HeatMapBuilder

TooltipRender(String)

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

Type	Description
HeatMapBuilder

TooltipSettings(HeatMapTooltipSettings)

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

Type	Name	Description
HeatMapTooltipSettings	tooltipSettings

Returns

Type	Description
HeatMapBuilder

TooltipSettings(Action<HeatMapTooltipSettingsBuilder>)

Declaration

public HeatMapBuilder TooltipSettings(Action<HeatMapTooltipSettingsBuilder> tooltipSettings)

Parameters

Type	Name	Description
System.Action<HeatMapTooltipSettingsBuilder>	tooltipSettings

Returns

Type	Description
HeatMapBuilder

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

Type	Description
HeatMapBuilder

XAxis(HeatMapAxis)

Sets and gets the options to configure the horizontal axis.

Declaration

public HeatMapBuilder XAxis(HeatMapAxis xAxis)

Parameters

Type	Name	Description
HeatMapAxis	xAxis

Returns

Type	Description
HeatMapBuilder

XAxis(Action<HeatMapAxisBuilder>)

Declaration

public HeatMapBuilder XAxis(Action<HeatMapAxisBuilder> xAxis)

Parameters

Type	Name	Description
System.Action<HeatMapAxisBuilder>	xAxis

Returns

Type	Description
HeatMapBuilder

YAxis(HeatMapAxis)

Sets and gets the options to configure the vertical axis.

Declaration

public HeatMapBuilder YAxis(HeatMapAxis yAxis)

Parameters

Type	Name	Description
HeatMapAxis	yAxis

Returns

Type	Description
HeatMapBuilder

YAxis(Action<HeatMapAxisBuilder>)

Declaration

public HeatMapBuilder YAxis(Action<HeatMapAxisBuilder> yAxis)

Parameters

Type	Name	Description
System.Action<HeatMapAxisBuilder>	yAxis

Returns

Type	Description
HeatMapBuilder