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

Interface: IDynamicUiRenderData<D>

types.ui.IDynamicUiRenderData

Helper for the provided data:

Type parameters

Name Type
D extends IMinProvidedDataSet = IMinProvidedDataSet

Hierarchy

Properties

currentUi

currentUi: IBasicLayoutComponent<IMinProvidedDataSet & IDynamicUiRenderData<D>>

dispatcher

dispatcher: INopeDispatcher

Inherited from

IRenderData.dispatcher

helpers

helpers: Object

Type declaration

Name Type
connection { hostname: string ; layers: TSession & { connected: boolean }[] ; noExternalConnectionRequired: boolean ; sessionsConnected: INopeObservable<boolean, boolean, boolean, IEventAdditionalData> ; addCommunicationLayer: (_session: TSession) => void ; connect: (options?: { delay: number }) => Promise<boolean> ; removeCommunicationLayer: (session: TSession) => void }
connection.hostname string
connection.layers TSession & { connected: boolean }[]
connection.noExternalConnectionRequired boolean
connection.sessionsConnected INopeObservable<boolean, boolean, boolean, IEventAdditionalData>
connection.addCommunicationLayer [object Object]
connection.connect [object Object]
connection.removeCommunicationLayer [object Object]
data { getData: <T>(key: string, defaultValue: T) => Promise<T> ; hasData: (key: string) => Promise<boolean> ; registerSchema: (key: string, schema: IJsonSchema) => boolean ; setData: (key: string, value: any) => Promise<boolean> ; store: () => Promise<boolean> }
data.getData [object Object]
data.hasData [object Object]
data.registerSchema [object Object]
data.setData [object Object]
data.store [object Object]
file { download: (content: string, fileName?: string, option?: { autoBom: boolean }) => void ; upload: (options: { height?: number ; title: string ; width?: number ; callback: (error: any, data: string) => void }) => void }
file.download (content: string, fileName?: string, option?: { autoBom: boolean }) => void
file.upload (options: { height?: number ; title: string ; width?: number ; callback: (error: any, data: string) => void }) => void
layout { toolbar: { generateRadioMenuEntry: <D, T>(options: { items: T[] ; onSelect: (data: D, item: T) => void ; selected?: string }) => void ; generateSelectMenuEntry: <D, T>(options: { items: (string | T)[] ; onSelect: (data: D, selection: { [index: string]: boolean; }) => void ; selected?: string ; text: string }) => void } ; createLayout: (panelConfig: IPanel[], options: TcreateLayoutOptions, ...args: any[]) => { layout: { destroy: () => void ; element: any ; layout: any } ; panels: IPossiblePanels } }
layout.toolbar { generateRadioMenuEntry: <D, T>(options: { items: T[] ; onSelect: (data: D, item: T) => void ; selected?: string }) => void ; generateSelectMenuEntry: <D, T>(options: { items: (string | T)[] ; onSelect: (data: D, selection: { [index: string]: boolean; }) => void ; selected?: string ; text: string }) => void }
layout.toolbar.generateRadioMenuEntry [object Object]
layout.toolbar.generateSelectMenuEntry [object Object]
layout.createLayout [object Object]
logging { log: (level: LoggerLevel, sender: string, message: string) => any ; toast: (level: LoggerLevel, sender: string, message: string) => any }
logging.log [object Object]
logging.toast [object Object]
ui { fullscreen: INopeObservable<boolean, boolean, boolean, IEventAdditionalData> ; closeFullscreen: () => void ; getTheme: () => IUiTheme ; openFullscreen: () => void }
ui.fullscreen INopeObservable<boolean, boolean, boolean, IEventAdditionalData>
ui.closeFullscreen [object Object]
ui.getTheme [object Object]
ui.openFullscreen [object Object]
url { generateLinkWithQueryParams: (...objects: TSettingsObject[]) => Promise<string> ; getObjectFromQuery: (simpleSchema: TSimpleSchema) => Promise<false | { [index: string]: any; }> ; getObjectFromQueryWithSchema: (schema: IJsonSchema) => Promise<false | { [index: string]: any; }> }
url.generateLinkWithQueryParams [object Object]
url.getObjectFromQuery [object Object]
url.getObjectFromQueryWithSchema [object Object]

Inherited from

IRenderData.helpers

libraries

libraries: TLibraries

Inherited from

IRenderData.libraries

logger

logger: ILogger

Inherited from

IRenderData.logger

session

session: IUiDefinition

Contains the information about the session.

Inherited from

IRenderData.session

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