Interface DataTableCollection

Bag of data tables.

To access the items you can use for...of:

const dataTables = ...;
for (const dataTable of dataTables) {
     ...
}

If you need an array use the tables property

const dataTables = ...;
const tables = dataTables.tables;

Use the size property to check how many data tables are available.

const dataTables = ...;
const size = dataTables.size;

Use getFirstSelectedTable to access the first selected data table (the one shown in the result-ui).

const dataTables = ...;
const dataTable = dataTables.getFirstSelectedTable();

You can watch the events changed, selection-changed and destroyed.

const dataTables = ...;
dataTables.on("changed",({added, deleted, updated})=> { ... });
dataTables.on("selection-changed",({added, deleted, updated})=> { ... });
dataTables.on("destroyed",()=> { ... });
interface DataTableCollection {
    add(value: DataTable): this;
    clearTableSelection(): void;
    clickTable(id: string): void;
    deleteAndDestroyById(id: string): undefined | DataTable;
    deleteById(id: string): undefined | DataTable;
    deselectTables(ids: Iterable<string>): void;
    destroy(): void;
    focusTable(id: undefined | string): void;
    getById(id: string): undefined | DataTable;
    getFirstSelectedTable(): undefined | DataTable;
    getFirstSelectedTableId(): undefined | string;
    getSelectedTableIds(): Iterable<string>;
    getSelectedTables(): Iterable<DataTable>;
    getSelectedTablesCount(): number;
    hasId(id: string): boolean;
    hasSelectedTables(): boolean;
    isSelectedTable(id: string): boolean;
    on<Name extends keyof DataTableCollectionEvents>(
        name: Name,
        callBack: EventCallback<DataTableCollectionEvents[Name]>,
    ): Handle;
    selectTables(ids: Iterable<string>, selected?: boolean): void;
    size: number;
    tables: readonly DataTable[];
}

Hierarchy

Properties

size tables

Methods

add clearTableSelection clickTable deleteAndDestroyById deleteById deselectTables destroy focusTable getById getFirstSelectedTable getFirstSelectedTableId getSelectedTableIds getSelectedTables getSelectedTablesCount hasId hasSelectedTables isSelectedTable on selectTables

Properties

Readonlysize

size: number

Amount of data tables.

Readonlytables

tables: readonly DataTable[]

Provides access to an array representation of the tables. Equivalent to Array.from(tableCollection). A change to the array is not reflected in the collection.

Methods

add

  • add(value: DataTable): this

  • Appends a new data table.

    Parameters

    Returns this

clearTableSelection

  • clearTableSelection(): void

  • Clears the selection. Note: A new table will be selected automatically, a tick later.

    Returns void

clickTable

  • clickTable(id: string): void

  • Emits event 'data-table-clicked'.

    Parameters

    • id: string

      id of data table

    Returns void

deleteAndDestroyById

  • deleteAndDestroyById(id: string): undefined | DataTable

  • Delete data table by id and destroys it.

    Parameters

    • id: string

    Returns undefined | DataTable

deleteById

  • deleteById(id: string): undefined | DataTable

  • Delete data table by id

    Parameters

    • id: string

    Returns undefined | DataTable

deselectTables

  • deselectTables(ids: Iterable<string>): void

  • Removes all table ids from the selection.

    Parameters

    • ids: Iterable<string>

      iterable of ids.

    Returns void

destroy

  • destroy(): void

  • Destroy instance. Delegates destruction to all data tables.

    Returns void

focusTable

  • focusTable(id: undefined | string): void

  • Emits event 'data-table-focus-changed'.

    Parameters

    • id: undefined | string

      id of data table

    Returns void

getById

  • getById(id: string): undefined | DataTable

  • Lookup data table by id

    Parameters

    • id: string

    Returns undefined | DataTable

getFirstSelectedTable

  • getFirstSelectedTable(): undefined | DataTable

  • Provides access to the first selected data table, if one is available.

    Returns undefined | DataTable

getFirstSelectedTableId

  • getFirstSelectedTableId(): undefined | string

  • Provides access to the first selected data table, if one is available.

    Returns undefined | string

getSelectedTableIds

  • getSelectedTableIds(): Iterable<string>

  • Provides access to all selected ids.

    Returns Iterable<string>

getSelectedTables

  • getSelectedTables(): Iterable<DataTable>

  • Provides a way to get all selected items.

    Returns Iterable<DataTable>

getSelectedTablesCount

  • getSelectedTablesCount(): number

  • Amount of selected items.

    Returns number

hasId

  • hasId(id: string): boolean

  • Test if data table with id is contained.

    Parameters

    • id: string

    Returns boolean

hasSelectedTables

  • hasSelectedTables(): boolean

  • true = selected tables available. false = no tables selected.

    Returns boolean

isSelectedTable

  • isSelectedTable(id: string): boolean

  • Parameters

    • id: string

    Returns boolean

    a boolean indicating whether the given id is selected.

on

selectTables

  • selectTables(ids: Iterable<string>, selected?: boolean): void

  • Adds all table ids to the selection.

    Parameters

    • ids: Iterable<string>

      iterable of ids.

    • Optionalselected: boolean

      true = select, false = deselect. If omitted true is assumed.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods