Interface ISideArea

The restorable description of a sidebar in the user interface.

interface ISideArea {
    collapsed: boolean;
    currentWidget: null | Widget;
    visible: boolean;
    widgetStates: {
        [id: string]: {
            expansionStates: boolean[] | null;
            sizes: number[] | null;
        };
    };
    widgets: null | Widget[];
}

Properties

collapsed currentWidget visible widgetStates widgets

Properties

Readonly collapsed

collapsed: boolean

A flag denoting whether the sidebar has been collapsed.

Readonly currentWidget

currentWidget: null | Widget

The current widget that has side area focus.

Readonly visible

visible: boolean

A flag denoting whether the side tab bar is visible.

Readonly widgetStates

widgetStates: {
    [id: string]: {
        expansionStates: boolean[] | null;
        sizes: number[] | null;
    };
}

The collection of widgets states held by the sidebar.

Type declaration

  • [id: string]: {
        expansionStates: boolean[] | null;
        sizes: number[] | null;
    }
    • Readonly expansionStates: boolean[] | null

      Expansion states of the widgets.

    • Readonly sizes: number[] | null

      Vertical sizes of the widgets.

Readonly widgets

widgets: null | Widget[]

The collection of widgets held by the sidebar.

Settings

Member Visibility

Theme

On This Page

collapsedcurrentWidgetvisiblewidgetStateswidgets