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

    Interface RenderTrendOptions

    Options accepted by renderTrend.

    interface RenderTrendOptions {
        align?: TextAlign;
        omission?: string;
        truncatePosition?: "end" | "middle" | "start";
        width?: number;
        characters?: TrendCharacters;
        direction: TrendDirection;
        label?: string;
        labels?: TrendDirectionLabels;
        mode?: TrendMode;
        overflow?: "clip" | "truncate";
        value?: string | number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    align? omission? truncatePosition? width? characters? direction label? labels? mode? overflow? value?

    Properties

    align?: TextAlign

    Horizontal alignment applied after overflow handling.

    'left'

    omission?: string

    Omission marker used by truncate overflow.

    '…'

    truncatePosition?: "end" | "middle" | "start"

    Truncation position used by truncate overflow.

    'end'

    width?: number

    Maximum rendered width measured in terminal cells.

    characters?: TrendCharacters

    Glyphs used for up, down, and flat trends.

    Every glyph must be non-empty.

    { up: '↑', down: '↓', flat: '→' }

    direction: TrendDirection

    Semantic direction used to select a character and fallback text.

    label?: string

    Optional context rendered after the trend value.

    labels?: TrendDirectionLabels

    Text labels used by text and symbol-text modes.

    { up: 'up', down: 'down', flat: 'flat' }

    mode?: TrendMode

    Direction rendering strategy.

    'symbol'

    overflow?: "clip" | "truncate"

    Single-line overflow policy.

    'truncate'

    value?: string | number

    Magnitude or text describing the change. Numeric values must be finite.

    Settings

    Member Visibility

    On This Page

    Properties