IDataView

Home > @gooddata/sdk-backend-spi > IDataView

IDataView interface

A view on the calculated data.

Signature:

export interface IDataView 

Remarks

See also the {@link @gooddata/sdk-ui#DataViewFacade}. This wrapper on top of this raw IDataView can be used to work with the data in a way more convenient fashion.

Properties

Property	Modifiers	Type	Description
clusteringConfig?	readonly	IClusteringConfig	(BETA) (Optional) Configuration for the clustering, if available.
clusteringResult?	readonly	IClusteringResult	(BETA) (Optional) Clustering result, if available.
count	readonly	number[]	Count of data in each dimension.
data	readonly	DataValue[][] | DataValue[]	The calculated data. Dimensionality of the data matches the dimensions requested at execution time.
definition	readonly	IExecutionDefinition	Full definition of execution that computed data included in this DataView.
forecastConfig?	readonly	IForecastConfig	(BETA) (Optional) Configuration for the forecasting, if available.
forecastResult?	readonly	IForecastResult	(BETA) (Optional) Forecasting result, if available.
headerItems	readonly	IResultHeader[][][]	Headers are metadata for the data in this view.
metadata	readonly	IExecutionResultMetadata	(ALPHA) Additional metadata for the particular execution result.
offset	readonly	number[]	Coordinates of where this data view starts. One coordinate per result dimension.
result	readonly	IExecutionResult	Result of the execution that calculated data for this view.
totalCount	readonly	number[]	Total size of data in each dimension.
totals?	readonly	DataValue[][][]	(Optional) Grand totals included in this data view.
totalTotals?	readonly	DataValue[][][]	(Optional) Totals of grand totals included in this data view.
warnings?	readonly	IResultWarning[]	(Optional) Result warnings.

Methods

Method	Description
clustering()	(BETA) Return clustering data view. This object is empty if withClustering was not called
equals(other)	Tests if this data view is same as the other data view.
fingerprint()	Unique fingerprint of this data view.
forecast()	(BETA) Return forecast data view. This object is empty if not withForecast was called
withClustering(config, result)	(BETA) Adds clustering for this data view.
withForecast(config, result)	(BETA) Adds forecast for this data view.