HomeWeb Components API Reference - v0.10.1
    Preparing search index...

    Class ScrollViewComponentElement

    The ScrollViewComponentElement interface provides properties and methods for manipulating <pc-scrollview> elements. The ScrollViewComponentElement interface also inherits the properties and methods of the HTMLElement interface.

    Hierarchy (View Summary)

    Index
    bounceAmount closestApp closestEntity component content enabled friction horizontal horizontalScrollbar horizontalScrollbarVisibility mouseWheelSensitivity scrollMode useMouseWheel vertical verticalScrollbar verticalScrollbarVisibility viewport
    _onReady ready
    • get closestApp(): AppElement | null

      The nearest ancestor <pc-app> element, or null if this element has no <pc-app> ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns AppElement | null

      The closest app element, or null.

    • get closestEntity(): EntityElement | null

      The nearest ancestor <pc-entity> element, or null if this element has no <pc-entity> ancestor. The search starts at the parent, so an element never resolves to itself.

      Returns EntityElement | null

      The closest entity element, or null.

    • get component(): ScrollViewComponent

      Gets the underlying PlayCanvas scroll view component.

      Returns ScrollViewComponent

      The scroll view component.

    content

    • get content(): string

      Gets the reference to the <pc-entity> used as the content.

      Returns string

      The content entity reference.

    • set content(value: string): void

      Sets the reference (CSS selector, element id or entity name) to the <pc-entity> used as the content, which is moved as the scroll view is scrolled.

      Parameters

      • value: string

        The content entity reference.

      Returns void

    • get enabled(): boolean

      Gets the enabled state of the component.

      Returns boolean

      The enabled state of the component.

    • set enabled(value: boolean): void

      Sets the enabled state of the component.

      Parameters

      • value: boolean

        The enabled state of the component.

      Returns void

    • get horizontalScrollbar(): string

      Gets the reference to the <pc-entity> containing the horizontal scrollbar.

      Returns string

      The horizontal scrollbar entity reference.

    • set horizontalScrollbar(value: string): void

      Sets the reference (CSS selector, element id or entity name) to the <pc-entity> containing the horizontal <pc-scrollbar>.

      Parameters

      • value: string

        The horizontal scrollbar entity reference.

      Returns void

    • get horizontalScrollbarVisibility(): "always" | "when-required"

      Gets the visibility of the horizontal scrollbar.

      Returns "always" | "when-required"

      The horizontal scrollbar visibility.

    • set horizontalScrollbarVisibility(value: "always" | "when-required"): void

      Sets the visibility of the horizontal scrollbar. Can be always or when-required. Defaults to when-required.

      Parameters

      • value: "always" | "when-required"

        The horizontal scrollbar visibility.

      Returns void

    • get scrollMode(): "infinite" | "clamp" | "bounce"

      Gets how the scroll view behaves when the content is scrolled beyond its bounds.

      Returns "infinite" | "clamp" | "bounce"

      The scroll mode.

    • set scrollMode(value: "infinite" | "clamp" | "bounce"): void

      Sets how the scroll view should behave when the content is scrolled beyond its bounds. Can be clamp, bounce or infinite. Defaults to bounce.

      Parameters

      • value: "infinite" | "clamp" | "bounce"

        The scroll mode.

      Returns void

    • get verticalScrollbar(): string

      Gets the reference to the <pc-entity> containing the vertical scrollbar.

      Returns string

      The vertical scrollbar entity reference.

    • set verticalScrollbar(value: string): void

      Sets the reference (CSS selector, element id or entity name) to the <pc-entity> containing the vertical <pc-scrollbar>.

      Parameters

      • value: string

        The vertical scrollbar entity reference.

      Returns void

    • get verticalScrollbarVisibility(): "always" | "when-required"

      Gets the visibility of the vertical scrollbar.

      Returns "always" | "when-required"

      The vertical scrollbar visibility.

    • set verticalScrollbarVisibility(value: "always" | "when-required"): void

      Sets the visibility of the vertical scrollbar. Can be always or when-required. Defaults to when-required.

      Parameters

      • value: "always" | "when-required"

        The vertical scrollbar visibility.

      Returns void

    • get viewport(): string

      Gets the reference to the <pc-entity> used as the viewport.

      Returns string

      The viewport entity reference.

    • set viewport(value: string): void

      Sets the reference (CSS selector, element id or entity name) to the <pc-entity> used as the viewport, which clips the content to the scroll view's bounds.

      Parameters

      • value: string

        The viewport entity reference.

      Returns void

    Protected_onReady

    • _onReady(): void

      Called when the element is fully initialized and ready. Subclasses should call this when they're ready. Resolves the ready promise and dispatches a bubbling, composed ready event.

      Returns void

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods