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

    Class LayoutChildComponentElement

    The LayoutChildComponentElement interface provides properties and methods for manipulating <pc-layoutchild> elements. The LayoutChildComponentElement 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(): LayoutChildComponent

      Gets the underlying PlayCanvas layout child component.

      Returns LayoutChildComponent

      The layout child 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 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

    • get maxHeight(): number | null

      Gets the maximum height the element should be laid out with.

      Returns number | null

      The maximum height.

    • set maxHeight(value: number | null): void

      Sets the maximum height the element should be laid out with (or null for no limit).

      Parameters

      • value: number | null

        The maximum height.

      Returns void

    • get maxWidth(): number | null

      Gets the maximum width the element should be laid out with.

      Returns number | null

      The maximum width.

    • set maxWidth(value: number | null): void

      Sets the maximum width the element should be laid out with (or null for no limit).

      Parameters

      • value: number | null

        The maximum width.

      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