com.aspose.cells

Class SeriesCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.SeriesCollection

All Implemented Interfaces:

java.lang.Iterable

public class SeriesCollection
extends CollectionBase

Encapsulates a collection of Series objects.

Example

 
         //Instantiating a Workbook object
         Workbook workbook = new Workbook();
         //Adding a new worksheet to the Excel object
         int sheetIndex = workbook.getWorksheets().add();
         //Obtaining the reference of the newly added worksheet by passing its sheet index
         Worksheet worksheet = workbook.getWorksheets().get(sheetIndex);
         //Adding a sample value to "A1" cell
         worksheet.getCells().get("A1").putValue(50);
         //Adding a sample value to "A2" cell
         worksheet.getCells().get("A2").putValue(100);
         //Adding a sample value to "A3" cell
         worksheet.getCells().get("A3").putValue(150);
         //Adding a sample value to "A4" cell
         worksheet.getCells().get("A4").putValue(200);
         //Adding a sample value to "B1" cell
         worksheet.getCells().get("B1").putValue(60);
         //Adding a sample value to "B2" cell
         worksheet.getCells().get("B2").putValue(32);
         //Adding a sample value to "B3" cell
         worksheet.getCells().get("B3").putValue(50);
         //Adding a sample value to "B4" cell
         worksheet.getCells().get("B4").putValue(40);
         //Adding a sample value to "C1" cell as category data
         worksheet.getCells().get("C1").putValue("Q1");
         //Adding a sample value to "C2" cell as category data
         worksheet.getCells().get("C2").putValue("Q2");
         //Adding a sample value to "C3" cell as category data
         worksheet.getCells().get("C3").putValue("Y1");
         //Adding a sample value to "C4" cell as category data
         worksheet.getCells().get("C4").putValue("Y2");
         //Adding a chart to the worksheet
         int chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5);
         //Accessing the instance of the newly added chart
         Chart chart = worksheet.getCharts().get(chartIndex);
         //Adding NSeries (chart data source) to the chart ranging from "A1" cell to "B4"
         chart.getNSeries().add("A1:B4", true);
         //Setting the data source for the category data of NSeries
         chart.getNSeries().setCategoryData("C1:C4");
         //Saving the Excel file
         workbook.save("book1.xls");
 

Method Summary

Methods

Modifier and Type	Method and Description
int	add(java.lang.String area, boolean isVertical) Adds the Series collection to a chart.
int	add(java.lang.String area, boolean isVertical, boolean checkLabels) Adds the Series collection to a chart.
int	addR1C1(java.lang.String area, boolean isVertical) Adds the Series collection to a chart.
void	changeColors(int type) Set Monochromatic Palette for chart series.
void	changeSeriesOrder(int sourceIndex, int destIndex) Deprecated. Use SeriesCollection.SwapSeries property, instead.
void	clear() Clears the collection
Series	get(int index) Gets the Series element at the specified index.
java.lang.String	getCategoryData() Gets the range of category Axis values.
java.lang.String	getSecondCategoryData() Gets the range of second category Axis values.
Series	getSeriesByOrder(int order) Gets the Series element by order.
boolean	isColorVaried() Represents if the color of points is varied.
void	removeAt(int index) Remove at a series at the specific index.
void	setCategoryData(java.lang.String value) Sets the range of category Axis values.
void	setColorVaried(boolean value) Represents if the color of points is varied.
void	setSecondCategoryData(java.lang.String value) Sets the range of second category Axis values.
void	setSeriesNames(int startIndex, java.lang.String area, boolean isVertical) Sets the name of all the serieses in the chart.
void	swapSeries(int sourceIndex, int destIndex) Directly changes the orders of the two series.

Methods inherited from class com.aspose.cells.CollectionBase

add, contains, getCount, indexOf, iterator

Methods inherited from class java.lang.Object

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

Method Detail

get

public Series get(int index)

Gets the Series 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.

getSeriesByOrder

public Series getSeriesByOrder(int order)

Gets the Series element by order.

Parameters:

order - The order of series

Returns:

The element series

removeAt

public void removeAt(int index)

Remove at a series at the specific index.

