The Heat Map component for Retool Apps

A content area to display heat maps.

The Heat Map component renders data on an x-axis and y-axis, with a value for each point on the map. Heat Map is useful for visualizing intensity and identifying patterns or correlations.

Refer to the charts guide for more information on building charts.

Demo

Settings

Heat Map includes the following configurable options when building apps in the IDE.

Chart typeNode colorsDataData sourceShow color scale legend on chartHiddenShow on desktopShow on mobileLegend postitionMaintain space when hiddenMarginAlways show in edit modeStyles

Properties

All properties for Heat Map with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

chartType

enum

The type of chart to display.

Values

bar	Bar Chart or Stacked Bar Chart.
bubble	Bubble Chart.
funnel	Funnel Chart.
heatmap	Heat Map.
line	Line Chart or Sparkline.
mixed	Mixed Chart.
pie	Pie Chart.
plotlyJson	Plotly JSON Chart.
sankey	Sankey Chart.
scatter	Scatter Chart.
line	Sparkline.
sunburst	Sunburst Chart.
treemap	Treemap.
waterfall	Waterfall Chart.

---

colorArray

string[]

The color scale for the chart, input as an array of colors.

---

colorArrayDropDown

string[]

The color scale for the chart, manually selected.

---

colorInputMode

enum

The mode for the color input.

---

data

object

The data for the heatmap.

Properties

dataLabelPosition

---

dataLabelTemplate

string

The template for the data label.

---

datasource

object[]

The data source.

---

hoverTemplate

string

The template for the information presented when you hover over a point.

---

type

enum

The type of chart to display.

Values

bar	Bar Chart or Stacked Bar Chart.
bubble	Bubble Chart.
funnel	Funnel Chart.
heatmap	Heat Map.
line	Line Chart or Sparkline.
mixed	Mixed Chart.
pie	Pie Chart.
plotlyJson	Plotly JSON Chart.
sankey	Sankey Chart.
scatter	Scatter Chart.
line	Sparkline.
sunburst	Sunburst Chart.
treemap	Treemap.
waterfall	Waterfall Chart.

---

values

number[]

The values for the points on the heatmap.

---

xData

array

The x-axis data.

---

yData

array

The y-axis data.

---

---

datasource

object[]

The data source.

---

datasourceMode

enum

The data source mode.

Values

manual	Manual.
source	Source.

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

gradientColorArray

object[]

The color scale for the chart.

---

heatmapShowScale

boolean

Whether to show the color scale on the heatmap.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

legendPosition

enum

The position of the legend.

Values

bottom	Bottom.
left	Left.
none	None.
right	Right.
left	Top.

---

linkColorArray

array

The link color scale for the chart, input as an array of colors.

---

linkColorArrayDropDown

string

The link color scale for the chart, manually selected.

---

linkColorInputMode

enum

The input mode for the link color scale.

Values

colorArray	Color array.
gradientColorArray	Gradient color array.
colorArrayDropDown	Color array dropdown.

---

linkGradientColorArray

array

The link color scale for the chart.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

pluginType

string

The plugin type.

---

selectedPoints

object[]

A list of selected points.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

title

string

The text to display as a title.

---

Methods

JavaScript API methods for interacting with Heat Map. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

heatMap.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

---

---

---

setHidden

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

heatMap.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.

clear

The value is cleared.

---

hover

A chart is hovered over.

---

legendClick

A chart legend is clicked.

---

legendDoubleClick

A chart legend is double clicked.

---

select

A value is selected.

---

unhover

A chart is no longer hovered over.

---