Skip to content

Latest commit

 

History

History
261 lines (131 loc) · 4.79 KB

VListHandle.md

File metadata and controls

261 lines (131 loc) · 4.79 KB

API


Interface: VListHandle

Methods of VList.

Extends

Methods

getItemOffset()

getItemOffset(index): number

Get item offset from start.

Parameters

index

number

index of item

Returns

number

Inherited from

VirtualizerHandle.getItemOffset

Defined in

src/react/Virtualizer.tsx:67


getItemSize()

getItemSize(index): number

Get item size.

Parameters

index

number

index of item

Returns

number

Inherited from

VirtualizerHandle.getItemSize

Defined in

src/react/Virtualizer.tsx:72


scrollToIndex()

scrollToIndex(index, opts?): void

Scroll to the item specified by index.

Parameters

index

number

index of item

opts?

ScrollToIndexOpts

options

Returns

void

Inherited from

VirtualizerHandle.scrollToIndex

Defined in

src/react/Virtualizer.tsx:78


scrollTo()

scrollTo(offset): void

Scroll to the given offset.

Parameters

offset

number

offset from start

Returns

void

Inherited from

VirtualizerHandle.scrollTo

Defined in

src/react/Virtualizer.tsx:83


scrollBy()

scrollBy(offset): void

Scroll by the given offset.

Parameters

offset

number

offset from current position

Returns

void

Inherited from

VirtualizerHandle.scrollBy

Defined in

src/react/Virtualizer.tsx:88

Properties

cache

readonly cache: CacheSnapshot

Get current CacheSnapshot.

Inherited from

VirtualizerHandle.cache

Defined in

src/react/Virtualizer.tsx:42


scrollOffset

readonly scrollOffset: number

Get current scrollTop, or scrollLeft if horizontal: true.

Inherited from

VirtualizerHandle.scrollOffset

Defined in

src/react/Virtualizer.tsx:46


scrollSize

readonly scrollSize: number

Get current scrollHeight, or scrollWidth if horizontal: true.

Inherited from

VirtualizerHandle.scrollSize

Defined in

src/react/Virtualizer.tsx:50


viewportSize

readonly viewportSize: number

Get current offsetHeight, or offsetWidth if horizontal: true.

Inherited from

VirtualizerHandle.viewportSize

Defined in

src/react/Virtualizer.tsx:54


findStartIndex()

findStartIndex: () => number

Find the start index of visible range of items.

Returns

number

Inherited from

VirtualizerHandle.findStartIndex

Defined in

src/react/Virtualizer.tsx:58


findEndIndex()

findEndIndex: () => number

Find the end index of visible range of items.

Returns

number

Inherited from

VirtualizerHandle.findEndIndex

Defined in

src/react/Virtualizer.tsx:62