Gauge¶

class foxglove.layouts.GaugePanel¶

Display a colored gauge based on a continuous value.

For more information, see the documentation.

Example¶

import foxglove.layouts as fl

layout = fl.Layout(
    content=fl.GaugePanel(
        config=fl.GaugeConfig(
            path="/topic.field",
            min_value=0,
            max_value=100,
            color_mode="gradient",
            gradient=("#0000ff", "#ff0000"),
        ),
    ),
)

config: GaugeConfig¶

title: str | None = None¶: The title of the panel.

class foxglove.layouts.GaugeConfig¶

Configuration for the Gauge panel.

color_map: Optional[Literal['red-yellow-green', 'rainbow', 'turbo']] = None¶: Preset gradients for the gauge

color_mode: Optional[Literal['colormap', 'gradient']] = None¶: Type of gradient to use for the gauge

gradient: tuple[str, str] | None = None¶: Starting and ending color stops for custom gradient

max_value: float | None = None¶: Maximum value for the gauge

min_value: float | None = None¶: Minimum value for the gauge

path: str | None = None¶: Message path containing a numeric value (or string value that can be coerced to a numeric value)

reverse: bool | None = None¶: Reverse the colors of the gauge

reverse_direction: bool | None = None¶: Reverse the direction of the gauge (min on right, max on left)

style: Literal['dial', 'bar'] = 'dial'¶: Visual style of the gauge