• Studio

  • Studio API

  • Bots

  • Web API

  • Designer Resources

  • Host Resources

  • Globals

    IScrollView

    Abstraction over a scrollable view, exposing scroll offset, viewport and content sizing information, and the common controls for programmatic scrolling.

    Properties

    The element that holds the full content, which may be only partially visible within the viewport.

    The visible window into ; content outside this region is clipped.

    isAtEnd

    boolean
    ClientOnly
    ReadOnly

    True when the scroll offset has reached (or passed) the end of the scrollable range.

    isEnabled

    boolean
    ClientOnly

    Enables or disables the underlying gesture recognizer. When false, the scroll view stops responding to user input.

    isInertiaEnabled

    boolean
    ClientOnly

    When true, the scroll view continues to scroll with a decaying velocity after the user releases a touch drag.

    isPagingEnabled

    boolean
    ClientOnly

    When true, the scroll view snaps to full pages instead of allowing free scrolling.

    isPanEndIntercepted

    () -> (boolean)
    ClientOnly

    Optional predicate consulted at the end of a pan gesture. When it returns true, the scroll view suppresses its usual end-of-pan handling (settling, inertia, paging snap).

    isReversed

    boolean
    ClientOnly

    When true, the first item is laid out at the end and subsequent items are laid out before it. For horizontal layouts, the effective direction also depends on RightToLeft.IsEnabled.

    isScrollOffsetLocked

    boolean
    ClientOnly

    When true, assignments to are ignored, effectively freezing the scroll position.

    isScrollWheelEnabled

    boolean
    ClientOnly

    When true, the scroll view responds to mouse scroll wheel events.

    onScrollableSizeChanged

    (obj: number) -> ()
    ClientOnly

    Invoked when changes; the callback receives the new scrollable size.

    pageEndOffset

    number
    ClientOnly

    An offset subtracted from the viewport size when computing the size of a page. Only applies when is true.

    When true, the scroll view will not automatically clamp its value when the scrollable size changes. Useful when external code is managing the scroll offset directly.

    scrollableSize

    number
    ClientOnly
    ReadOnly

    The total amount of scrollable distance, equal to the content size minus the viewport size. Returns zero when the content fits within the viewport.

    shouldFadeEdges

    boolean
    ClientOnly

    When true, the edges of the scroll view fade out visually to indicate that more content exists beyond the viewport.

    value

    number
    ClientOnly

    The current scroll offset along the scroll axis. Setting this value notifies value-changed listeners unless is true.

    viewportSize

    number
    ClientOnly
    ReadOnly

    The size of the viewport along the scroll axis, including its padding.

    worldBound

    ClientOnly
    ReadOnly

    The world-space bounding rectangle of the scroll view.

    Methods

    Shift the current scroll offset and related internal anchors by the given delta without firing a change notification. Useful when content is inserted or removed and the visible position should be preserved.

    Parameters

    offset
    number

    Returns

    void

    CancelAnimation

    ClientOnly

    Stop any in-progress scroll animation immediately, leaving the scroll offset at its current value.

    Returns

    void

    Scroll to the beginning of the content (offset = 0).

    Parameters

    animationDuration
    number
    optional

    Duration of the scroll animation in seconds. Zero scrolls instantly.

    Returns

    void

    ScrollToEnd

    ClientOnly

    Scroll to the end of the content (offset = ).

    Parameters

    animationDuration
    number
    optional

    Duration of the scroll animation in seconds. Zero scrolls instantly.

    Returns

    void

    ScrollToOffset

    ClientOnly

    Scroll to an absolute offset along the scroll axis.

    Parameters

    offset
    number

    Target scroll offset, clamped to [0, ].

    animationDuration
    number
    optional

    Duration of the scroll animation in seconds. Zero scrolls instantly.

    propagateAnimation
    boolean
    optional

    When false, the scroll-end notification is suppressed.

    Returns

    void
    PocketWorlds Icon

    © 2026 Pocket Worlds. All rights reserved.