API

---

Interface: VirtualizerHandle

Defined in: src/svelte/Virtualizer.type.ts:93

Methods of Virtualizer.

Extended by

• VListHandle

Methods

findItemIndex()

findItemIndex(offset): number

Defined in: src/svelte/Virtualizer.type.ts:114

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/svelte/Virtualizer.type.ts:119

Get item offset from start.

Parameters

index

number

index of item

Returns

number

---

getItemSize()

getItemSize(index): number

Defined in: src/svelte/Virtualizer.type.ts:124

Get item size.

Parameters

index

number

index of item

Returns

number

---

scrollToIndex()

scrollToIndex(index, opts?): void

Defined in: src/svelte/Virtualizer.type.ts:130

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/svelte/Virtualizer.type.ts:135

Scroll to the given offset.

Parameters

offset

number

offset from start

Returns

void

---

scrollBy()

scrollBy(offset): void

Defined in: src/svelte/Virtualizer.type.ts:140

Scroll by the given offset.

Parameters

offset

number

offset from current position

Returns

void

Properties

getCache

getCache: () => CacheSnapshot

Defined in: src/svelte/Virtualizer.type.ts:97

Get current CacheSnapshot.

Returns

CacheSnapshot

---

getScrollOffset

getScrollOffset: () => number

Defined in: src/svelte/Virtualizer.type.ts:101

Get current scrollTop, or scrollLeft if horizontal: true.

Returns

number

---

getScrollSize

getScrollSize: () => number

Defined in: src/svelte/Virtualizer.type.ts:105

Get current scrollHeight, or scrollWidth if horizontal: true.

Returns

number

---

getViewportSize

getViewportSize: () => number

Defined in: src/svelte/Virtualizer.type.ts:109

Get current offsetHeight, or offsetWidth if horizontal: true.

Returns

number