Interface OpenViewArguments

Options for adding a widget to the application shell.

interface OpenViewArguments {
    activate?: boolean;
    area?: Area;
    mode?: InsertMode | OpenToSideMode | "tab-replace";
    rank?: number;
    ref?: Widget;
    reveal?: boolean;
    toggle?: boolean;
}

Hierarchy (view full)

Properties

activate? area? mode? rank? ref? reveal? toggle?

Properties

Optional activate

activate?: boolean

Optional area

area?: Area

The area of the application shell where the widget will reside.

Optional mode

mode?: InsertMode | OpenToSideMode | "tab-replace"

The insertion mode for adding the widget.

The default is 'tab-after'.

Optional rank

rank?: number

The rank order of the widget among its siblings.

Optional ref

ref?: Widget

The reference widget for the insert location.

The default is undefined.

Optional reveal

reveal?: boolean

Optional toggle

toggle?: boolean

Settings

Member Visibility

Theme

On This Page

activateareamoderankrefrevealtoggle