com.grapecity.documents.excel

Interface ISparklineGroups

All Superinterfaces:

java.lang.Iterable<ISparklineGroup>

public interface ISparklineGroups
extends java.lang.Iterable<ISparklineGroup>

Represents a collection of sparkline groups.

Method Summary

Modifier and Type	Method and Description
ISparklineGroup	add(SparkType type, java.lang.String sourceData) Creates a new sparkline group and returns an ISparklineGroup object.
void	clear() Clears the selected sparklines.
void	clearGroups() Clears the selected sparkline groups.
ISparklineGroup	get(int index) Returns the ISparklineGroup object from a collection.
int	getCount() Gets the number of sparkline groups in the associated IRange object.
void	group() Groups the selected sparklines.
void	group(IRange Location) Groups the selected sparklines.
void	ungroup() Ungroups the sparklines in the selected sparkline group.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getCount

int getCount()

Gets the number of sparkline groups in the associated IRange object.

get

ISparklineGroup get(int index)

Returns the ISparklineGroup object from a collection.

Parameters:

index - Specifies the position of an element in the collection.

add

ISparklineGroup add(SparkType type,
                    java.lang.String sourceData)

Creates a new sparkline group and returns an ISparklineGroup object.

Parameters:

type - The type of sparkline.

sourceData - Represents the range to use to create the sparkline.

clear

void clear()

Clears the selected sparklines.

clearGroups

void clearGroups()

Clears the selected sparkline groups.

group

void group()

Groups the selected sparklines.

group

void group(IRange Location)

Groups the selected sparklines.

Parameters:

Location - The range the sparkline group is based on. If it is null, it is based on the first sparkline in groups.

ungroup

void ungroup()

Ungroups the sparklines in the selected sparkline group.