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

    Class LayoutChildComponentElement

    The LayoutChildComponentElement interface provides properties and methods for manipulating <pc-layout-child> elements. The LayoutChildComponentElement interface also inherits the properties and methods of the HTMLElement interface.

    Engine component: LayoutChildComponent (layoutchild).

    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(): 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.

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

      Gets whether the element is excluded from the layout.

      Returns boolean

      Whether the element is excluded from layout.

    • set excludeFromLayout(value: boolean): void

      Sets whether the element should be excluded from the layout (and thus not take up space).

      Parameters

      • value: boolean

        Whether to exclude the element from layout.

      Returns void

    • get fitHeightProportion(): number

      Gets the proportion of the container's spare height this element should take.

      Returns number

      The fit height proportion.

    • set fitHeightProportion(value: number): void

      Sets the proportion of the container's spare height this element should take (when the layout group's height-fitting is set to stretch or shrink).

      Parameters

      • value: number

        The fit height proportion.

      Returns void

    • get fitWidthProportion(): number

      Gets the proportion of the container's spare width this element should take.

      Returns number

      The fit width proportion.

    • set fitWidthProportion(value: number): void

      Sets the proportion of the container's spare width this element should take (when the layout group's width-fitting is set to stretch or shrink).

      Parameters

      • value: number

        The fit width proportion.

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

      Returns 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 the data the component is created with. Overridden by subclasses to supply the initial values of their cached properties.

      Returns {
          excludeFromLayout: boolean;
          fitHeightProportion: number;
          fitWidthProportion: number;
          maxHeight: number | null;
          maxWidth: number | null;
          minHeight: number;
          minWidth: number;
      }

      The initial component data.

    • 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<LayoutChildComponentElement>

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