ChartPointsCollection Object (JavaScript API for Excel)
A collection of all the chart points within a series inside a chart.
Properties
| Property | Type | Description | Req. Set |
|---|---|---|---|
| count | int | Returns the number of chart points in the series. Read-only. | 1.1 |
| items | ChartPoint[] | A collection of chartPoints objects. Read-only. | 1.1 |
See property access examples.
Relationships
None
Methods
| Method | Return Type | Description | Req. Set |
|---|---|---|---|
| getCount() | int | Returns the number of chart points in the series. | 1.4 |
| getItemAt(index: number) | ChartPoint | Retrieve a point based on its position within the series. | 1.1 |
Method Details
getCount()
Returns the number of chart points in the series.
Syntax
chartPointsCollectionObject.getCount();
Parameters
None
Returns
int
getItemAt(index: number)
Retrieve a point based on its position within the series.
Syntax
chartPointsCollectionObject.getItemAt(index);
Parameters
| Parameter | Type | Description |
|---|---|---|
| index | number | Index value of the object to be retrieved. Zero-indexed. |
Returns
Examples
Set the border color for the first points in the points collection
Excel.run(function (ctx) {
var points = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points;
points.getItemAt(0).format.fill.setSolidColor("8FBC8F");
return ctx.sync().then(function() {
console.log("Point Border Color Changed");
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
```### Property access examples
Get the names of points in the points collection
```js
Excel.run(function (ctx) {
var pointsCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points;
pointsCollection.load('items');
return ctx.sync().then(function() {
console.log("Points Collection loaded");
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});
Get the number of points
Excel.run(function (ctx) {
var pointsCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series.getItemAt(0).points;
pointsCollection.load('count');
return ctx.sync().then(function() {
console.log("points: Count= " + pointsCollection.count);
});
}).catch(function(error) {
console.log("Error: " + error);
if (error instanceof OfficeExtension.Error) {
console.log("Debug info: " + JSON.stringify(error.debugInfo));
}
});