Theia API Documentation v1.66.0
    Preparing search index...

    Interface IOptions

    An options object for creating a dock panel.

    interface IOptions {
        addButtonEnabled?: boolean;
        closeHandler?: (
            sender: TabBar<Widget>,
            args: ITabCloseRequestedArgs<Widget>,
        ) => boolean;
        disableDragAndDrop?: boolean;
        document?: Document | ShadowRoot;
        edges?: IEdges;
        hiddenMode?: HiddenMode;
        mode?: Mode;
        overlay?: IOverlay;
        renderer?: DockLayout.IRenderer;
        spacing?: number;
        tabsConstrained?: boolean;
        tabsMovable?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addButtonEnabled? closeHandler? disableDragAndDrop? document? edges? hiddenMode? mode? overlay? renderer? spacing? tabsConstrained? tabsMovable?

    Properties

    addButtonEnabled?: boolean

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

    The default is 'false'.

    closeHandler?: (
        sender: TabBar<Widget>,
        args: ITabCloseRequestedArgs<Widget>,
    ) => boolean

    Type Declaration

    disableDragAndDrop?: boolean

    whether drag and drop for tabs should be disabled

    document?: Document | ShadowRoot

    The document to use with the dock panel.

    The default is the global document instance.

    edges?: IEdges

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

    hiddenMode?: HiddenMode

    The method for hiding widgets.

    The default is Widget.HiddenMode.Display.

    mode?: Mode

    The mode for the dock panel.

    The default is 'multiple-document'.

    overlay?: IOverlay

    The overlay to use with the dock panel.

    The default is a new Overlay instance.

    renderer?: DockLayout.IRenderer

    The renderer to use for the dock panel.

    The default is a shared renderer instance.

    spacing?: number

    The spacing between the items in the panel.

    The default is 4.

    tabsConstrained?: boolean

    Constrain tabs to this dock panel

    The default is 'false'.

    tabsMovable?: boolean

    Allow tabs to be draggable / movable by user.

    The default is 'true'.

    Settings

    Member Visibility

    On This Page

    Properties