Excel.ChartSeries class

Represents a series in a chart.

[ API set: ExcelApi 1.1 ]

Extends

Properties

axisGroup

Returns or sets the group for the specified series. Read/Write

[ API set: ExcelApi 1.8 ]

chartType

Represents the chart type of a series. See Excel.ChartType for details.

[ API set: ExcelApi 1.7 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

dataLabels

Represents a collection of all dataLabels in the series.

[ API set: ExcelApi 1.8 ]

doughnutHoleSize

Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnutExploded charts. Throws an invalid argument exception on invalid charts.

[ API set: ExcelApi 1.7 ]

explosion

Returns or sets the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie). Read/Write.

[ API set: ExcelApi 1.8 ]

filtered

Boolean value representing if the series is filtered or not. Not applicable for surface charts.

[ API set: ExcelApi 1.7 ]

firstSliceAngle

Returns or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360. Read/Write

[ API set: ExcelApi 1.8 ]

format

Represents the formatting of a chart series, which includes fill and line formatting. Read-only.

[ API set: ExcelApi 1.1 ]

gapWidth

Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of line and pie charts. Throws an invalid argument exception on invalid charts.

[ API set: ExcelApi 1.7 ]

hasDataLabels

Boolean value representing if the series has data labels or not.

[ API set: ExcelApi 1.7 ]

invertIfNegative

True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number. Read/Write.

[ API set: ExcelApi 1.8 ]

markerBackgroundColor

Represents markers background color of a chart series.

[ API set: ExcelApi 1.7 ]

markerForegroundColor

Represents markers foreground color of a chart series.

[ API set: ExcelApi 1.7 ]

markerSize

Represents marker size of a chart series.

[ API set: ExcelApi 1.7 ]

markerStyle

Represents marker style of a chart series. See Excel.ChartMarkerStyle for details.

[ API set: ExcelApi 1.7 ]

name

Represents the name of a series in a chart.

[ API set: ExcelApi 1.1 ]

overlap

Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write.

[ API set: ExcelApi 1.8 ]

plotOrder

Represents the plot order of a chart series within the chart group.

[ API set: ExcelApi 1.7 ]

points

Represents a collection of all points in the series. Read-only.

[ API set: ExcelApi 1.1 ]

secondPlotSize

Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. Read/Write.

[ API set: ExcelApi 1.8 ]

showShadow

Boolean value representing if the series has a shadow or not.

[ API set: ExcelApi 1.7 ]

smooth

Boolean value representing if the series is smooth or not. Only applicable to line and scatter charts.

[ API set: ExcelApi 1.7 ]

splitType

Returns or sets the way the two sections of either a pie of pie chart or a bar of pie chart are split. Read/Write.

[ API set: ExcelApi 1.8 ]

trendlines

Represents a collection of trendlines in the series. Read-only.

[ API set: ExcelApi 1.7 ]

varyByCategories

True if Microsoft Excel assigns a different color or pattern to each data marker. The chart must contain only one series. Read/Write.

[ API set: ExcelApi 1.8 ]

Methods

delete()

Deletes the chart series.

[ API set: ExcelApi 1.7 ]

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

setBubbleSizes(sourceData)

Set bubble sizes for a chart series. Only works for bubble charts.

[ API set: ExcelApi 1.7 ]

setValues(sourceData)

Set values for a chart series. For scatter chart, it means Y axis values.

[ API set: ExcelApi 1.7 ]

setXAxisValues(sourceData)

Set values of X axis for a chart series. Only works for scatter charts.

[ API set: ExcelApi 1.7 ]

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartSeries object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartSeriesData) that contains shallow copies of any loaded child properties from the original object.

Property Details

axisGroup

Returns or sets the group for the specified series. Read/Write

[ API set: ExcelApi 1.8 ]

axisGroup: Excel.ChartAxisGroup | "Primary" | "Secondary";

Property Value

