ChartSeriesCollection Object (JavaScript API for Excel)

Represents a collection of chart series.

Properties

Property Type Description Req. Set
count int Returns the number of series in the collection. Read-only. 1.1
items ChartSeries[] A collection of chartSeries objects. Read-only. 1.1

See property access examples.

Relationships

None

Methods

Method Return Type Description Req. Set
getCount() int Returns the number of series in the collection. 1.4
getItemAt(index: number) ChartSeries Retrieves a series based on its position in the collection 1.1

Method Details

getCount()

Returns the number of series in the collection.

Syntax

chartSeriesCollectionObject.getCount();

Parameters

None

Returns

int

getItemAt(index: number)

Retrieves a series based on its position in the collection

Syntax

chartSeriesCollectionObject.getItemAt(index);

Parameters

Parameter Type Description  
index number Index value of the object to be retrieved. Zero-indexed.  

Returns

ChartSeries

Examples

Get the name of the first series in the series collection.

Excel.run(function (ctx) { 
    var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('items');
    return ctx.sync().then(function() {
        console.log(seriesCollection.items[0].name);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Property access examples

Getting the names of series in the series collection.

Excel.run(function (ctx) { 
    var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('items');
    return ctx.sync().then(function() {
        for (var i = 0; i < seriesCollection.items.length; i++)
        {
            console.log(seriesCollection.items[i].name);
        }
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Get the number of chart series in collection.

Excel.run(function (ctx) { 
    var seriesCollection = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1").series;
    seriesCollection.load('count');
    return ctx.sync().then(function() {
        console.log("series: Count= " + seriesCollection.count);
    });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});
orksheets.getItem("Sheet1").charts.getItem("Chart1").series; seriesCollection.load('count'); return ctx.sync().then(function() { console.log("series: Count= " + seriesCollection.count); }); }).catch(function(error) { console.log("Error: " + error); if (error instanceof OfficeExtension.Error) { console.log("Debug info: " + JSON.stringify(error.debugInfo)); } });