AboutSupportDeveloper GuideVersion 38.126.83.79
interface LayoutOptions {
    content?: LayoutContent;
    dimensions?: {
        borderWidth?: number;
        headerHeight?: number;
        minItemHeight?: number;
        minItemWidth?: number;
    };
    settings?: {
        constrainDragToContainer?: boolean;
        constrainDragToHeaders?: boolean;
        hasHeaders?: boolean;
        popoutWholeStack?: boolean;
        preventDragIn?: boolean;
        preventDragOut?: boolean;
        preventSplitterResize?: boolean;
        reorderEnabled?: boolean;
        showCloseIcon?: boolean;
        showMaximiseIcon?: boolean;
        showPopoutIcon?: boolean;
    };
}

Properties

content?: LayoutContent

Content of the layout. There can only be one top-level LayoutItem in the content array. We do not recommend trying to build Layouts or LayoutItems by hand and instead use calls such as getSnapshot.

dimensions?: {
    borderWidth?: number;
    headerHeight?: number;
    minItemHeight?: number;
    minItemWidth?: number;
}

Type declaration

  • Optional borderWidth?: number
  • Optional headerHeight?: number
  • Optional minItemHeight?: number
  • Optional minItemWidth?: number
settings?: {
    constrainDragToContainer?: boolean;
    constrainDragToHeaders?: boolean;
    hasHeaders?: boolean;
    popoutWholeStack?: boolean;
    preventDragIn?: boolean;
    preventDragOut?: boolean;
    preventSplitterResize?: boolean;
    reorderEnabled?: boolean;
    showCloseIcon?: boolean;
    showMaximiseIcon?: boolean;
    showPopoutIcon?: boolean;
}

Represents a potential ways to customize behavior of your Layout

Type declaration

  • Optional constrainDragToContainer?: boolean

    Default Value

    false

    Limits the area to which tabs can be dragged.
    If true, the layout container is the only area where tabs can be dropped.
  • Optional constrainDragToHeaders?: boolean

    Default Value

    false

    Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.
  • Optional hasHeaders?: boolean

    Default Value

    true

    Turns tab headers on or off.
    If false, the layout will be displayed with splitters only.
  • Optional popoutWholeStack?: boolean

    Default Value

    false

    Whether the popout button will only act on the entire stack,
    as opposed to only the active tab.
  • Optional preventDragIn?: boolean

    @defaultValue=false

    If true, tabs can't be dragged into the window.

  • Optional preventDragOut?: boolean

    Default Value

    false

    If true, tabs can't be dragged out of the window.
  • Optional preventSplitterResize?: boolean

    Default Value

    false

    When true the splitters will not be draggable and the layout will not resize.
  • Optional reorderEnabled?: boolean

    Default Value

    true

    If true, the user can re-arrange the layout by
    dragging items by their tabs to the desired location.
  • Optional showCloseIcon?: boolean

    Default Value

    false

    Whether to show the close button on stack header
    (not to be confused with close button on every tab).
  • Optional showMaximiseIcon?: boolean

    Default Value

    false

    Whether to show the maximize button on stack header.
    The button will maximize the current tab to fill the entire window.
  • Optional showPopoutIcon?: boolean

    Default Value

    false

    Whether to show the popout button on stack header. The button will create a new window with current tab as its content. In case popoutWholeStack is set to true, all tabs in the stack will be in the new window.