Skip to main content

Heatmap

Ant Design

The Heatmap chart shows a grid of cells shaded by value, which reveals patterns across two categories, such as order volume by weekday and time of day.

Properties​

Property
Description
Expected Value
DataThe cells to show, one row per pair of x and y values, such as [{ day, hour, value }].Array
X fieldName of the field in Data that holds the column category, such as a weekday.Text. Default: x
Y fieldName of the field that holds the row category, such as a time of day.Text. Default: y
Color fieldName of the field that holds each cell's number. Higher values get a darker shade.Text. Default: value
TitleHeading shown above the chart.Text
LabelShows each cell's value inside the cell.On or off. Default: Off
Highlight clicked pointKeeps the clicked cell at full strength and fades the rest, until another cell is clicked or Clear clicked point runs.On or off. Default: Off

Additional Actions​

Each of these can be switched on or off, or set with a logical expression by clicking fx.

Property
Description
Expected Value
VisibilityShows or hides the component. Hidden components keep their space unless Collapse when hidden is on.On or off. Default: On
Collapse when hiddenRemoves the hidden component's space, so the components below it move up.On or off. Default: Off
Loading stateShows the component's loading look and blocks interaction, for example while a query runs.On or off. Default: Off
DisableStops the user from interacting with the component.On or off. Default: Off

Devices​

Property
Description
Expected Value
Show on desktopShows the component in the desktop layout.On or off. Default: On
Show on mobileShows the component in the mobile layout.On or off. Default: Off

Events​

Add a handler from the Events section of the properties panel. See Event Triggers for the steps.

Event
Description
On element clickTriggers when the user clicks a cell.

Component Specific Actions (CSA)​

Run these from an event handler with Control Component, or from a RunJS query. See Component Specific Actions.

Action
Description
How To Access
Clear clicked pointClears the clicked mark, which empties selectedDatum and removes the highlight.components.heatmap1.clearClickedPoint()
Set visibilityShows the component when true, hides it when false.components.heatmap1.setVisibility(false)
Set disableDisables the component when true, enables it when false.components.heatmap1.setDisable(false)
Set loadingTurns the loading state on with true, off with false.components.heatmap1.setLoading(false)

Exposed Variables​

Variable
Description
How To Access
dataThe cells to show, one row per pair of x and y values, such as [{ day, hour, value }].{{components.heatmap1.data}}
xFieldName of the field in Data that holds the column category, such as a weekday.{{components.heatmap1.xField}}
yFieldName of the field that holds the row category, such as a time of day.{{components.heatmap1.yField}}
colorFieldName of the field that holds each cell's number. Higher values get a darker shade.{{components.heatmap1.colorField}}
titleHeading shown above the chart.{{components.heatmap1.title}}
labelShows each cell's value inside the cell.{{components.heatmap1.label}}
highlightClickedKeeps the clicked cell at full strength and fades the rest, until another cell is clicked or Clear clicked point runs.{{components.heatmap1.highlightClicked}}
selectedDatumThe data row of the cell the user clicked last. It is empty after Clear clicked point.{{components.heatmap1.selectedDatum}}
isVisibleWhether the component is visible.{{components.heatmap1.isVisible}}
isLoadingWhether the component is in its loading state.{{components.heatmap1.isLoading}}
isDisabledWhether the component is disabled.{{components.heatmap1.isDisabled}}

Styles​

Style
Default
Primary colorTheme: Brand primary
Text colorTheme: Primary text
Container backgroundTheme: Surface 1
Border colorTheme: Default border
Border radius—
Box shadow0px 0px 0px 0px #00000040

A default that starts with Theme: follows the app's theme until the style is set to another value. See App Themes.