# GC.Spread.Sheets.Charts.SeriesCollection

## Content

# Class: SeriesCollection

[Sheets](../modules/GC.Spread.Sheets).[Charts](../modules/GC.Spread.Sheets.Charts).SeriesCollection

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.Charts.SeriesCollection#constructor)

### Methods

- [add](GC.Spread.Sheets.Charts.SeriesCollection#add)
- [get](GC.Spread.Sheets.Charts.SeriesCollection#get)
- [remove](GC.Spread.Sheets.Charts.SeriesCollection#remove)
- [set](GC.Spread.Sheets.Charts.SeriesCollection#set)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new SeriesCollection**()

Represents the series manager that managers all series in a chart.

## Methods

### <a id="add" name="add"></a> add

▸ **add**(`series`): `void`

Adds a new series to series collection.

**`example`**
```javascript
// This example shows how to add a new series.
var dataRange = "A1:D4";
var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);
chart.series().add({
    chartType: GC.Spread.Sheets.Charts.ChartType.columnClustered,
    axisGroup: GC.Spread.Sheets.Charts.AxisGroup.primary,
    backColor: {
        color: "lightblue",
        width: 2
    },
    xValues: "A2:A4",
    yValues: "B2:B4"
});
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `series` | [`ISeries`](../interfaces/GC.Spread.Sheets.Charts.ISeries) \| [`ISeries`](../interfaces/GC.Spread.Sheets.Charts.ISeries)[] | The series of the chart. |

#### Returns

`void`

___

### <a id="get" name="get"></a> get

▸ **get**(`index?`): `any`

Gets all series or a specified series from series collection.

**`example`**
```javascript
// This example shows how to get a series.
var dataRange = "A1:D4";
var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);
var series1 = chart.series().get(0);
```

#### Parameters

| Name | Type |
| :------ | :------ |
| `index?` | `number` |

#### Returns

`any`

The series of the chart.

___

### <a id="remove" name="remove"></a> remove

▸ **remove**(`index`): `void`

Removes a specified series from series collection.

**`example`**
```javascript
// This example shows how to remove a specified series.
var dataRange = "A1:D4";
var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);
chart.series().remove(0);
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `index` | `number` | The index of the series. |

#### Returns

`void`

___

### <a id="set" name="set"></a> set

▸ **set**(`index`, `series`): `void`

Updates the specified series's property.

**`example`**
```javascript
// This example shows how to update the property of a series.
var dataRange = "A1:D4";
var chart = activeSheet.charts.add('Chart1', GC.Spread.Sheets.Charts.ChartType.columnClustered, 250, 20, 600, 400, dataRange);
var series1 = chart.series().get(0);
series1.backColor = "red";
chart.series().set(0, series1);
```

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `index` | `number` | The index of the series. |
| `series` | [`ISeries`](../interfaces/GC.Spread.Sheets.Charts.ISeries) | The series of the chart. |

#### Returns

`void`
