blessed-components - v1.20.0
    Preparing search index...

    Interface GaugeData

    Stateful data accepted by the Blessed gauge adapter.

    interface GaugeData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        characters?: GaugeCharacters;
        formatValue?: (context: GaugeValueContext) => string;
        label?: string;
        max?: number;
        min?: number;
        thresholds?: readonly ThresholdRange[];
        value: number;
        width: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? characters? formatValue? label? max? min? thresholds? value width

    Properties

    capabilities?: Pick<TerminalCapabilities, "colorLevel">

    Explicit color capability used for deterministic rendering.

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    characters?: GaugeCharacters

    Characters used to render the gauge track.

    { filled: '█', empty: '░', leftCap: '[', rightCap: ']' }

    formatValue?: (context: GaugeValueContext) => string

    Formats the value text appended after the track.

    ({ percentage }) => ${percentage}%``

    label?: string

    Optional text rendered before the gauge track.

    max?: number

    Upper bound of the numeric range.

    100

    min?: number

    Lower bound of the numeric range.

    0

    thresholds?: readonly ThresholdRange[]

    Ordered qualitative ranges matched against the clamped value.

    value: number

    Current finite numeric value.

    width: number

    Positive integer width reserved for the gauge track.

    Settings

    Member Visibility

    On This Page

    Properties