Skip to content

Latest commit

 

History

History
239 lines (120 loc) · 4.74 KB

VListHandle.md

File metadata and controls

239 lines (120 loc) · 4.74 KB

API

Interface: VListHandle

Defined in: src/svelte/VList.type.ts:25

Methods of VList.

Extends

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

Inherited from

VirtualizerHandle.getItemOffset

getItemSize()

getItemSize(index): number

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

Get item size.

Parameters

index

number

index of item

Returns

number

Inherited from

VirtualizerHandle.getItemSize

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

Inherited from

VirtualizerHandle.scrollToIndex

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

Inherited from

VirtualizerHandle.scrollTo

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

Inherited from

VirtualizerHandle.scrollBy

Properties

getScrollOffset()

getScrollOffset: () => number

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

Get current scrollTop, or scrollLeft if horizontal: true.

Returns

number

Inherited from

VirtualizerHandle.getScrollOffset

getScrollSize()

getScrollSize: () => number

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

Get current scrollHeight, or scrollWidth if horizontal: true.

Returns

number

Inherited from

VirtualizerHandle.getScrollSize

getViewportSize()

getViewportSize: () => number

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

Get current offsetHeight, or offsetWidth if horizontal: true.

Returns

number

Inherited from

VirtualizerHandle.getViewportSize

findStartIndex()

findStartIndex: () => number

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

Find the start index of visible range of items.

Returns

number

Inherited from

VirtualizerHandle.findStartIndex

findEndIndex()

findEndIndex: () => number

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

Find the end index of visible range of items.

Returns

number

Inherited from

VirtualizerHandle.findEndIndex