Interface DataTableUi

Displays the data tables.

It is possible to watch for the events open-changed and destroyed on the ui.

const ui = ...;
ui.on("open-changed",(open)=> { ... });
ui.on("destroyed",()=> { ... });
interface DataTableUi {
    destroy(): void;
    hide(): void;
    on<Name extends keyof DataTableUiEvents>(
        name: Name,
        callBack: EventCallback<DataTableUiEvents[Name]>,
    ): Handle;
    open: boolean;
    show(dataTables: DataTableCollection): void;
}

Hierarchy

  • EventSource<DataTableUiEvents>
    • DataTableUi

Properties

open

Methods

destroy hide on show

Properties

Readonlyopen

open: boolean

Provides access to the current open state true ui is shown false ui is hidden

Methods

destroy

  • destroy(): void

  • Destroys the instance.

    Returns void

hide

  • hide(): void

  • Stops displaying the current content (if any).

    The ui should stop referencing the current content and release all model-related resources and watchers.

    Returns void

on

  • on<Name extends keyof DataTableUiEvents>(
        name: Name,
        callBack: EventCallback<DataTableUiEvents[Name]>,
    ): Handle

  • Registers event listener.

    Type Parameters

    • Name extends keyof DataTableUiEvents

    Parameters

    • name: Name
    • callBack: EventCallback<DataTableUiEvents[Name]>

    Returns Handle

show

  • show(dataTables: DataTableCollection): void

  • Displays the content of the given tables. Existing content for previous tables are replaced.

    Parameters

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods