Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class SparklineGroupCollection

java.lang.Object
  extended by com.aspose.cells.SparklineGroupCollection

public class SparklineGroupCollection
extends java.lang.Object

Encapsulates a collection of SparklineGroup objects.


Method Summary
 int add(int sparklineType, java.lang.String dataRange, boolean isVertical, CellArea locationRange)
          Adds an SparklineGroup item to the collection.
 void clear()
          Removes all of the sparklineGroups from this collection.
 void clearSparklineGroups(CellArea cellArea)
          Clears the sparkline groups that overlaps an area of cells.
 void clearSparklines(CellArea cellArea)
          Clears the sparklines that is inside an area of cells.
 SparklineGroup get(int index)
          Gets the SparklineGroup element at the specified index.
 boolean remove(int index)
          Removes the sparklineGroup at the specified position in this collection.
 boolean remove(SparklineGroup sparklineGroup)
          Removes a sparklineGroup from this collection.
 int size()
          Gets the number of sparklineGroups in this collection.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

get

public SparklineGroup get(int 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.

add

public int add(int sparklineType,
               java.lang.String dataRange,
               boolean isVertical,
               CellArea locationRange)
        throws java.lang.IllegalArgumentException
Adds an SparklineGroup item to the collection.

Parameters:
sparklineType - specifies the type of the Sparkline group.
dataRange - specifies the data range of the sparkline group.
isVertical - specifies whether to plot the sparklines from the data range by row or by column.
locationRange - specifies where the sparklines to be placed.
Returns:
SparklineGroup object index.
Throws:
java.lang.IllegalArgumentException
See Also:
SparklineType

size

public int size()
Gets the number of sparklineGroups in this collection.


clear

public void clear()
Removes all of the sparklineGroups from this collection.


remove

public boolean remove(int index)
Removes the sparklineGroup at the specified position in this collection.

Parameters:
index - the zero based index of the sparklineGroup.
Returns:
true if the sparklineGroup exists and be removed.

remove

public boolean remove(SparklineGroup sparklineGroup)
Removes a sparklineGroup from this collection.

Parameters:
sparklineGroup - the sparklineGroup to be removed
Returns:
true if the sparklineGroup exists and be removed.

clearSparklines

public void clearSparklines(CellArea cellArea)
Clears the sparklines that is inside an area of cells.

Parameters:
cellArea - the area of cells.

clearSparklineGroups

public void clearSparklineGroups(CellArea cellArea)
Clears the sparkline groups that overlaps an area of cells.

Parameters:
cellArea - the area of cells.