Interface DataTableFactory

Factory for data tables.

interface DataTableFactory {
    createDataTableCollection(dataTables?): DataTableCollection;
    createDataTableFromStore(options): Promise<DataTable>;
    createDataTableFromStoreAndQuery(options): Promise<DataTable>;
}

Index

Methods

createDataTableCollection createDataTableFromStore createDataTableFromStoreAndQuery

Methods

createDataTableCollection

createDataTableCollection(dataTables?): DataTableCollection
Creates a collection of data tables.
Parameters
- Optional dataTables: Iterable<DataTable>
Returns DataTableCollection
- Defined in search/result-api/api/service.ts:100

createDataTableFromStore

createDataTableFromStore(options): Promise<DataTable>
Creates a data table from a store and an id provider.
Parameters
- options: {
      allowedFieldNames?: Set<string> | ((name) => 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);
  }
```
  - Optional allowedFieldNames?: Set<string> | ((name) => boolean)
  - dataSource: Store
  - Optional dataSourceId?: string
  - Optional dataSourceProperties?: Record<string, unknown>
  - Optional dataTableId?: string
  - Optional dataTableTitle?: string
  - idsProvider: DatasetItemIdsProvider<AllowedIdTypes>
Returns Promise<DataTable>
- Defined in search/result-api/api/service.ts:116

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
  - Optional dataSourceId?: string
  - Optional dataSourceProperties?: Record<string, unknown>
  - Optional dataTableId?: string
  - Optional dataTableTitle?: string
  - queryExpression: ComplexQueryExpression
  - Optional queryOptions?: QueryOptions
Returns Promise<DataTable>
- Defined in search/result-api/api/service.ts:140

Generated using TypeDoc