VListHandle.md

API

---

Interface: VListHandle

Methods of VList.

Extends

• VirtualizerHandle

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

---

getItemSize()

getItemSize(index): number

Get item size.

Parameters

index

number

index of item

Returns

number

Inherited from

VirtualizerHandle.getItemSize

Defined in

src/svelte/Virtualizer.type.ts:104

---

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

---

scrollTo()

scrollTo(offset): void

Scroll to the given offset.

Parameters

offset

number

offset from start

Returns

void

Inherited from

VirtualizerHandle.scrollTo

Defined in

src/svelte/Virtualizer.type.ts:115

---

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

Properties

getScrollOffset()

getScrollOffset: () => number

Get current scrollTop, or scrollLeft if horizontal: true.

Returns

number

Inherited from

VirtualizerHandle.getScrollOffset

Defined in

src/svelte/Virtualizer.type.ts:78

---

getScrollSize()

getScrollSize: () => number

Get current scrollHeight, or scrollWidth if horizontal: true.

Returns

number

Inherited from

VirtualizerHandle.getScrollSize

Defined in

src/svelte/Virtualizer.type.ts:82

---

getViewportSize()

getViewportSize: () => number

Get current offsetHeight, or offsetWidth if horizontal: true.

Returns

number

Inherited from

VirtualizerHandle.getViewportSize

Defined in

src/svelte/Virtualizer.type.ts:86

---

findStartIndex()

findStartIndex: () => number

Find the start index of visible range of items.

Returns

number

Inherited from

VirtualizerHandle.findStartIndex

Defined in

src/svelte/Virtualizer.type.ts:90

---

findEndIndex()

findEndIndex: () => number

Find the end index of visible range of items.

Returns

number

Inherited from

VirtualizerHandle.findEndIndex

Defined in

src/svelte/Virtualizer.type.ts:94