> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IDataView

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/execution/index.ts

A view on the calculated data.

**Signature:**

```typescript
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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewclusteringconfig) | `readonly` | [IClusteringConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iclusteringconfig/index.md) | **_(BETA)_** _(Optional)_ Configuration for the clustering, if available. |
| [clusteringResult?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewclusteringresult) | `readonly` | [IClusteringResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iclusteringresult/index.md) | **_(BETA)_** _(Optional)_ Clustering result, if available. |
| [context?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewcontext) | `readonly` | [IExecutionContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexecutioncontext/index.md) | _(Optional)_ Execution context metadata available on this data view. |
| [count](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewcount) | `readonly` | number[] | Count of data in each dimension. |
| [data](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewdata) | `readonly` | [DataValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datavalue/index.md)[][] \| [DataValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datavalue/index.md)[] | The calculated data. Dimensionality of the data matches the dimensions requested at execution time. |
| [definition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewdefinition) | `readonly` | [IExecutionDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexecutiondefinition/index.md) | Full definition of execution that computed data included in this DataView. |
| [forecastConfig?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewforecastconfig) | `readonly` | [IForecastConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iforecastconfig/index.md) | **_(BETA)_** _(Optional)_ Configuration for the forecasting, if available. |
| [forecastResult?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewforecastresult) | `readonly` | [IForecastResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iforecastresult/index.md) | **_(BETA)_** _(Optional)_ Forecasting result, if available. |
| [headerItems](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewheaderitems) | `readonly` | [IResultHeader](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iresultheader/index.md)[][][] | Headers are metadata for the data in this view. |
| [metadata](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewmetadata) | `readonly` | [IExecutionResultMetadata](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexecutionresultmetadata/index.md) | **_(ALPHA)_** Additional metadata for the particular execution result. |
| [offset](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewoffset) | `readonly` | number[] | Coordinates of where this data view starts. One coordinate per result dimension. |
| [outliersConfig?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewoutliersconfig) | `readonly` | [IOutliersConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ioutliersconfig/index.md) | **_(ALPHA)_** _(Optional)_ Configuration for the outliers, if available. |
| [outliersResult?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewoutliersresult) | `readonly` | [IOutliersResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ioutliersresult/index.md) | **_(ALPHA)_** _(Optional)_ Outliers result, if available. |
| [result](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewresult) | `readonly` | [IExecutionResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexecutionresult/index.md) | Result of the execution that calculated data for this view. |
| [totalCount](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewtotalcount) | `readonly` | number[] | Total size of data in each dimension. |
| [totals?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewtotals) | `readonly` | [DataValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datavalue/index.md)[][][] | _(Optional)_ Grand totals included in this data view. |
| [totalTotals?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewtotaltotals) | `readonly` | [DataValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.datavalue/index.md)[][][] | _(Optional)_ Totals of grand totals included in this data view. |
| [warnings?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewwarnings) | `readonly` | [IResultWarning](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iresultwarning/index.md)[] | _(Optional)_ Result warnings. |

## Methods

| Method | Description |
| --- | --- |
| [clustering()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewclustering) | **_(BETA)_** Return clustering data view. This object is empty if `withClustering` was not called |
| [equals(other)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewequals) | Tests if this data view is same as the other data view. |
| [fingerprint()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewfingerprint) | Unique fingerprint of this data view. |
| [forecast()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewforecast) | **_(BETA)_** Return forecast data view. This object is empty if not `withForecast` was called |
| [outliers()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewoutliers) | **_(ALPHA)_** Return outliers data view. This object is empty if not `withOutliers` was called |
| [readCollectionItems(config)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewreadcollectionitems) | **_(ALPHA)_** Retrieves collection items (geospatial features) using provided configuration. |
| [withClustering(config, result)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewwithclustering) | **_(BETA)_** Adds clustering for this data view. |
| [withForecast(config, result)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewwithforecast) | **_(BETA)_** Adds forecast for this data view. |
| [withOutliers(config, result)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md#idataviewwithoutliers) | **_(ALPHA)_** Adds outliers for this data view. |

## Property details

### IDataView.clusteringConfig

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Configuration for the clustering, if available.

**Signature:**

```typescript
readonly clusteringConfig?: IClusteringConfig;
```

### IDataView.clusteringResult

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Clustering result, if available.

**Signature:**

```typescript
readonly clusteringResult?: IClusteringResult;
```

### IDataView.context

Execution context metadata available on this data view.

**Signature:**

```typescript
readonly context?: IExecutionContext;
```

### IDataView.count

Count of data in each dimension.

**Signature:**

```typescript
readonly count: number[];
```

### IDataView.data

The calculated data. Dimensionality of the data matches the dimensions requested at execution time.

**Signature:**

```typescript
readonly data: DataValue[][] | DataValue[];
```

### IDataView.definition

Full definition of execution that computed data included in this DataView.

**Signature:**

```typescript
readonly definition: IExecutionDefinition;
```

### IDataView.forecastConfig

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Configuration for the forecasting, if available.

**Signature:**

```typescript
readonly forecastConfig?: IForecastConfig;
```

### IDataView.forecastResult

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Forecasting result, if available.

**Signature:**

```typescript
readonly forecastResult?: IForecastResult;
```

### IDataView.headerItems

Headers are metadata for the data in this view.

**Signature:**

```typescript
readonly headerItems: IResultHeader[][][];
```

#### Remarks

There are headers for each dimension and in each dimension headers are further sliced by the attribute or measure or total to which the data belongs.

Thus:

- Top array contains 0 to N per-dimension arrays, one for each requested dimension (if any) - The per-dimension arrays then contain per-slice array, one for each attribute or measure in the dimension - The per-slice-array then contains the actual result header which includes information such as attribute element  or measure name

### IDataView.metadata

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Additional metadata for the particular execution result.

**Signature:**

```typescript
readonly metadata: IExecutionResultMetadata;
```

### IDataView.offset

Coordinates of where this data view starts. One coordinate per result dimension.

**Signature:**

```typescript
readonly offset: number[];
```

### IDataView.outliersConfig

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Configuration for the outliers, if available.

**Signature:**

```typescript
readonly outliersConfig?: IOutliersConfig;
```

### IDataView.outliersResult

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Outliers result, if available.

**Signature:**

```typescript
readonly outliersResult?: IOutliersResult;
```

### IDataView.result

Result of the execution that calculated data for this view.

**Signature:**

```typescript
readonly result: IExecutionResult;
```

### IDataView.totalCount

Total size of data in each dimension.

**Signature:**

```typescript
readonly totalCount: number[];
```

### IDataView.totals

Grand totals included in this data view.

**Signature:**

```typescript
readonly totals?: DataValue[][][];
```

#### Remarks

Grand totals are included for each dimension; within each dimension there is one entry per requested total and for each requested total there are list of values.

Thus:

- Top array contains 0 to N per-dimension arrays - Each per-dimension array contains one per-total entry for each requested total - Each per-total entry contains array of calculated values, cardinality of this matches the cardinality  of the data in the respective dimension.

### IDataView.totalTotals

Totals of grand totals included in this data view.

**Signature:**

```typescript
readonly totalTotals?: DataValue[][][];
```

### IDataView.warnings

Result warnings.

**Signature:**

```typescript
readonly warnings?: IResultWarning[];
```

#### Remarks

Backend MAY return warnings to indicate that the result is different compared to what the caller can expect. For example, the caller executes a definition with particular filter, but the backend determines that the filter has no effect on the computation. Backend runs the execution and communicates by warning that the filter was useless.

## Method details

### IDataView.clustering()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Return clustering data view. This object is empty if `withClustering` was not called

**Signature:**

```typescript
clustering(): IClusteringResult;
```
**Returns:**

[IClusteringResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iclusteringresult/index.md)

### IDataView.equals()

Tests if this data view is same as the other data view.

**Signature:**

```typescript
equals(other: IDataView): boolean;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| other | [IDataView](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md) | other data view |

