IMeasureDateDatasets
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The measure date datasets holds information about available date datasets that can be used for date-filtering a particular measure.
The data included herein can be used to select an appropriate date dataset to filter a KPI widget that renders value of particular measure.
export interface IMeasureDateDatasets
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| Record<string, string> | (ALPHA) A mapping between original date dataset title and a nicely formatted title that is suitable to display to the end-user. All date datasets that figure in the result structure have their titles included in this mapping | |
| ReadonlyArray<ICatalogDateDataset> | (ALPHA) Date datasets that are available for filtering of the measure. The available datasets are obtained by inspecting relation of measure and the different date datasets in the workspace’s logical data model. | |
| ReadonlyArray<ICatalogDateDataset> | (ALPHA) The contents of the |
Property details
IMeasureDateDatasets.dateDatasetDisplayNamespropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A mapping between original date dataset title and a nicely formatted title that is suitable to display to the end-user. All date datasets that figure in the result structure have their titles included in this mapping
readonly dateDatasetDisplayNames: Record<string, string>;
IMeasureDateDatasets.dateDatasetspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Date datasets that are available for filtering of the measure. The available datasets are obtained by inspecting relation of measure and the different date datasets in the workspace’s logical data model.
readonly dateDatasets: ReadonlyArray<ICatalogDateDataset>;
IMeasureDateDatasets.dateDatasetsOrderedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
The contents of the dateDatasets prop that are ordered according to the relevance. The most relevant and thus most recommended date dataset is first.
readonly dateDatasetsOrdered: ReadonlyArray<ICatalogDateDataset>;