> For the complete documentation index, see [llms.txt](https://docs.buildings.ability.abb/collection/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.buildings.ability.abb/collection/platform/live-cockpit/widgets/predefined-widgets/heatmap.md).

# Heatmap

The "Heatmap" widget visualizes values through color areas on a map.

<div data-full-width="true"><figure><img src="https://3489494878-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9GvUpaatBiReR43XFSMg%2Fuploads%2FFmRVlX1iauG4CLDrICV4%2F8C4CAE4F-CB91-4A52-8DC5-617B91C8BE8D.png?alt=media&#x26;token=d7dafd08-8faf-4aa0-baba-5e895c19c1a5" alt=""><figcaption><p>The "Heatmap" widget</p></figcaption></figure></div>

## When should this display be used?

This display is well-suited for recognizing and clearly visualizing patterns in complex data. One possible application would be, for example, the visualization of the presence of people in one or more buildings.

## Overview

<div data-full-width="true"><figure><img src="https://3489494878-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9GvUpaatBiReR43XFSMg%2Fuploads%2Fn5ipymOkYmqBz7MnfjVF%2F3951B30D-3E7C-44A0-8BA9-E028704F26FB.png?alt=media&#x26;token=a662d244-af83-41c8-99f0-b36da00f5f73" alt=""><figcaption></figcaption></figure></div>

<table data-full-width="true"><thead><tr><th width="69.73332722981769"></th><th width="272.20001220703125"></th><th></th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Title</td><td>Is influenced by the primary asset</td></tr><tr><td><strong>[B]</strong></td><td>Icon</td><td></td></tr><tr><td><strong>[C]</strong></td><td>Visualizations of asset values</td><td>Each of the three color dots represents values from one asset</td></tr><tr><td><strong>[D]</strong></td><td>Zoom in</td><td>Enlarges the map display</td></tr><tr><td><strong>[E]</strong></td><td>Zoom out</td><td>Reduces the map display</td></tr><tr><td><strong>[F]</strong></td><td>Home view</td><td>Switches to the home view</td></tr><tr><td><strong>[G]</strong></td><td>Current location</td><td>Switches to the user's current location.<br>Caution: BuildingPro Suites needs permission to access the user's location for this</td></tr><tr><td><strong>[H]</strong></td><td>Center assets</td><td>Displays all assets present in the widget</td></tr></tbody></table>

## Configuration

<figure><img src="https://2013058394-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FOqGnkz52o2zVUsEGEZGk%2Fuploads%2F5eIYAyS1XsKe6OBp3XJo%2FGroup%20681.png?alt=media&amp;token=89a4d4a1-a4b3-4b95-8874-48377dfb472f" alt=""><figcaption></figcaption></figure>

1. Make sure you are in the "Dashboard" menu
2. Click on "Add widget"
3. Click on "View"
4. Click on "Heatmap"
5. Select the primary asset. The name of this asset will appear in the title bar of the widget **\[A]**.
6. Choose whether the color coding should be static or dynamic **\[B]** Static: The calculation of the value range is done automatically Dynamic: You can set the value range manually
7. Select an asset that you want to add
8. Select an attribute for the asset **\[C]** \[Note: This field only appears after you have completed the previous step]
9. (Optional) Give the asset an individual title **\[D]**
10. Choose whether the current value or an aggregated value should be displayed **\[E]**
11. Add more assets if necessary **\[F]**
12. Optional: Choose how much space your new widget should occupy on the dashboard **\[H]**
13. Click on "Add widget" **\[G]**


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.buildings.ability.abb/collection/platform/live-cockpit/widgets/predefined-widgets/heatmap.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
