Class ScrollView

constructor

• new ScrollView(): ScrollView

• Returns ScrollView

_debugDrawEnabled

_enableScrollInertia

_scrollLimit

enableHorizontalScroll

enableScrollLimit

enableVerticalScroll

scrollAreaBounds

transform

contentLength

• get contentLength(): number

• Returns number

  the length of the content along the y-axis in local units relative to the ScrollView canvas.
• set contentLength(length): void

• Parameters

  • length: number

    the length of the content along the y-axis in local units relative to the ScrollView canvas.

  Returns void

contentOffset

• get contentOffset(): Rect

• Returns Rect

  the offset to each content edge and the ScrollArea in world units relative to the canvas' rotation.

contentPosition

• get contentPosition(): vec3

• Returns vec3

• set contentPosition(position): void

• Parameters

  • position: vec3

  Returns void

debugDrawEnabled

• get debugDrawEnabled(): boolean

• Returns boolean

• set debugDrawEnabled(debugDrawEnabled): void

• Parameters

  • debugDrawEnabled: boolean

  Returns void

enableScrollInertia

• get enableScrollInertia(): boolean

• Returns boolean

• set enableScrollInertia(enableScrollInertia): void

• Parameters

  • enableScrollInertia: boolean

  Returns void

onFocusEnter

• get onFocusEnter(): PublicApi<ScrollViewFocusEventArgs>

• Returns PublicApi<ScrollViewFocusEventArgs>

onFocusExit

• get onFocusExit(): PublicApi<ScrollViewFocusEventArgs>

• Returns PublicApi<ScrollViewFocusEventArgs>

onReady

• get onReady(): PublicApi<void>

• Returns PublicApi<void>

onScrollUpdate

• get onScrollUpdate(): PublicApi<ScrollViewEventArgs>

• Returns PublicApi<ScrollViewEventArgs>

onSnapUpdate

• get onSnapUpdate(): PublicApi<ScrollViewEventArgs>

• Returns PublicApi<ScrollViewEventArgs>

overflow

• get overflow(): number

• Returns number

  the amount of content overflow along the y-axis in local units relative to the ScrollView's canvas.

scrollAreaSize

• get scrollAreaSize(): vec2

• Returns vec2

  the ScrollArea's size in local units relative to the ScrollView canvas.

scrollColliderBounds

• get scrollColliderBounds(): vec2

• Returns vec2

  the ScrollArea collider's BoxShape's bounds.
• set scrollColliderBounds(bounds): void

• Parameters

  • bounds: vec2

    the ScrollArea collider's BoxShape's bounds.

  Returns void

scrollLimit

• get scrollLimit(): number

• Returns number

• set scrollLimit(limit): void

• Parameters

  • limit: number

  Returns void

scrollPercentage

• get scrollPercentage(): number

• Returns number

  the scroll percentage of the ScrollView (0=top of ScrollView, 1= bottom).

checkContentEdgeFullyVisible

• checkContentEdgeFullyVisible(xEdge, yEdge): boolean

• Checks if both inputted content edges are fully visible in the ScrollArea.

  Parameters

  • xEdge: -1 | 0 | 1

    0 if not checking any x-axis edge, 1 for right edge, -1 for left edge.
  • yEdge: -1 | 0 | 1

    0 if not checking any y-axis edge, 1 for top edge, -1 for bottom edge.

  Returns boolean

onAwake

• onAwake(): void

• Returns void

recomputeBoundaries

• recomputeBoundaries(): void

• Returns void

resetContentOrigin

• resetContentOrigin(): void

• Resets the content origin for the purpose of calculating scrollPercentage. Assumes that the ScrollView is currently at the top of content in the pooling use case.

  Returns void

scrollBy

• scrollBy(dragVector): void

• Parameters

  • dragVector: vec2

  Returns void

snapToEdges

• snapToEdges(selectedEdges): void

• Parameters

  • selectedEdges: EdgeSelector

  Returns void