Interface ScrollAreaModel

One-dimensional scrolling behavior shared by vertical and horizontal views.

interface ScrollAreaModel {
    end(): number;
    home(): number;
    lineBackward(amount?: number): number;
    lineForward(amount?: number): number;
    metrics(): ScrollAreaMetrics;
    pageBackward(): number;
    pageForward(): number;
    setSizes(sizes: ScrollAreaSizes): number;
    scrollTo(offset: number): number;
}

Index

Methods

end home lineBackward lineForward metrics pageBackward pageForward setSizes scrollTo

Methods

end

end(): number
Moves to the maximum offset.

Returns number
- Defined in primitives/scroll-area/index.ts:51

home

home(): number
Moves to offset zero.

Returns number
- Defined in primitives/scroll-area/index.ts:54

lineBackward

lineBackward(amount?: number): number
Moves backward by one or more cells.
Parameters
- Optionalamount: number
Returns number
- Defined in primitives/scroll-area/index.ts:57

lineForward

lineForward(amount?: number): number
Moves forward by one or more cells.
Parameters
- Optionalamount: number
Returns number
- Defined in primitives/scroll-area/index.ts:60

metrics

metrics(): ScrollAreaMetrics
Returns current content and scrollbar measurements.

Returns ScrollAreaMetrics
- Defined in primitives/scroll-area/index.ts:63

pageBackward

pageBackward(): number
Moves backward by one page minus configured overlap.

Returns number
- Defined in primitives/scroll-area/index.ts:66

pageForward

pageForward(): number
Moves forward by one page minus configured overlap.

Returns number
- Defined in primitives/scroll-area/index.ts:69

setSizes

setSizes(sizes: ScrollAreaSizes): number
Replaces dimensions and reclamps the offset.
Parameters
- sizes: ScrollAreaSizes
Returns number
- Defined in primitives/scroll-area/index.ts:72

scrollTo

scrollTo(offset: number): number
Moves to an absolute offset.
Parameters
- offset: number
Returns number
- Defined in primitives/scroll-area/index.ts:75