siteKiosk.ui

Index

Properties

availableLanguages currentWindow documentViewer

Methods

createBrowserWindow createWebWindow getCurrentLanguage getMainArea getTheme getWorkArea hideTaskbar minimizeTaskbarWindows restoreMinimizedTaskbarWindows setCurrentLanguage setMainArea setTheme showTaskbar

Events

onLanguageChange onWorkAreaChanged

Properties

availableLanguages

availableLanguages: string[]

The available languages.

currentWindow

currentWindow: null | CurrentWindow

Current window controll.

documentViewer

documentViewer: DocumentViewer

Document viewer controll.

Methods

createBrowserWindow

createBrowserWindow(options: BrowserWindowCreationOptions): BrowserWindow
Creates a new BrowserWindow.
Parameters
- options: BrowserWindowCreationOptions
  
  The BrowserWindowCreationOptions.
Returns BrowserWindow

createWebWindow

createWebWindow(options: WebWindowCreationOptions): WebWindow
Creates a new WebWindow.
Parameters
- options: WebWindowCreationOptions
  
  The WebWindowCreationOptions.
Returns WebWindow

getCurrentLanguage

getCurrentLanguage(): string
Returns the currently set language

Returns string

getMainArea

getMainArea(): Rectangle
gets the position and size of the main area.

Returns Rectangle

getTheme

getTheme(): FixedThemeSettings | CustomThemeSettings
Returns FixedThemeSettings | CustomThemeSettings

getWorkArea

getWorkArea(): Rectangle
gets the position and size of the work area.

Returns Rectangle

hideTaskbar

hideTaskbar(): void
Hides the taskbar. Windows only.

Returns void

minimizeTaskbarWindows

minimizeTaskbarWindows(): void
Windows which are visible in the taskbar will be minimized.

Returns void

restoreMinimizedTaskbarWindows

restoreMinimizedTaskbarWindows(): void
Minimized windows which are visible in the taskbar will be restored.

Returns void

setCurrentLanguage

setCurrentLanguage(language: string): void
Sets the provided language
Parameters
- language: string
  
  The language to be set.
Returns void

setMainArea

setMainArea(left: number, top: number, width: number, height: number): void
Sets the position and size of the main area.
Parameters
- left: number
  
  The left position of the main area.
- top: number
  
  The top position of the main area.
- width: number
  
  The width of the main area.
- height: number
  
  The height of the main area.
Returns void

setTheme

setTheme(settings: FixedThemeSettings | CustomThemeSettings): void
Parameters
- settings: FixedThemeSettings | CustomThemeSettings
Returns void

showTaskbar

showTaskbar(): void
Shows the taskbar. Windows only.

Returns void

Events

onLanguageChange

onLanguageChange(callback: ((language: string) => void)): EventSubscription
Registers a callback which will be triggered when the language has changed.
Parameters
- callback: ((language: string) => void)
  
  The callback which will be triggered when the language has changed.
  - - (language: string): void
    - Parameters
      
      language: string
      
      Returns void
Returns EventSubscription

onWorkAreaChanged

onWorkAreaChanged(callback: ((newArea: Rectangle) => void)): EventSubscription
Registers a callback which will be triggered when the work area has changed.
Parameters
- callback: ((newArea: Rectangle) => void)
  
  The callback which will be triggered when the work area has changed.
  - - (newArea: Rectangle): void
    - Parameters
      
      newArea: Rectangle
      
      Returns void
Returns EventSubscription

Generated using TypeDoc