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

    Class ScrollViewComponentElement

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

    Engine component: ScrollViewComponent (scrollview).

    Hierarchy (View Summary)

    Index
    bounceAmount closestApp closestEntity component content enabled friction horizontal horizontalScrollbar horizontalScrollbarVisibility mouseWheelSensitivity scrollMode useMouseWheel vertical verticalScrollbar verticalScrollbarVisibility viewport
    _onReady _resetReady getInitialComponentData initComponent 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(): EntityBaseElement | null

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

      Returns EntityBaseElement | null

      The closest entity-fronting element, or null.

    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 horizontal(): boolean

      Gets whether scrolling along the horizontal axis is enabled.

      Returns boolean

      Whether horizontal scrolling is enabled.

    • set horizontal(value: boolean): void

      Sets whether scrolling along the horizontal axis is enabled. This is a toggle, unlike the orientation of a <pc-scrollbar>, for which horizontal is one of the accepted values.

      Parameters

      • value: boolean

        Whether horizontal scrolling is enabled.

      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(): "clamp" | "bounce" | "infinite"

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

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

      The scroll mode.

    • set scrollMode(value: "clamp" | "bounce" | "infinite"): 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: "clamp" | "bounce" | "infinite"

        The scroll mode.

      Returns void

    • get vertical(): boolean

      Gets whether scrolling along the vertical axis is enabled.

      Returns boolean

      Whether vertical scrolling is enabled.

    • set vertical(value: boolean): void

      Sets whether scrolling along the vertical axis is enabled. This is a toggle, unlike the orientation of a <pc-scrollbar>, for which vertical is one of the accepted values.

      Parameters

      • value: boolean

        Whether vertical scrolling is enabled.

      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. Signals at most once per readiness cycle: a repeat call before _resetReady has re-armed the promise does nothing.

      Returns void

    Protected_resetReady

    • _resetReady(): void

      Returns the ready promise to its pending state. Subclasses should call this when the resource their readiness announced is torn down (typically from disconnectedCallback), so that a later re-initialization can signal readiness again. Does nothing while the promise is still pending — an in-flight waiter carries over to the next readiness cycle rather than being stranded on a promise nothing will ever resolve.

      Returns void

    • Returns a promise that resolves with this element when it's ready. This is the low-level primitive underlying whenReady, which is the recommended way to wait for elements.

      Readiness tracks the element's current lifecycle: once a ready element is torn down (for example by removing it from the document), this returns a fresh promise that resolves when the element is next ready. A promise obtained earlier stays resolved — call this again after re-inserting an element rather than reusing a promise from before its removal.

      Returns Promise<ScrollViewComponentElement>

      A promise that resolves with this element when it's ready.

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods