Interface IOpenOptions

The options used to open a widget.

interface IOpenOptions {
    activate?: boolean;
    mode?: InsertMode;
    rank?: number;
    ref?: null | string;
    type?: string;
}

Properties

activate? mode? rank? ref? type?

Properties

Optionalactivate

activate?: boolean

Whether to activate the widget. Defaults to true.

Optionalmode

mode?: InsertMode

The supported insertion modes.

An insert mode is used to specify how a widget should be added to the main area relative to a reference widget.

Optionalrank

rank?: number

The rank order of the widget among its siblings.

Notes

This field may be used or ignored depending on shell implementation.

Optionalref

ref?: null | string

The reference widget id for the insert location.

The default is null.

Optionaltype

type?: string

Type of widget to open

Notes

This is the key used to load user customization. Its typical value is: a factory name or the widget id (if singleton)

Settings

Member Visibility

On This Page

Properties