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

    Interface LogExplorerData

    Stateful data accepted by the Blessed logExplorer adapter.

    interface LogExplorerData {
        characters?: LogViewerCharacters;
        emptyText?: string;
        filter?: LogExplorerFilter;
        noMatchesText?: string;
        onEntriesChange?: (entries: readonly LogEntry[]) => void;
        onFilteredEntriesChange?: (entries: readonly LogEntry[]) => void;
        onFilterChange?: (filter: LogExplorerFilter) => void;
        onOffsetChange?: (offset: number) => void;
        onPausedChange?: (paused: boolean) => void;
        pageOverlap?: number;
        showLevel?: boolean;
        showSource?: boolean;
        showTimestamp?: boolean;
        defaultPaused?: boolean;
        entries?: readonly LogEntry[];
        follow?: boolean;
        maxEntries?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    characters? emptyText? filter? noMatchesText? onEntriesChange? onFilteredEntriesChange? onFilterChange? onOffsetChange? onPausedChange? pageOverlap? showLevel? showSource? showTimestamp? defaultPaused? entries? follow? maxEntries?

    Properties

    characters?: LogViewerCharacters

    Character tokens for row structure and level state.

    emptyText?: string

    Text displayed when no entries exist before filtering.

    filter?: LogExplorerFilter

    Search and facet filters.

    noMatchesText?: string

    Text displayed when filters hide all entries.

    onEntriesChange?: (entries: readonly LogEntry[]) => void

    Called when visible raw entries change after append, resume, clear, or setData.

    onFilteredEntriesChange?: (entries: readonly LogEntry[]) => void

    Called when filtered visible entries change.

    onFilterChange?: (filter: LogExplorerFilter) => void

    Called when filters change through LogExplorerHandle.setFilter.

    onOffsetChange?: (offset: number) => void

    Called when visual offset changes.

    onPausedChange?: (paused: boolean) => void

    Called when pause state changes.

    pageOverlap?: number

    Rows retained between page operations.

    1

    showLevel?: boolean

    Whether to include level markers.

    true

    showSource?: boolean

    Whether to include source text.

    true

    showTimestamp?: boolean

    Whether to include timestamps.

    false

    defaultPaused?: boolean

    Whether append operations are queued instead of displayed.

    entries?: readonly LogEntry[]

    Initial visible entries.

    follow?: boolean

    Whether visible offset follows appended entries.

    true

    maxEntries?: number

    Maximum retained visible entries.

    1000

    Settings

    Member Visibility

    On This Page

    Properties