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

    Class LayoutGroupComponentElement

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

    Engine component: LayoutGroupComponent (layoutgroup).

    Hierarchy (View Summary)

    Index
    alignment closestApp closestEntity component enabled heightFitting orientation padding reverseX reverseY spacing widthFitting wrap
    _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.

    • 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 heightFitting(): "none" | "stretch" | "shrink" | "both"

      Gets the fitting mode along the vertical axis.

      Returns "none" | "stretch" | "shrink" | "both"

      The height fitting mode.

    • set heightFitting(value: "none" | "stretch" | "shrink" | "both"): void

      Sets the fitting mode along the vertical axis. Can be none, stretch, shrink or both. Defaults to none.

      Parameters

      • value: "none" | "stretch" | "shrink" | "both"

        The height fitting mode.

      Returns void

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

      Gets the orientation of the layout group.

      Returns "horizontal" | "vertical"

      The orientation.

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

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

      Parameters

      • value: "horizontal" | "vertical"

        The orientation.

      Returns void

    • get reverseX(): boolean

      Gets whether the order of children is reversed along the horizontal axis.

      Returns boolean

      Whether the horizontal order is reversed.

    • set reverseX(value: boolean): void

      Sets whether the order of children is reversed along the horizontal axis.

      Parameters

      • value: boolean

        Whether to reverse the horizontal order.

      Returns void

    • get reverseY(): boolean

      Gets whether the order of children is reversed along the vertical axis.

      Returns boolean

      Whether the vertical order is reversed.

    • set reverseY(value: boolean): void

      Sets whether the order of children is reversed along the vertical axis.

      Parameters

      • value: boolean

        Whether to reverse the vertical order.

      Returns void

    • get widthFitting(): "none" | "stretch" | "shrink" | "both"

      Gets the fitting mode along the horizontal axis.

      Returns "none" | "stretch" | "shrink" | "both"

      The width fitting mode.

    • set widthFitting(value: "none" | "stretch" | "shrink" | "both"): void

      Sets the fitting mode along the horizontal axis. Can be none, stretch, shrink or both. Defaults to none.

      Parameters

      • value: "none" | "stretch" | "shrink" | "both"

        The width fitting mode.

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

      Returns {
          alignment: Vec2;
          heightFitting: number | undefined;
          orientation: number | undefined;
          padding: Vec4;
          reverseX: boolean;
          reverseY: boolean;
          spacing: Vec2;
          widthFitting: number | undefined;
          wrap: boolean;
      }

      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<LayoutGroupComponentElement>

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

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods