Interface ILayout

A description of the application's user interface layout.

interface ILayout {
    downArea: null | IDownArea;
    fresh?: boolean;
    leftArea: null | ISideArea;
    mainArea: null | IMainArea;
    relativeSizes: null | number[];
    rightArea: null | ISideArea;
    topArea: null | ITopArea;
}

Properties

downArea fresh? leftArea mainArea relativeSizes rightArea topArea

Properties

Readonly downArea

downArea: null | IDownArea

The down area of the user interface.

Optional Readonly fresh

fresh?: boolean

Indicates whether fetched session restore data was actually retrieved from the state database or whether it is a fresh blank slate.

Notes

This attribute is only relevant when the layout data is retrieved via a fetch call. If it is set when being passed into save, it will be ignored.

Readonly leftArea

leftArea: null | ISideArea

The left area of the user interface.

Readonly mainArea

mainArea: null | IMainArea

The main area of the user interface.

Readonly relativeSizes

relativeSizes: null | number[]

The relatives sizes of the areas of the user interface.

Readonly rightArea

rightArea: null | ISideArea

The right area of the user interface.

Readonly topArea

topArea: null | ITopArea

The top area of the user interface.

Settings

Member Visibility

Theme

On This Page

downAreafreshleftAreamainArearelativeSizesrightAreatopArea