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

    Class ScrollbarComponentElement

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

    Hierarchy (View Summary)

    Index
    • 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(): ScrollbarComponent

      Gets the underlying PlayCanvas scrollbar component.

      Returns ScrollbarComponent

      The scrollbar component.

    • 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 handle(): string

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

      Returns string

      The handle entity reference.

    • set handle(value: string): void

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

      Parameters

      • value: string

        The handle entity reference.

      Returns void

    • get orientation(): "horizontal" | "vertical"

      Gets the orientation of the scrollbar.

      Returns "horizontal" | "vertical"

      The orientation.

    • set orientation(value: "horizontal" | "vertical"): void

      Sets the orientation of the scrollbar. Can be horizontal or vertical. Defaults to horizontal.

      Parameters

      • value: "horizontal" | "vertical"

        The orientation.

      Returns 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