Class ModelLayout

A layout within the model: the main layout, a sublayout hosted in a tab, or a popout (a native window or floating panel) layout. Layouts are passed to the popout props (ILayoutProps.renderPopoutContent, ILayoutProps.onPopoutOpen, ILayoutProps.onPopoutClose) and are also reachable from the model's layout map (see Model).

Index

Constructors

Methods

getLayoutId getName getPath getRect getType getWindow isMainLayout visitNodes

Constructors

constructor

new ModelLayout(
    layoutId: string,
    subLayoutId: number,
    type: ILayoutType,
    rect: Rect,
    json?: IJsonSubLayout,
): ModelLayout
Parameters
- layoutId: string
- subLayoutId: number
- type: ILayoutType
- rect: Rect
- Optionaljson: IJsonSubLayout
Returns ModelLayout

Methods

getLayoutId

getLayoutId(): string

the id of this layout

Returns string

getName

getName(): string | undefined

the name of this layout, e.g. as shown in the model explorer; undefined if not set

Returns string | undefined

getPath

getPath(): string

the path of this layout within the model, e.g. /sublayout1

Returns string

getRect

getRect(): Rect

the rectangle of this layout (popout windows/floating panels)

Returns Rect

getType

getType(): ILayoutType

the type of this layout: window, float or tab

Returns ILayoutType

getWindow

getWindow(): Window | undefined

the browser window this layout is rendered in (the popout window for a popout layout)

Returns Window | undefined

isMainLayout

isMainLayout(): boolean

whether this is the main layout

Returns boolean

visitNodes

visitNodes(fn: (node: Node, level: number) => void): void
visit every node in this layout's tree
Parameters
- fn: (node: Node, level: number) => void
Returns void