Layout class

A container holding the components that are visible on the screen.

Signature:

export declare class Layout extends AbstractLayout implements ILayout 

Extends: AbstractLayout

Implements: ILayout

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Layout class.

Properties

PropertyModifiersTypeDescription
Direction

static

readonly

typeof LayoutDirectionEnumeration that controls how non-overlapping sibling layout elements are arranged.
Position

static

readonly

typeof LayoutPositionEnumeration that defines a position within layout element

Methods

MethodModifiersDescription
getComponent(componentId)Get a component of this layout by it's id

Layout.Direction property

Warning: This API is now obsolete.

Use LayoutDirection

Enumeration that controls how non-overlapping sibling layout elements are arranged.

Signature:

static readonly Direction: typeof LayoutDirection;

Layout.getComponent() method

Get a component of this layout by it's id

Signature:

getComponent(componentId: string): Component | undefined;

Parameters

ParameterTypeDescription
componentIdstringThe identifier for the component

Returns:

Component | undefined

A component instance, or undefined if no component with the given componentId exists.

Layout.Position property

Warning: This API is now obsolete.

Use LayoutPosition

Enumeration that defines a position within layout element

Signature:

static readonly Position: typeof LayoutPosition;