pivotick - v2.0.1
    Preparing search index...

    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.

    // A dock holding only a plugin's pane, open on load
    UI: { mode: 'full', table: false, dock: { open: true, height: 0.3 } }
    interface DockOptions {
        collapsed?: boolean | "auto";
        height?: number;
        open?: boolean;
    }
    Index

    Properties

    collapsed? height? open?

    Properties

    collapsed?: boolean | "auto"

    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.

    'auto'
    height?: number

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

    open?: boolean

    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.

    Settings

    Member Visibility

    On This Page

    Properties