SparklineGroupCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

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);

Methods

Method	Description
add(int type)	Adds an SparklineGroup with a Sparkline to the collection.
add(int type, String dataRange, boolean isVertical, CellArea locationRange)	Adds an SparklineGroup with Sparkline to the collection.
add(Object o)	Adds an item to the CollectionBase instance.
clear()	Removes all objects from the CollectionBase instance.
clearSparklineGroups(CellArea cellArea)	Clears the sparkline groups that overlaps an area of cells.
clearSparklines(CellArea cellArea)	Clears the sparklines that is inside an area of cells.
contains(Object o)	Return whether instance contains this object
equals(Object arg0)
get(int index)	Gets the SparklineGroup element at the specified index.
getClass()
getCount()	Gets the number of elements contained in the CollectionBase instance.
hashCode()
indexOf(Object o)	Determines the index of a specific item in the CollectionBase instance.
iterator()	Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
removeAt(int index)	Removes the item at the specified index.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(int type)

public int add(int type)

Adds an SparklineGroup with a Sparkline to the collection.

Parameters:

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

Returns: int - SparklineGroup object index.

add(int type, String dataRange, boolean isVertical, CellArea locationRange)

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

Adds an SparklineGroup with Sparkline to the collection.

Parameters:

Parameter	Type	Description
type	int	SparklineType. Specifies the type of the Sparkline group.
dataRange	java.lang.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: int - SparklineGroup object index.

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	The Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

clear()

public void clear()

Removes all objects from the CollectionBase instance.

clearSparklineGroups(CellArea cellArea)

public void clearSparklineGroups(CellArea cellArea)

Clears the sparkline groups that overlaps an area of cells.

Parameters:

Parameter	Type	Description
cellArea	CellArea	Specifies the area of cells

clearSparklines(CellArea cellArea)

public void clearSparklines(CellArea cellArea)

Clears the sparklines that is inside an area of cells.

Parameters:

Parameter	Type	Description
cellArea	CellArea	Specifies the area of cells

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

Parameter	Type	Description
o	java.lang.Object	test object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

get(int index)

public SparklineGroup get(int index)

Gets the SparklineGroup element at the specified index.

Parameters:

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

Returns: SparklineGroup - The element at the specified index.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

Parameter	Type	Description
o	java.lang.Object	Determines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

removeAt(int index)

public void removeAt(int index)

Removes the item at the specified index.

Parameters:

Parameter	Type	Description
index	int	The zero-based index of the item to remove.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int