Interface ViewportModel

Headless two-dimensional viewport state.

interface ViewportModel {
    ensureVisible(rect: ViewportRect): ViewportSnapshot;
    setContentSize(size: { height: number; width: number }): ViewportSnapshot;
    resize(size: ViewportSize): ViewportSnapshot;
    scrollBy(offset: ViewportOffsetInput): ViewportSnapshot;
    scrollTo(offset: ViewportOffsetInput): ViewportSnapshot;
    snapshot(): ViewportSnapshot;
}

Index

Methods

ensureVisible setContentSize resize scrollBy scrollTo snapshot

Methods

ensureVisible

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

setContentSize

setContentSize(size: { height: number; width: number }): ViewportSnapshot
Replaces content dimensions and reclamps current offsets.
Parameters
- size: { height: number; width: number }
Returns ViewportSnapshot
- Defined in primitives/viewport/index.ts:77

resize

resize(size: ViewportSize): ViewportSnapshot
Replaces viewport dimensions and reclamps current offsets.
Parameters
- size: ViewportSize
Returns ViewportSnapshot
- Defined in primitives/viewport/index.ts:80

scrollBy

scrollBy(offset: ViewportOffsetInput): ViewportSnapshot
Scrolls by relative cell and row deltas.
Parameters
- offset: ViewportOffsetInput
Returns ViewportSnapshot
- Defined in primitives/viewport/index.ts:83

scrollTo

scrollTo(offset: ViewportOffsetInput): ViewportSnapshot
Scrolls to absolute content offsets.
Parameters
- offset: ViewportOffsetInput
Returns ViewportSnapshot
- Defined in primitives/viewport/index.ts:86

snapshot

snapshot(): ViewportSnapshot
Returns an immutable state snapshot.

Returns ViewportSnapshot
- Defined in primitives/viewport/index.ts:89