# Sankey

With the "Sankey" module, you can embed Sankey diagrams in a widget.

Sankey diagrams are particularly well-suited for displaying inflows and outflows to a quantity.

Since the inflows and outflows are represented by arrows with a thickness proportional to the quantity, energy flows, for example, can be made intuitively understandable.

<figure><img src="https://3489494878-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9GvUpaatBiReR43XFSMg%2Fuploads%2FTxuqzZtp9Q6zleiD7PLH%2FA44982D5-25AB-4CDD-925C-63B338D5F795.png?alt=media&#x26;token=cfb1d67a-2b04-4975-9fe5-ec9800e906ab" alt=""><figcaption></figcaption></figure>

<table><thead><tr><th width="57.133321126302064"></th><th width="129.4000244140625"></th><th></th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Description</td><td>This text is displayed when the custom widget is later connected to assets</td></tr><tr><td><strong>[B]</strong></td><td>Text</td><td>Free text</td></tr><tr><td><strong>[C]</strong></td><td>Show total</td><td>Displays the sum of all sinks, rounded to whole numbers.</td></tr></tbody></table>

{% hint style="info" %}
You can learn how this module is used in practice [->here](/collection/platform/live-cockpit/widgets/predefined-widgets/sankey-diagram.md)
{% endhint %}


---

# 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.buildings.ability.abb/collection/platform/live-cockpit/widgets/custom-widgets/modules/sankey.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.
