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

    Interface RenderStackedGaugeOptions

    Options accepted by renderStackedGauge.

    interface RenderStackedGaugeOptions {
        characters?: StackedGaugeCharacters;
        formatValue?: (context: StackedGaugeValueContext) => string;
        height?: number;
        label?: string;
        showLegend?: boolean;
        segments: readonly StackedGaugeSegment[];
        total?: number;
        width: number;
    }
    Index

    Properties

    characters? formatValue? height? label? showLegend? segments total? width

    Properties

    characters?: StackedGaugeCharacters

    Characters used to render the stacked gauge.

    { empty: '░', leftCap: '[', rightCap: ']', segments: STACKED_GAUGE_UNICODE_CHARACTERS }

    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