SparklineGroupCollection

SparklineGroupCollection class

Encapsulates a collection of SparklineGroup objects.

class SparklineGroupCollection;

Methods

Method	Description
get(number)	Gets the SparklineGroup element at the specified index.
add(SparklineType)	Adds an SparklineGroup with a Sparkline to the collection.
add(SparklineType, string, boolean, CellArea)	Adds an SparklineGroup with some Sparkline to the collection.
clearSparklines(CellArea)	Clears the sparklines that is inside an area of cells.
clearSparklineGroups(CellArea)	Clears the sparkline groups that overlaps an area of cells.
getCount()	@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.
isNull()	Checks whether the implementation object is null.

get(number)

Gets the SparklineGroup element at the specified index.

get(index: number) : SparklineGroup;

Parameters:

Parameter	Type	Description
index	number	The zero based index of the element.

Returns

The element at the specified index.

add(SparklineType)

Adds an SparklineGroup with a Sparkline to the collection.

add(type: SparklineType) : number;

Parameters:

Parameter	Type	Description
type	SparklineType	Specifies the type of the Sparkline group.

Returns

SparklineGroup object index.

add(SparklineType, string, boolean, CellArea)

Adds an SparklineGroup with some Sparkline to the collection.

add(type: SparklineType, dataRange: string, isVertical: boolean, locationRange: CellArea) : number;

Parameters:

Parameter	Type	Description
type	SparklineType	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.

Remarks

This method will create sparklines too. If is true, the number of rows in dataRange and locationRange must be same. If is false, the number of columns in dataRange and locationRange must be same.

clearSparklines(CellArea)

Clears the sparklines that is inside an area of cells.

clearSparklines(cellArea: CellArea) : void;

Parameters:

Parameter	Type	Description
cellArea	CellArea	Specifies the area of cells

Remarks

SparklineGroup will be removed too if it does not contains any Sparkline.

clearSparklineGroups(CellArea)

Clears the sparkline groups that overlaps an area of cells.

clearSparklineGroups(cellArea: CellArea) : void;

Parameters:

Parameter	Type	Description
cellArea	CellArea	Specifies the area of cells

getCount()

@deprecated. Please use the ‘count’ property instead. Gets the number of elements contained in.

getCount() : number;

isNull()

Checks whether the implementation object is null.

isNull() : boolean;