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

    Interface DataTableHandle<TRow>

    Imperative handle returned by dataTable.

    interface DataTableHandle<TRow extends TableRow = TableRow> {
        activeId(): string | undefined;
        focus(): void;
        focusRow(id: string): string | undefined;
        first(): string | undefined;
        hiddenColumnIds(): readonly string[];
        last(): string | undefined;
        next(): string | undefined;
        nextPage(): number;
        page(): { page: number; pageCount: number };
        pageBackward(): string | undefined;
        pageForward(): string | undefined;
        previousPage(): number;
        previous(): string | undefined;
        query(): string | undefined;
        selectActive(): string | undefined;
        setHiddenColumnIds(hiddenColumnIds: readonly string[]): readonly string[];
        setPage(page: number): number;
        setQuery(query: string): void;
        setSort(sort: DataTableSort | undefined): void;
        sort(): DataTableSort | undefined;
        toggleSort(columnId: string): DataTableSort | undefined;
        value(): string | undefined;
        element: BoxElement;
        destroy(): void;
        setData(data: DataTableData): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Moves the cursor to an enabled row identifier on the current page.

      Parameters

      • id: string

      Returns string | undefined

    • Moves the cursor to the next enabled row, wrapping at the end of the page.

      Returns string | undefined

    • Returns the current 1-based page and total page count.

      Returns { page: number; pageCount: number }

    • Moves the cursor one viewport page backward, or to the previous page when paginated.

      Returns string | undefined

    • Moves the cursor one viewport page forward, or to the next page when paginated.

      Returns string | undefined

    • Moves the cursor to the previous enabled row, wrapping at the start of the page.

      Returns string | undefined

    • Replaces hidden column identifiers. Ignores a request that would hide every column.

      Parameters

      • hiddenColumnIds: readonly string[]

      Returns readonly string[]

    • Moves to a specific 1-based page. Clamped to the available page range.

      Parameters

      • page: number

      Returns number