Heatmap reference¶
Compare a large number of metrics and dimensions
Parameters¶
Required¶
You must fill these parameters to produce a Heatmap
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| x | X axis (columns) | string (Column of dataset expected) | Column containing the horizontal breakdown | |
| value | Value | string (Column of dataset expected) | Column containing the value | Intersection of your breakdowns |
| meta | | | ||
| y | Y axis (rows) | string (Column of dataset expected) | Column containing the vertical breakdown | |
| dataset | string | Dataset | |
Optional¶
You can let these parameters unset if you do not need them
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| alwaysShowValues | Display all values and subvalues | boolean | | |
| packNames | Display pack names | boolean | | |
| 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 |
| xPackOrder | X packs order | | By default, alphabetical order | |
| selectOnHover | Select intersection on hover | boolean | | |
| legend | Display legend | | | |
| xOrder | X order | | By default, alphabetical order | |
| defaultSelected | Default selection | object | | |
| defaultSelected/x | Default selected column | | | |
| defaultSelected/y | Default selected row | | | |
| xPack | X Packs | string (Column of dataset expected) | Column containing grouping of labels | For the x axis |
| yOrder | Y order | | By default, alphabetical order | |
| 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. | |
| style | Custom CSS class | string | amazing-class | Set a custom CSS class to target this specific chart with CSS |
| yPackOrder | Y packs order | | By default, alphabetical order | |
| subvalue | Second value | string (Column of dataset expected) | Column containing secondary value | |
| opacity | Square’s transparency | string (Column of dataset expected) | Column containing values | Will compute transparency based on the values in the column |
| yPack | Y Packs | string (Column of dataset expected) | Column containing grouping of labels | For the y axis |
| size | Size | number | Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| target | Target | string (Column of dataset expected) | Column containing target value | Will be displayed only in the legend |
| squareHeight | Square height (in pixels) | number | Enter a new height (default: 60) | Capped at a 40px on mobile |
| mobileSize | Mobile Size | number | Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| yLabelWidth | Y labels width (in pixels) | number | Enter a new width (default : 100) | Capped at a 100px on mobile |
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 | | | ||
| ypack | string (Column of dataset expected) | | | |
| xpack | string (Column of dataset expected) | | | |
| comment | string | | | |
| 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 | |