trueChart Core API

UserInterfaceManager interface

Hierarchy

  • IUserInterfaceManager

Index

Properties

Methods

Properties

CustomDataDialog

CustomDataDialog: ICustomDataDialogOptions | null

The 'Data' tab in the UI may display a custom section. The intention is to be able to modify the data binding to the environment (BI system). Setting this to null removes a formerly defined dialog.

Readonly Toaster

Toaster: object

Type declaration

  • error: function
      • (message: string, title?: undefined | string, options?: IToastOptions, onTextClick?: undefined | function): IToastRef

      • Parameters

        • message: string
        • Optional title: undefined | string
        • Optional options: IToastOptions
        • Optional onTextClick: undefined | function

        Returns IToastRef

  • info: function
      • (message: string, title?: undefined | string, options?: IToastOptions, onTextClick?: undefined | function): IToastRef

      • Parameters

        • message: string
        • Optional title: undefined | string
        • Optional options: IToastOptions
        • Optional onTextClick: undefined | function

        Returns IToastRef

  • success: function
      • (message: string, title?: undefined | string, options?: IToastOptions, onTextClick?: undefined | function): IToastRef

      • Parameters

        • message: string
        • Optional title: undefined | string
        • Optional options: IToastOptions
        • Optional onTextClick: undefined | function

        Returns IToastRef

  • warning: function
      • (message: string, title?: undefined | string, options?: IToastOptions, onTextClick?: undefined | function): IToastRef

      • Parameters

        • message: string
        • Optional title: undefined | string
        • Optional options: IToastOptions
        • Optional onTextClick: undefined | function

        Returns IToastRef

Methods

getRegisteredLibNames

  • getRegisteredLibNames(): string[]

  • Returns a list of the names of all registered UI libraries. The indices of the entries can be used for getUI()

    Returns string[]

    List of names, list will be empty when no UI libraries are registered

getUI

  • Returns an instance of the registered UserInterface class.

    Returns IUserInterface | undefined

    The UI instance or undefined if no UI is active.

registerUI

  • Registers a new UI lib for use with trueChart.

    Parameters

    Returns number | undefined

    The index of the registered library in the list of all registered libraries or undefined when the library could not be loaded

setActiveUI

  • setActiveUI(index: number): void

  • Sets the active UI instance.

    Parameters

    • index: number

      Index in the list of registered user interfaces

    Returns void