com.grapecity.documents.excel.drawing

Interface ISeriesCollection

All Superinterfaces:

java.lang.Iterable<ISeries>

public interface ISeriesCollection
extends java.lang.Iterable<ISeries>

Represents a collection of all the ISeries objects in the specified chart.

Method Summary

Modifier and Type	Method and Description
void	add(IRange source) Adds one or more new series to the ISeriesCollection collection.
void	add(IRange source, RowCol rowCol) Adds one or more new series to the ISeriesCollection collection.
void	add(IRange source, RowCol rowCol, boolean seriesLabels, boolean categoryLabels) Adds one or more new series to the ISeriesCollection collection.
void	extend(IRange source, RowCol rowcol, boolean categoryLabels) Adds new data points to an existing series collection.
ISeries	get(int index) Returns a single object from a collection.
ISeries	get(java.lang.String name) Returns a single object from a collection.
int	getCount() Returns the number of objects in the collection.
IChart	getParent() Returns the parent object for the specified object.
ISeries	newSeries() Creates a new series.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getParent

IChart getParent()

Returns the parent object for the specified object.

getCount

int getCount()

Returns the number of objects in the collection.

add

void add(IRange source)

Adds one or more new series to the ISeriesCollection collection. Spread will determine where the values are by the size and orientation of the selected range.

Parameters:

source - The new data, a Range object.

add

void add(IRange source,
         RowCol rowCol)

Adds one or more new series to the ISeriesCollection collection.

Parameters:

source - The new data, a Range object.

rowCol - Specifies whether the new values are in the rows or columns of the given range source. Can be one of the following RowCol constants: Rows or Columns.

add

void add(IRange source,
         RowCol rowCol,
         boolean seriesLabels,
         boolean categoryLabels)

Adds one or more new series to the ISeriesCollection collection.

Parameters:

source - The new data, either as a Range object or an array of data points.

rowCol - Specifies whether the new values are in the rows or columns of the specified range.

seriesLabels - True if the first row or column contains the name of the data series. False if the first row or column contains the first data point of the series.

categoryLabels - True if the first row or column contains the name of the category labels. False if the first row or column contains the first data point of the series.

extend

void extend(IRange source,
            RowCol rowcol,
            boolean categoryLabels)

Adds new data points to an existing series collection.

Parameters:

source - The new data to be added to the ISeriesCollection object

rowcol - Specifies whether the new values are in the rows or columns of the given range source. Can be one of the RowCol constants: Rows or Columns.

categoryLabels - True to have the first row or column contain the name of the category labels. False to have the first row or column contain the first data point of the series.

get

ISeries get(int index)

Returns a single object from a collection.

Parameters:

index - The index number for the object.

get

ISeries get(java.lang.String name)

Returns a single object from a collection.

Parameters:

name - The name for the object.

newSeries

ISeries newSeries()

Creates a new series.

Returns:

Returns the ISeries object that represents the new series.