HeatMap

Properties

allowSelection

boolean

Enable or disable the selection of multiple cells in heatmap

Defaults to false

cellSettings

CellSettingsModel

Options to customize the heat map cell

dataSource

Object

Specifies the datasource for the heat map.

Defaults to null

dataSourceSettings

DataModel

Specifies the datasource settings for heat map.

enablePersistence

boolean

Enable or disable persisting component’s state between page reloads.

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

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.

Defaults to null

legendSettings

LegendSettingsModel

Options for customizing the legend of the heat map

Defaults to ”

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

Defaults to ”

margin

MarginModel

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

paletteSettings

PaletteSettingsModel

Options for customizing the cell color of the heat map

renderingMode

string

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.

Defaults to SVG

showTooltip

boolean

Enable or disable the tool tip for heatmap

Defaults to true

theme

string

Specifies the theme for heatmap.

Defaults to ‘Material’

titleSettings

TitleModel

Title of heat map

Defaults to ”

tooltipSettings

TooltipSettingsModel

Options for customizing the ToolTipSettings property of the heat map

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.

Defaults to null

xAxis

AxisModel

Options to configure the horizontal axis.

yAxis

AxisModel

Options to configure the vertical axis.

Methods

addEventListener

Adds the handler to the given event listener.

Returns void

appendTo

Appends the control within the given HTML element

Parameter	Type	Description
selector (optional)	string | HTMLElement	Target element where control needs to be appended

Returns void

clearSelection

To clear the multi cell selection

Returns void

dataBind

When invoked, applies the pending property changes immediately to the component.

Returns void

destroy

To destroy the widget

Returns void

export

Handles the export method for heatmap control.

Returns void

getModuleName

Get component name

Returns string

getRootElement

Returns the route element of the component

Returns HTMLElement

print

Method to print the heatmap.

Returns void

refresh

Applies all the pending property changes and render the component again.

Returns void

removeEventListener

Removes the handler from the given event listener.

Returns void

Inject

Dynamically injects the required modules to the component.

Returns void

Events

cellClick

EmitType<ICellClickEventArgs>

Triggers when click the heat map cell.

cellRender

EmitType<ICellEventArgs>

Triggers before each heatmap cell renders.

cellSelected

EmitType<ISelectedEventArgs>

Triggers when multiple cells gets selected.

created

EmitType<Object>

Triggers after heat map rendered.

legendRender

EmitType<ILegendRenderEventArgs>

Triggers before the legend is rendered.

load

EmitType<ILoadedEventArgs>

Triggers before heat map load.

loaded

EmitType<ILoadedEventArgs>

Triggers after heatmap is loaded.

resized

EmitType<IResizeEventArgs>

Triggers after resizing of Heatmap.

tooltipRender

EmitType<ITooltipEventArgs>

Triggers when click the heat map cell.