Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

An options object for initializing a widget. An options object for creating a dock panel.

Hierarchy

  • IOptions

Index

Properties

Optional addButtonEnabled

addButtonEnabled: undefined | false | true

Enable add buttons in each of the dock panel's tab bars.

The default is 'false'.

Optional document

document: Document | ShadowRoot

The document to use with the dock panel.

The default is the global document instance.

Optional edges

edges: IEdges

The sizes of the edge drop zones, in pixels. If not given, default values will be used.

Optional hiddenMode

hiddenMode: HiddenMode

The method for hiding widgets.

The default is Widget.HiddenMode.Display.

Optional mode

mode: Mode

The mode for the dock panel.

The default is 'multiple-document'.

Optional node

node: HTMLElement

The optional node to use for the widget.

If a node is provided, the widget will assume full ownership and control of the node, as if it had created the node itself.

The default is a new <div>.

Optional overlay

overlay: IOverlay

The overlay to use with the dock panel.

The default is a new Overlay instance.

Optional renderer

renderer: IRenderer

The renderer to use for the dock panel.

The default is a shared renderer instance.

Optional spacing

spacing: undefined | number

The spacing between the items in the panel.

The default is 4.

Optional tabsConstrained

tabsConstrained: undefined | false | true

Constrain tabs to this dock panel

The default is 'false'.

Optional tabsMovable

tabsMovable: undefined | false | true

Allow tabs to be draggable / movable by user.

The default is 'true'.

Optional tag

tag: keyof HTMLElementTagNameMap

The optional element tag, used for constructing the widget's node.

If a pre-constructed node is provided via the node arg, this value is ignored.

Generated using TypeDoc