asposecells.api

Classes

Constants

Class SeriesCollection

Encapsulates a collection of Series objects.

Example:

# Instantiating a Workbook object
workbook = Workbook()
# Adding a new worksheet to the Excel object
sheetIndex = workbook.getWorksheets().add()
# Obtaining the reference of the newly added worksheet by passing its sheet index
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
chartIndex = worksheet.getCharts().add(ChartType.COLUMN, 5, 0, 15, 5)
# Accessing the instance of the newly added 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")

Property Getters/Setters Summary
`method`	`getCategoryData()`
`method`	`setCategoryData(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}").
`method`	`getCount()`

`method`	`isColorVaried()`
`method`	`setColorVaried(value)`
	Represents if the color of points is varied.
`method`	`getSecondCategoryData()`
`method`	`setSecondCategoryData(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.
`method`	`get(index)`
	Gets the Series element at the specified index.

Method Summary
`method`	`add(value)`
`method`	Reserved for internal use.
`method`	`add(area, isVertical)`
`method`	Adds the SeriesCollection collection to a chart.
`method`	`add(area, isVertical, checkLabels)`
`method`	Adds the SeriesCollection collection to a chart.
`method`	`addR1C1(area, isVertical)`
`method`	Adds the SeriesCollection collection to a chart.
`method`	`changeSeriesOrder(sourceIndex, destIndex)`
`method`	Directly changes the orders of the two series.
`method`	`clear()`
`method`	Clears the collection
`method`	`contains(value)`
`method`	Reserved for internal use.
`method`	`get(index)`
`method`	Reserved for internal use.
`method`	`getSeriesByOrder(order)`
`method`	Gets the Series element by order.
`method`	`indexOf(value)`
`method`	Reserved for internal use.
`method`	`iterator()`
`method`
`method`	`removeAt(index)`
`method`	Remove at a series at the specific index.
`method`	`setSeriesNames(startIndex, area, isVertical)`
`method`	Sets the name of all the serieses in the chart.

- Property Getters/Setters Detail
  - getCategoryData/setCategoryData : String
```
String getCategoryData() / setCategoryData(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 : String
```
String getSecondCategoryData() / setSecondCategoryData(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 : boolean
```
boolean isColorVaried() / setColorVaried(value)
```
    Represents if the color of points is varied.
  - getCount : int
```
int getCount()
```
  - get : Series
```
Series get(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
```
Series getSeriesByOrder(order)
```
    Gets the Series element by order.
    Parameters:
    order: int - The order of series
    Returns:
    The element series
  - removeAt
```
 removeAt(index)
```
    Remove at a series at the specific index.
    Parameters:
    index: int - The index.
  - changeSeriesOrder
```
 changeSeriesOrder(sourceIndex, destIndex)
```
    Directly changes the orders of the two series.
    Parameters:
    sourceIndex: int - The current index
    destIndex: int - The dest index
  - setSeriesNames
```
 setSeriesNames(startIndex, area, 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: int - The index of the first series which you want to set the name.
    area: String - Specifies the area for the series name.
    isVertical: boolean - >Specifies whether to plot the series from a range of cell values by row or by column.
  - addR1C1
```
int addR1C1(area, 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: String - Specifies values from which to plot the data series
    isVertical: boolean - 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
```
int add(area, 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: String - Specifies values from which to plot the data series
    isVertical: boolean - 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
```
int add(area, isVertical, 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: String - Specifies values from which to plot the data series
    isVertical: boolean - Specifies whether to plot the series from a range of cell values by row or by column.
    checkLabels: boolean - Indicates whether the range contains series's name
    Returns:
    Return the first index of the added ASeries in the NSeries.
  - clear
```
 clear()
```
    Clears the collection
  - iterator
```
Iterator iterator()
```
  - get
```
Object get(index)
```
    Reserved for internal use.
  - contains
```
boolean contains(value)
```
    Reserved for internal use.
  - add
```
int add(value)
```
    Reserved for internal use.
  - indexOf
```
int indexOf(value)
```
    Reserved for internal use.

asposecells.api

Classes

Constants

Class SeriesCollection

Property Getters/Setters Detail

getCategoryData/setCategoryData : String

getSecondCategoryData/setSecondCategoryData : String

isColorVaried/setColorVaried : boolean

getCount : int

get : Series

Method Detail

getSeriesByOrder

removeAt

changeSeriesOrder

setSeriesNames

addR1C1

add

add

clear

iterator

get

contains

add

indexOf