Excel.ChartAxisGroup | "Primary" | "Secondary"

chartType

Represents the chart type of a series. See Excel.ChartType for details.

[ API set: ExcelApi 1.7 ]

chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";

Property Value

Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel"

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

RequestContext

dataLabels

Represents a collection of all dataLabels in the series.

[ API set: ExcelApi 1.8 ]

readonly dataLabels: Excel.ChartDataLabels;

Property Value

doughnutHoleSize

Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnutExploded charts. Throws an invalid argument exception on invalid charts.

[ API set: ExcelApi 1.7 ]

doughnutHoleSize: number;

Property Value

number

explosion

Returns or sets the explosion value for a pie-chart or doughnut-chart slice. Returns 0 (zero) if there's no explosion (the tip of the slice is in the center of the pie). Read/Write.

[ API set: ExcelApi 1.8 ]

explosion: number;

Property Value

number

filtered

Boolean value representing if the series is filtered or not. Not applicable for surface charts.

[ API set: ExcelApi 1.7 ]

filtered: boolean;

Property Value

boolean

firstSliceAngle

Returns or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts. Can be a value from 0 through 360. Read/Write

[ API set: ExcelApi 1.8 ]

firstSliceAngle: number;

Property Value

number

format

Represents the formatting of a chart series, which includes fill and line formatting. Read-only.

[ API set: ExcelApi 1.1 ]

readonly format: Excel.ChartSeriesFormat;

Property Value

gapWidth

Represents the gap width of a chart series. Only valid on bar and column charts, as well as specific classes of line and pie charts. Throws an invalid argument exception on invalid charts.

[ API set: ExcelApi 1.7 ]

gapWidth: number;

Property Value

number

hasDataLabels

Boolean value representing if the series has data labels or not.

[ API set: ExcelApi 1.7 ]

hasDataLabels: boolean;

Property Value

boolean

invertIfNegative

True if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number. Read/Write.

[ API set: ExcelApi 1.8 ]

invertIfNegative: boolean;

Property Value

boolean

markerBackgroundColor

Represents markers background color of a chart series.

[ API set: ExcelApi 1.7 ]

markerBackgroundColor: string;

Property Value

string

Examples

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 

    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerForegroundColor

Represents markers foreground color of a chart series.

[ API set: ExcelApi 1.7 ]

markerForegroundColor: string;

Property Value

string

Examples

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 

    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerSize

Represents marker size of a chart series.

[ API set: ExcelApi 1.7 ]

markerSize: number;

Property Value

number

Examples

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 

    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

markerStyle

Represents marker style of a chart series. See Excel.ChartMarkerStyle for details.

[ API set: ExcelApi 1.7 ]

markerStyle: Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture";

Property Value

Excel.ChartMarkerStyle | "Invalid" | "Automatic" | "None" | "Square" | "Diamond" | "Triangle" | "X" | "Star" | "Dot" | "Dash" | "Circle" | "Plus" | "Picture"

Examples

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let salesTable = sheet.tables.getItem("SalesTable");
    let dataRange = sheet.getRange("A1:E7");

    // Create an XY scatter chart.
    let chart = sheet.charts.add("XYScatterSmooth", dataRange, "Auto");
    chart.title.text = "Bicycle Parts Quarterly Sales"; 

    let series = chart.series;
    let series0 = series.getItemAt(0);
    let series1 = series.getItemAt(1);
    let series2 = series.getItemAt(2);
    let series3 = series.getItemAt(3);

    // Set markers.
    series0.markerStyle = "Dash";
    series0.markerForegroundColor = "black";
    series1.markerStyle = "Star";
    series1.markerForegroundColor = "black";
    series2.markerStyle = "X";
    series2.markerSize = 12;
    series3.markerStyle = "Triangle";
    series3.markerBackgroundColor = "purple";

    await context.sync();
});

name

Represents the name of a series in a chart.

[ API set: ExcelApi 1.1 ]

