Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UIAPI

User interface API.

Hierarchy

  • UIAPI

Index

Properties

Methods

Properties

ContextMenu

ContextMenu: { prototype: ContextMenu }

Represents a context menu object.

Type declaration

DialogCreator

DialogCreator: DialogCreator

DialogCreator API.

DropZone

DropZone: DropZone

DropZone API.

MenuBar

MenuBar: { prototype: MenuBar }

Represents a MenuBar (a strip with menus containing tasks).

Type declaration

MessageBox

MessageBox: { prototype: MessageBox }
deprecated

old api - kept for compatibility.

An object representing a message box.

Type declaration

MsgBoxSimple

MsgBoxSimple: MsgBoxSimple

Simple MsgBox API.

OpenFileDialog

OpenFileDialog: { prototype: OpenFileDialog }

An object representing a dialog to allow the user to select (open) a file.

Type declaration

OperationDialog

OperationDialog: { prototype: OperationDialog }

Represents an operation dialog.

Type declaration

SaveFileDialog

SaveFileDialog: { prototype: SaveFileDialog }

An object representing a dialog to allow the user to save a file.

Type declaration

Theme

Theme: ThemeAPI

Theming API.

comp

comp: WinCompAPI

Window compositor API.

components

components: ComponentsNS

Components namespace.

ecss

ecss: ECSSAPI

Extended CSS API.

util

util: UIUtilsAPI

UI Utilities API

Methods

animateElement

  • animateElement(element: string | HTMLElement, animationName: string, callback: () => void): void

  • Animates an element.

    Parameters

    • element: string | HTMLElement

      The element to aniamte.

    • animationName: string

      The name of the animation to use.

    • callback: () => void

      The callback to call when the animation is complete.

        • (): void

        • Returns void

    Returns void

showExceptionWindow

  • showExceptionWindow(exception: string | Error): Promise<void>

  • Shows an exception window.

    Parameters

    • exception: string | Error

      The exception to show.

    Returns Promise<void>

Generated using TypeDoc