Indicator

class foxglove.layouts.IndicatorPanel

Display a colored and/or textual indicator based on a threshold value.

For more information, see the documentation.

Example

import foxglove.layouts as fl

layout = fl.Layout(
    content=fl.IndicatorPanel(
        config=fl.IndicatorConfig(
            path="/topic.status",
            style="bulb",
            rules=[
                fl.IndicatorRule(operator="=", raw_value="OK", color="#00ff00", label="OK"),
                fl.IndicatorRule(operator="=", raw_value="ERROR", color="#ff0000", label="Error"),
            ],
            fallback_color="#888888",
            fallback_label="Unknown",
        ),
    ),
)

config: IndicatorConfig

title: str | None = None

The title of the panel.

class foxglove.layouts.IndicatorConfig

Configuration for the Indicator panel.

fallback_color: str | None = None

Color to use when no other rules match

fallback_label: str | None = None

Label to use when no other rules match

font_size: float | None = None

Font size of the indicator

path: str | None = None

Message path to the data

rules: list[IndicatorRule] | None = None

Range rules list to determine what the indicator should display, evaluated in order of precedence

style: Optional[Literal['bulb', 'background']] = None

Style of indicator to display

class foxglove.layouts.IndicatorRule

A rule to determine what the indicator should display

color: str | None = None

Color to use when the rule matches

label: str | None = None

Label to use when the rule matches

operator: Optional[Literal['=', '<', '<=', '>', '>=']] = None

Operator to use for the indicator rule

raw_value: str | None = None

Value to compare against