Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Gauge Outputs

A Gauge Formula Output presents a calculated percentage as a visual gauge.

Use a Gauge when the result naturally represents progress, achievement or performance on a 0–100 scale.

Examples include:

  • Automation Rate

  • Adoption Rate

  • Utilisation

  • Completion Rate

  • Target Achievement

  • Percentage Improvement

For currency, time or general numerical results, use a Std Formula Output or Card Formula Output instead.

Adding a Gauge Output

From Components, under Outputs, select:

Gauge Formula Output

Configure the component and create the Formula that determines the value displayed by the Gauge.

How the Gauge Works

The Gauge displays the Formula result on a semi-circle scale labelled:

0 to 100

The calculated Formula result is supplied directly to the Gauge.

For example:

  • a result of 25 represents 25%;

  • a result of 50 represents 50%;

  • a result of 75 represents 75%.

The Formula should therefore calculate the percentage-style value you want displayed.

Percentage Formatting

Gauge Formula Outputs are specifically designed for percentage-style results.

A Gauge is automatically configured with:

  • Percentage formatting;

  • % as the suffix;

  • no prefix.

Although Numerical, Percentage, Time and Currency format options may be visible while configuring the component, the Gauge remains percentage formatted.

The % suffix is applied automatically and cannot be replaced with a custom suffix.

If your result needs to be presented as currency, time or a general number, use a Standard or Card Formula Output instead.

Configuring the Gauge

Gauge configuration includes:

  • Display Label

  • Display Detail

  • Display Icon

  • icon colour

  • font colour

  • background/gauge colour

  • font size

  • Formula

  • decimal places

  • tooltip

  • Visibility Condition

  • Calculate on Hidden

Use the Display Label and Display Detail to make it clear what the percentage represents.

Creating the Formula

Gauge Outputs use the same Formula Editor as Standard and Card Formula Outputs.

The Formula can reference eligible:

  • Inputs;

  • Outputs.

This allows the Gauge to represent a calculated percentage based on values elsewhere in the model.

For example, an Automation Rate Gauge might calculate the proportion of eligible activity expected to be automated.

For detailed Formula guidance, see Creating & Editing Formulas and Formula Reference.

Formula Validation

A Gauge requires a valid Formula before it can be saved.

If the Formula is missing, you may see:

Please confirm the formula.

Formula errors must be resolved before saving the component.

Decimal Places

You can configure the decimal precision used for the calculated result.

When the live Formula result is a number below 1, ROI Studio automatically sets the decimal places to 2.

Review the displayed result to make sure the chosen precision communicates the percentage clearly.

Styling the Gauge

Gauge presentation can be configured using settings including:

  • font colour;

  • gauge/background colour;

  • font size;

  • Display Icon;

  • icon colour;

  • tooltip.

Use styling consistently with the rest of the ROI Model so that the Gauge provides emphasis without making the model harder to interpret.

Conditional Visibility

Gauge Outputs support Visibility Condition.

This allows the Gauge to appear only when a specified condition is met.

When conditional visibility is enabled, you can also configure:

Calculate on Hidden

This determines whether the Gauge's underlying Formula continues calculating while the component is hidden.

Visibility and calculation behaviour are separate.

See Conditional Visibility and Calculate on Hidden for more information.

Attached Resources

Gauge Formula Outputs do not support Attached Resources.

If supporting evidence or collateral needs to be associated directly with a calculated result, consider using a Std Formula Output or Card Formula Output, both of which support Attached Resources.

Changing a Gauge to Another Output Type

An existing Gauge can be changed to:

  • Std Formula Output

  • Card Formula Output

When editing the Gauge, select:

Swap component type

Standard, Card and Gauge Formula Outputs use the same underlying Formula system, allowing you to change the presentation without rebuilding the calculation from scratch.

Changing an Existing Output to a Gauge

A Std Formula Output or Card Formula Output can also be changed into a Gauge.

When the component is saved as a Gauge, its number format becomes percentage-based:

  • Percentage is enabled;

  • % becomes the suffix;

  • the prefix is removed.

Review the Formula after changing the component to make sure its result is appropriate for a 0–100 Gauge.

Card-specific styling such as borders, shadows and separate label/value text colours does not have an equivalent on the Gauge.

When to Use a Gauge

A Gauge is most appropriate when:

  • the result is a percentage;

  • the value has a meaningful 0–100 interpretation;

  • progress or performance is easier to understand visually;

  • the result benefits from more visual emphasis than a standard inline value.

A Gauge is less appropriate when the exact number is more important than its relative position on a scale.

In those situations, a Standard or Card Formula Output may communicate the result more clearly.

PreviousOutput Components
NextTable Outputs

Last updated