ScrollContainer
Defined in: ui/collection/scroll-container.ts:32
Scroll state for a virtualized view. Clamps offset to the legal range
[0, contentSize - viewportSize] and notifies listeners on any change.
The ScrollContainer itself has no input knowledge; a system pushes
wheel / drag deltas into scrollBy. Consumers that need to react
(e.g. a ListView) subscribe via onScroll.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ScrollContainer(
opts):ScrollContainer
Defined in: ui/collection/scroll-container.ts:43
Parameters
Section titled “Parameters”ScrollContainerOptions
Returns
Section titled “Returns”ScrollContainer
Methods
Section titled “Methods”dispose()
Section titled “dispose()”dispose():
void
Defined in: ui/collection/scroll-container.ts:134
Returns
Section titled “Returns”void
getContentSize()
Section titled “getContentSize()”getContentSize():
Vec2
Defined in: ui/collection/scroll-container.ts:62
Returns
Section titled “Returns”getDecelerationRate()
Section titled “getDecelerationRate()”getDecelerationRate():
number
Defined in: ui/collection/scroll-container.ts:85
Returns
Section titled “Returns”number
getDragScroll()
Section titled “getDragScroll()”getDragScroll():
boolean
Defined in: ui/collection/scroll-container.ts:81
Returns
Section titled “Returns”boolean
getMaxOffset()
Section titled “getMaxOffset()”getMaxOffset():
Vec2
Defined in: ui/collection/scroll-container.ts:66
Returns
Section titled “Returns”getOffset()
Section titled “getOffset()”getOffset():
Vec2
Defined in: ui/collection/scroll-container.ts:54
Returns
Section titled “Returns”getShowScrollbar()
Section titled “getShowScrollbar()”getShowScrollbar():
boolean
Defined in: ui/collection/scroll-container.ts:73
Returns
Section titled “Returns”boolean
getViewportSize()
Section titled “getViewportSize()”getViewportSize():
Vec2
Defined in: ui/collection/scroll-container.ts:58
Returns
Section titled “Returns”getWheelSpeed()
Section titled “getWheelSpeed()”getWheelSpeed():
number
Defined in: ui/collection/scroll-container.ts:77
Returns
Section titled “Returns”number
onScroll()
Section titled “onScroll()”onScroll(
listener): () =>void
Defined in: ui/collection/scroll-container.ts:127
Parameters
Section titled “Parameters”listener
Section titled “listener”ScrollListener
Returns
Section titled “Returns”() => void
scrollBy()
Section titled “scrollBy()”scrollBy(
delta):void
Defined in: ui/collection/scroll-container.ts:108
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
setContentSize()
Section titled “setContentSize()”setContentSize(
size):void
Defined in: ui/collection/scroll-container.ts:121
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
setOffset()
Section titled “setOffset()”setOffset(
offset):void
Defined in: ui/collection/scroll-container.ts:89
Parameters
Section titled “Parameters”offset
Section titled “offset”Returns
Section titled “Returns”void
setViewportSize()
Section titled “setViewportSize()”setViewportSize(
size):void
Defined in: ui/collection/scroll-container.ts:115
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void