**Returns:**

boolean

true if equal, false if not

### IDataView.fingerprint()

Unique fingerprint of this data view.

**Signature:**

```typescript
fingerprint(): string;
```
**Returns:**

string

#### Remarks

The fingerprint is influenced by the execution result and the offset and limit of the data view.

Thus, two data views on the same result, with same offset and limit will have the same fingerprint.

### IDataView.forecast()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Return forecast data view. This object is empty if not `withForecast` was called

**Signature:**

```typescript
forecast(): IForecastView;
```
**Returns:**

[IForecastView](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iforecastview/index.md)

### IDataView.outliers()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Return outliers data view. This object is empty if not `withOutliers` was called

**Signature:**

```typescript
outliers(): IOutliersView;
```
**Returns:**

[IOutliersView](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ioutliersview/index.md)

### IDataView.readCollectionItems()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Retrieves collection items (geospatial features) using provided configuration.

**Signature:**

```typescript
readCollectionItems(config: ICollectionItemsConfig): Promise<ICollectionItemsResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| config | [ICollectionItemsConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.icollectionitemsconfig/index.md) | configuration including collection identifier and optional filters |

**Returns:**

Promise&lt;[ICollectionItemsResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.icollectionitemsresult/index.md)&gt;

promise of collection items result with GeoJSON features

### IDataView.withClustering()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Adds clustering for this data view.

**Signature:**

```typescript
withClustering(config?: IClusteringConfig, result?: IClusteringResult): IDataView;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| config | [IClusteringConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iclusteringconfig/index.md) | _(Optional)_ clustering configuration |
| result | [IClusteringResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iclusteringresult/index.md) | _(Optional)_ clustering result |

**Returns:**

[IDataView](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md)

new data view with clustering enabled

### IDataView.withForecast()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Adds forecast for this data view.

**Signature:**

```typescript
withForecast(config?: IForecastConfig, result?: IForecastResult): IDataView;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| config | [IForecastConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iforecastconfig/index.md) | _(Optional)_ forecast configuration |
| result | [IForecastResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iforecastresult/index.md) | _(Optional)_ forecast result |

**Returns:**

[IDataView](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md)

new data view with forecasting enabled

### IDataView.withOutliers()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Adds outliers for this data view.

**Signature:**

```typescript
withOutliers(config?: IOutliersConfig, result?: IOutliersResult): IDataView;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| config | [IOutliersConfig](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ioutliersconfig/index.md) | _(Optional)_ outliers configuration |
| result | [IOutliersResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ioutliersresult/index.md) | _(Optional)_ outliers result |

**Returns:**

[IDataView](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.idataview/index.md)

new data view with outliers enabled