# GC.Spread.Sheets.Sparklines.SparklineGroup

## Content

# Class: SparklineGroup

[Sheets](../modules/GC.Spread.Sheets).[Sparklines](../modules/GC.Spread.Sheets.Sparklines).SparklineGroup

## Table of contents

### Constructors

- [constructor](GC.Spread.Sheets.Sparklines.SparklineGroup#constructor)

### Properties

- [setting](GC.Spread.Sheets.Sparklines.SparklineGroup#setting)
- [sparklineType](GC.Spread.Sheets.Sparklines.SparklineGroup#sparklinetype)

### Methods

- [add](GC.Spread.Sheets.Sparklines.SparklineGroup#add)
- [clone](GC.Spread.Sheets.Sparklines.SparklineGroup#clone)
- [contains](GC.Spread.Sheets.Sparklines.SparklineGroup#contains)
- [count](GC.Spread.Sheets.Sparklines.SparklineGroup#count)
- [dateAxisData](GC.Spread.Sheets.Sparklines.SparklineGroup#dateaxisdata)
- [dateAxisOrientation](GC.Spread.Sheets.Sparklines.SparklineGroup#dateaxisorientation)
- [remove](GC.Spread.Sheets.Sparklines.SparklineGroup#remove)

## Constructors

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

• **new SparklineGroup**(`type`, `setting`)

Represents a sparkline group.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `type` | [`SparklineType`](../enums/GC.Spread.Sheets.Sparklines.SparklineType) | The type of sparkline. |
| `setting` | [`SparklineSetting`](GC.Spread.Sheets.Sparklines.SparklineSetting) | The setting of the sparkline group. |

## Properties

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

• **setting**: [`SparklineSetting`](GC.Spread.Sheets.Sparklines.SparklineSetting)

Indicates the sparkline settings.

___

### <a id="sparklinetype" name="sparklinetype"></a> sparklineType

• **sparklineType**: [`SparklineType`](../enums/GC.Spread.Sheets.Sparklines.SparklineType)

Indicates the sparkline type.

## Methods

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

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

Adds a sparkline to the group.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `item` | [`Sparkline`](GC.Spread.Sheets.Sparklines.Sparkline) | The sparkline item. |

#### Returns

`void`

___

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

▸ **clone**(): [`SparklineGroup`](GC.Spread.Sheets.Sparklines.SparklineGroup)

Clones the current sparkline group.

#### Returns

[`SparklineGroup`](GC.Spread.Sheets.Sparklines.SparklineGroup)

The cloned sparkline group.

___

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

▸ **contains**(`item`): `boolean`

Determines whether the group contains a specific value.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `item` | [`Sparkline`](GC.Spread.Sheets.Sparklines.Sparkline) | The object to locate in the group. |

#### Returns

`boolean`

`true` if the item is found in the group; otherwise, `false`.

___

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

▸ **count**(): `number`

Represents the count of the sparkline group innerlist.

#### Returns

`number`

The sparkline count in the group.

___

### <a id="dateaxisdata" name="dateaxisdata"></a> dateAxisData

▸ **dateAxisData**(`value?`): `any`

Represents the date axis data.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value?` | [`Range`](GC.Spread.Sheets.Range) | The date axis data. |

#### Returns

`any`

If no value is set, returns the date axis data; otherwise, returns undefined.

___

### <a id="dateaxisorientation" name="dateaxisorientation"></a> dateAxisOrientation

▸ **dateAxisOrientation**(`value`): `any`

Represents the date axis orientation.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `value` | [`DataOrientation`](../enums/GC.Spread.Sheets.Sparklines.DataOrientation) | The date axis orientation. |

#### Returns

`any`

If no value is set, returns the date axis orientation; otherwise, returns undefined.

___

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

▸ **remove**(`item`): [`Sparkline`](GC.Spread.Sheets.Sparklines.Sparkline)[]

Removes the first occurrence of a specific object from the group.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `item` | [`Sparkline`](GC.Spread.Sheets.Sparklines.Sparkline) | The sparkline item. |

#### Returns

[`Sparkline`](GC.Spread.Sheets.Sparklines.Sparkline)[]

The GC.Spread.Sheets.Sparklines.Sparkline array.