Interface Dataset<IdType>

A data set represents a subset of items of a data source. It provides access to full displayable data.

The dataSource property is the source of the available data and in most cases an instance of a store.

You can watch the properties title, itemCount, state, initError and updateError for changes.

 const dataset = ...;
 dataset.watch("state", ({value})=> {
     const newState = value;
     // newState can be: "not-initialized" | "initializing" | "initialized" | "init-error" | "destroyed" | "updating"
 });

You can watch for the events items-changed, destroyed.

const dataset = ...;
dataset.on("items-changed", ({added, deleted, updated})=> { ... });
dataset.on("destroyed",()=> { ... });
interface Dataset<IdType> {
    addItemsById(itemIds): Promise<void>;
    addItemsByIdsProvider(idsProvider): Promise<void>;
    capabilities: DatasetCapabilities;
    clean(): Promise<void>;
    dataSource: unknown;
    dataSourceProperties: undefined | Readonly<Record<string, unknown>>;
    destroy(): void;
    fields: readonly FieldData[];
    id: string;
    init(): void;
    initError: undefined | Error;
    initialIdsProvider: undefined | DatasetItemIdsProvider<AllowedIdTypes>;
    isDomainValueField(fieldName): boolean;
    isInitialized(): boolean;
    itemCount: ItemCount;
    lookupDomainValues(fieldValues): Record<string, any>;
    on<Name>(name, callBack): Handle;
    queryAllIds(): QueryResult<IdType>;
    queryItems(query): QueryResult<DatasetItem<IdType>>;
    refresh(): Promise<void>;
    removeItemsById(itemIds): Promise<void>;
    state: DatasetState;
    title: string;
    updateError: undefined | Error;
    updateItemsById(itemIds): Promise<void>;
}

Type Parameters

Hierarchy

Properties

capabilities dataSource dataSourceProperties fields id initError initialIdsProvider itemCount state title updateError

Methods

addItemsById addItemsByIdsProvider clean destroy init isDomainValueField isInitialized lookupDomainValues on queryAllIds queryItems refresh removeItemsById updateItemsById

Properties

Readonly capabilities

capabilities: DatasetCapabilities

Capabilities of the data set. The capabilities are only readable if the dataset is "initialized".

Readonly dataSource

dataSource: unknown

The real data source.

Readonly dataSourceProperties

dataSourceProperties: undefined | Readonly<Record<string, unknown>>

Service metadata about the data source if provided.

Readonly fields

fields: readonly FieldData[]

The fields of the data set. The fields are only readable if the dataset is "initialized".

Readonly id

id: string

Dataset id. Typically initialized and equal to id of data source (store id).

Readonly initError

initError: undefined | Error

A initialization error. Is available if state === "init-error".

Readonly initialIdsProvider

initialIdsProvider: undefined | DatasetItemIdsProvider<AllowedIdTypes>

Provides access to the initial id provider, if not yet used to init the dataset.

Readonly itemCount

itemCount: ItemCount

The amount of items in the dataset. The itemCount is only readable if the dataset is "initialized".

Readonly state

state: DatasetState

The current state of the dataset.

title

title: string

Changeable title. Typically initialized from data source.

Readonly updateError

updateError: undefined | Error

A update error. This error may happen if an updating process failed.

Methods

addItemsById

  • addItemsById(itemIds): Promise<void>

  • Adds the given items to the dataset. Before using this method check the DatasetCapabilities.supportsAddItems State. If supportsAddItems is false, the method will throw an error.

    Parameters

    • itemIds: Iterable<IdType>

      Ids which will be added to the Dataset.

    Returns Promise<void>

addItemsByIdsProvider

  • addItemsByIdsProvider(idsProvider): Promise<void>

  • Adds the given items to the dataset. Before using this method check the DatasetCapabilities.supportsAddItems State. If supportsAddItems is false, the method will throw an error.

    Parameters

    Returns Promise<void>

clean

  • clean(): Promise<void>

  • Removes any data from the dataset.

    Returns Promise<void>

destroy

  • destroy(): void

  • Destroys the dataset.

    Returns void

init

  • init(): void

  • Starts dataset initialization.

    Returns void

isDomainValueField

  • isDomainValueField(fieldName): boolean

  • Provides a way to check if the values of a field can be converted into domain values.

    Parameters

    • fieldName: string

      name of a field.

    Returns boolean

    true if the values can be converted.

isInitialized

  • isInitialized(): boolean

  • Returns true if the dataset is in state initialized or updating

    Returns boolean

lookupDomainValues

  • lookupDomainValues(fieldValues): Record<string, any>

  • Provides a way to convert the values of a data set item into a domain values. Note to ensure that the method is working correctly the values of all domain fields should be provided.

    Parameters

    • fieldValues: Record<string, any>

      fields and the matching values.

    Returns Record<string, any>

    converted values or the original value if not convertible.

on

  • on<Name>(name, callBack): Handle

  • Registers event listener.

    Type Parameters

    Parameters

    Returns Handle

queryAllIds

queryItems

refresh

  • refresh(): Promise<void>

  • Enforces the refresh of the data. It may completely re-fetch item data and drop no longer existing items.

    Equivalent to:

      const allIds = await dataset.queryAllIds().toArray();
      dataset.updateItemsById(allIds);

    Returns Promise<void>

removeItemsById

  • removeItemsById(itemIds): Promise<void>

  • Removes the given items from the dataset. Before using this method check the DatasetCapabilities.supportsRemoveItems State. If supportsRemoveItems is false, the method will throw an error.

    Parameters

    • itemIds: Iterable<IdType>

      Ids which should be deleted from the dataset.

    Returns Promise<void>

updateItemsById

  • updateItemsById(itemIds): Promise<void>

  • Enforces the refresh of data of the given items. Note: If one of the ids did not exist, then it is ignored.

    Parameters

    • itemIds: Iterable<IdType>

      Ids which data will be updated.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

capabilitiesdataSourcedataSourcePropertiesfieldsidinitErrorinitialIdsProvideritemCountstatetitleupdateErroraddItemsByIdaddItemsByIdsProvidercleandestroyinitisDomainValueFieldisInitializedlookupDomainValuesonqueryAllIdsqueryItemsrefreshremoveItemsByIdupdateItemsById

Generated using TypeDoc