Heatmap reference

Compare a large number of metrics and dimensions

Overview

📖 Learn More about the Heatmap here.

📖 Find examples on the Heatmap here.

Options

Available in studio

parameters label type optional description choices
squareWidth Square width (in pixels) number True Enter a new width (default : 60) (Capped at a 40px on mobile)  
xPack   string True Column containing a grouping of labels (For the x axis)  
yPack   string True Column containing a grouping of labels (For the y axis)  
subvalue Subvalue string True Column containing a secondary value  
selectOnHover Select intersection on hover? boolean True    
drillOnLabels Allow drill on labels boolean True (Users will be able to click on labels to change the view)  
opacity Square’s transparency string True Column containing the value (0-1)  
value Value string   Column containing the value (Intersection of your breakdowns)  
squareHeight Square height (in pixels) number True Enter a new height (default: 60) (Capped at a 40px on mobile)  
showYLabelsDots Display y axis dots boolean True (Between y labels and squares)  
target Target string True Column containing a target value (Will be displayed only in the legend)  
y Y axis (rows) string   Column containing the vertical breakdown  
x X axis (columns) string   Column containing the horizontal breakdown  
yLabelWidth Y labels width (in pixels) number True Enter a new width (default : 100) (Capped at a 100px on mobile)  
alwaysShowValues Display all values and subvalues boolean True    

Only in code mode

parameters label type optional description choices
yPackOrder   oneOf   Select your dataset column  
xOrder   oneOf   Select your dataset column  
style   string True    
source   string      
xPackOrder   oneOf   Select your dataset column  
legend   anyOf      
reverse   oneOf      
xpack   string      
yOrder   oneOf   Select your dataset column  
comment   string      
ypack   string      

Code mode sample

charts: [
  {
    "y": "",
    "chartType": "new-heatmap",
    "value": "",
    "x": ""
  }
]