name: string;

Property Value

string

overlap

Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write.

[ API set: ExcelApi 1.8 ]

overlap: number;

Property Value

number

plotOrder

Represents the plot order of a chart series within the chart group.

[ API set: ExcelApi 1.7 ]

plotOrder: number;

Property Value

number

points

Represents a collection of all points in the series. Read-only.

[ API set: ExcelApi 1.1 ]

readonly points: Excel.ChartPointsCollection;

Property Value

secondPlotSize

Returns or sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. Can be a value from 5 to 200. Read/Write.

[ API set: ExcelApi 1.8 ]

secondPlotSize: number;

Property Value

number

showShadow

Boolean value representing if the series has a shadow or not.

[ API set: ExcelApi 1.7 ]

showShadow: boolean;

Property Value

boolean

smooth

Boolean value representing if the series is smooth or not. Only applicable to line and scatter charts.

[ API set: ExcelApi 1.7 ]

smooth: boolean;

Property Value

boolean

splitType

Returns or sets the way the two sections of either a pie of pie chart or a bar of pie chart are split. Read/Write.

[ API set: ExcelApi 1.8 ]

splitType: Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit";

Property Value

Excel.ChartSplitType | "SplitByPosition" | "SplitByValue" | "SplitByPercentValue" | "SplitByCustomSplit"

trendlines

Represents a collection of trendlines in the series. Read-only.

[ API set: ExcelApi 1.7 ]

readonly trendlines: Excel.ChartTrendlineCollection;

Property Value

varyByCategories

True if Microsoft Excel assigns a different color or pattern to each data marker. The chart must contain only one series. Read/Write.

[ API set: ExcelApi 1.8 ]

varyByCategories: boolean;

Property Value

boolean

Method Details

delete()

Deletes the chart series.

[ API set: ExcelApi 1.7 ]

delete(): void;

Returns

void

Examples

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");
  const seriesCollection = sheet.charts.getItemAt(0).series;
  seriesCollection.load("count");
  await context.sync();

  if (seriesCollection.count > 0) {
    const series = seriesCollection.getItemAt(0);

    // Delete the first series.
    series.delete();
  }

  await context.sync();
});

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

load(option?: string | string[]): Excel.ChartSeries;

Parameters

option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Excel.ChartSeries - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.ChartSeries - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

Examples

// Rename the 1st series of Chart1 to "New Series Name"
Excel.run(function (ctx) { 
    var chart = ctx.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");    
    chart.series.getItemAt(0).name = "New Series Name";
    return ctx.sync().then(function() {
            console.log("Series1 Renamed");
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

setBubbleSizes(sourceData)

Set bubble sizes for a chart series. Only works for bubble charts.

[ API set: ExcelApi 1.7 ]

setBubbleSizes(sourceData: Range): void;

Parameters

sourceData
Range

The Range object corresponding to the source data.

Returns

void

setValues(sourceData)

Set values for a chart series. For scatter chart, it means Y axis values.

[ API set: ExcelApi 1.7 ]

setValues(sourceData: Range): void;

Parameters

sourceData
Range

The Range object corresponding to the source data.

Returns

void

Examples

await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sample");

  let seriesCollection = sheet.charts.getItemAt(0);
  let rangeSelection = sheet.getRange("C2:C7");
  let xRangeSelection = sheet.getRange("A1:A7");

  // Add a series.
  let newSeries = seriesCollection.series.add("Qtr2");
  newSeries.setValues(rangeSelection);
  newSeries.setXAxisValues(xRangeSelection);

  await context.sync();
});

setXAxisValues(sourceData)

Set values of X axis for a chart series. Only works for scatter charts.

[ API set: ExcelApi 1.7 ]

setXAxisValues(sourceData: Range): void;

Parameters

sourceData
Range

The Range object corresponding to the source data.

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ChartSeries object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ChartSeriesData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ChartSeriesData;

Returns