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

    Interface RenderProgressStackOptions

    Options accepted by renderProgressStack.

    interface RenderProgressStackOptions {
        characters?: readonly string[];
        formatValue?: (context: ProgressStackValueContext) => string;
        height?: number;
        showLegend?: boolean;
        segments: readonly ProgressStackSegment[];
        total?: number;
        width: number;
    }
    Index

    Properties

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

    Properties

    characters?: readonly string[]

    Characters used for segments without an explicit character.

    PROGRESS_STACK_UNICODE_CHARACTERS

    formatValue?: (context: ProgressStackValueContext) => string

    Formats legend value text.

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

    height?: number

    Maximum rendered line count.

    showLegend?: boolean

    Whether legend rows are rendered under the track.

    true

    segments: readonly ProgressStackSegment[]

    Ordered segments to render.

    total?: number

    Total value represented by the full track.

    Defaults to the sum of segment values.

    width: number

    Fixed track width measured in terminal cells.

    Settings

    Member Visibility

    On This Page

    Properties