VirtualizerHandle.md

API

---

Interface: VirtualizerHandle

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

Methods of Virtualizer.

Extended by

• VListHandle

Methods

getItemOffset()

getItemOffset(index): number

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

Get item offset from start.

Parameters

index

number

index of item

Returns

number

---

getItemSize()

getItemSize(index): number

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

Get item size.

Parameters

index

number

index of item

Returns

number

---

scrollToIndex()

scrollToIndex(index, opts?): void

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

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:115

Scroll to the given offset.

Parameters

offset

number

offset from start

Returns

void

---

scrollBy()

scrollBy(offset): void

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

Scroll by the given offset.

Parameters

offset

number

offset from current position

Returns

void

Properties

getScrollOffset()

getScrollOffset: () => number

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

Get current scrollTop, or scrollLeft if horizontal: true.

Returns

number

---

getScrollSize()

getScrollSize: () => number

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

Get current scrollHeight, or scrollWidth if horizontal: true.

Returns

number

---

getViewportSize()

getViewportSize: () => number

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

Get current offsetHeight, or offsetWidth if horizontal: true.

Returns

number

---

findStartIndex()

findStartIndex: () => number

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

Find the start index of visible range of items.

Returns

number

---

findEndIndex()

findEndIndex: () => number

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

Find the end index of visible range of items.

Returns

number