All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aspose.cells.SeriesCollection.html Maven / Gradle / Ivy

There is a newer version: 23.1
Show newest version





SeriesCollection




com.aspose.cells
Class SeriesCollection

java.lang.Object
  extended by CollectionBase
      extended by 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("C:\\book1.xls");


Property Getters/Setters Summary
java.lang.StringgetCategoryData()
voidsetCategoryData(java.lang.String)
           Gets or 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}").
intgetCount()→ inherited from com.aspose.cells.CollectionBase
          
booleanisColorVaried()
voidsetColorVaried(boolean)
           Represents if the color of points is varied.
java.lang.StringgetSecondCategoryData()
voidsetSecondCategoryData(java.lang.String)
           Gets or 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.
Seriesget(int)
           Gets the Series element at the specified index.
 
Method Summary
intadd(java.lang.Object value)→ inherited from com.aspose.cells.CollectionBase
          Reserved for internal use.
intadd(java.lang.String area, boolean isVertical)
           Adds the SeriesCollection collection to a chart.
intadd(java.lang.String area, boolean isVertical, boolean checkLabels)
           Adds the SeriesCollection collection to a chart.
intaddR1C1(java.lang.String area, boolean isVertical)
           Adds the SeriesCollection collection to a chart.
voidchangeSeriesOrder(int sourceIndex, int destIndex)
           Directly changes the orders of the two series.
voidclear()
           Clears the collection
booleancontains(java.lang.Object value)→ inherited from com.aspose.cells.CollectionBase
          Reserved for internal use.
SeriesgetSeriesByOrder(int order)
           Gets the Series element by order.
intindexOf(java.lang.Object value)→ inherited from com.aspose.cells.CollectionBase
          Reserved for internal use.
java.util.Iteratoriterator()→ inherited from com.aspose.cells.CollectionBase
          
voidremoveAt(int index)
           Remove at a series at the specific index.
voidsetSeriesNames(int startIndex, java.lang.String area, boolean isVertical)
           Sets the name of all the serieses in the chart.
 

Property Getters/Setters Detail

getCategoryData/setCategoryData

public java.lang.String getCategoryData() / public void setCategoryData(java.lang.String value)
Gets or 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}").

setCategoryData

public void setCategoryData(java.lang.String value)
Gets or 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/setSecondCategoryData

public java.lang.String getSecondCategoryData() / public void setSecondCategoryData(java.lang.String value)
Gets or 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.

setSecondCategoryData

public void setSecondCategoryData(java.lang.String value)
Gets or 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.

isColorVaried/setColorVaried

public boolean isColorVaried() / public void setColorVaried(boolean value)
Represents if the color of points is varied.

setColorVaried

public void setColorVaried(boolean value)
Represents if the color of points is varied.

getCount

→ inherited from com.aspose.cells.CollectionBase
public int getCount()

get

public Series get(int index)
Gets the Series element at the specified index.
Parameters:
index - The zero based index of the element.
Returns:
The element at the specified index.

Method Detail

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.
Parameters:
index - The index.

changeSeriesOrder

public void changeSeriesOrder(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.
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 SeriesCollection collection to a chart.
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 SeriesCollection collection to a chart.
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 SeriesCollection collection to a chart.
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.

clear

public void clear()
Clears the collection

iterator

→ inherited from com.aspose.cells.CollectionBase
public java.util.Iterator iterator()

contains

→ inherited from com.aspose.cells.CollectionBase
public boolean contains(java.lang.Object value)
Reserved for internal use.

add

→ inherited from com.aspose.cells.CollectionBase
public int add(java.lang.Object value)
Reserved for internal use.

indexOf

→ inherited from com.aspose.cells.CollectionBase
public int indexOf(java.lang.Object value)
Reserved for internal use.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy