SparklineGroupCollection
Contents
[
Hide
]SparklineGroupCollection class
Encapsulates a collection of SparklineGroup objects.
Methods
| Name | Description |
|---|---|
| add() | |
| add(type, dataRange, isVertical, locationRange) | Adds an SparklineGroup item to the collection. |
| add() | Reserved for internal use. |
| clear() | |
| clearSparklineGroups(cellArea) | Clears the sparkline groups that overlaps an area of cells. |
| clearSparklines(cellArea) | Clears the sparklines that is inside an area of cells. |
| contains() | Reserved for internal use. |
| get(index) | Gets the SparklineGroup element at the specified index. |
| get() | Reserved for internal use. |
| getCount() | |
| indexOf() | Reserved for internal use. |
| iterator() | |
| removeAt() |
add()
add(type, dataRange, isVertical, locationRange)
Adds an SparklineGroup item to the collection.
| Parameter | Type | Description |
|---|---|---|
| type | Number | SparklineType |
| dataRange | String | Specifies the data range of the sparkline group. |
| isVertical | boolean | Specifies whether to plot the sparklines from the data range by row or by column. |
| locationRange | CellArea | Specifies where the sparklines to be placed. |
Returns: Number — Number SparklineGroup object index.
add()
Reserved for internal use.
clear()
clearSparklineGroups(cellArea)
Clears the sparkline groups that overlaps an area of cells.
| Parameter | Type | Description |
|---|---|---|
| cellArea | CellArea | Specifies the area of cells |
clearSparklines(cellArea)
Clears the sparklines that is inside an area of cells.
| Parameter | Type | Description |
|---|---|---|
| cellArea | CellArea | Specifies the area of cells |
contains()
Reserved for internal use.
get(index)
Gets the SparklineGroup element at the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | Number | The zero based index of the element. |
Returns: SparklineGroup — SparklineGroup The element at the specified index.
get()
Reserved for internal use.
getCount()
indexOf()
Reserved for internal use.