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

    Interface StackedGaugeData

    Stateful data accepted by the Blessed stackedGauge adapter.

    interface StackedGaugeData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        characters?: StackedGaugeCharacters;
        tone?: keyof ThemeColors;
        formatValue?: (context: StackedGaugeValueContext) => string;
        height?: number;
        label?: string;
        showLegend?: boolean;
        segments: readonly StackedGaugeSegment[];
        total?: number;
        width: number;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? capabilities? characters? tone? formatValue? height? label? showLegend? segments total? width

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">

    Explicit terminal capabilities used for deterministic rendering.

    characters?: StackedGaugeCharacters

    Custom stacked gauge characters.

    tone?: keyof ThemeColors

    Semantic foreground token.

    'foreground'

    formatValue?: (context: StackedGaugeValueContext) => string

    Formats legend value text.

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

    height?: number

    Maximum rendered line count.

    label?: string

    Optional text rendered before the gauge track.

    showLegend?: boolean

    Whether legend rows are rendered under the track.

    true

    segments: readonly StackedGaugeSegment[]

    Ordered segments to render.

    total?: number

    Total value represented by the full track.

    Defaults to the sum of segment values.

    width: number

    Positive integer width reserved for the gauge track.

    Settings

    Member Visibility

    On This Page

    Properties