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

    Interface ThresholdsData

    Stateful data accepted by the Blessed thresholds adapter.

    interface ThresholdsData {
        capabilities?: Pick<TerminalCapabilities, "colorLevel">;
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        tone?: keyof ThemeColors;
        emptyText?: string;
        formatRange?: (context: ThresholdFormatContext) => string;
        max: number;
        min: number;
        separator?: string;
        thresholds: readonly ThresholdRange[];
        value?: number;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capabilities? backgroundTone? borderTone? theme? tone? emptyText? formatRange? max min separator? thresholds value? width?

    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.

    'foreground'

    emptyText?: string

    Text returned when thresholds is empty.

    'No thresholds'

    formatRange?: (context: ThresholdFormatContext) => string

    Formats each resolved range.

    ({ start, end }) => ${start}..${end}``

    max: number

    Upper domain bound.

    min: number

    Lower domain bound.

    separator?: string

    Separator used between horizontal ranges.

    ' '

    thresholds: readonly ThresholdRange[]

    Ordered qualitative ranges.

    value?: number

    Optional value used to mark one active range.

    width?: number

    Optional maximum width of each rendered line.

    Settings

    Member Visibility

    On This Page

    Properties