ChartCollection
Contents
[
Hide
]ChartCollection class
Encapsulates a collection of Chart objects.
class ChartCollection;
Methods
| Method | Description |
|---|---|
| get(number) | Gets the Chart element at the specified index. |
| addFloatingChart(ChartType, number, number, number, number) | Adds a chart to the collection. |
| add(ChartType, number, number, number, number) | Adds a chart to the collection. |
| add(number[], string, boolean, number, number, number, number) | Adds a chart with preset template. |
| add(ChartType, string, boolean, number, number, number, number) | Adds a chart to the collection. |
| removeAt(number) | Remove a chart at the specific index. |
| clear() | Clear all charts. |
| getCount() | Gets the number of elements contained in. |
get(number)
Gets the Chart element at the specified index.
get(index: number) : Chart;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index of the element. |
Returns
The element at the specified index.
addFloatingChart(ChartType, number, number, number, number)
Adds a chart to the collection.
addFloatingChart(type: ChartType, left: number, top: number, width: number, height: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | ChartType | Chart type |
| 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
Chart object index.
add(ChartType, number, number, number, number)
Adds a chart to the collection.
add(type: ChartType, upperLeftRow: number, upperLeftColumn: number, lowerRightRow: number, lowerRightColumn: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | ChartType | Chart type |
| 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
Chart object index.
add(number[], string, boolean, number, number, number, number)
Adds a chart with preset template.
add(data: number[], dataRange: string, isVertical: boolean, topRow: number, leftColumn: number, rightRow: number, bottomColumn: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| data | number[] | 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
Chart object index.
add(ChartType, string, boolean, number, number, number, number)
Adds a chart to the collection.
add(type: ChartType, dataRange: string, isVertical: boolean, topRow: number, leftColumn: number, rightRow: number, bottomColumn: number) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| type | ChartType | Chart type |
| 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
Chart object index.
removeAt(number)
Remove a chart at the specific index.
removeAt(index: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The chart index. |
clear()
Clear all charts.
clear() : void;
getCount()
Gets the number of elements contained in.
getCount() : number;