API

---

Interface: VirtualizerHandle

Defined in: src/vue/Virtualizer.tsx:120

Methods of Virtualizer.

Extended by

• VListHandle

Methods

findItemIndex()

findItemIndex(offset): number

Defined in: src/vue/Virtualizer.tsx:141

Find nearest item index from offset.

Parameters

offset

number

offset in pixels from the start of the scroll container

Returns

number

---

getItemOffset()

getItemOffset(index): number

Defined in: src/vue/Virtualizer.tsx:146

Get item offset from start.

Parameters

index

number

index of item

Returns

number

---

getItemSize()

getItemSize(index): number

Defined in: src/vue/Virtualizer.tsx:151

Get item size.

Parameters

index

number

index of item

Returns

number

---

scrollToIndex()

scrollToIndex(index, opts?): void

Defined in: src/vue/Virtualizer.tsx:157

Scroll to the item specified by index.

Parameters

index

number

index of item

opts?

ScrollToIndexOpts

options

Returns

void

---

scrollTo()

scrollTo(offset): void

Defined in: src/vue/Virtualizer.tsx:162

Scroll to the given offset.

Parameters

offset

number

offset from start

Returns

void

---

scrollBy()

scrollBy(offset): void

Defined in: src/vue/Virtualizer.tsx:167

Scroll by the given offset.

Parameters

offset

number

offset from current position

Returns

void

Properties

cache

readonly cache: CacheSnapshot

Defined in: src/vue/Virtualizer.tsx:124

Get current CacheSnapshot.

---

scrollOffset

readonly scrollOffset: number

Defined in: src/vue/Virtualizer.tsx:128

Get current scrollTop, or scrollLeft if horizontal: true. Always positive even in RTL.

---

scrollSize

readonly scrollSize: number

Defined in: src/vue/Virtualizer.tsx:132

Get current scrollHeight, or scrollWidth if horizontal: true.

---

viewportSize

readonly viewportSize: number

Defined in: src/vue/Virtualizer.tsx:136

Get current clientHeight, or clientWidth if horizontal: true.