> For the complete documentation index, see [llms.txt](https://docs.heisenware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.heisenware.com/reference/widgets/display/linear-gauge.md).

# Linear Gauge

Horizontal or vertical bar gauge for a numeric value with sub-value marker and colored scale ranges

<figure><img src="https://3495989837-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FE5Ketpww1s7TauSAJrJ8%2Fuploads%2Fgit-blob-6501a3e3a73c637e9b28a7805bf13f522c3d133b%2Fwidget-linear-gauge.png?alt=media" alt="Three vertical linear gauges showing syrup tank levels, with colored ranges and a reorder mark at 20 %" width="488"><figcaption></figcaption></figure>

A linear gauge shows a value on a straight scale, upright or lying. It fits a tank level, a fill height or anything with a natural top and bottom, and several gauges side by side compare at a glance. Colored ranges mark the zones, and a sub-value marker shows a limit or a target, such as the level at which to reorder.

**Good for:** tank and silo levels, fill heights, compact limit displays in narrow spaces.

## Properties

The widget's General tab lists these properties under Receives and Emits. Drop an executor's output, input or trigger onto a row to link it. An example also fills an unlinked widget as demo data in the App Builder.

{% tabs %}
{% tab title="Receives" %}
**`value`** (from an output, `number`): The main indicator value.

<details>

<summary>Example</summary>

```json
42
```

</details>

**`subValue`** (from an output, `number | Array<number>`): A sub-value or an array of sub-values to visualize next to the value.

<details>

<summary>Example</summary>

```json
50
```

</details>

**`scale`** (from an output, `object`): Settings regarding the value range.

<details>

<summary>Example</summary>

```json
{
  "startValue": 0,
  "endValue": 100
}
```

</details>

**`frame`** (from an output, `object`): Allows you to configure the appearance of the frame.

<details>

<summary>Example</summary>

```json
{
  "ranges": [
    {
      "startValue": 0,
      "endValue": 60,
      "color": "#19914b"
    },
    {
      "startValue": 60,
      "endValue": 100,
      "color": "#dc2828"
    }
  ]
}
```

</details>
{% endtab %}
{% endtabs %}

## Settings

Double-click the widget in the Page editor to open its settings, grouped in these tabs. Settings marked *set per screen* are pinned by nature: every screen keeps its own value.

<details>

<summary>General</summary>

* **Animate**: Eases the display to new data in one second; off draws every update at once, for fast live data.

</details>

<details>

<summary>Frame</summary>

* **Frame**: The bar around the scale: its direction, thickness, background and colored sections.
  * **Orientation**: Direction of the gauge: vertical runs bottom to top, horizontal left to right. Choices: Vertical, Horizontal. *Set per screen.*
  * **Width**: Thickness of the bar in px. Range 1 to 20.
  * **Background color**: Color of the bar where no colored section covers it; empty or auto keeps the theme's.
  * **Color sections**: Colored sections of the bar, each from a start value to an end value.
    * **Start value**: Scale value where the section begins.
    * **End value**: Scale value where the section ends.
    * **Color**: Color of the section; empty takes the next color of the gauge's palette.

</details>

<details>

<summary>Indicator</summary>

* **Primary indicator**: The pointer that marks the bound value.
  * **Type**: Shape of the pointer that marks the value on the scale; each shape unlocks its own settings below. Choices: Rectangle, Rhombus, Circle, Range bar, Triangle marker, Text cloud.
  * **Color**: Color of the pointer; empty or auto keeps the theme's.
  * **Offset**: Distance between the pointer and the scale line in px; empty keeps the shape's default.
  * **Length**: Extent of the rectangle across the scale in px. Only when Type is Rectangle.
  * **Width**: Extent of the rectangle along the scale in px. Only when Type is Rectangle.
  * **Background color**: Color of the bar's track where the bar does not reach; none leaves it transparent. Only when Type is Range bar.
  * **Size**: Thickness of the range bar in px. Only when Type is Range bar.
  * **Arrow length**: Length of the arrow that joins the text cloud to the scale in px. Only when Type is Text cloud.
* **Subvalue indicator**: The pointer used for every bound sub-value.
  * **Type**: Shape of the pointer that marks the value on the scale; each shape unlocks its own settings below. Choices: Rectangle, Rhombus, Circle, Range bar, Triangle marker, Text cloud.
  * **Color**: Color of the pointer; empty or auto keeps the theme's.
  * **Offset**: Distance between the pointer and the scale line in px; empty keeps the shape's default.
  * **Length**: Extent of the rectangle across the scale in px. Only when Type is Rectangle.
  * **Width**: Extent of the rectangle along the scale in px. Only when Type is Rectangle.
  * **Background color**: Color of the bar's track where the bar does not reach; none leaves it transparent. Only when Type is Range bar.
  * **Size**: Thickness of the range bar in px. Only when Type is Range bar.
  * **Arrow length**: Length of the arrow that joins the text cloud to the scale in px. Only when Type is Text cloud.

</details>

<details>

<summary>Scale</summary>

* **Scale**: The value axis of the gauge: its bounds, numbers and tick marks.
  * **Start value**: Value at the start of the scale.
  * **End value**: Value at the end of the scale.
  * **Label**: The numbers written along the scale.
    * **Visible**: Shows the numbers along the scale.
    * **Size**: Font size of the scale numbers in px.
    * **Weight**: Font weight of the scale numbers, 100 (thin) to 900 (black). Range 100 to 900.
    * **Color**: Color of the scale numbers; empty or auto keeps the theme's.
  * **Major tick**: The main tick marks on the scale, one per labeled step.
    * **Visible**: Shows the major tick marks.
    * **Interval**: Distance between major ticks in scale units; empty lets the gauge choose.
    * **Length**: Length of each major tick in px.
  * **Minor tick**: The small tick marks between two major ticks.
    * **Visible**: Shows the minor tick marks.
    * **Interval**: Distance between minor ticks in scale units; empty lets the gauge choose.
    * **Length**: Length of each minor tick in px.

</details>


---

# 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.heisenware.com/reference/widgets/display/linear-gauge.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.
