# GC.Spread.Sheets.DataRange.DataRangeManager

## Content

# Class: DataRangeManager

[Sheets](../modules/GC.Spread.Sheets).[DataRange](../modules/GC.Spread.Sheets.DataRange).DataRangeManager

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.DataRange.DataRangeManager#constructor)

### Methods

- [add](GC.Spread.Sheets.DataRange.DataRangeManager#add)
- [all](GC.Spread.Sheets.DataRange.DataRangeManager#all)
- [clear](GC.Spread.Sheets.DataRange.DataRangeManager#clear)
- [get](GC.Spread.Sheets.DataRange.DataRangeManager#get)
- [remove](GC.Spread.Sheets.DataRange.DataRangeManager#remove)

## Constructors

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

• **new DataRangeManager**(`sheet`)

**`description`** Represents a data range manager.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `sheet` | [`Worksheet`](GC.Spread.Sheets.Worksheet) | The worksheet. |

## Methods

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

▸ **add**(`name`, `dataProvider`, `range`, `options?`): [`DataRange`](GC.Spread.Sheets.DataRange.DataRange)

**`description`** Adds a data range.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | `string` | The data range name. |
| `dataProvider` | `string` \| [`IDataProvider`](../interfaces/GC.Spread.Sheets.DataRange.IDataProvider) | The data provider. String type means the tableSheet name, it will create a TableSheetDataProvider. |
| `range` | [`Range`](GC.Spread.Sheets.Range) | The range of data range. |
| `options?` | [`IDataRangeOptions`](../interfaces/GC.Spread.Sheets.DataRange.IDataRangeOptions) | - |

#### Returns

[`DataRange`](GC.Spread.Sheets.DataRange.DataRange)

The added data range.

___

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

▸ **all**(): [`DataRange`](GC.Spread.Sheets.DataRange.DataRange)[]

**`description`** Get all data ranges.

#### Returns

[`DataRange`](GC.Spread.Sheets.DataRange.DataRange)[]

The array of data range instances. Default is empty array.

___

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

▸ **clear**(): `void`

**`description`** Remove all data ranges.

#### Returns

`void`

___

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

▸ **get**(`name`): [`DataRange`](GC.Spread.Sheets.DataRange.DataRange)

**`description`** Gets a data range.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | `string` | The data range name. |

#### Returns

[`DataRange`](GC.Spread.Sheets.DataRange.DataRange)

The target data range.

___

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

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

**`description`** Remove a data range.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `name` | `string` | The data range name. |

#### Returns

`void`