Heatmap reference

Compare a large number of metrics and dimensions

Overview

📖 Learn More about the Heatmap here.

📖 Find examples on the Heatmap here.

Parameters

Required

You must fill these parameters to produce a Heatmap

parameters label type description (placeholder | tooltip)
meta     |
dataset   string |
x X axis (columns) string (Column of dataset expected) Column containing the horizontal breakdown |
y Y axis (rows) string (Column of dataset expected) Column containing the vertical breakdown |
value Value string (Column of dataset expected) Column containing the value | Intersection of your breakdowns

Optional

You can let these parameters unset if you do not need them

parameters label type description (placeholder | tooltip)
squareHeight Square height (in pixels) number Enter a new height (default: 60) | Capped at a 40px on mobile
selectOnHover Select intersection on hover boolean |
alwaysShowValues Display all values and subvalues boolean |
mobileSize Mobile Size number Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1
xPack X Packs string (Column of dataset expected) Column containing grouping of labels | For the x axis
squareWidth Square width (in pixels) number Enter a new width (default : 60) | Capped at a 40px on mobile
showYLabelsDots Display y axis dots boolean | Between y labels and squares
packNames Display pack names boolean |
defaultSelected Default selection object |
defaultSelected/x Default selected column   |
defaultSelected/y Default selected row   |
yPack Y Packs string (Column of dataset expected) Column containing grouping of labels | For the y axis
target Target string (Column of dataset expected) Column containing target value | Will be displayed only in the legend
yLabelWidth Y labels width (in pixels) number Enter a new width (default : 100) | Capped at a 100px on mobile
tutorial Tutorial object |
tutorial/content Message string Enter your message | This will be displayed to your users
tutorial/alwaysShow Always show this tutorial boolean | By default the tutorial is shown once only
tutorial/id   string Enter an ID | Change the ID to display the tutorial again. All tutorials with the same ID will be displayed only once.
yPackOrder Y packs order   | By default, alphabetical order
subvalue Second value string (Column of dataset expected) Column containing secondary value |
yOrder Y order   | By default, alphabetical order
legend Display legend   |
size Size number Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1
opacity Square’s transparency string (Column of dataset expected) Column containing values | Will compute transparency based on the values in the column
xPackOrder X packs order   | By default, alphabetical order
drillOnLabels Allow drill on labels boolean | Users will be able to click on labels to change the view and go to its childrenCharts labels should match exactly reports labels
xOrder X order   | By default, alphabetical order

Others

This parameters are either common to all charts, or hidden from studio. You can use them in code mode, but it’s not recommended !

parameters label type description (placeholder | tooltip)
source   string |
reverse     |
xpack   string (Column of dataset expected) |
sentiment   object |
crossfilter   object | Use it for crossfilter configurationShould be configured on the primary chart
crossfilter/datasets Select the filtered datasets array | Datasets that will be filtered on the ‘on’ column
crossfilter/on on column string (Column of dataset expected) Column existing in primary and filtered datasets |
comment   string |
style   string |
ypack   string (Column of dataset expected) |