DataViewLoader
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
DataViewLoader allows you to speficy, load and access data results with convenient series and slices API.
export declare class DataViewLoader
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(…filters: INullableFilter[]) => DataViewLoader | (ALPHA) Filters to apply on server side. | ||
() => Promise<DataViewFacade> | (ALPHA) Loads all the result data and wraps them in DataViewFacade. | ||
(dataWindow: DataViewWindow) => Promise<DataViewFacade> | (ALPHA) Loads subset of the result data and wraps them in DataViewFacade. | ||
(…measuresAndScopingAttributes: IAttributeOrMeasure[]) => DataViewLoader | (ALPHA) Data series will be built using the provided measures that are further scoped for elements of the specified attributes. | ||
(…attributes: IAttribute[]) => DataViewLoader | (ALPHA) Slice all data series by elements of these attributes. | ||
(…sorts: ISortItem[]) => DataViewLoader | (ALPHA) Sorting to apply on server side. | ||
(signal: AbortSignal) => DataViewLoader | (ALPHA) Runs execution with the provided AbortSignal. | ||
(…totals: ITotal[]) => DataViewLoader | (ALPHA) Include these totals among the data slices. |
Property details
DataViewLoader.filterBypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Filters to apply on server side.
filterBy: (...filters: INullableFilter[]) => DataViewLoader;
DataViewLoader.loadAllpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Loads all the result data and wraps them in DataViewFacade.
loadAll: () => Promise<DataViewFacade>;
DataViewLoader.loadWindowpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Loads subset of the result data and wraps them in DataViewFacade.
loadWindow: (dataWindow: DataViewWindow) => Promise<DataViewFacade>;
DataViewLoader.seriesFrompropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Data series will be built using the provided measures that are further scoped for elements of the specified attributes.
seriesFrom: (...measuresAndScopingAttributes: IAttributeOrMeasure[]) => DataViewLoader;
Remarks
You must define at least 1 measure for the series.
DataViewLoader.slicesFrompropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Slice all data series by elements of these attributes.
slicesFrom: (...attributes: IAttribute[]) => DataViewLoader;
DataViewLoader.sortBypropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Sorting to apply on server side.
sortBy: (...sorts: ISortItem[]) => DataViewLoader;
DataViewLoader.withSignalpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Runs execution with the provided AbortSignal.
withSignal: (signal: AbortSignal) => DataViewLoader;
DataViewLoader.withTotalspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Include these totals among the data slices.
withTotals: (...totals: ITotal[]) => DataViewLoader;