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

    Interface PreformattedHandle

    Imperative handle returned by preformatted.

    interface PreformattedHandle {
        columnBackward(): { horizontalOffset: number; verticalOffset: number };
        columnForward(): { horizontalOffset: number; verticalOffset: number };
        focus(): void;
        home(): { horizontalOffset: number; verticalOffset: number };
        lineBackward(): { horizontalOffset: number; verticalOffset: number };
        lineForward(): { horizontalOffset: number; verticalOffset: number };
        offsets(): { horizontalOffset: number; verticalOffset: number };
        pageBackward(): { horizontalOffset: number; verticalOffset: number };
        pageForward(): { horizontalOffset: number; verticalOffset: number };
        scrollTo(
            offsets: { horizontalOffset?: number; verticalOffset?: number },
        ): { horizontalOffset: number; verticalOffset: number };
        element: BoxElement;
        destroy(): void;
        setData(data: PreformattedData): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    element: BoxElement

    Underlying Blessed element available for standard element operations.

    Methods

    • Moves the horizontal viewport left by one cell.

      Returns { horizontalOffset: number; verticalOffset: number }

    • Moves the horizontal viewport right by one cell.

      Returns { horizontalOffset: number; verticalOffset: number }

    • Moves both viewport offsets to zero.

      Returns { horizontalOffset: number; verticalOffset: number }

    • Moves the vertical viewport up by one row.

      Returns { horizontalOffset: number; verticalOffset: number }

    • Moves the vertical viewport down by one row.

      Returns { horizontalOffset: number; verticalOffset: number }

    • Returns current viewport offsets.

      Returns { horizontalOffset: number; verticalOffset: number }

    • Moves the vertical viewport backward by one page.

      Returns { horizontalOffset: number; verticalOffset: number }

    • Moves the vertical viewport forward by one page.

      Returns { horizontalOffset: number; verticalOffset: number }

    • Moves to absolute viewport offsets.

      Parameters

      • offsets: { horizontalOffset?: number; verticalOffset?: number }

      Returns { horizontalOffset: number; verticalOffset: number }