ScrollViewOptions

Defined in: ui/widgets/scroll-view.ts:24

Properties

background?

optional background?: UIVisualInit

Defined in: ui/widgets/scroll-view.ts:36

Viewport background. Default: a transparent hit-target (so the wheel works).

---

contentSize

contentSize: Vec2

Defined in: ui/widgets/scroll-view.ts:32

Pixel size of the scrollable content frame.

---

decelerationRate?

optional decelerationRate?: number

Defined in: ui/widgets/scroll-view.ts:44

Fling velocity fraction left after 1s of coasting. Default 0.135.

---

direction?

optional direction?: "both" | "vertical" | "horizontal"

Defined in: ui/widgets/scroll-view.ts:38

Scroll axis. Default ‘vertical’.

---

dragScroll?

optional dragScroll?: boolean

Defined in: ui/widgets/scroll-view.ts:42

Drag/touch scrolling with a kinetic fling. Default true.

---

host

host: ListViewHost

Defined in: ui/widgets/scroll-view.ts:27

The plugin that routes scroll input (uiPlugin).

---

node?

optional node?: UINodeInit

Defined in: ui/widgets/scroll-view.ts:34

Extra viewport UINode props (its size defaults to viewportSize).

---

onScroll?

optional onScroll?: (offset) => void

Defined in: ui/widgets/scroll-view.ts:45

Parameters

offset

Vec2

Returns

void

---

parent?

optional parent?: number

Defined in: ui/widgets/scroll-view.ts:28

---

viewportSize

viewportSize: Vec2

Defined in: ui/widgets/scroll-view.ts:30

Pixel size of the visible window.

---

wheelSpeed?

optional wheelSpeed?: number

Defined in: ui/widgets/scroll-view.ts:40

Wheel delta multiplier. Default 1.

---

world

world: World

Defined in: ui/widgets/scroll-view.ts:25