Interface: DockOptions

UI.dock — the bottom dock's own settings: the region, not its occupants.

Everything about what is in the dock is declared elsewhere — the table under UI.table, anything else through addDockTab(). What is left here is the region the occupants share, which is why there is exactly one of each setting however many tabs are registered.

Example

// A dock holding only a plugin's pane, open on load
UI: { mode: 'full', table: false, dock: { open: true, height: 0.3 } }

Properties

collapsed?

optional collapsed: boolean | "auto"

Defined in: interfaces/GraphUI.ts:390

Folded away to just its header bar. 'auto' follows the room available, until the first explicit collapse or expand hands control to the user for good.

Default

'auto'

height?

optional height: number

Defined in: interfaces/GraphUI.ts:392

Expanded height: a pixel count, or a fraction of the canvas between 0 and 1.

open?

optional open: boolean

Defined in: interfaces/GraphUI.ts:384

Whether the region is present, and expanded when it is. Three states, because the collapsed bar is the control that opens it:

true — present and expanded.
false — not present at all. Shift+T still brings it in.
unset (default) — present, folded to its header bar.

Interface: DockOptions ​

Example ​

Properties ​

collapsed? ​

Default ​

height? ​