The options used to open a widget.


  • IOpenOptions


activate?: boolean

Whether to activate the widget. Defaults to true.

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.

rank?: number

The rank order of the widget among its siblings.


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

ref?: string

The reference widget id for the insert location.

The default is null.

type?: string

Type of widget to open


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

Generated using TypeDoc