Overrides:

removeAt in class CollectionBase

Parameters:

index - The index.

getCategoryData

public java.lang.String getCategoryData()

Gets the range of category Axis values. It can be a range of cells (such as, "d1:e10"), or a sequence of values (such as,"{2,6,8,10}").

setCategoryData

public void setCategoryData(java.lang.String value)

Sets the range of category Axis values. It can be a range of cells (such as, "d1:e10"), or a sequence of values (such as,"{2,6,8,10}").

getSecondCategoryData

public java.lang.String getSecondCategoryData()

Gets the range of second category Axis values. It can be a range of cells (such as, "d1:e10"), or a sequence of values (such as,"{2,6,8,10}"). Only effects when some ASerieses plot on the second axis.

setSecondCategoryData

public void setSecondCategoryData(java.lang.String value)

Sets the range of second category Axis values. It can be a range of cells (such as, "d1:e10"), or a sequence of values (such as,"{2,6,8,10}"). Only effects when some ASerieses plot on the second axis.

changeSeriesOrder

public void changeSeriesOrder(int sourceIndex,
                     int destIndex)

Deprecated. Use SeriesCollection.SwapSeries property, instead.

Directly changes the orders of the two series.

Remarks

NOTE: This method is now obsolete. Instead, please use SeriesCollection.SwapSeries method. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

sourceIndex - The current index

destIndex - The dest index

swapSeries

public void swapSeries(int sourceIndex,
              int destIndex)

Directly changes the orders of the two series.

Parameters:

sourceIndex - The current index

destIndex - The dest index

setSeriesNames

public void setSeriesNames(int startIndex,
                  java.lang.String area,
                  boolean isVertical)

Sets the name of all the serieses in the chart.

Remarks

If the start index is larger than the count of the serieses, it will return and do nothing.

If set data on contiguous cells, use colon to seperate them.For example, $C$2:$C$5.

If set data on contiguous cells, use comma to seperate them.For example, ($C$2,$D$5).

Parameters:

startIndex - The index of the first series which you want to set the name.

area - Specifies the area for the series name.

isVertical - >Specifies whether to plot the series from a range of cell values by row or by column.

addR1C1

public int addR1C1(java.lang.String area,
          boolean isVertical)

Adds the Series collection to a chart.

Remarks

If set data on contiguous cells, use colon to seperate them.For example, R[1]C[1]:R[3]C[2].

If set data on contiguous cells, use comma to seperate them.For example,(R[1]C[1],R[3]C[2]).

Parameters:

area - Specifies values from which to plot the data series

isVertical - Specifies whether to plot the series from a range of cell values by row or by column.

Returns:

Return the first index of the added ASeries in the NSeries.

add

public int add(java.lang.String area,
      boolean isVertical)

Adds the Series collection to a chart.

Remarks

If set data on contiguous cells, use colon to seperate them.For example, $C$2:$C$5.

If set data on non contiguous cells, use comma to seperate them.For example: ($C$2,$D$5).

Parameters:

area - Specifies values from which to plot the data series

isVertical - Specifies whether to plot the series from a range of cell values by row or by column.

Returns:

Return the first index of the added ASeries in the NSeries.

add

public int add(java.lang.String area,
      boolean isVertical,
      boolean checkLabels)

Adds the Series collection to a chart.

Remarks

If set data on contiguous cells, use colon to seperate them.For example, $C$2:$C$5.

If set data on non contiguous cells, use comma to seperate them.For example, ($C$2,$D$5).

Parameters:

area - Specifies values from which to plot the data series

isVertical - Specifies whether to plot the series from a range of cell values by row or by column.

checkLabels - Indicates whether the range contains series's name

Returns:

Return the first index of the added ASeries in the NSeries.

isColorVaried

public boolean isColorVaried()

Represents if the color of points is varied.

setColorVaried

public void setColorVaried(boolean value)

Represents if the color of points is varied.

clear

public void clear()

Clears the collection

Overrides:

clear in class CollectionBase

changeColors

public void changeColors(int type)

Set Monochromatic Palette for chart series.

Parameters:

type - ChartColorPaletteType. The Monochromatic Type.