com.aspose.cells

Class SparklineGroupCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.SparklineGroupCollection

All Implemented Interfaces:

java.lang.Iterable

public class SparklineGroupCollection
extends CollectionBase

Encapsulates a collection of SparklineGroup objects.

Example

 
         Workbook book = new Workbook(); 
         Worksheet sheet = book.getWorksheets().get(0);
 
         sheet.getCells().get("A1").putValue(5);
         sheet.getCells().get("B1").putValue(2);
         sheet.getCells().get("C1").putValue(1);
         sheet.getCells().get("D1").putValue(3);
 
         // Define the CellArea
         CellArea ca = new CellArea();
         ca.StartColumn = 4;
         ca.EndColumn = 4;
         ca.StartRow = 0;
         ca.EndRow = 0;
 
         int idx = sheet.getSparklineGroups().add(com.aspose.cells.SparklineType.LINE, "A1:D1", false, ca);
         SparklineGroup group = sheet.getSparklineGroups().get(idx);
         group.getSparklines().add(sheet.getName() + "!A1:D1", 0, 4);
         book.save("output.xlsx", SaveFormat.XLSX);
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(int type) Adds an SparklineGroup with a Sparkline to the collection.
int	add(int type, java.lang.String dataRange, boolean isVertical, CellArea locationRange) Adds an SparklineGroup with Sparkline to the 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.

Methods inherited from class com.aspose.cells.CollectionBase

add, clear, contains, getCount, indexOf, iterator, removeAt

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public SparklineGroup get(int index)

Gets the SparklineGroup element at the specified index.

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

add

public int add(int type)

Adds an SparklineGroup with a Sparkline to the collection.

Parameters:

type - SparklineType. Specifies the type of the Sparkline group.

Returns:

SparklineGroup object index.

add

public int add(int type,
      java.lang.String dataRange,
      boolean isVertical,
      CellArea locationRange)

Adds an SparklineGroup with Sparkline to the collection.

Parameters:

type - 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.

clearSparklines

public void clearSparklines(CellArea cellArea)

Clears the sparklines that is inside an area of cells.

Parameters:

cellArea - Specifies the area of cells

clearSparklineGroups

public void clearSparklineGroups(CellArea cellArea)

Clears the sparkline groups that overlaps an area of cells.

Parameters:

cellArea - Specifies the area of cells