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

    Class ScreenComponentElement

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

    Hierarchy (View Summary)

    Index
    closestApp closestEntity component enabled
    _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 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

    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