types.ui.layout - ZeMA-gGmbH/NoPE-JS GitHub Wiki

Namespace: layout

types.ui.layout

Interfaces

Type Aliases

IAdaptDataCallback

IAdaptDataCallback<D>: (event: any, panels: IPossiblePanels) => D

Type parameters

Name Type
D extends IMinProvidedDataSet

Type declaration

(event, panels): D

Default Callback for Buttons etc inside of a toolbar and the layout.

Parameters
Name Type
event any
panels IPossiblePanels
Returns

D


ICallback

ICallback<D>: (data: D) => void

Type parameters

Name Type
D extends IMinProvidedDataSet

Type declaration

(data): void

Parameters
Name Type
data D
Returns

void


IPanels

IPanels: { [P in ValidPanels]?: IPanelControl }


IPossiblePanels

IPossiblePanels: { [P in ValidPanels]?: IPanelInstance }


IToolbarElements

IToolbarElements<D>: IButton<D> | ICheckbox<D> | IRadioButton<D> | IMenu<D> | IMenuCheckbox<D> | ICustomDropDown<D> | ICustomHTML<D> | IColor<D> | ITextColor<D> | IBreak | ISpacer

Type describing valid Elements of A Menu

Type parameters

Name Type
D extends IMinProvidedDataSet

TRenderAngularComponentAtElement

TRenderAngularComponentAtElement<T>: (options: { component: T ; element: any ; inputs?: { [index: string]: any; } ; outputs?: { [index: string]: (value: any) => void; } }) => { destroy: () => void ; instance: T }

Type parameters

Name Type
T any

Type declaration

(options): Object

Parameters
Name Type
options Object
options.component T
options.element any
options.inputs? Object
options.outputs? Object
Returns

Object

Name Type
destroy () => void
instance T

TRenderFunction

TRenderFunction<I, O, D>: (div: HTMLDivElement, options: { input: I ; layout: IBasicLayoutComponent<D> ; setVisibilityOfPanel: (value: boolean) => void }) => Promise<O>

Type parameters

Name Type
I I
O extends TRenderFunctionResult = TRenderFunctionResult
D extends IMinProvidedDataSet = IMinProvidedDataSet

Type declaration

(div, options): Promise<O>

Type which is used to render an custom html code. Must return a function, which will be called if the panel is destroyed.

Parameters
Name Type
div HTMLDivElement
options Object
options.input I
options.layout IBasicLayoutComponent<D>
options.setVisibilityOfPanel (value: boolean) => void
Returns

Promise<O>


TRenderFunctionResult

TRenderFunctionResult: Object

Type which is used to render an custom html code. Must return a function, which will be called if the panel is destroyed.

Result, that must be provided by the Render Function.

Type declaration

Name Type
onDestroy? () => Promise<boolean>
onHide? () => Promise<boolean>
onShow? () => Promise<void>

TRendering

TRendering: IRenderHTML | IRenderW2UIElement | IRenderMarkdown | ICustomRender


ValidPanels

ValidPanels: "left" | "right" | "top" | "bottom" | "preview" | "main"

Valid panel defintions. (see w2ui)

Variables

ValidPanels

ValidPanels: ValidPanels[]

⚠️ **GitHub.com Fallback** ⚠️