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

    Interface TrendData

    Stateful data accepted by the Blessed trend adapter.

    interface TrendData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        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

    capabilities? backgroundTone? borderTone? theme? tone? align? omission? truncatePosition? width? characters? direction label? labels? mode? overflow? value?

    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. Defaults to a tone derived from direction.

    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