AboutSupportDeveloper GuideVersion 42.138.102.4

Interface LayoutOptions

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

Properties

content? dimensions? settings?

Properties

Optionalcontent

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.

Optionaldimensions

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

Optionalsettings

settings?: {
    constrainDragToContainer?: boolean;
    constrainDragToHeaders?: boolean;
    hasHeaders?: boolean;
    newTabButtonUrl?: string;
    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

  • OptionalconstrainDragToContainer?: boolean

    Limits the area to which tabs can be dragged. If true, the layout container is the only area where tabs can be dropped.

    Default

    false
  • OptionalconstrainDragToHeaders?: boolean

    Limits the area to which tabs can be dragged. If true, stack headers are the only areas where tabs can be dropped.

    Default

    false
  • OptionalhasHeaders?: boolean

    Turns tab headers on or off. If false, the layout will be displayed with splitters only.

    Default

    true
  • OptionalnewTabButtonUrl?: string

    The button will create a new tab with the URL specified in newTabButtonUrl.

  • OptionalpopoutWholeStack?: boolean

    Whether the popout button will only act on the entire stack, as opposed to only the active tab.

    Default

    false
  • OptionalpreventDragIn?: boolean

    @defaultValue=false

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

    Default

    false
  • OptionalpreventDragOut?: boolean

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

    Default

    false
  • OptionalpreventSplitterResize?: boolean

    When true the splitters will not be draggable and the layout will not resize.

    Default

    false
  • OptionalreorderEnabled?: boolean

    If true, the user can re-arrange the layout by dragging items by their tabs to the desired location.

    Default

    true
  • OptionalshowCloseIcon?: boolean

    Whether to show the close button on stack header (not to be confused with close button on every tab).

    Default

    false
  • OptionalshowMaximiseIcon?: boolean

    Whether to show the maximize button on stack header. The button will maximize the current tab to fill the entire window.

    Default

    false
  • OptionalshowPopoutIcon?: boolean

    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.

    Default

    false

Settings

On This Page

Properties