ChartCollection
Source: aspose.
Encapsulates a collection of Chart objects.
Methods
Methods
add(type, upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) → Number
Adds a chart to the collection.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
type |
Number |
|
ChartType |
|
upperLeftRow |
Number |
|
Upper left row index. |
|
upperLeftColumn |
Number |
|
Upper left column index. |
|
lowerRightRow |
Number |
|
Lower right row index |
|
lowerRightColumn |
Number |
|
Lower right column index |
- Returns
-
NumberChart object index.
add(type, dataRange, upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn) → Number
Adds a chart to the collection.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
type |
Number |
|
ChartType |
|
dataRange |
String |
|
Specifies the data range of the chart |
|
upperLeftRow |
Number |
|
Upper left row index. |
|
upperLeftColumn |
Number |
|
Upper left column index. |
|
lowerRightRow |
Number |
|
Lower right row index |
|
lowerRightColumn |
Number |
|
Lower right column index |
- Returns
-
NumberChart object index.
add()
Reserved for internal use.
addFloatingChart(type, left, top, width, height) → Number
Adds a chart to the collection.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
type |
Number |
|
ChartType |
|
left |
Number |
|
The x offset to corner |
|
top |
Number |
|
The y offset to corner |
|
width |
Number |
|
The chart width |
|
height |
Number |
|
The chart height |
- Returns
-
NumberChart object index.
clear()
Clear all charts.
contains()
Reserved for internal use.
get(index) → Chart
Gets the Chart element at the specified index.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
index |
Number |
|
The zero based index of the element. |
- Returns
-
ChartThe element at the specified index.
get(name) → Chart
Gets the chart by the name. The default chart name is null. So you have to explicitly set the name of the chart.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The chart name. |
- Returns
-
ChartThe chart.
get()
Reserved for internal use.
getCount()
indexOf()
Reserved for internal use.
iterator()
remove(chart)
Remove the specific chart.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
chart |
|
removeAt(index)
Remove a chart at the specific index.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
index |
Number |
|
The chart index. |