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

# IDataSeriesCollection

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

An iterable collection of data series.

**Signature:**

```typescript
export interface IDataSeriesCollection extends Iterable<IDataSeries> 
```
**Extends:** Iterable&lt;[IDataSeries](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseries/index.md)&gt;

## Remarks

The collection additionally includes basic information about the origin of the data series that can be iterated - their number, measures they were calculated from and the scoping attributes.

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [count](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseriescollection/index.md#idataseriescollectioncount) | `readonly` | number | Number of available data series. |
| [fromMeasures](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseriescollection/index.md#idataseriescollectionfrommeasures) | `readonly` | [IMeasureDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imeasuredescriptor/index.md)[] | Descriptors of measures that are used in the data series. |
| [fromMeasuresDef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseriescollection/index.md#idataseriescollectionfrommeasuresdef) | `readonly` | [IMeasure](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imeasure/index.md)[] | Definitions of measures which were sent to execution and resulted in the data series. |
| [scopingAttributes?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseriescollection/index.md#idataseriescollectionscopingattributes) | `readonly` | [IAttributeDescriptor](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattributedescriptor/index.md)[] | _(Optional)_ Descriptors of attributes that are used to create data series with scoped measure values. |
| [scopingAttributesDef?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseriescollection/index.md#idataseriescollectionscopingattributesdef) | `readonly` | [IAttribute](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iattribute/index.md)[] | _(Optional)_ Definitions of attributes which were sent to execution and resulted in the data series with scoped measure values. |

## Methods

| Method | Description |
| --- | --- |
| [allForMeasure(localIdOrMeasure)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseriescollection/index.md#idataseriescollectionallformeasure) | Returns iterator over all data series created for particular measure. |
| [firstForMeasure(localIdOrMeasure)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseriescollection/index.md#idataseriescollectionfirstformeasure) | Returns first-found data series for the provided measure. |
| [toArray()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseriescollection/index.md#idataseriescollectiontoarray) | Returns all data series in an array. |

## Property details

### IDataSeriesCollection.count

Number of available data series.

**Signature:**

```typescript
readonly count: number;
```

### IDataSeriesCollection.fromMeasures

Descriptors of measures that are used in the data series.

**Signature:**

```typescript
readonly fromMeasures: IMeasureDescriptor[];
```

#### Remarks

Note that the number of measures MAY differ from number of data series - that is because the data series may be created for multiple scopes of each measure (e.g. measure X calculated for attribute element A, then same measure calculated for attribute element B etc)

### IDataSeriesCollection.fromMeasuresDef

Definitions of measures which were sent to execution and resulted in the data series.

**Signature:**

```typescript
readonly fromMeasuresDef: IMeasure[];
```

#### Remarks

Order of appearance matches the order of appearance in the `fromMeasures` array.

### IDataSeriesCollection.scopingAttributes

Descriptors of attributes that are used to create data series with scoped measure values.

**Signature:**

```typescript
readonly scopingAttributes?: IAttributeDescriptor[];
```

### IDataSeriesCollection.scopingAttributesDef

Definitions of attributes which were sent to execution and resulted in the data series with scoped measure values.

**Signature:**

```typescript
readonly scopingAttributesDef?: IAttribute[];
```

#### Remarks

Order of apperance matches the order of appreance in the `scopingAttributes` array.

## Method details

### IDataSeriesCollection.allForMeasure()

Returns iterator over all data series created for particular measure.

**Signature:**

```typescript
allForMeasure(localIdOrMeasure: string | IMeasure): Iterable<IDataSeries>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| localIdOrMeasure | string \| [IMeasure](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imeasure/index.md) | local id of measure or measure object to get local id from |

**Returns:**

Iterable&lt;[IDataSeries](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseries/index.md)&gt;

iterable with no elements

### IDataSeriesCollection.firstForMeasure()

Returns first-found data series for the provided measure.

**Signature:**

```typescript
firstForMeasure(localIdOrMeasure: string | IMeasure): IDataSeries;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| localIdOrMeasure | string \| [IMeasure](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imeasure/index.md) | local id of measure or measure object to get local id from |

**Returns:**

[IDataSeries](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseries/index.md)

data series

#### Exceptions

error if no data series or no data series from the provided measure

#### Remarks

This is a 'get-or-die' method and will throw in case data series from the provided measure is not located.

### IDataSeriesCollection.toArray()

Returns all data series in an array.

**Signature:**

```typescript
toArray(): IDataSeries[];
```
**Returns:**

[IDataSeries](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.idataseries/index.md)[]

empty if no data series

#### Remarks

Note: if you are looking for a subset of measures, always prefer using the first-class methods  and  in favor of getting the array and filtering yourself.