aspose.cells
Class SparklineGroupCollection

Encapsulates a collection of SparklineGroup objects.

Property Getters/Setters Summary
functiongetCount()
          
functionget(index)
           Gets the SparklineGroup element at the specified index.
 
Method Summary
functionadd(type, dataRange, isVertical, locationRange)
           Adds an SparklineGroup item to the collection.
functionadd(value)→ inherited from CollectionBase
          Reserved for internal use.
functionclear()→ inherited from CollectionBase
          
functionclearSparklineGroups(cellArea)
           Clears the sparkline groups that overlaps an area of cells.
functionclearSparklines(cellArea)
           Clears the sparklines that is inside an area of cells.
functioncontains(value)→ inherited from CollectionBase
          Reserved for internal use.
functionget(index)→ inherited from CollectionBase
          Reserved for internal use.
functionindexOf(value)→ inherited from CollectionBase
          Reserved for internal use.
functioniterator()→ inherited from CollectionBase
          
functionremoveAt(index)→ inherited from CollectionBase
          
 

Property Getters/Setters Detail

getCount : Number 

function getCount()

get : SparklineGroup 

function get(index)
Gets the SparklineGroup element at the specified index.
Parameters:
index - The zero based index of the element.
Returns:
The element at the specified index.

Method Detail

add

function add(type, dataRange, isVertical, locationRange)
Adds an SparklineGroup item to the collection.
Parameters:
type: Number - 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.

clearSparklines

function clearSparklines(cellArea)
Clears the sparklines that is inside an area of cells.
Parameters:
cellArea: CellArea - Specifies the area of cells

clearSparklineGroups

function clearSparklineGroups(cellArea)
Clears the sparkline groups that overlaps an area of cells.
Parameters:
cellArea: CellArea - Specifies the area of cells

clear

function clear()

removeAt

function removeAt(index)

iterator

function iterator()

get

function get(index)
Reserved for internal use.

contains

function contains(value)
Reserved for internal use.

add

function add(value)
Reserved for internal use.

indexOf

function indexOf(value)
Reserved for internal use.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.