Interface ILayoutOptions<D>

Options for a Layout

Export

ILayoutOptions

Template

The Template Element.

Type Parameters

Hierarchy

  • ILayoutOptions

Properties

adaptData dispose? fullScreen? hotkeys? id? onEditModeChanged? onReady? onResized? panels showToggleElements? title toolbar?

Properties

adaptData

adaptData: IAdaptDataCallback<D>

An addtional Function which will be called before a Callback of the Context-Menu or Toolbar will be called.

Memberof

ILayoutOptions

Optional dispose

dispose?: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Function, which will be called before the Componented is getting destroyed. This function could be used to clean up everything

      Memberof

      ILayoutOptions

      Returns Promise<void>

Optional fullScreen

fullScreen?: boolean

Boolean to toggle the FullScreen

Author

M.Karkowski

Memberof

ILayoutOptions

Optional hotkeys

hotkeys?: IHotKeyAction<D>[]

Optional Hotkey, which will triggerd custom Functions

Memberof

ILayoutOptions

Optional id

id?: string

Define a custom ID.

Optional onEditModeChanged

onEditModeChanged?: ((editingEnabled) => Promise<void>)

Type declaration

    • (editingEnabled): Promise<void>

    • Callback, which will be used to provide the actual Editmode.

      Memberof

      ILayoutOptions

      Parameters

      • editingEnabled: boolean

      Returns Promise<void>

Optional onReady

onReady?: (() => Promise<void>)

Type declaration

    • (): Promise<void>

    • Called if the layout is ready

      Author

      M.Karkowski

      Memberof

      ILayoutOptions

      Returns Promise<void>

Optional onResized

onResized?: ((panels) => Promise<void>)

Type declaration

    • (panels): Promise<void>

    • Optional callback which will be called it a resize event occours.

      Memberof

      ILayoutOptions

      Parameters

      Returns Promise<void>

panels

panels: IPanel[]

A List containing all Panels, which should be generaged

Memberof

ILayoutOptions

Optional showToggleElements

showToggleElements?: boolean

Helper to show the Toggle Elements or not.

title

title: string

The Title which will be shown on the Top. If not present, no titlebar will be shown

Memberof

ILayoutOptions

Optional toolbar

toolbar?: {
    config: IToolbarConfig<D>;
    panel: types.ui.layout.ValidPanels;
}

Configuration of the Toolbar.

Memberof

ILayoutOptions

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc