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 |
|---|---|---|
| Data | The cells to show, one row per pair of x and y values, such as [{ day, hour, value }]. | Array |
| X field | Name of the field in Data that holds the column category, such as a weekday. | Text. Default: x |
| Y field | Name of the field that holds the row category, such as a time of day. | Text. Default: y |
| Color field | Name of the field that holds each cell's number. Higher values get a darker shade. | Text. Default: value |
| Title | Heading shown above the chart. | Text |
| Label | Shows each cell's value inside the cell. | On or off. Default: Off |
| Highlight clicked point | Keeps 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 |
|---|---|---|
| Visibility | Shows or hides the component. Hidden components keep their space unless Collapse when hidden is on. | On or off. Default: On |
| Collapse when hidden | Removes the hidden component's space, so the components below it move up. | On or off. Default: Off |
| Loading state | Shows the component's loading look and blocks interaction, for example while a query runs. | On or off. Default: Off |
| Disable | Stops the user from interacting with the component. | On or off. Default: Off |
Devices​
Property | Description | Expected Value |
|---|---|---|
| Show on desktop | Shows the component in the desktop layout. | On or off. Default: On |
| Show on mobile | Shows 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 click | Triggers 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 point | Clears the clicked mark, which empties selectedDatum and removes the highlight. | components.heatmap1.clearClickedPoint() |
| Set visibility | Shows the component when true, hides it when false. | components.heatmap1.setVisibility(false) |
| Set disable | Disables the component when true, enables it when false. | components.heatmap1.setDisable(false) |
| Set loading | Turns the loading state on with true, off with false. | components.heatmap1.setLoading(false) |
Exposed Variables​
Variable | Description | How To Access |
|---|---|---|
data | The cells to show, one row per pair of x and y values, such as [{ day, hour, value }]. | {{components.heatmap1.data}} |
xField | Name of the field in Data that holds the column category, such as a weekday. | {{components.heatmap1.xField}} |
yField | Name of the field that holds the row category, such as a time of day. | {{components.heatmap1.yField}} |
colorField | Name of the field that holds each cell's number. Higher values get a darker shade. | {{components.heatmap1.colorField}} |
title | Heading shown above the chart. | {{components.heatmap1.title}} |
label | Shows each cell's value inside the cell. | {{components.heatmap1.label}} |
highlightClicked | Keeps the clicked cell at full strength and fades the rest, until another cell is clicked or Clear clicked point runs. | {{components.heatmap1.highlightClicked}} |
selectedDatum | The data row of the cell the user clicked last. It is empty after Clear clicked point. | {{components.heatmap1.selectedDatum}} |
isVisible | Whether the component is visible. | {{components.heatmap1.isVisible}} |
isLoading | Whether the component is in its loading state. | {{components.heatmap1.isLoading}} |
isDisabled | Whether the component is disabled. | {{components.heatmap1.isDisabled}} |
Styles​
Style | Default |
|---|---|
| Primary color | Theme: Brand primary |
| Text color | Theme: Primary text |
| Container background | Theme: Surface 1 |
| Border color | Theme: Default border |
| Border radius | — |
| Box shadow | 0px 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.