# Tile Heatmap

<figure><img src="https://1809014303-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZxYYf1KpgarKMgMsDCrw%2Fuploads%2Fgit-blob-8b9d6d2213da356f38f609495199643249c53d1b%2Fwidget-heatmap.png?alt=media" alt="Tile Heatmap"><figcaption><p>Tile Heatmap</p></figcaption></figure>

## Overview

The heatmap is good for comparison. Use the heatmap to get an overview of what’s happening across a large number of metrics and dimensions. Each value represents the intersection of the the x-axis and the y-axis. You can also add a secondary value (for instance variation vs last period).

## Options

| Option             | Mandatory | Description                                                     |
| ------------------ | --------- | --------------------------------------------------------------- |
| `title`            | `✅`       | Title of your tile                                              |
| `value`            | `✅`       | Column containing the value of the intersection of x & y        |
| `columns (x axis)` | `✅`       | Column name containing the columns labels                       |
| `rows (y axis)`    | `✅`       | Column name containing the rows labels                          |
| `columns order`    | **❌**     | Specify the order of the columns (x axis)                       |
| `rows order`       | **❌**     | specify the order of the rows (y axis)                          |
| `columns packs`    | **❌**     | Column name containing grouping for the columns (x axis)        |
| `row packs`        | **❌**     | Column name containing grouping for the rows (y axis)           |
| `source`           | **❌**     | Text displayed to give additional information (ex: data source) |

### Display

| Option                  | Mandatory | Description                                                                                                   |
| ----------------------- | --------- | ------------------------------------------------------------------------------------------------------------- |
| `custom width`          | **❌**     | <p>Choose between XS, S, M, L and XL to increase the width of your tile</p><p><strong>Default</strong>: S</p> |
| `display all values`    | **❌**     | Set true to always show values and subvalues                                                                  |
| `square's transparency` | **❌**     | Column containing a number between 0 and 1                                                                    |
| `rows labels width`     | **❌**     | Size of rows's labels width. In pixels.                                                                       |
| `squares' height`       | **❌**     | Size of squares' height. In pixels.                                                                           |
| `squares' width`        | **❌**     | Size of squares' width width. In pixels.                                                                      |

### Enrich Navigation

| Option    | Mandatory | Description                                                                   |
| --------- | --------- | ----------------------------------------------------------------------------- |
| `link to` | **❌**     | Allows to redirect to a Story or to an external URL when clicking on the tile |
