ChartCollection
Source: aspose.
Encapsulates a collection of Chart objects.
Methods
- add(type, upperLeftRow, upperLeftColumn, lowerRightRow, lowerRightColumn)
- add(type, dataRange, topRow, leftColumn, rightRow, bottomColumn)
- add(data, dataRange, isVertical, topRow, leftColumn, rightRow, bottomColumn)
- add(type, dataRange, isVertical, topRow, leftColumn, rightRow, bottomColumn)
- add()
- addFloatingChart(type, left, top, width, height)
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, topRow, leftColumn, rightRow, bottomColumn) → Number
Adds a chart to the collection. NOTE: This member is now obsolete. Instead, please use add(int, java.lang.String, boolean, int, int, int, int) property. This property will be removed 12 months later since May 2022. Aspose apologizes for any inconvenience you may have experienced.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
type |
Number |
|
ChartType |
|
dataRange |
String |
|
Specifies the data range of the chart |
|
topRow |
Number |
|
Upper left row index. |
|
leftColumn |
Number |
|
Upper left column index. |
|
rightRow |
Number |
|
Lower right row index |
|
bottomColumn |
Number |
|
Lower right column index |
- Returns
-
NumberChart object index.
add(data, dataRange, isVertical, topRow, leftColumn, rightRow, bottomColumn) → Number
Adds a chart with preset template.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
data |
Array of byte |
|
The data of chart template file(.crtx). |
|
dataRange |
String |
|
Specifies the data range of the chart |
|
isVertical |
boolean |
|
Specifies whether to plot the series from a range of cell values by row or by column. |
|
topRow |
Number |
|
Upper left row index. |
|
leftColumn |
Number |
|
Upper left column index. |
|
rightRow |
Number |
|
Lower right row index |
|
bottomColumn |
Number |
|
Lower right column index |
- Returns
-
NumberChart object index.
add(type, dataRange, isVertical, topRow, leftColumn, rightRow, bottomColumn) → Number
Adds a chart to the collection.
Parameters
| Name | Type | Optional | Description |
|---|---|---|---|
|
type |
Number |
|
ChartType |
|
dataRange |
String |
|
Specifies the data range of the chart |
|
isVertical |
boolean |
|
Specifies whether to plot the series from a range of cell values by row or by column. |
|
topRow |
Number |
|
Upper left row index. |
|
leftColumn |
Number |
|
Upper left column index. |
|
rightRow |
Number |
|
Lower right row index |
|
bottomColumn |
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. |