Interface DataTableFactory

Factory for data tables.

interface DataTableFactory {
    createDataTableCollection(dataTables?: Iterable<DataTable, any, any>): DataTableCollection;
    createDataTableFromStore(options: {
        allowedFieldNames?: Set<string> | ((name: string) => boolean);
        dataSource: Store;
        dataSourceId?: string;
        dataSourceProperties?: Record<string, unknown>;
        dataTableId?: string;
        dataTableTitle?: string;
        idsProvider: DatasetItemIdsProvider<AllowedIdTypes>;
    }): Promise<DataTable>;
    createDataTableFromStoreAndQuery(options: {
        dataSource: Store;
        dataSourceId?: string;
        dataSourceProperties?: Record<string, unknown>;
        dataTableId?: string;
        dataTableTitle?: string;
        queryExpression: ComplexQueryExpression;
        queryOptions?: QueryOptions;
    }): Promise<DataTable>;
}

Methods

createDataTableCollection createDataTableFromStore createDataTableFromStoreAndQuery

Methods

createDataTableCollection

createDataTableFromStore

  • createDataTableFromStore(options): Promise<DataTable>

  • Creates a data table from a store and an id provider.

    Parameters

    • options: {
          allowedFieldNames?: Set<string> | ((name: string) => boolean);
          dataSource: Store;
          dataSourceId?: string;
          dataSourceProperties?: Record<string, unknown>;
          dataTableId?: string;
          dataTableTitle?: string;
          idsProvider: DatasetItemIdsProvider<AllowedIdTypes>;
      }
        {
          dataTableId?: string;
          dataTableTitle?: string;
          dataSourceId?: string;
          dataSource: Store;
          idsProvider: DatasetItemIdsProvider;
          allowedFieldNames?: Set<string> | ((name: string) => boolean);
        }
      • OptionalallowedFieldNames?: Set<string> | ((name: string) => boolean)
      • dataSource: Store
      • OptionaldataSourceId?: string
      • OptionaldataSourceProperties?: Record<string, unknown>
      • OptionaldataTableId?: string
      • OptionaldataTableTitle?: string
      • idsProvider: DatasetItemIdsProvider<AllowedIdTypes>

    Returns Promise<DataTable>

createDataTableFromStoreAndQuery

  • createDataTableFromStoreAndQuery(options): Promise<DataTable>

  • Creates a data table from a store and a query expression.

    Parameters

    • options: {
          dataSource: Store;
          dataSourceId?: string;
          dataSourceProperties?: Record<string, unknown>;
          dataTableId?: string;
          dataTableTitle?: string;
          queryExpression: ComplexQueryExpression;
          queryOptions?: QueryOptions;
      }
        {
          dataTableId?: string;
          dataTableTitle?: string;
          dataSourceId?: string;
          dataSource: Store;
          queryExpression: ComplexQueryExpression;
          queryOptions?: QueryOptions;
        }
      • dataSource: Store
      • OptionaldataSourceId?: string
      • OptionaldataSourceProperties?: Record<string, unknown>
      • OptionaldataTableId?: string
      • OptionaldataTableTitle?: string
      • queryExpression: ComplexQueryExpression
      • OptionalqueryOptions?: QueryOptions

    Returns Promise<DataTable>

Settings

Member Visibility

On This Page

Methods