SparklineGroupCollection
Contents
[
Hide
]SparklineGroupCollection class
Encapsulates a collection of SparklineGroup objects.
Properties
| Name | Type | Description |
|---|---|---|
| Count | int | |
| Item (int) | SparklineGroup | Gets the SparklineGroup element at the specified index. |
Methods
| Name | Description |
|---|---|
| add | Adds an SparklineGroup with a Sparkline to the collection. |
| clearSparklines | Clears the sparklines that is inside an area of cells. |
| clearSparklineGroups | Clears the sparkline groups that overlaps an area of cells. |
| clear | |
| removeAt | |
| iterator | |
| get | Reserved for internal use. |
| contains | Reserved for internal use. |
| indexOf | Reserved for internal use. |
SparklineGroupCollection.Count property
Type: int
SparklineGroupCollection.Item (int) property
Gets the SparklineGroup element at the specified index.
Type: SparklineGroup
add(type) (1 of 3)
Adds an SparklineGroup with a Sparkline to the collection.
| Parameter | Type | Description |
|---|---|---|
| type | int | A SparklineType value. Specifies the type of the Sparkline group. |
Returns: SparklineGroup object index.
add(type, dataRange, isVertical, locationRange) (2 of 3)
Adds an SparklineGroup with Sparkline to the collection.
| Parameter | Type | Description |
|---|---|---|
| type | int | A SparklineType value. Specifies the type of the Sparkline group. |
| 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: SparklineGroup object index.
add(value) (3 of 3)
Reserved for internal use.
clearSparklines(cellArea)
Clears the sparklines that is inside an area of cells.
| Parameter | Type | Description |
|---|---|---|
| cellArea | CellArea | Specifies the area of cells |
clearSparklineGroups(cellArea)
Clears the sparkline groups that overlaps an area of cells.
| Parameter | Type | Description |
|---|---|---|
| cellArea | CellArea | Specifies the area of cells |
clear()
removeAt(index)
iterator()
get(index)
Reserved for internal use.
contains(value)
Reserved for internal use.
indexOf(value)
Reserved for internal use.