# Tile Heatmap

<figure><img src="/files/Io42sLU6pxWFlLTFdqdc" 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 |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs-v3.toucantoco.com/visualizations-and-layouts/apps/home/creating-tiles/tile-heatmap.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
