Interface ViewportHandle

Imperative handle returned by viewport.

interface ViewportHandle {
    element: BoxElement;
    destroy(): void;
    setData(data: ViewportData): void;
    contentElement: BoxElement;
    ensureVisible(rect: ViewportRect): ViewportSnapshot;
    resize(): ViewportSnapshot;
    scrollBy(offset: ViewportOffsetInput): ViewportSnapshot;
    scrollTo(offset: ViewportOffsetInput): ViewportSnapshot;
    snapshot(): ViewportSnapshot;
}

Hierarchy (View Summary)

BlessedComponentHandle<ViewportData, blessed.Widgets.BoxElement>
- ViewportHandle

Index

Properties

element contentElement

Methods

destroy setData ensureVisible resize scrollBy scrollTo snapshot

Properties

`Readonly`element

element: BoxElement

Underlying Blessed element available for standard element operations.

`Readonly`contentElement

contentElement: BoxElement

Inner element that receives caller-owned content children.

Methods

destroy

destroy(): void
Destroys and detaches the owned element without destroying its parent.

Returns void
Inherited from BlessedComponentHandle.destroy
- Defined in adapters/blessed/types.ts:23

setData

setData(data: ViewportData): void
Re-renders component content using complete replacement data.

The element identity is preserved. Call screen.render() explicitly when one or more updates should become visible.
Parameters
- data: ViewportData
Returns void
Inherited from BlessedComponentHandle.setData
- Defined in adapters/blessed/types.ts:31

ensureVisible

ensureVisible(rect: ViewportRect): ViewportSnapshot
Scrolls the minimum distance needed to reveal a content rectangle.
Parameters
- rect: ViewportRect
Returns ViewportSnapshot
- Defined in adapters/blessed/viewport.ts:50

resize

resize(): ViewportSnapshot
Re-measures visible dimensions from the Blessed container.

Returns ViewportSnapshot
- Defined in adapters/blessed/viewport.ts:53

scrollBy

scrollBy(offset: ViewportOffsetInput): ViewportSnapshot
Scrolls by relative terminal cells and rows.
Parameters
- offset: ViewportOffsetInput
Returns ViewportSnapshot
- Defined in adapters/blessed/viewport.ts:56

scrollTo

scrollTo(offset: ViewportOffsetInput): ViewportSnapshot
Scrolls to an absolute content offset.
Parameters
- offset: ViewportOffsetInput
Returns ViewportSnapshot
- Defined in adapters/blessed/viewport.ts:59

snapshot

snapshot(): ViewportSnapshot
Returns current visible dimensions, content dimensions, and offsets.

Returns ViewportSnapshot
- Defined in adapters/blessed/viewport.ts:62