ui.layout.ILayoutOptions

Options for a Layout

Export

ILayoutOptions

Template

The Template Element.

Name	Type	Description
D	extends IMinProvidedDataSet	Callback Data

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: () => Promise<void>

(): Promise<void>

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

Memberof

ILayoutOptions

Promise<void>

---

Optional fullScreen: boolean

Boolean to toggle the FullScreen

Author

M.Karkowski

Memberof

ILayoutOptions

---

Optional hotkeys: IHotKeyAction<D>[]

Optional Hotkey, which will triggerd custom Functions

Memberof

ILayoutOptions

---

Optional id: string

Define a custom ID.

---

Optional onEditModeChanged: (editingEnabled: boolean) => Promise<void>

(editingEnabled): Promise<void>

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

Memberof

ILayoutOptions

Name	Type
editingEnabled	boolean

Promise<void>

---

Optional onReady: () => Promise<void>

(): Promise<void>

Called if the layout is ready

Author

M.Karkowski

Memberof

ILayoutOptions

Promise<void>

---

Optional onResized: (panels: IPossiblePanels) => Promise<void>

(panels): Promise<void>

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

Memberof

ILayoutOptions

Name	Type
panels	IPossiblePanels

Promise<void>

---

panels: IPanel[]

A List containing all Panels, which should be generaged

Memberof

ILayoutOptions

---

Optional showToggleElements: boolean

Helper to show the Toggle Elements or not.

---

title: string

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

Memberof

ILayoutOptions

---

Optional toolbar: Object

Configuration of the Toolbar.

Memberof

ILayoutOptions

Name	Type	Description
config	IToolbarConfig<D>	A Toolbar Configuration.
panel	ValidPanels	The Panel, which will be used to render the Toolbar. Normally this should be set to "top".