> For the complete documentation index, see [llms.txt](https://docs.shimoku.com/dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shimoku.com/dev/elements/charts/indicators/gauge-indicator.md).

# Gauge Indicator

The gauge indicator uses an indicator and a gauge chart and joins them with a [bentobox](broken://pages/dadvKRrogrNNufQovFK6).

{% hint style="info" %}
Each gauge indicator creates a gauge component and an indicator component, so it uses two positions in the grid, the next component has to the the order+2.
{% endhint %}

## The Method To Use <a href="#the-method-to-use" id="the-method-to-use"></a>

The method is `s.plt.gauge_indicator()`

It must contain the following input variables:

```python
order: int
value: int
```

Accepts the following input variables as optional:

```python
title: Optional[str]              # Title that shows in the left
description: Optional[str]        # Text that shows below the title
rows_size: Optional[int]          # How many rows does it occupy, by default = 1
cols_size: Optional[int]          # How many columns does it occupy, by default = 6
color: Union[str, int]            # Color of the gauge
```

## Examples

When we execute this example:

<pre class="language-python"><code class="lang-python">s.plt.gauge_indicator(
<strong>    order=0,
</strong>    value=42,
    title="Gauge Indicator",
    description="composite chart",
)
s.plt.gauge_indicator(
<strong>    order=2,
</strong>    value=24,
    title="Gauge Indicator",
    description="composite chart",
    color=2
)
</code></pre>

<figure><img src="/files/nlYFJKUa1SEkoMZzRVp6" alt=""><figcaption><p>Gauge indicators</p></figcaption></figure>

In case we don't have a static limit on how many gauge indicators we have, the following pattern can be useful:

```python
import random

order = 0

for i in range(random.randint(1, 5)):
    s.plt.gauge_indicator(
        order=order, title=f'Gauge Indicatior {i}',
        description='random gauge indicators',
        value=random.randint(0, 100),
        color=random.randint(0, 10),
    )
    order += 2
    
# Use the variable order for the next chart
```

One possible result of executing the previous code is:

<figure><img src="/files/ZKPsl6EV8nn6Sb3AWIo4" alt=""><figcaption><p>Random gauge indicators</p></figcaption></figure>


---

# 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 dynamically by asking a question.

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

```
GET https://docs.shimoku.com/dev/elements/charts/indicators/gauge-indicator.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.