InsightDateDatasets

Home > @gooddata/sdk-ui-dashboard > InsightDateDatasets

InsightDateDatasets interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The insight date datasets is a digest of information related to what date datasets are used by the insight and what date datasets are also relevant to the insight.

Signature:

export interface InsightDateDatasets 

Remarks

The relevancy of date datasets is determined by relation of the entities used by the insight (facts, metric, attributes) and the data datasets in the workspace's LDM.

The data included herein can be used to select an appropriate date dataset to filter the insight on a dashboard.

The mostImportantFromInsight date dataset - if available, should be typically picked to use for date filtering. If it is not available (meaning the insight does not directly use anything related to date datasets) then the dateDatasetsOrdered can be used to pick the date dataset for filtering.

Properties

Property	Modifiers	Type	Description
allAvailableDateDatasets	readonly	ICatalogDateDataset[]	(ALPHA) All date datasets that can be used to filter the insight. This list is union of all the categorized date datasets listed in this result.
dateDatasetDisplayNames	readonly	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
dateDatasets	readonly	ReadonlyArray<ICatalogDateDataset>	(ALPHA) Date datasets that are available for filtering of the insight. The available datasets are obtained by inspecting the LDM entities used in the insight and how they relate to date datasets in the workspace's logical data model.
dateDatasetsOrdered	readonly	ReadonlyArray<ICatalogDateDataset>	(ALPHA) The contents of the dateDatasets prop that are ordered according to the relevance. The most relevant and thus most recommended date dataset is first.
mostImportantFromInsight	readonly	ICatalogDateDataset | undefined	(ALPHA) Pin-points the 'most important' date dataset referenced by the insight itself. This may be undefined if the insight does not use any date filtering or does not use any date attribute display form's to filter or slice or dice the results. The importance is evaluated as follows: 1. Date datasets used directly in date filters have highest importance. Dataset from first-found filter will be used 2. Date datasets that own the display forms used to slice or dice the insight's data have the second highest importance. Dataset from first-found attribute will be used. 3. Date datasets that own the display forms used for attribute-filtering the insight have the least important. Dataset from first-found attribute filter will be used.
usedInAttributeFilters	readonly	ReadonlyArray<ICatalogDateDataset | undefined>	(ALPHA) Date datasets that the insight references in the attribute filters. The order of appearance matches the order in which attribute display forms used for filtering appear in the InsightAttributesMeta's usage.inFilters. If some display form does not belong to a date dataset, then the element will be undefined.
usedInAttributes	readonly	ReadonlyArray<ICatalogDateDataset | undefined>	(ALPHA) Date datasets that the insight references in the attributes used to slice and dice the results. The order of appearance matches the order in which display forms from the data sets appear in the InsightAttributesMeta's usage.inAttributes. If some display form does not belong to a date dataset, then the element will be undefined.
usedInDateFilters	readonly	ReadonlyArray<ICatalogDateDataset>	(ALPHA) Date datasets that the insight references in its date filters. Will be empty if the insight does not have any date filters.