diff --git a/docs/docs-ref-autogen/excelscript/excelscript.chartseries.yml b/docs/docs-ref-autogen/excelscript/excelscript.chartseries.yml
index afd07f61..9b2f223b 100644
--- a/docs/docs-ref-autogen/excelscript/excelscript.chartseries.yml
+++ b/docs/docs-ref-autogen/excelscript/excelscript.chartseries.yml
@@ -1,1897 +1,1897 @@
### YamlMime:TSType
-name: ExcelScript.ChartSeries
-uid: ExcelScript!ExcelScript.ChartSeries:interface
-package: ExcelScript!
-fullName: ExcelScript.ChartSeries
-summary: Represents a series in a chart.
-remarks: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample produces a line chart with two series.
- * The chart assumes data in A1:E5 that looks like this:
- * Product Qtr1 Qtr2 Qtr3 Qtr4
- * Frames 5000 7000 6544 4377
- * Saddles 400 323 276 651
- */
- function main(workbook: ExcelScript.Workbook) {
- // Establish the ranges to use.
- const sheet = workbook.getActiveWorksheet();
- const headerRange = sheet.getRange("A1:E1");
- const firstSeriesRange = sheet.getRange("A2:E2");
- const secondSeriesRange = sheet.getRange("A3:E3");
-
- // Create the chart.
- const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);
-
- // Add the first chart series.
- const firstSeries = lineChart.addChartSeries();
- firstSeries.setXAxisValues(headerRange);
- firstSeries.setValues(firstSeriesRange);
-
- // Add the second chart series.
- const secondSeries = lineChart.addChartSeries();
- secondSeries.setXAxisValues(headerRange);
- secondSeries.setValues(secondSeriesRange);
- }
- ```
-
-isPreview: false
-isDeprecated: false
-type: interface
-methods:
- - name: addChartTrendline(type)
- uid: ExcelScript!ExcelScript.ChartSeries#addChartTrendline:member(1)
- package: ExcelScript!
- fullName: addChartTrendline(type)
- summary: Adds a new trendline to trendline collection.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'addChartTrendline(type?: ChartTrendlineType): ChartTrendline;'
- parameters:
- - id: type
- description: >-
- Specifies the trendline type. The default value is "Linear". See
- `ExcelScript.ChartTrendline` for details.
- type:
- return:
- type:
- description: ''
- - name: delete()
- uid: ExcelScript!ExcelScript.ChartSeries#delete:member(1)
- package: ExcelScript!
- fullName: delete()
- summary: Deletes the chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'delete(): void;'
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample creates a bubble chart and manually adds each series.
- */
- function main(workbook: ExcelScript.Workbook) {
- const sheet = workbook.getActiveWorksheet();
-
- // Add sample data.
- const data = [
- ["Product", "Price ($)", "Quality Score", "Market Share"],
- ["Keyboards", 85, 88, 25],
- ["Mice", 120, 80, 20]
- ];
- const dataRange = sheet.getRange("A1:D3");
- dataRange.setValues(data);
-
- // Create bubble chart - start with headers to create empty chart.
- const chart = sheet.addChart(
- ExcelScript.ChartType.bubble,
- sheet.getRange("B1:D1")
- );
- chart.setPosition("A5");
- chart.getTitle().setText("Product Analysis");
-
- // Remove any default series that were created.
- while (chart.getSeries().length > 0) {
- chart.getSeries()[0].delete();
- }
-
- // Add each product as its own series.
- for (let i = 2; i <= 3; i++) {
- const productName = sheet.getRange(`A${i}`).getValue() as string;
- const newSeries = chart.addChartSeries(productName);
- newSeries.setXAxisValues(sheet.getRange(`B${i}:B${i}`));
- newSeries.setValues(sheet.getRange(`C${i}:C${i}`));
- newSeries.setBubbleSizes(sheet.getRange(`D${i}:D${i}`));
- }
- }
- ```
- - name: getAxisGroup()
- uid: ExcelScript!ExcelScript.ChartSeries#getAxisGroup:member(1)
- package: ExcelScript!
- fullName: getAxisGroup()
- summary: Specifies the group for the specified series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getAxisGroup(): ChartAxisGroup;'
- return:
- type:
- description: ''
- - name: getBinOptions()
- uid: ExcelScript!ExcelScript.ChartSeries#getBinOptions:member(1)
- package: ExcelScript!
- fullName: getBinOptions()
- summary: Encapsulates the bin options for histogram charts and pareto charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBinOptions(): ChartBinOptions;'
- return:
- type:
- description: ''
- - name: getBoxwhiskerOptions()
- uid: ExcelScript!ExcelScript.ChartSeries#getBoxwhiskerOptions:member(1)
- package: ExcelScript!
- fullName: getBoxwhiskerOptions()
- summary: Encapsulates the options for the box and whisker charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBoxwhiskerOptions(): ChartBoxwhiskerOptions;'
- return:
- type: >-
-
- description: ''
- - name: getBubbleScale()
- uid: ExcelScript!ExcelScript.ChartSeries#getBubbleScale:member(1)
- package: ExcelScript!
- fullName: getBubbleScale()
- summary: >-
- This can be an integer value from 0 (zero) to 300, representing the
- percentage of the default size. This property only applies to bubble
- charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getBubbleScale(): number;'
- return:
- type: number
- description: ''
- - name: getChartTrendline(index)
- uid: ExcelScript!ExcelScript.ChartSeries#getChartTrendline:member(1)
- package: ExcelScript!
- fullName: getChartTrendline(index)
- summary: >-
- Gets a trendline object by index, which is the insertion order in the
- items array.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getChartTrendline(index: number): ChartTrendline;'
- parameters:
- - id: index
- description: Represents the insertion order in the items array.
- type: number
- return:
- type:
- description: ''
- - name: getChartType()
- uid: ExcelScript!ExcelScript.ChartSeries#getChartType:member(1)
- package: ExcelScript!
- fullName: getChartType()
- summary: >-
- Represents the chart type of a series. See `ExcelScript.ChartType` for
- details.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getChartType(): ChartType;'
- return:
- type:
- description: ''
- - name: getDataLabels()
- uid: ExcelScript!ExcelScript.ChartSeries#getDataLabels:member(1)
- package: ExcelScript!
- fullName: getDataLabels()
- summary: Represents a collection of all data labels in the series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDataLabels(): ChartDataLabels;'
- return:
- type:
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample accesses and configures data labels for a series.
- * This assumes the active worksheet has a chart.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first chart on the active worksheet.
- const sheet = workbook.getActiveWorksheet();
- const chart = sheet.getCharts()[0];
-
- // Configure data labels via series.
- const series = chart.getSeries()[0];
- const dataLabels = series.getDataLabels();
- dataLabels.setShowPercentage(true);
- dataLabels.setShowValue(false);
- }
- ```
- - name: getDimensionDataSourceString(dimension)
- uid: ExcelScript!ExcelScript.ChartSeries#getDimensionDataSourceString:member(1)
- package: ExcelScript!
- fullName: getDimensionDataSourceString(dimension)
- summary: >-
- Gets the string representation of the data source of the chart series. The
- string representation could be information such as a cell address.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDimensionDataSourceString(dimension: ChartSeriesDimension): string;'
- parameters:
- - id: dimension
- description: The dimension of the axis where the data is from.
- type:
- return:
- type: string
- description: ''
- - name: getDimensionDataSourceType(dimension)
- uid: ExcelScript!ExcelScript.ChartSeries#getDimensionDataSourceType:member(1)
- package: ExcelScript!
- fullName: getDimensionDataSourceType(dimension)
- summary: Gets the data source type of the chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- getDimensionDataSourceType(
- dimension: ChartSeriesDimension
- ): ChartDataSourceType;
- parameters:
- - id: dimension
- description: The dimension of the axis where the data is from.
- type:
- return:
- type:
- description: ''
- - name: getDimensionValues(dimension)
- uid: ExcelScript!ExcelScript.ChartSeries#getDimensionValues:member(1)
- package: ExcelScript!
- fullName: getDimensionValues(dimension)
- summary: >-
- Gets the values from a single dimension of the chart series. These could
- be either category values or data values, depending on the dimension
- specified and how the data is mapped for the chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDimensionValues(dimension: ChartSeriesDimension): string[];'
- parameters:
- - id: dimension
- description: The dimension of the axis where the data is from.
- type:
- return:
- type: string[]
- description: ''
- - name: getDoughnutHoleSize()
- uid: ExcelScript!ExcelScript.ChartSeries#getDoughnutHoleSize:member(1)
- package: ExcelScript!
- fullName: getDoughnutHoleSize()
- summary: >-
- Represents the doughnut hole size of a chart series. Only valid on
- doughnut and doughnut exploded charts. Throws an `InvalidArgument` error
- on invalid charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getDoughnutHoleSize(): number;'
- return:
- type: number
- description: ''
- - name: getExplosion()
- uid: ExcelScript!ExcelScript.ChartSeries#getExplosion:member(1)
- package: ExcelScript!
- fullName: getExplosion()
- summary: >-
- Specifies 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).
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getExplosion(): number;'
- return:
- type: number
- description: ''
- - name: getFiltered()
- uid: ExcelScript!ExcelScript.ChartSeries#getFiltered:member(1)
- package: ExcelScript!
- fullName: getFiltered()
- summary: Specifies if the series is filtered. Not applicable for surface charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFiltered(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getFirstSliceAngle()
- uid: ExcelScript!ExcelScript.ChartSeries#getFirstSliceAngle:member(1)
- package: ExcelScript!
- fullName: getFirstSliceAngle()
- summary: >-
- Specifies 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.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFirstSliceAngle(): number;'
- return:
- type: number
- description: ''
- - name: getFormat()
- uid: ExcelScript!ExcelScript.ChartSeries#getFormat:member(1)
- package: ExcelScript!
- fullName: getFormat()
- summary: >-
- Represents the formatting of a chart series, which includes fill and line
- formatting.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getFormat(): ChartSeriesFormat;'
- return:
- type:
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample gets the series format to customize appearance.
- * This assumes the active worksheet has a chart.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first chart on the active worksheet.
- const sheet = workbook.getActiveWorksheet();
- const chart = sheet.getCharts()[0];
-
- // Customize the series color.
- const series = chart.getSeries()[0];
- const format = series.getFormat();
- format.getFill().setSolidColor("#B0C4DE");
- }
- ```
- - name: getGapWidth()
- uid: ExcelScript!ExcelScript.ChartSeries#getGapWidth:member(1)
- package: ExcelScript!
- fullName: getGapWidth()
- summary: >-
- 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.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGapWidth(): number;'
- return:
- type: number
- description: ''
- - name: getGradientMaximumColor()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMaximumColor:member(1)
- package: ExcelScript!
- fullName: getGradientMaximumColor()
- summary: Specifies the color for maximum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMaximumColor(): string;'
- return:
- type: string
- description: ''
- - name: getGradientMaximumType()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMaximumType:member(1)
- package: ExcelScript!
- fullName: getGradientMaximumType()
- summary: Specifies the type for maximum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMaximumType(): ChartGradientStyleType;'
- return:
- type:
- description: ''
- - name: getGradientMaximumValue()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMaximumValue:member(1)
- package: ExcelScript!
- fullName: getGradientMaximumValue()
- summary: Specifies the maximum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMaximumValue(): number;'
- return:
- type: number
- description: ''
- - name: getGradientMidpointColor()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMidpointColor:member(1)
- package: ExcelScript!
- fullName: getGradientMidpointColor()
- summary: Specifies the color for the midpoint value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMidpointColor(): string;'
- return:
- type: string
- description: ''
- - name: getGradientMidpointType()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMidpointType:member(1)
- package: ExcelScript!
- fullName: getGradientMidpointType()
- summary: Specifies the type for the midpoint value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMidpointType(): ChartGradientStyleType;'
- return:
- type:
- description: ''
- - name: getGradientMidpointValue()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMidpointValue:member(1)
- package: ExcelScript!
- fullName: getGradientMidpointValue()
- summary: Specifies the midpoint value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMidpointValue(): number;'
- return:
- type: number
- description: ''
- - name: getGradientMinimumColor()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMinimumColor:member(1)
- package: ExcelScript!
- fullName: getGradientMinimumColor()
- summary: Specifies the color for the minimum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMinimumColor(): string;'
- return:
- type: string
- description: ''
- - name: getGradientMinimumType()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMinimumType:member(1)
- package: ExcelScript!
- fullName: getGradientMinimumType()
- summary: Specifies the type for the minimum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMinimumType(): ChartGradientStyleType;'
- return:
- type:
- description: ''
- - name: getGradientMinimumValue()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientMinimumValue:member(1)
- package: ExcelScript!
- fullName: getGradientMinimumValue()
- summary: Specifies the minimum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientMinimumValue(): number;'
- return:
- type: number
- description: ''
- - name: getGradientStyle()
- uid: ExcelScript!ExcelScript.ChartSeries#getGradientStyle:member(1)
- package: ExcelScript!
- fullName: getGradientStyle()
- summary: Specifies the series gradient style of a region map chart.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getGradientStyle(): ChartGradientStyle;'
- return:
- type:
- description: ''
- - name: getHasDataLabels()
- uid: ExcelScript!ExcelScript.ChartSeries#getHasDataLabels:member(1)
- package: ExcelScript!
- fullName: getHasDataLabels()
- summary: Specifies if the series has data labels.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getHasDataLabels(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getInvertColor()
- uid: ExcelScript!ExcelScript.ChartSeries#getInvertColor:member(1)
- package: ExcelScript!
- fullName: getInvertColor()
- summary: Specifies the fill color for negative data points in a series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInvertColor(): string;'
- return:
- type: string
- description: ''
- - name: getInvertIfNegative()
- uid: ExcelScript!ExcelScript.ChartSeries#getInvertIfNegative:member(1)
- package: ExcelScript!
- fullName: getInvertIfNegative()
- summary: >-
- True if Excel inverts the pattern in the item when it corresponds to a
- negative number.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getInvertIfNegative(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getMapOptions()
- uid: ExcelScript!ExcelScript.ChartSeries#getMapOptions:member(1)
- package: ExcelScript!
- fullName: getMapOptions()
- summary: Encapsulates the options for a region map chart.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMapOptions(): ChartMapOptions;'
- return:
- type:
- description: ''
- - name: getMarkerBackgroundColor()
- uid: ExcelScript!ExcelScript.ChartSeries#getMarkerBackgroundColor:member(1)
- package: ExcelScript!
- fullName: getMarkerBackgroundColor()
- summary: Specifies the marker background color of a chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerBackgroundColor(): string;'
- return:
- type: string
- description: ''
- - name: getMarkerForegroundColor()
- uid: ExcelScript!ExcelScript.ChartSeries#getMarkerForegroundColor:member(1)
- package: ExcelScript!
- fullName: getMarkerForegroundColor()
- summary: Specifies the marker foreground color of a chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerForegroundColor(): string;'
- return:
- type: string
- description: ''
- - name: getMarkerSize()
- uid: ExcelScript!ExcelScript.ChartSeries#getMarkerSize:member(1)
- package: ExcelScript!
- fullName: getMarkerSize()
- summary: >-
- Specifies the marker size of a chart series. The supported size range is 2
- to 72. This method returns an InvalidArgument error if it's set with a
- size outside of the supported range.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerSize(): number;'
- return:
- type: number
- description: ''
- - name: getMarkerStyle()
- uid: ExcelScript!ExcelScript.ChartSeries#getMarkerStyle:member(1)
- package: ExcelScript!
- fullName: getMarkerStyle()
- summary: >-
- Specifies the marker style of a chart series. See
- `ExcelScript.ChartMarkerStyle` for details.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getMarkerStyle(): ChartMarkerStyle;'
- return:
- type:
- description: ''
- - name: getName()
- uid: ExcelScript!ExcelScript.ChartSeries#getName:member(1)
- package: ExcelScript!
- fullName: getName()
- summary: >-
- Specifies the name of a series in a chart. The name's length should not be
- greater than 255 characters.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getName(): string;'
- return:
- type: string
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample logs the names of each of the chart series in a chart named "ColumnClusteredChart".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnClusteredChart".
- let chart = selectedSheet.getChart("ColumnClusteredChart");
-
- // Log the name of each chart series in the chart.
- let seriesList = chart.getSeries();
- seriesList.forEach((series) => {
- console.log(series.getName());
- });
- }
- ```
- - name: getOverlap()
- uid: ExcelScript!ExcelScript.ChartSeries#getOverlap:member(1)
- package: ExcelScript!
- fullName: getOverlap()
- summary: >-
- 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.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getOverlap(): number;'
- return:
- type: number
- description: ''
- - name: getParentLabelStrategy()
- uid: ExcelScript!ExcelScript.ChartSeries#getParentLabelStrategy:member(1)
- package: ExcelScript!
- fullName: getParentLabelStrategy()
- summary: Specifies the series parent label strategy area for a treemap chart.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getParentLabelStrategy(): ChartParentLabelStrategy;'
- return:
- type:
- description: ''
- - name: getPlotOrder()
- uid: ExcelScript!ExcelScript.ChartSeries#getPlotOrder:member(1)
- package: ExcelScript!
- fullName: getPlotOrder()
- summary: Specifies the plot order of a chart series within the chart group.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPlotOrder(): number;'
- return:
- type: number
- description: ''
- - name: getPoints()
- uid: ExcelScript!ExcelScript.ChartSeries#getPoints:member(1)
- package: ExcelScript!
- fullName: getPoints()
- summary: Returns a collection of all points in the series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getPoints(): ChartPoint[];'
- return:
- type: []
- description: ''
- - name: getSecondPlotSize()
- uid: ExcelScript!ExcelScript.ChartSeries#getSecondPlotSize:member(1)
- package: ExcelScript!
- fullName: getSecondPlotSize()
- summary: >-
- Specifies 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.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSecondPlotSize(): number;'
- return:
- type: number
- description: ''
- - name: getShowConnectorLines()
- uid: ExcelScript!ExcelScript.ChartSeries#getShowConnectorLines:member(1)
- package: ExcelScript!
- fullName: getShowConnectorLines()
- summary: Specifies whether connector lines are shown in waterfall charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowConnectorLines(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowLeaderLines()
- uid: ExcelScript!ExcelScript.ChartSeries#getShowLeaderLines:member(1)
- package: ExcelScript!
- fullName: getShowLeaderLines()
- summary: >-
- Specifies whether leader lines are displayed for each data label in the
- series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowLeaderLines(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getShowShadow()
- uid: ExcelScript!ExcelScript.ChartSeries#getShowShadow:member(1)
- package: ExcelScript!
- fullName: getShowShadow()
- summary: Specifies if the series has a shadow.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getShowShadow(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSmooth()
- uid: ExcelScript!ExcelScript.ChartSeries#getSmooth:member(1)
- package: ExcelScript!
- fullName: getSmooth()
- summary: >-
- Specifies if the series is smooth. Only applicable to line and scatter
- charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSmooth(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getSplitType()
- uid: ExcelScript!ExcelScript.ChartSeries#getSplitType:member(1)
- package: ExcelScript!
- fullName: getSplitType()
- summary: >-
- Specifies the way the two sections of either a pie-of-pie chart or a
- bar-of-pie chart are split.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSplitType(): ChartSplitType;'
- return:
- type:
- description: ''
- - name: getSplitValue()
- uid: ExcelScript!ExcelScript.ChartSeries#getSplitValue:member(1)
- package: ExcelScript!
- fullName: getSplitValue()
- summary: >-
- Specifies the threshold value that separates two sections of either a
- pie-of-pie chart or a bar-of-pie chart.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getSplitValue(): number;'
- return:
- type: number
- description: ''
- - name: getTrendlines()
- uid: ExcelScript!ExcelScript.ChartSeries#getTrendlines:member(1)
- package: ExcelScript!
- fullName: getTrendlines()
- summary: The collection of trendlines in the series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getTrendlines(): ChartTrendline[];'
- return:
- type: []
- description: ''
- - name: getVaryByCategories()
- uid: ExcelScript!ExcelScript.ChartSeries#getVaryByCategories:member(1)
- package: ExcelScript!
- fullName: getVaryByCategories()
- summary: >-
- True if Excel assigns a different color or pattern to each data marker.
- The chart must contain only one series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getVaryByCategories(): boolean;'
- return:
- type: boolean
- description: ''
- - name: getXErrorBars()
- uid: ExcelScript!ExcelScript.ChartSeries#getXErrorBars:member(1)
- package: ExcelScript!
- fullName: getXErrorBars()
- summary: Represents the error bar object of a chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getXErrorBars(): ChartErrorBars;'
- return:
- type:
- description: ''
- - name: getYErrorBars()
- uid: ExcelScript!ExcelScript.ChartSeries#getYErrorBars:member(1)
- package: ExcelScript!
- fullName: getYErrorBars()
- summary: Represents the error bar object of a chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'getYErrorBars(): ChartErrorBars;'
- return:
- type:
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This script adds error bars for the standard error of each chart series point.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the range for the chart.
- const worksheet = workbook.getWorksheet("Sample");
- const dataRange = worksheet.getRange("A1:B15");
-
- // Create a line chart.
- const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);
-
- // For each series, add error bars for the standard error on each point
- const allSeries = chart.getSeries();
- allSeries.forEach((series) => {
- series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
- series.getYErrorBars().setVisible(true);
- });
- }
- ```
- - name: setAxisGroup(axisGroup)
- uid: ExcelScript!ExcelScript.ChartSeries#setAxisGroup:member(1)
- package: ExcelScript!
- fullName: setAxisGroup(axisGroup)
- summary: Specifies the group for the specified series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setAxisGroup(axisGroup: ChartAxisGroup): void;'
- parameters:
- - id: axisGroup
- description: ''
- type:
- return:
- type: void
- description: ''
- - name: setBubbleScale(bubbleScale)
- uid: ExcelScript!ExcelScript.ChartSeries#setBubbleScale:member(1)
- package: ExcelScript!
- fullName: setBubbleScale(bubbleScale)
- summary: >-
- This can be an integer value from 0 (zero) to 300, representing the
- percentage of the default size. This property only applies to bubble
- charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBubbleScale(bubbleScale: number): void;'
- parameters:
- - id: bubbleScale
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setBubbleSizes(sourceData)
- uid: ExcelScript!ExcelScript.ChartSeries#setBubbleSizes:member(1)
- package: ExcelScript!
- fullName: setBubbleSizes(sourceData)
- summary: Sets the bubble sizes for a chart series. Only works for bubble charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setBubbleSizes(sourceData: Range): void;'
- parameters:
- - id: sourceData
- description: The `Range` object corresponding to the source data.
- type:
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets bubble sizes for a bubble chart series.
- */
- function main(workbook: ExcelScript.Workbook) {
- const sheet = workbook.getActiveWorksheet();
-
- // Add sample data.
- const data = [
- ["Product", "Price ($)", "Quality Score", "Market Share"],
- ["Product A", 85, 88, 25]
- ];
- const dataRange = sheet.getRange("A1:D2");
- dataRange.setValues(data);
-
- // Create bubble chart.
- const chart = sheet.addChart(
- ExcelScript.ChartType.bubble,
- sheet.getRange("B1:D1")
- );
- chart.setPosition("A4");
-
- // Remove default series.
- while (chart.getSeries().length > 0) {
- chart.getSeries()[0].delete();
- }
-
- // Add series with bubble sizes.
- const newSeries = chart.addChartSeries("Product A");
- newSeries.setXAxisValues(sheet.getRange("B2:B2"));
- newSeries.setValues(sheet.getRange("C2:C2"));
- newSeries.setBubbleSizes(sheet.getRange("D2:D2"));
- }
- ```
- - name: setChartType(chartType)
- uid: ExcelScript!ExcelScript.ChartSeries#setChartType:member(1)
- package: ExcelScript!
- fullName: setChartType(chartType)
- summary: >-
- Represents the chart type of a series. See `ExcelScript.ChartType` for
- details.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setChartType(chartType: ChartType): void;'
- parameters:
- - id: chartType
- description: ''
- type:
- return:
- type: void
- description: ''
- - name: setDoughnutHoleSize(doughnutHoleSize)
- uid: ExcelScript!ExcelScript.ChartSeries#setDoughnutHoleSize:member(1)
- package: ExcelScript!
- fullName: setDoughnutHoleSize(doughnutHoleSize)
- summary: >-
- Represents the doughnut hole size of a chart series. Only valid on
- doughnut and doughnut exploded charts. Throws an `InvalidArgument` error
- on invalid charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setDoughnutHoleSize(doughnutHoleSize: number): void;'
- parameters:
- - id: doughnutHoleSize
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setExplosion(explosion)
- uid: ExcelScript!ExcelScript.ChartSeries#setExplosion:member(1)
- package: ExcelScript!
- fullName: setExplosion(explosion)
- summary: >-
- Specifies 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).
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setExplosion(explosion: number): void;'
- parameters:
- - id: explosion
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setFiltered(filtered)
- uid: ExcelScript!ExcelScript.ChartSeries#setFiltered:member(1)
- package: ExcelScript!
- fullName: setFiltered(filtered)
- summary: Specifies if the series is filtered. Not applicable for surface charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFiltered(filtered: boolean): void;'
- parameters:
- - id: filtered
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setFirstSliceAngle(firstSliceAngle)
- uid: ExcelScript!ExcelScript.ChartSeries#setFirstSliceAngle:member(1)
- package: ExcelScript!
- fullName: setFirstSliceAngle(firstSliceAngle)
- summary: >-
- Specifies 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.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setFirstSliceAngle(firstSliceAngle: number): void;'
- parameters:
- - id: firstSliceAngle
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGapWidth(gapWidth)
- uid: ExcelScript!ExcelScript.ChartSeries#setGapWidth:member(1)
- package: ExcelScript!
- fullName: setGapWidth(gapWidth)
- summary: >-
- 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.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGapWidth(gapWidth: number): void;'
- parameters:
- - id: gapWidth
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGradientMaximumColor(gradientMaximumColor)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMaximumColor:member(1)
- package: ExcelScript!
- fullName: setGradientMaximumColor(gradientMaximumColor)
- summary: Specifies the color for maximum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMaximumColor(gradientMaximumColor: string): void;'
- parameters:
- - id: gradientMaximumColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setGradientMaximumType(gradientMaximumType)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMaximumType:member(1)
- package: ExcelScript!
- fullName: setGradientMaximumType(gradientMaximumType)
- summary: Specifies the type for maximum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setGradientMaximumType(
- gradientMaximumType: ChartGradientStyleType
- ): void;
- parameters:
- - id: gradientMaximumType
- description: ''
- type:
- return:
- type: void
- description: ''
- - name: setGradientMaximumValue(gradientMaximumValue)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMaximumValue:member(1)
- package: ExcelScript!
- fullName: setGradientMaximumValue(gradientMaximumValue)
- summary: Specifies the maximum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMaximumValue(gradientMaximumValue: number): void;'
- parameters:
- - id: gradientMaximumValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGradientMidpointColor(gradientMidpointColor)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMidpointColor:member(1)
- package: ExcelScript!
- fullName: setGradientMidpointColor(gradientMidpointColor)
- summary: Specifies the color for the midpoint value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMidpointColor(gradientMidpointColor: string): void;'
- parameters:
- - id: gradientMidpointColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setGradientMidpointType(gradientMidpointType)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMidpointType:member(1)
- package: ExcelScript!
- fullName: setGradientMidpointType(gradientMidpointType)
- summary: Specifies the type for the midpoint value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setGradientMidpointType(
- gradientMidpointType: ChartGradientStyleType
- ): void;
- parameters:
- - id: gradientMidpointType
- description: ''
- type:
- return:
- type: void
- description: ''
- - name: setGradientMidpointValue(gradientMidpointValue)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMidpointValue:member(1)
- package: ExcelScript!
- fullName: setGradientMidpointValue(gradientMidpointValue)
- summary: Specifies the midpoint value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMidpointValue(gradientMidpointValue: number): void;'
- parameters:
- - id: gradientMidpointValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGradientMinimumColor(gradientMinimumColor)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMinimumColor:member(1)
- package: ExcelScript!
- fullName: setGradientMinimumColor(gradientMinimumColor)
- summary: Specifies the color for the minimum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMinimumColor(gradientMinimumColor: string): void;'
- parameters:
- - id: gradientMinimumColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setGradientMinimumType(gradientMinimumType)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMinimumType:member(1)
- package: ExcelScript!
- fullName: setGradientMinimumType(gradientMinimumType)
- summary: Specifies the type for the minimum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setGradientMinimumType(
- gradientMinimumType: ChartGradientStyleType
- ): void;
- parameters:
- - id: gradientMinimumType
- description: ''
- type:
- return:
- type: void
- description: ''
- - name: setGradientMinimumValue(gradientMinimumValue)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientMinimumValue:member(1)
- package: ExcelScript!
- fullName: setGradientMinimumValue(gradientMinimumValue)
- summary: Specifies the minimum value of a region map chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientMinimumValue(gradientMinimumValue: number): void;'
- parameters:
- - id: gradientMinimumValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setGradientStyle(gradientStyle)
- uid: ExcelScript!ExcelScript.ChartSeries#setGradientStyle:member(1)
- package: ExcelScript!
- fullName: setGradientStyle(gradientStyle)
- summary: Specifies the series gradient style of a region map chart.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setGradientStyle(gradientStyle: ChartGradientStyle): void;'
- parameters:
- - id: gradientStyle
- description: ''
- type:
- return:
- type: void
- description: ''
- - name: setHasDataLabels(hasDataLabels)
- uid: ExcelScript!ExcelScript.ChartSeries#setHasDataLabels:member(1)
- package: ExcelScript!
- fullName: setHasDataLabels(hasDataLabels)
- summary: Specifies if the series has data labels.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setHasDataLabels(hasDataLabels: boolean): void;'
- parameters:
- - id: hasDataLabels
- description: ''
- type: boolean
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample enables data labels on a chart series.
- * This assumes the active worksheet has a chart.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first chart on the active worksheet.
- const sheet = workbook.getActiveWorksheet();
- const chart = sheet.getCharts()[0];
-
- // Enable data labels on the series.
- const series = chart.getSeries()[0];
- series.setHasDataLabels(true);
- }
- ```
- - name: setInvertColor(invertColor)
- uid: ExcelScript!ExcelScript.ChartSeries#setInvertColor:member(1)
- package: ExcelScript!
- fullName: setInvertColor(invertColor)
- summary: Specifies the fill color for negative data points in a series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInvertColor(invertColor: string): void;'
- parameters:
- - id: invertColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setInvertIfNegative(invertIfNegative)
- uid: ExcelScript!ExcelScript.ChartSeries#setInvertIfNegative:member(1)
- package: ExcelScript!
- fullName: setInvertIfNegative(invertIfNegative)
- summary: >-
- True if Excel inverts the pattern in the item when it corresponds to a
- negative number.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setInvertIfNegative(invertIfNegative: boolean): void;'
- parameters:
- - id: invertIfNegative
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setMarkerBackgroundColor(markerBackgroundColor)
- uid: ExcelScript!ExcelScript.ChartSeries#setMarkerBackgroundColor:member(1)
- package: ExcelScript!
- fullName: setMarkerBackgroundColor(markerBackgroundColor)
- summary: Specifies the marker background color of a chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerBackgroundColor(markerBackgroundColor: string): void;'
- parameters:
- - id: markerBackgroundColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setMarkerForegroundColor(markerForegroundColor)
- uid: ExcelScript!ExcelScript.ChartSeries#setMarkerForegroundColor:member(1)
- package: ExcelScript!
- fullName: setMarkerForegroundColor(markerForegroundColor)
- summary: Specifies the marker foreground color of a chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerForegroundColor(markerForegroundColor: string): void;'
- parameters:
- - id: markerForegroundColor
- description: ''
- type: string
- return:
- type: void
- description: ''
- - name: setMarkerSize(markerSize)
- uid: ExcelScript!ExcelScript.ChartSeries#setMarkerSize:member(1)
- package: ExcelScript!
- fullName: setMarkerSize(markerSize)
- summary: >-
- Specifies the marker size of a chart series. The supported size range is 2
- to 72. This method returns an InvalidArgument error if it's set with a
- size outside of the supported range.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerSize(markerSize: number): void;'
- parameters:
- - id: markerSize
- description: ''
- type: number
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the marker size for a line chart series.
- * This assumes the active worksheet has a line chart with markers.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first chart on the active worksheet.
- const sheet = workbook.getActiveWorksheet();
- const chart = sheet.getCharts()[0];
-
- // Set the marker size for all series.
- const series = chart.getSeries();
- series.forEach((s) => {
- s.setMarkerSize(8);
- });
- }
- ```
- - name: setMarkerStyle(markerStyle)
- uid: ExcelScript!ExcelScript.ChartSeries#setMarkerStyle:member(1)
- package: ExcelScript!
- fullName: setMarkerStyle(markerStyle)
- summary: >-
- Specifies the marker style of a chart series. See
- `ExcelScript.ChartMarkerStyle` for details.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setMarkerStyle(markerStyle: ChartMarkerStyle): void;'
- parameters:
- - id: markerStyle
- description: ''
- type:
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the marker style for a line chart series.
- * This assumes the active worksheet has a line chart with markers.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first chart on the active worksheet.
- const sheet = workbook.getActiveWorksheet();
- const chart = sheet.getCharts()[0];
-
- // Set the marker style to circle.
- const series = chart.getSeries()[0];
- series.setMarkerStyle(ExcelScript.ChartMarkerStyle.circle);
- }
- ```
- - name: setName(name)
- uid: ExcelScript!ExcelScript.ChartSeries#setName:member(1)
- package: ExcelScript!
- fullName: setName(name)
- summary: >-
- Specifies the name of a series in a chart. The name's length should not be
- greater than 255 characters.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setName(name: string): void;'
- parameters:
- - id: name
- description: ''
- type: string
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the name of chart series.
- * This assumes the active worksheet has a chart with at least 4 series.
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the first chart on the active worksheet.
- const sheet = workbook.getActiveWorksheet();
- const chart = sheet.getCharts()[0];
-
- // Set names for all series.
- const seriesCollection = chart.getSeries();
- seriesCollection[0].setName("Solar");
- seriesCollection[1].setName("Wind");
- seriesCollection[2].setName("Hydro");
- seriesCollection[3].setName("Geothermal");
- }
- ```
- - name: setOverlap(overlap)
- uid: ExcelScript!ExcelScript.ChartSeries#setOverlap:member(1)
- package: ExcelScript!
- fullName: setOverlap(overlap)
- summary: >-
- 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.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setOverlap(overlap: number): void;'
- parameters:
- - id: overlap
- description: ''
- type: number
- return:
- type: void
- description: |-
-
-
- #### Examples
-
- ```TypeScript
- /**
- * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
- */
- function main(workbook: ExcelScript.Workbook) {
- // Get the current worksheet.
- let selectedSheet = workbook.getActiveWorksheet();
-
- // Get an existing chart named "ColumnClusteredChart".
- let chart = selectedSheet.getChart("ColumnClusteredChart");
-
- // Set the overlap of every column of each series within a category.
- let seriesList = chart.getSeries();
- seriesList.forEach((series) => {
- // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
- series.setOverlap(25);
- });
- }
- ```
- - name: setParentLabelStrategy(parentLabelStrategy)
- uid: ExcelScript!ExcelScript.ChartSeries#setParentLabelStrategy:member(1)
- package: ExcelScript!
- fullName: setParentLabelStrategy(parentLabelStrategy)
- summary: Specifies the series parent label strategy area for a treemap chart.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: |-
- setParentLabelStrategy(
- parentLabelStrategy: ChartParentLabelStrategy
- ): void;
- parameters:
- - id: parentLabelStrategy
- description: ''
- type:
- return:
- type: void
- description: ''
- - name: setPlotOrder(plotOrder)
- uid: ExcelScript!ExcelScript.ChartSeries#setPlotOrder:member(1)
- package: ExcelScript!
- fullName: setPlotOrder(plotOrder)
- summary: Specifies the plot order of a chart series within the chart group.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setPlotOrder(plotOrder: number): void;'
- parameters:
- - id: plotOrder
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setSecondPlotSize(secondPlotSize)
- uid: ExcelScript!ExcelScript.ChartSeries#setSecondPlotSize:member(1)
- package: ExcelScript!
- fullName: setSecondPlotSize(secondPlotSize)
- summary: >-
- Specifies 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.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSecondPlotSize(secondPlotSize: number): void;'
- parameters:
- - id: secondPlotSize
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setShowConnectorLines(showConnectorLines)
- uid: ExcelScript!ExcelScript.ChartSeries#setShowConnectorLines:member(1)
- package: ExcelScript!
- fullName: setShowConnectorLines(showConnectorLines)
- summary: Specifies whether connector lines are shown in waterfall charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowConnectorLines(showConnectorLines: boolean): void;'
- parameters:
- - id: showConnectorLines
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowLeaderLines(showLeaderLines)
- uid: ExcelScript!ExcelScript.ChartSeries#setShowLeaderLines:member(1)
- package: ExcelScript!
- fullName: setShowLeaderLines(showLeaderLines)
- summary: >-
- Specifies whether leader lines are displayed for each data label in the
- series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowLeaderLines(showLeaderLines: boolean): void;'
- parameters:
- - id: showLeaderLines
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setShowShadow(showShadow)
- uid: ExcelScript!ExcelScript.ChartSeries#setShowShadow:member(1)
- package: ExcelScript!
- fullName: setShowShadow(showShadow)
- summary: Specifies if the series has a shadow.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setShowShadow(showShadow: boolean): void;'
- parameters:
- - id: showShadow
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setSmooth(smooth)
- uid: ExcelScript!ExcelScript.ChartSeries#setSmooth:member(1)
- package: ExcelScript!
- fullName: setSmooth(smooth)
- summary: >-
- Specifies if the series is smooth. Only applicable to line and scatter
- charts.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSmooth(smooth: boolean): void;'
- parameters:
- - id: smooth
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setSplitType(splitType)
- uid: ExcelScript!ExcelScript.ChartSeries#setSplitType:member(1)
- package: ExcelScript!
- fullName: setSplitType(splitType)
- summary: >-
- Specifies the way the two sections of either a pie-of-pie chart or a
- bar-of-pie chart are split.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSplitType(splitType: ChartSplitType): void;'
- parameters:
- - id: splitType
- description: ''
- type:
- return:
- type: void
- description: ''
- - name: setSplitValue(splitValue)
- uid: ExcelScript!ExcelScript.ChartSeries#setSplitValue:member(1)
- package: ExcelScript!
- fullName: setSplitValue(splitValue)
- summary: >-
- Specifies the threshold value that separates two sections of either a
- pie-of-pie chart or a bar-of-pie chart.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setSplitValue(splitValue: number): void;'
- parameters:
- - id: splitValue
- description: ''
- type: number
- return:
- type: void
- description: ''
- - name: setValues(sourceData)
- uid: ExcelScript!ExcelScript.ChartSeries#setValues:member(1)
- package: ExcelScript!
- fullName: setValues(sourceData)
- summary: >-
- Sets the values for a chart series. For scatter charts, it refers to
- y-axis values.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setValues(sourceData: Range): void;'
- parameters:
- - id: sourceData
- description: The `Range` object corresponding to the source data.
- type:
- return:
- type: void
- description: ''
- - name: setVaryByCategories(varyByCategories)
- uid: ExcelScript!ExcelScript.ChartSeries#setVaryByCategories:member(1)
- package: ExcelScript!
- fullName: setVaryByCategories(varyByCategories)
- summary: >-
- True if Excel assigns a different color or pattern to each data marker.
- The chart must contain only one series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setVaryByCategories(varyByCategories: boolean): void;'
- parameters:
- - id: varyByCategories
- description: ''
- type: boolean
- return:
- type: void
- description: ''
- - name: setXAxisValues(sourceData)
- uid: ExcelScript!ExcelScript.ChartSeries#setXAxisValues:member(1)
- package: ExcelScript!
- fullName: setXAxisValues(sourceData)
- summary: Sets the values of the x-axis for a chart series.
- remarks: ''
-
- isPreview: false
- isDeprecated: false
- syntax:
- content: 'setXAxisValues(sourceData: Range): void;'
- parameters:
- - id: sourceData
- description: The `Range` object corresponding to the source data.
- type:
- return:
- type: void
- description: ''
+name: ExcelScript.ChartSeries
+uid: ExcelScript!ExcelScript.ChartSeries:interface
+package: ExcelScript!
+fullName: ExcelScript.ChartSeries
+summary: Represents a series in a chart.
+remarks: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample produces a line chart with two series.
+ * The chart assumes data in A1:E5 that looks like this:
+ * Product Qtr1 Qtr2 Qtr3 Qtr4
+ * Frames 5000 7000 6544 4377
+ * Saddles 400 323 276 651
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Establish the ranges to use.
+ const sheet = workbook.getActiveWorksheet();
+ const headerRange = sheet.getRange("A1:E1");
+ const firstSeriesRange = sheet.getRange("A2:E2");
+ const secondSeriesRange = sheet.getRange("A3:E3");
+
+ // Create the chart.
+ const lineChart = sheet.addChart(ExcelScript.ChartType.line, headerRange);
+
+ // Add the first chart series.
+ const firstSeries = lineChart.addChartSeries();
+ firstSeries.setXAxisValues(headerRange);
+ firstSeries.setValues(firstSeriesRange);
+
+ // Add the second chart series.
+ const secondSeries = lineChart.addChartSeries();
+ secondSeries.setXAxisValues(headerRange);
+ secondSeries.setValues(secondSeriesRange);
+ }
+ ```
+
+isPreview: false
+isDeprecated: false
+type: interface
+methods:
+ - name: addChartTrendline(type)
+ uid: ExcelScript!ExcelScript.ChartSeries#addChartTrendline:member(1)
+ package: ExcelScript!
+ fullName: addChartTrendline(type)
+ summary: Adds a new trendline to trendline collection.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'addChartTrendline(type?: ChartTrendlineType): ChartTrendline;'
+ parameters:
+ - id: type
+ description: >-
+ Specifies the trendline type. The default value is "Linear". See
+ `ExcelScript.ChartTrendline` for details.
+ type:
+ return:
+ type:
+ description: ''
+ - name: delete()
+ uid: ExcelScript!ExcelScript.ChartSeries#delete:member(1)
+ package: ExcelScript!
+ fullName: delete()
+ summary: Deletes the chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'delete(): void;'
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample creates a bubble chart and manually adds each series.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const sheet = workbook.getActiveWorksheet();
+
+ // Add sample data.
+ const data = [
+ ["Product", "Price ($)", "Quality Score", "Market Share"],
+ ["Keyboards", 85, 88, 25],
+ ["Mice", 120, 80, 20]
+ ];
+ const dataRange = sheet.getRange("A1:D3");
+ dataRange.setValues(data);
+
+ // Create bubble chart - start with headers to create empty chart.
+ const chart = sheet.addChart(
+ ExcelScript.ChartType.bubble,
+ sheet.getRange("B1:D1")
+ );
+ chart.setPosition("A5");
+ chart.getTitle().setText("Product Analysis");
+
+ // Remove any default series that were created.
+ while (chart.getSeries().length > 0) {
+ chart.getSeries()[0].delete();
+ }
+
+ // Add each product as its own series.
+ for (let i = 2; i <= 3; i++) {
+ const productName = sheet.getRange(`A${i}`).getValue() as string;
+ const newSeries = chart.addChartSeries(productName);
+ newSeries.setXAxisValues(sheet.getRange(`B${i}:B${i}`));
+ newSeries.setValues(sheet.getRange(`C${i}:C${i}`));
+ newSeries.setBubbleSizes(sheet.getRange(`D${i}:D${i}`));
+ }
+ }
+ ```
+ - name: getAxisGroup()
+ uid: ExcelScript!ExcelScript.ChartSeries#getAxisGroup:member(1)
+ package: ExcelScript!
+ fullName: getAxisGroup()
+ summary: Specifies the group for the specified series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getAxisGroup(): ChartAxisGroup;'
+ return:
+ type:
+ description: ''
+ - name: getBinOptions()
+ uid: ExcelScript!ExcelScript.ChartSeries#getBinOptions:member(1)
+ package: ExcelScript!
+ fullName: getBinOptions()
+ summary: Encapsulates the bin options for histogram charts and pareto charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBinOptions(): ChartBinOptions;'
+ return:
+ type:
+ description: ''
+ - name: getBoxwhiskerOptions()
+ uid: ExcelScript!ExcelScript.ChartSeries#getBoxwhiskerOptions:member(1)
+ package: ExcelScript!
+ fullName: getBoxwhiskerOptions()
+ summary: Encapsulates the options for the box and whisker charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBoxwhiskerOptions(): ChartBoxwhiskerOptions;'
+ return:
+ type: >-
+
+ description: ''
+ - name: getBubbleScale()
+ uid: ExcelScript!ExcelScript.ChartSeries#getBubbleScale:member(1)
+ package: ExcelScript!
+ fullName: getBubbleScale()
+ summary: >-
+ This can be an integer value from 0 (zero) to 300, representing the
+ percentage of the default size. This property only applies to bubble
+ charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getBubbleScale(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getChartTrendline(index)
+ uid: ExcelScript!ExcelScript.ChartSeries#getChartTrendline:member(1)
+ package: ExcelScript!
+ fullName: getChartTrendline(index)
+ summary: >-
+ Gets a trendline object by index, which is the insertion order in the
+ items array.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getChartTrendline(index: number): ChartTrendline;'
+ parameters:
+ - id: index
+ description: Represents the insertion order in the items array.
+ type: number
+ return:
+ type:
+ description: ''
+ - name: getChartType()
+ uid: ExcelScript!ExcelScript.ChartSeries#getChartType:member(1)
+ package: ExcelScript!
+ fullName: getChartType()
+ summary: >-
+ Represents the chart type of a series. See `ExcelScript.ChartType` for
+ details.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getChartType(): ChartType;'
+ return:
+ type:
+ description: ''
+ - name: getDataLabels()
+ uid: ExcelScript!ExcelScript.ChartSeries#getDataLabels:member(1)
+ package: ExcelScript!
+ fullName: getDataLabels()
+ summary: Represents a collection of all data labels in the series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDataLabels(): ChartDataLabels;'
+ return:
+ type:
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample accesses and configures data labels for a series.
+ * This assumes the active worksheet has a chart.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first chart on the active worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const chart = sheet.getCharts()[0];
+
+ // Configure data labels via series.
+ const series = chart.getSeries()[0];
+ const dataLabels = series.getDataLabels();
+ dataLabels.setShowPercentage(true);
+ dataLabels.setShowValue(false);
+ }
+ ```
+ - name: getDimensionDataSourceString(dimension)
+ uid: ExcelScript!ExcelScript.ChartSeries#getDimensionDataSourceString:member(1)
+ package: ExcelScript!
+ fullName: getDimensionDataSourceString(dimension)
+ summary: >-
+ Gets the string representation of the data source of the chart series. The
+ string representation could be information such as a cell address.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDimensionDataSourceString(dimension: ChartSeriesDimension): string;'
+ parameters:
+ - id: dimension
+ description: The dimension of the axis where the data is from.
+ type:
+ return:
+ type: string
+ description: ''
+ - name: getDimensionDataSourceType(dimension)
+ uid: ExcelScript!ExcelScript.ChartSeries#getDimensionDataSourceType:member(1)
+ package: ExcelScript!
+ fullName: getDimensionDataSourceType(dimension)
+ summary: Gets the data source type of the chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ getDimensionDataSourceType(
+ dimension: ChartSeriesDimension
+ ): ChartDataSourceType;
+ parameters:
+ - id: dimension
+ description: The dimension of the axis where the data is from.
+ type:
+ return:
+ type:
+ description: ''
+ - name: getDimensionValues(dimension)
+ uid: ExcelScript!ExcelScript.ChartSeries#getDimensionValues:member(1)
+ package: ExcelScript!
+ fullName: getDimensionValues(dimension)
+ summary: >-
+ Gets the values from a single dimension of the chart series. These could
+ be either category values or data values, depending on the dimension
+ specified and how the data is mapped for the chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDimensionValues(dimension: ChartSeriesDimension): string[];'
+ parameters:
+ - id: dimension
+ description: The dimension of the axis where the data is from.
+ type:
+ return:
+ type: string[]
+ description: ''
+ - name: getDoughnutHoleSize()
+ uid: ExcelScript!ExcelScript.ChartSeries#getDoughnutHoleSize:member(1)
+ package: ExcelScript!
+ fullName: getDoughnutHoleSize()
+ summary: >-
+ Represents the doughnut hole size of a chart series. Only valid on
+ doughnut and doughnut exploded charts. Throws an `InvalidArgument` error
+ on invalid charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getDoughnutHoleSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getExplosion()
+ uid: ExcelScript!ExcelScript.ChartSeries#getExplosion:member(1)
+ package: ExcelScript!
+ fullName: getExplosion()
+ summary: >-
+ Specifies 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).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getExplosion(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getFiltered()
+ uid: ExcelScript!ExcelScript.ChartSeries#getFiltered:member(1)
+ package: ExcelScript!
+ fullName: getFiltered()
+ summary: Specifies if the series is filtered. Not applicable for surface charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFiltered(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getFirstSliceAngle()
+ uid: ExcelScript!ExcelScript.ChartSeries#getFirstSliceAngle:member(1)
+ package: ExcelScript!
+ fullName: getFirstSliceAngle()
+ summary: >-
+ Specifies 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFirstSliceAngle(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getFormat()
+ uid: ExcelScript!ExcelScript.ChartSeries#getFormat:member(1)
+ package: ExcelScript!
+ fullName: getFormat()
+ summary: >-
+ Represents the formatting of a chart series, which includes fill and line
+ formatting.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getFormat(): ChartSeriesFormat;'
+ return:
+ type:
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample gets the series format to customize appearance.
+ * This assumes the active worksheet has a chart.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first chart on the active worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const chart = sheet.getCharts()[0];
+
+ // Customize the series color.
+ const series = chart.getSeries()[0];
+ const format = series.getFormat();
+ format.getFill().setSolidColor("#B0C4DE");
+ }
+ ```
+ - name: getGapWidth()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGapWidth:member(1)
+ package: ExcelScript!
+ fullName: getGapWidth()
+ summary: >-
+ 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGapWidth(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getGradientMaximumColor()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMaximumColor:member(1)
+ package: ExcelScript!
+ fullName: getGradientMaximumColor()
+ summary: Specifies the color for maximum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMaximumColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getGradientMaximumType()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMaximumType:member(1)
+ package: ExcelScript!
+ fullName: getGradientMaximumType()
+ summary: Specifies the type for maximum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMaximumType(): ChartGradientStyleType;'
+ return:
+ type:
+ description: ''
+ - name: getGradientMaximumValue()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMaximumValue:member(1)
+ package: ExcelScript!
+ fullName: getGradientMaximumValue()
+ summary: Specifies the maximum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMaximumValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getGradientMidpointColor()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMidpointColor:member(1)
+ package: ExcelScript!
+ fullName: getGradientMidpointColor()
+ summary: Specifies the color for the midpoint value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMidpointColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getGradientMidpointType()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMidpointType:member(1)
+ package: ExcelScript!
+ fullName: getGradientMidpointType()
+ summary: Specifies the type for the midpoint value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMidpointType(): ChartGradientStyleType;'
+ return:
+ type:
+ description: ''
+ - name: getGradientMidpointValue()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMidpointValue:member(1)
+ package: ExcelScript!
+ fullName: getGradientMidpointValue()
+ summary: Specifies the midpoint value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMidpointValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getGradientMinimumColor()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMinimumColor:member(1)
+ package: ExcelScript!
+ fullName: getGradientMinimumColor()
+ summary: Specifies the color for the minimum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMinimumColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getGradientMinimumType()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMinimumType:member(1)
+ package: ExcelScript!
+ fullName: getGradientMinimumType()
+ summary: Specifies the type for the minimum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMinimumType(): ChartGradientStyleType;'
+ return:
+ type:
+ description: ''
+ - name: getGradientMinimumValue()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientMinimumValue:member(1)
+ package: ExcelScript!
+ fullName: getGradientMinimumValue()
+ summary: Specifies the minimum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientMinimumValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getGradientStyle()
+ uid: ExcelScript!ExcelScript.ChartSeries#getGradientStyle:member(1)
+ package: ExcelScript!
+ fullName: getGradientStyle()
+ summary: Specifies the series gradient style of a region map chart.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getGradientStyle(): ChartGradientStyle;'
+ return:
+ type:
+ description: ''
+ - name: getHasDataLabels()
+ uid: ExcelScript!ExcelScript.ChartSeries#getHasDataLabels:member(1)
+ package: ExcelScript!
+ fullName: getHasDataLabels()
+ summary: Specifies if the series has data labels.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getHasDataLabels(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getInvertColor()
+ uid: ExcelScript!ExcelScript.ChartSeries#getInvertColor:member(1)
+ package: ExcelScript!
+ fullName: getInvertColor()
+ summary: Specifies the fill color for negative data points in a series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInvertColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getInvertIfNegative()
+ uid: ExcelScript!ExcelScript.ChartSeries#getInvertIfNegative:member(1)
+ package: ExcelScript!
+ fullName: getInvertIfNegative()
+ summary: >-
+ True if Excel inverts the pattern in the item when it corresponds to a
+ negative number.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getInvertIfNegative(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getMapOptions()
+ uid: ExcelScript!ExcelScript.ChartSeries#getMapOptions:member(1)
+ package: ExcelScript!
+ fullName: getMapOptions()
+ summary: Encapsulates the options for a region map chart.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMapOptions(): ChartMapOptions;'
+ return:
+ type:
+ description: ''
+ - name: getMarkerBackgroundColor()
+ uid: ExcelScript!ExcelScript.ChartSeries#getMarkerBackgroundColor:member(1)
+ package: ExcelScript!
+ fullName: getMarkerBackgroundColor()
+ summary: Specifies the marker background color of a chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerBackgroundColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getMarkerForegroundColor()
+ uid: ExcelScript!ExcelScript.ChartSeries#getMarkerForegroundColor:member(1)
+ package: ExcelScript!
+ fullName: getMarkerForegroundColor()
+ summary: Specifies the marker foreground color of a chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerForegroundColor(): string;'
+ return:
+ type: string
+ description: ''
+ - name: getMarkerSize()
+ uid: ExcelScript!ExcelScript.ChartSeries#getMarkerSize:member(1)
+ package: ExcelScript!
+ fullName: getMarkerSize()
+ summary: >-
+ Specifies the marker size of a chart series. The supported size range is 2
+ to 72. This method returns an InvalidArgument error if it's set with a
+ size outside of the supported range.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getMarkerStyle()
+ uid: ExcelScript!ExcelScript.ChartSeries#getMarkerStyle:member(1)
+ package: ExcelScript!
+ fullName: getMarkerStyle()
+ summary: >-
+ Specifies the marker style of a chart series. See
+ `ExcelScript.ChartMarkerStyle` for details.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getMarkerStyle(): ChartMarkerStyle;'
+ return:
+ type:
+ description: ''
+ - name: getName()
+ uid: ExcelScript!ExcelScript.ChartSeries#getName:member(1)
+ package: ExcelScript!
+ fullName: getName()
+ summary: >-
+ Specifies the name of a series in a chart. The name's length should not be
+ greater than 255 characters.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getName(): string;'
+ return:
+ type: string
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample logs the names of each of the chart series in a chart named "ColumnClusteredChart".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnClusteredChart".
+ let chart = selectedSheet.getChart("ColumnClusteredChart");
+
+ // Log the name of each chart series in the chart.
+ let seriesList = chart.getSeries();
+ seriesList.forEach((series) => {
+ console.log(series.getName());
+ });
+ }
+ ```
+ - name: getOverlap()
+ uid: ExcelScript!ExcelScript.ChartSeries#getOverlap:member(1)
+ package: ExcelScript!
+ fullName: getOverlap()
+ summary: >-
+ 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getOverlap(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getParentLabelStrategy()
+ uid: ExcelScript!ExcelScript.ChartSeries#getParentLabelStrategy:member(1)
+ package: ExcelScript!
+ fullName: getParentLabelStrategy()
+ summary: Specifies the series parent label strategy area for a treemap chart.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getParentLabelStrategy(): ChartParentLabelStrategy;'
+ return:
+ type:
+ description: ''
+ - name: getPlotOrder()
+ uid: ExcelScript!ExcelScript.ChartSeries#getPlotOrder:member(1)
+ package: ExcelScript!
+ fullName: getPlotOrder()
+ summary: Specifies the plot order of a chart series within the chart group.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPlotOrder(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getPoints()
+ uid: ExcelScript!ExcelScript.ChartSeries#getPoints:member(1)
+ package: ExcelScript!
+ fullName: getPoints()
+ summary: Returns a collection of all points in the series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getPoints(): ChartPoint[];'
+ return:
+ type: []
+ description: ''
+ - name: getSecondPlotSize()
+ uid: ExcelScript!ExcelScript.ChartSeries#getSecondPlotSize:member(1)
+ package: ExcelScript!
+ fullName: getSecondPlotSize()
+ summary: >-
+ Specifies 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSecondPlotSize(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getShowConnectorLines()
+ uid: ExcelScript!ExcelScript.ChartSeries#getShowConnectorLines:member(1)
+ package: ExcelScript!
+ fullName: getShowConnectorLines()
+ summary: Specifies whether connector lines are shown in waterfall charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowConnectorLines(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowLeaderLines()
+ uid: ExcelScript!ExcelScript.ChartSeries#getShowLeaderLines:member(1)
+ package: ExcelScript!
+ fullName: getShowLeaderLines()
+ summary: >-
+ Specifies whether leader lines are displayed for each data label in the
+ series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowLeaderLines(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getShowShadow()
+ uid: ExcelScript!ExcelScript.ChartSeries#getShowShadow:member(1)
+ package: ExcelScript!
+ fullName: getShowShadow()
+ summary: Specifies if the series has a shadow.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getShowShadow(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSmooth()
+ uid: ExcelScript!ExcelScript.ChartSeries#getSmooth:member(1)
+ package: ExcelScript!
+ fullName: getSmooth()
+ summary: >-
+ Specifies if the series is smooth. Only applicable to line and scatter
+ charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSmooth(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getSplitType()
+ uid: ExcelScript!ExcelScript.ChartSeries#getSplitType:member(1)
+ package: ExcelScript!
+ fullName: getSplitType()
+ summary: >-
+ Specifies the way the two sections of either a pie-of-pie chart or a
+ bar-of-pie chart are split.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSplitType(): ChartSplitType;'
+ return:
+ type:
+ description: ''
+ - name: getSplitValue()
+ uid: ExcelScript!ExcelScript.ChartSeries#getSplitValue:member(1)
+ package: ExcelScript!
+ fullName: getSplitValue()
+ summary: >-
+ Specifies the threshold value that separates two sections of either a
+ pie-of-pie chart or a bar-of-pie chart.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getSplitValue(): number;'
+ return:
+ type: number
+ description: ''
+ - name: getTrendlines()
+ uid: ExcelScript!ExcelScript.ChartSeries#getTrendlines:member(1)
+ package: ExcelScript!
+ fullName: getTrendlines()
+ summary: The collection of trendlines in the series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getTrendlines(): ChartTrendline[];'
+ return:
+ type: []
+ description: ''
+ - name: getVaryByCategories()
+ uid: ExcelScript!ExcelScript.ChartSeries#getVaryByCategories:member(1)
+ package: ExcelScript!
+ fullName: getVaryByCategories()
+ summary: >-
+ True if Excel assigns a different color or pattern to each data marker.
+ The chart must contain only one series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getVaryByCategories(): boolean;'
+ return:
+ type: boolean
+ description: ''
+ - name: getXErrorBars()
+ uid: ExcelScript!ExcelScript.ChartSeries#getXErrorBars:member(1)
+ package: ExcelScript!
+ fullName: getXErrorBars()
+ summary: Represents the error bar object of a chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getXErrorBars(): ChartErrorBars;'
+ return:
+ type:
+ description: ''
+ - name: getYErrorBars()
+ uid: ExcelScript!ExcelScript.ChartSeries#getYErrorBars:member(1)
+ package: ExcelScript!
+ fullName: getYErrorBars()
+ summary: Represents the error bar object of a chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'getYErrorBars(): ChartErrorBars;'
+ return:
+ type:
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This script adds error bars for the standard error of each chart series point.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the range for the chart.
+ const worksheet = workbook.getWorksheet("Sample");
+ const dataRange = worksheet.getRange("A1:B15");
+
+ // Create a line chart.
+ const chart = worksheet.addChart(ExcelScript.ChartType.line, dataRange);
+
+ // For each series, add error bars for the standard error on each point
+ const allSeries = chart.getSeries();
+ allSeries.forEach((series) => {
+ series.getYErrorBars().setType(ExcelScript.ChartErrorBarsType.stError);
+ series.getYErrorBars().setVisible(true);
+ });
+ }
+ ```
+ - name: setAxisGroup(axisGroup)
+ uid: ExcelScript!ExcelScript.ChartSeries#setAxisGroup:member(1)
+ package: ExcelScript!
+ fullName: setAxisGroup(axisGroup)
+ summary: Specifies the group for the specified series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setAxisGroup(axisGroup: ChartAxisGroup): void;'
+ parameters:
+ - id: axisGroup
+ description: ''
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setBubbleScale(bubbleScale)
+ uid: ExcelScript!ExcelScript.ChartSeries#setBubbleScale:member(1)
+ package: ExcelScript!
+ fullName: setBubbleScale(bubbleScale)
+ summary: >-
+ This can be an integer value from 0 (zero) to 300, representing the
+ percentage of the default size. This property only applies to bubble
+ charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBubbleScale(bubbleScale: number): void;'
+ parameters:
+ - id: bubbleScale
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setBubbleSizes(sourceData)
+ uid: ExcelScript!ExcelScript.ChartSeries#setBubbleSizes:member(1)
+ package: ExcelScript!
+ fullName: setBubbleSizes(sourceData)
+ summary: Sets the bubble sizes for a chart series. Only works for bubble charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setBubbleSizes(sourceData: Range): void;'
+ parameters:
+ - id: sourceData
+ description: The `Range` object corresponding to the source data.
+ type:
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets bubble sizes for a bubble chart series.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ const sheet = workbook.getActiveWorksheet();
+
+ // Add sample data.
+ const data = [
+ ["Product", "Price ($)", "Quality Score", "Market Share"],
+ ["Product A", 85, 88, 25]
+ ];
+ const dataRange = sheet.getRange("A1:D2");
+ dataRange.setValues(data);
+
+ // Create bubble chart.
+ const chart = sheet.addChart(
+ ExcelScript.ChartType.bubble,
+ sheet.getRange("B1:D1")
+ );
+ chart.setPosition("A4");
+
+ // Remove default series.
+ while (chart.getSeries().length > 0) {
+ chart.getSeries()[0].delete();
+ }
+
+ // Add series with bubble sizes.
+ const newSeries = chart.addChartSeries("Product A");
+ newSeries.setXAxisValues(sheet.getRange("B2:B2"));
+ newSeries.setValues(sheet.getRange("C2:C2"));
+ newSeries.setBubbleSizes(sheet.getRange("D2:D2"));
+ }
+ ```
+ - name: setChartType(chartType)
+ uid: ExcelScript!ExcelScript.ChartSeries#setChartType:member(1)
+ package: ExcelScript!
+ fullName: setChartType(chartType)
+ summary: >-
+ Represents the chart type of a series. See `ExcelScript.ChartType` for
+ details.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setChartType(chartType: ChartType): void;'
+ parameters:
+ - id: chartType
+ description: ''
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setDoughnutHoleSize(doughnutHoleSize)
+ uid: ExcelScript!ExcelScript.ChartSeries#setDoughnutHoleSize:member(1)
+ package: ExcelScript!
+ fullName: setDoughnutHoleSize(doughnutHoleSize)
+ summary: >-
+ Represents the doughnut hole size of a chart series. Only valid on
+ doughnut and doughnut exploded charts. Throws an `InvalidArgument` error
+ on invalid charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setDoughnutHoleSize(doughnutHoleSize: number): void;'
+ parameters:
+ - id: doughnutHoleSize
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setExplosion(explosion)
+ uid: ExcelScript!ExcelScript.ChartSeries#setExplosion:member(1)
+ package: ExcelScript!
+ fullName: setExplosion(explosion)
+ summary: >-
+ Specifies 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).
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setExplosion(explosion: number): void;'
+ parameters:
+ - id: explosion
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setFiltered(filtered)
+ uid: ExcelScript!ExcelScript.ChartSeries#setFiltered:member(1)
+ package: ExcelScript!
+ fullName: setFiltered(filtered)
+ summary: Specifies if the series is filtered. Not applicable for surface charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFiltered(filtered: boolean): void;'
+ parameters:
+ - id: filtered
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setFirstSliceAngle(firstSliceAngle)
+ uid: ExcelScript!ExcelScript.ChartSeries#setFirstSliceAngle:member(1)
+ package: ExcelScript!
+ fullName: setFirstSliceAngle(firstSliceAngle)
+ summary: >-
+ Specifies 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setFirstSliceAngle(firstSliceAngle: number): void;'
+ parameters:
+ - id: firstSliceAngle
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGapWidth(gapWidth)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGapWidth:member(1)
+ package: ExcelScript!
+ fullName: setGapWidth(gapWidth)
+ summary: >-
+ 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGapWidth(gapWidth: number): void;'
+ parameters:
+ - id: gapWidth
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGradientMaximumColor(gradientMaximumColor)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMaximumColor:member(1)
+ package: ExcelScript!
+ fullName: setGradientMaximumColor(gradientMaximumColor)
+ summary: Specifies the color for maximum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMaximumColor(gradientMaximumColor: string): void;'
+ parameters:
+ - id: gradientMaximumColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGradientMaximumType(gradientMaximumType)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMaximumType:member(1)
+ package: ExcelScript!
+ fullName: setGradientMaximumType(gradientMaximumType)
+ summary: Specifies the type for maximum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setGradientMaximumType(
+ gradientMaximumType: ChartGradientStyleType
+ ): void;
+ parameters:
+ - id: gradientMaximumType
+ description: ''
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setGradientMaximumValue(gradientMaximumValue)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMaximumValue:member(1)
+ package: ExcelScript!
+ fullName: setGradientMaximumValue(gradientMaximumValue)
+ summary: Specifies the maximum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMaximumValue(gradientMaximumValue: number): void;'
+ parameters:
+ - id: gradientMaximumValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGradientMidpointColor(gradientMidpointColor)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMidpointColor:member(1)
+ package: ExcelScript!
+ fullName: setGradientMidpointColor(gradientMidpointColor)
+ summary: Specifies the color for the midpoint value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMidpointColor(gradientMidpointColor: string): void;'
+ parameters:
+ - id: gradientMidpointColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGradientMidpointType(gradientMidpointType)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMidpointType:member(1)
+ package: ExcelScript!
+ fullName: setGradientMidpointType(gradientMidpointType)
+ summary: Specifies the type for the midpoint value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setGradientMidpointType(
+ gradientMidpointType: ChartGradientStyleType
+ ): void;
+ parameters:
+ - id: gradientMidpointType
+ description: ''
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setGradientMidpointValue(gradientMidpointValue)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMidpointValue:member(1)
+ package: ExcelScript!
+ fullName: setGradientMidpointValue(gradientMidpointValue)
+ summary: Specifies the midpoint value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMidpointValue(gradientMidpointValue: number): void;'
+ parameters:
+ - id: gradientMidpointValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGradientMinimumColor(gradientMinimumColor)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMinimumColor:member(1)
+ package: ExcelScript!
+ fullName: setGradientMinimumColor(gradientMinimumColor)
+ summary: Specifies the color for the minimum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMinimumColor(gradientMinimumColor: string): void;'
+ parameters:
+ - id: gradientMinimumColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setGradientMinimumType(gradientMinimumType)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMinimumType:member(1)
+ package: ExcelScript!
+ fullName: setGradientMinimumType(gradientMinimumType)
+ summary: Specifies the type for the minimum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setGradientMinimumType(
+ gradientMinimumType: ChartGradientStyleType
+ ): void;
+ parameters:
+ - id: gradientMinimumType
+ description: ''
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setGradientMinimumValue(gradientMinimumValue)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientMinimumValue:member(1)
+ package: ExcelScript!
+ fullName: setGradientMinimumValue(gradientMinimumValue)
+ summary: Specifies the minimum value of a region map chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientMinimumValue(gradientMinimumValue: number): void;'
+ parameters:
+ - id: gradientMinimumValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setGradientStyle(gradientStyle)
+ uid: ExcelScript!ExcelScript.ChartSeries#setGradientStyle:member(1)
+ package: ExcelScript!
+ fullName: setGradientStyle(gradientStyle)
+ summary: Specifies the series gradient style of a region map chart.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setGradientStyle(gradientStyle: ChartGradientStyle): void;'
+ parameters:
+ - id: gradientStyle
+ description: ''
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setHasDataLabels(hasDataLabels)
+ uid: ExcelScript!ExcelScript.ChartSeries#setHasDataLabels:member(1)
+ package: ExcelScript!
+ fullName: setHasDataLabels(hasDataLabels)
+ summary: Specifies if the series has data labels.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setHasDataLabels(hasDataLabels: boolean): void;'
+ parameters:
+ - id: hasDataLabels
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample enables data labels on a chart series.
+ * This assumes the active worksheet has a chart.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first chart on the active worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const chart = sheet.getCharts()[0];
+
+ // Enable data labels on the series.
+ const series = chart.getSeries()[0];
+ series.setHasDataLabels(true);
+ }
+ ```
+ - name: setInvertColor(invertColor)
+ uid: ExcelScript!ExcelScript.ChartSeries#setInvertColor:member(1)
+ package: ExcelScript!
+ fullName: setInvertColor(invertColor)
+ summary: Specifies the fill color for negative data points in a series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInvertColor(invertColor: string): void;'
+ parameters:
+ - id: invertColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setInvertIfNegative(invertIfNegative)
+ uid: ExcelScript!ExcelScript.ChartSeries#setInvertIfNegative:member(1)
+ package: ExcelScript!
+ fullName: setInvertIfNegative(invertIfNegative)
+ summary: >-
+ True if Excel inverts the pattern in the item when it corresponds to a
+ negative number.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setInvertIfNegative(invertIfNegative: boolean): void;'
+ parameters:
+ - id: invertIfNegative
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setMarkerBackgroundColor(markerBackgroundColor)
+ uid: ExcelScript!ExcelScript.ChartSeries#setMarkerBackgroundColor:member(1)
+ package: ExcelScript!
+ fullName: setMarkerBackgroundColor(markerBackgroundColor)
+ summary: Specifies the marker background color of a chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerBackgroundColor(markerBackgroundColor: string): void;'
+ parameters:
+ - id: markerBackgroundColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setMarkerForegroundColor(markerForegroundColor)
+ uid: ExcelScript!ExcelScript.ChartSeries#setMarkerForegroundColor:member(1)
+ package: ExcelScript!
+ fullName: setMarkerForegroundColor(markerForegroundColor)
+ summary: Specifies the marker foreground color of a chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerForegroundColor(markerForegroundColor: string): void;'
+ parameters:
+ - id: markerForegroundColor
+ description: ''
+ type: string
+ return:
+ type: void
+ description: ''
+ - name: setMarkerSize(markerSize)
+ uid: ExcelScript!ExcelScript.ChartSeries#setMarkerSize:member(1)
+ package: ExcelScript!
+ fullName: setMarkerSize(markerSize)
+ summary: >-
+ Specifies the marker size of a chart series. The supported size range is 2
+ to 72. This method returns an InvalidArgument error if it's set with a
+ size outside of the supported range.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerSize(markerSize: number): void;'
+ parameters:
+ - id: markerSize
+ description: ''
+ type: number
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the marker size for a line chart series.
+ * This assumes the active worksheet has a line chart with markers.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first chart on the active worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const chart = sheet.getCharts()[0];
+
+ // Set the marker size for all series.
+ const series = chart.getSeries();
+ series.forEach((s) => {
+ s.setMarkerSize(8);
+ });
+ }
+ ```
+ - name: setMarkerStyle(markerStyle)
+ uid: ExcelScript!ExcelScript.ChartSeries#setMarkerStyle:member(1)
+ package: ExcelScript!
+ fullName: setMarkerStyle(markerStyle)
+ summary: >-
+ Specifies the marker style of a chart series. See
+ `ExcelScript.ChartMarkerStyle` for details.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setMarkerStyle(markerStyle: ChartMarkerStyle): void;'
+ parameters:
+ - id: markerStyle
+ description: ''
+ type:
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the marker style for a line chart series.
+ * This assumes the active worksheet has a line chart with markers.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first chart on the active worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const chart = sheet.getCharts()[0];
+
+ // Set the marker style to circle.
+ const series = chart.getSeries()[0];
+ series.setMarkerStyle(ExcelScript.ChartMarkerStyle.circle);
+ }
+ ```
+ - name: setName(name)
+ uid: ExcelScript!ExcelScript.ChartSeries#setName:member(1)
+ package: ExcelScript!
+ fullName: setName(name)
+ summary: >-
+ Specifies the name of a series in a chart. The name's length should not be
+ greater than 255 characters.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setName(name: string): void;'
+ parameters:
+ - id: name
+ description: ''
+ type: string
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the name of chart series.
+ * This assumes the active worksheet has a chart with at least 4 series.
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the first chart on the active worksheet.
+ const sheet = workbook.getActiveWorksheet();
+ const chart = sheet.getCharts()[0];
+
+ // Set names for all series.
+ const seriesCollection = chart.getSeries();
+ seriesCollection[0].setName("Solar");
+ seriesCollection[1].setName("Wind");
+ seriesCollection[2].setName("Hydro");
+ seriesCollection[3].setName("Geothermal");
+ }
+ ```
+ - name: setOverlap(overlap)
+ uid: ExcelScript!ExcelScript.ChartSeries#setOverlap:member(1)
+ package: ExcelScript!
+ fullName: setOverlap(overlap)
+ summary: >-
+ 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setOverlap(overlap: number): void;'
+ parameters:
+ - id: overlap
+ description: ''
+ type: number
+ return:
+ type: void
+ description: |-
+
+
+ #### Examples
+
+ ```TypeScript
+ /**
+ * This sample sets the overlap of the columns in a chart named "ColumnClusteredChart".
+ */
+ function main(workbook: ExcelScript.Workbook) {
+ // Get the current worksheet.
+ let selectedSheet = workbook.getActiveWorksheet();
+
+ // Get an existing chart named "ColumnClusteredChart".
+ let chart = selectedSheet.getChart("ColumnClusteredChart");
+
+ // Set the overlap of every column of each series within a category.
+ let seriesList = chart.getSeries();
+ seriesList.forEach((series) => {
+ // An overlap of 25 means the columns have 25% of their length overlapping with the adjacent columns in the same category.
+ series.setOverlap(25);
+ });
+ }
+ ```
+ - name: setParentLabelStrategy(parentLabelStrategy)
+ uid: ExcelScript!ExcelScript.ChartSeries#setParentLabelStrategy:member(1)
+ package: ExcelScript!
+ fullName: setParentLabelStrategy(parentLabelStrategy)
+ summary: Specifies the series parent label strategy area for a treemap chart.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: |-
+ setParentLabelStrategy(
+ parentLabelStrategy: ChartParentLabelStrategy
+ ): void;
+ parameters:
+ - id: parentLabelStrategy
+ description: ''
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setPlotOrder(plotOrder)
+ uid: ExcelScript!ExcelScript.ChartSeries#setPlotOrder:member(1)
+ package: ExcelScript!
+ fullName: setPlotOrder(plotOrder)
+ summary: Specifies the plot order of a chart series within the chart group.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setPlotOrder(plotOrder: number): void;'
+ parameters:
+ - id: plotOrder
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setSecondPlotSize(secondPlotSize)
+ uid: ExcelScript!ExcelScript.ChartSeries#setSecondPlotSize:member(1)
+ package: ExcelScript!
+ fullName: setSecondPlotSize(secondPlotSize)
+ summary: >-
+ Specifies 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.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSecondPlotSize(secondPlotSize: number): void;'
+ parameters:
+ - id: secondPlotSize
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setShowConnectorLines(showConnectorLines)
+ uid: ExcelScript!ExcelScript.ChartSeries#setShowConnectorLines:member(1)
+ package: ExcelScript!
+ fullName: setShowConnectorLines(showConnectorLines)
+ summary: Specifies whether connector lines are shown in waterfall charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowConnectorLines(showConnectorLines: boolean): void;'
+ parameters:
+ - id: showConnectorLines
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowLeaderLines(showLeaderLines)
+ uid: ExcelScript!ExcelScript.ChartSeries#setShowLeaderLines:member(1)
+ package: ExcelScript!
+ fullName: setShowLeaderLines(showLeaderLines)
+ summary: >-
+ Specifies whether leader lines are displayed for each data label in the
+ series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowLeaderLines(showLeaderLines: boolean): void;'
+ parameters:
+ - id: showLeaderLines
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setShowShadow(showShadow)
+ uid: ExcelScript!ExcelScript.ChartSeries#setShowShadow:member(1)
+ package: ExcelScript!
+ fullName: setShowShadow(showShadow)
+ summary: Specifies if the series has a shadow.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setShowShadow(showShadow: boolean): void;'
+ parameters:
+ - id: showShadow
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setSmooth(smooth)
+ uid: ExcelScript!ExcelScript.ChartSeries#setSmooth:member(1)
+ package: ExcelScript!
+ fullName: setSmooth(smooth)
+ summary: >-
+ Specifies if the series is smooth. Only applicable to line and scatter
+ charts.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSmooth(smooth: boolean): void;'
+ parameters:
+ - id: smooth
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setSplitType(splitType)
+ uid: ExcelScript!ExcelScript.ChartSeries#setSplitType:member(1)
+ package: ExcelScript!
+ fullName: setSplitType(splitType)
+ summary: >-
+ Specifies the way the two sections of either a pie-of-pie chart or a
+ bar-of-pie chart are split.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSplitType(splitType: ChartSplitType): void;'
+ parameters:
+ - id: splitType
+ description: ''
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setSplitValue(splitValue)
+ uid: ExcelScript!ExcelScript.ChartSeries#setSplitValue:member(1)
+ package: ExcelScript!
+ fullName: setSplitValue(splitValue)
+ summary: >-
+ Specifies the threshold value that separates two sections of either a
+ pie-of-pie chart or a bar-of-pie chart.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setSplitValue(splitValue: number): void;'
+ parameters:
+ - id: splitValue
+ description: ''
+ type: number
+ return:
+ type: void
+ description: ''
+ - name: setValues(sourceData)
+ uid: ExcelScript!ExcelScript.ChartSeries#setValues:member(1)
+ package: ExcelScript!
+ fullName: setValues(sourceData)
+ summary: >-
+ Sets the values for a chart series. For scatter charts, it refers to
+ y-axis values.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setValues(sourceData: Range): void;'
+ parameters:
+ - id: sourceData
+ description: The `Range` object corresponding to the source data.
+ type:
+ return:
+ type: void
+ description: ''
+ - name: setVaryByCategories(varyByCategories)
+ uid: ExcelScript!ExcelScript.ChartSeries#setVaryByCategories:member(1)
+ package: ExcelScript!
+ fullName: setVaryByCategories(varyByCategories)
+ summary: >-
+ True if Excel assigns a different color or pattern to each data marker.
+ The chart must contain only one series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setVaryByCategories(varyByCategories: boolean): void;'
+ parameters:
+ - id: varyByCategories
+ description: ''
+ type: boolean
+ return:
+ type: void
+ description: ''
+ - name: setXAxisValues(sourceData)
+ uid: ExcelScript!ExcelScript.ChartSeries#setXAxisValues:member(1)
+ package: ExcelScript!
+ fullName: setXAxisValues(sourceData)
+ summary: Sets the values of the x-axis for a chart series.
+ remarks: ''
+
+ isPreview: false
+ isDeprecated: false
+ syntax:
+ content: 'setXAxisValues(sourceData: Range): void;'
+ parameters:
+ - id: sourceData
+ description: The `Range` object corresponding to the source data.
+ type:
+ return:
+ type: void
+ description: ''
diff --git a/docs/docs-ref-autogen/excelscript/excelscript.range.yml b/docs/docs-ref-autogen/excelscript/excelscript.range.yml
index 58741c23..ee6d9c49 100644
--- a/docs/docs-ref-autogen/excelscript/excelscript.range.yml
+++ b/docs/docs-ref-autogen/excelscript/excelscript.range.yml
@@ -1002,8 +1002,7 @@ methods:
summary: >-
Returns a range object that includes the current range and up to the edge
of the range, based on the provided direction. This matches the
- Ctrl+Shift+Arrow key behavior in the
- Excel on Windows UI.
+ Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
remarks: ''
isPreview: false
@@ -1749,8 +1748,8 @@ methods:
fullName: getRangeEdge(direction, activeCell)
summary: >-
Returns a range object that is the edge cell of the data region that
- corresponds to the provided direction. This matches the
- Ctrl+Arrow key behavior in the Excel on Windows UI.
+ corresponds to the provided direction. This matches the Ctrl+Arrow key
+ behavior in the Excel on Windows UI.
remarks: ''
isPreview: false
diff --git a/docs/docs-ref-autogen/officescript.yml b/docs/docs-ref-autogen/officescript.yml
index dc6d8313..30f0adb4 100644
--- a/docs/docs-ref-autogen/officescript.yml
+++ b/docs/docs-ref-autogen/officescript.yml
@@ -4,8 +4,8 @@ name: OfficeScript
type: package
summary: ''
interfaces:
+ - OfficeScript!OfficeScript.DownloadFileProperties:interface
- OfficeScript!OfficeScript.EmailAttachment:interface
- - OfficeScript!OfficeScript.FileProperties:interface
- OfficeScript!OfficeScript.MailProperties:interface
enums:
- OfficeScript!OfficeScript.EmailContentType:enum
@@ -14,39 +14,21 @@ functions:
- name: OfficeScript.convertToPdf()
uid: OfficeScript!OfficeScript.convertToPdf:function(1)
package: OfficeScript!
- summary: >-
- Converts the document to a PDF and returns the text encoding of it. Note:
- Recent changes made to the workbook in Excel on the web, through Office
- Scripts or the Excel UI, may not be captured in the PDF.
+ summary: Converts the document to a PDF and returns the text encoding of it.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'export function convertToPdf(): string;'
return:
type: string
- description: >-
+ description: |-
The content of the workbook as a string, in PDF format.
-
- **Throws**: `ConvertToPdfEmptyWorkbook` The error thrown if the
- document is empty.
-
-
- **Throws**: `ConvertToPdfProtectedWorkbook` The error thrown if
- the document is protected.
-
-
- **Throws**: `ExternalApiTimeout` The error thrown if the API
- reaches the timeout limit of 30 seconds.
-
-
#### Examples
-
```TypeScript
-
/**
* This script saves a worksheet as a PDF and emails that PDF to a recipient.
*/
@@ -63,7 +45,6 @@ functions:
attachments: [pdfFile]
})
}
-
```
- name: OfficeScript.downloadFile(fileProperties)
uid: OfficeScript!OfficeScript.downloadFile:function(1)
@@ -73,31 +54,18 @@ functions:
the local machine.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
- content: 'export function downloadFile(fileProperties: FileProperties): void;'
+ content: >-
+ export function downloadFile(fileProperties: DownloadFileProperties):
+ void;
parameters:
- id: fileProperties
- description: >-
- The file to download.
-
-
- **Throws**: `DownloadFileNameMissing` The error thrown if the
- name is empty.
-
-
- **Throws**: `DownloadFileContentMissing` The error thrown if the
- content is empty.
-
-
- **Throws**: `DownloadFileInvalidExtension` The error thrown if
- the file name extension is not ".txt" or ".pdf".
-
-
- **Throws**: `ExternalApiTimeout` The error thrown if the API
- reaches the timeout limit of 30 seconds.
- type:
+ description: The file to download.
+ type: >-
+
return:
type: void
description: ''
@@ -107,7 +75,7 @@ functions:
summary: Get the name of the currently running script.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'export function getScriptName(): string;'
@@ -119,10 +87,11 @@ functions:
package: OfficeScript!
summary: >-
Saves a copy of the current workbook in OneDrive, in the same directory as
- the original file, with the specified file name.
+ the original file, with the specified file name. This API must be called
+ before other APIs.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'export function saveCopyAs(filename: string): void;'
@@ -131,27 +100,6 @@ functions:
description: >-
The file name of the copied and saved file. The file name must end
with ".xlsx".
-
-
- **Throws**: `InvalidExtensionError` The error thrown if the file
- name doesn't end with ".xlsx".
-
-
- **Throws**: `SaveCopyAsFileMayAlreadyExistError` The error
- thrown if the file name of the copy already exists.
-
-
- **Throws**: `SaveCopyAsErrorInvalidCharacters` The error thrown
- if the file name contains invalid characters.
-
-
- **Throws**: `SaveCopyAsFileNotOnOneDriveError` The error thrown
- if the document is not saved to OneDrive.
-
-
- **Throws**: `ExternalApiTimeout` The error thrown if the API
- reaches the timeout limit of 30 seconds. Note that the copy may
- still be created.
type: string
return:
type: void
@@ -164,7 +112,7 @@ functions:
content and recipients of the email.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'export function sendMail(mailProperties: MailProperties): void;'
diff --git a/docs/docs-ref-autogen/officescript/officescript.fileproperties.yml b/docs/docs-ref-autogen/officescript/officescript.downloadfileproperties.yml
similarity index 67%
rename from docs/docs-ref-autogen/officescript/officescript.fileproperties.yml
rename to docs/docs-ref-autogen/officescript/officescript.downloadfileproperties.yml
index e54ebb14..91d44783 100644
--- a/docs/docs-ref-autogen/officescript/officescript.fileproperties.yml
+++ b/docs/docs-ref-autogen/officescript/officescript.downloadfileproperties.yml
@@ -1,30 +1,30 @@
-### YamlMime:TSType
-name: OfficeScript.FileProperties
-uid: OfficeScript!OfficeScript.FileProperties:interface
+### YamlMime:TSType
+name: OfficeScript.DownloadFileProperties
+uid: OfficeScript!OfficeScript.DownloadFileProperties:interface
package: OfficeScript!
-fullName: OfficeScript.FileProperties
+fullName: OfficeScript.DownloadFileProperties
summary: The file to download.
remarks: ''
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
- name: content
- uid: OfficeScript!OfficeScript.FileProperties#content:member
+ uid: OfficeScript!OfficeScript.DownloadFileProperties#content:member
package: OfficeScript!
fullName: content
summary: The content of the file.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'content: string;'
return:
type: string
- name: name
- uid: OfficeScript!OfficeScript.FileProperties#name:member
+ uid: OfficeScript!OfficeScript.DownloadFileProperties#name:member
package: OfficeScript!
fullName: name
summary: >-
@@ -33,7 +33,7 @@ properties:
".txt".
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'name: string;'
diff --git a/docs/docs-ref-autogen/officescript/officescript.emailattachment.yml b/docs/docs-ref-autogen/officescript/officescript.emailattachment.yml
index 8476b8f9..8af3627a 100644
--- a/docs/docs-ref-autogen/officescript/officescript.emailattachment.yml
+++ b/docs/docs-ref-autogen/officescript/officescript.emailattachment.yml
@@ -10,7 +10,7 @@ summary: >-
enter a value for at least one of the "to", "cc", or "bcc" parameters."
remarks: ''
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -21,7 +21,7 @@ properties:
summary: The contents of the file.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'content: string;'
@@ -36,7 +36,7 @@ properties:
This string doesn't need to match the file name.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'name: string;'
diff --git a/docs/docs-ref-autogen/officescript/officescript.emailcontenttype.yml b/docs/docs-ref-autogen/officescript/officescript.emailcontenttype.yml
index 970d34ff..9f89a3ab 100644
--- a/docs/docs-ref-autogen/officescript/officescript.emailcontenttype.yml
+++ b/docs/docs-ref-autogen/officescript/officescript.emailcontenttype.yml
@@ -6,7 +6,7 @@ fullName: OfficeScript.EmailContentType
summary: The type of the content. Possible values are text or HTML.
remarks: ''
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: html
diff --git a/docs/docs-ref-autogen/officescript/officescript.emailimportance.yml b/docs/docs-ref-autogen/officescript/officescript.emailimportance.yml
index d40863ae..fd3608bd 100644
--- a/docs/docs-ref-autogen/officescript/officescript.emailimportance.yml
+++ b/docs/docs-ref-autogen/officescript/officescript.emailimportance.yml
@@ -8,7 +8,7 @@ summary: >-
importance values available in the Outlook UI.
remarks: ''
-isPreview: true
+isPreview: false
isDeprecated: false
fields:
- name: high
diff --git a/docs/docs-ref-autogen/officescript/officescript.mailproperties.yml b/docs/docs-ref-autogen/officescript/officescript.mailproperties.yml
index 1a7938cc..bad65a3f 100644
--- a/docs/docs-ref-autogen/officescript/officescript.mailproperties.yml
+++ b/docs/docs-ref-autogen/officescript/officescript.mailproperties.yml
@@ -6,7 +6,7 @@ fullName: OfficeScript.MailProperties
summary: The properties of the email to be sent.
remarks: ''
-isPreview: true
+isPreview: false
isDeprecated: false
type: interface
properties:
@@ -19,7 +19,7 @@ properties:
Optional.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'attachments?: EmailAttachment | EmailAttachment[];'
@@ -36,7 +36,7 @@ properties:
Optional.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'bcc?: string | string[];'
@@ -49,7 +49,7 @@ properties:
summary: The carbon copy (CC) recipient or recipients of the email. Optional.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'cc?: string | string[];'
@@ -62,7 +62,7 @@ properties:
summary: The content of the email. Optional.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'content?: string;'
@@ -77,7 +77,7 @@ properties:
Optional.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'contentType?: EmailContentType;'
@@ -93,7 +93,7 @@ properties:
Optional.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'importance?: EmailImportance;'
@@ -106,7 +106,7 @@ properties:
summary: The subject of the email. Optional.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'subject?: string;'
@@ -119,7 +119,7 @@ properties:
summary: The direct recipient or recipients of the email. Optional.
remarks: ''
- isPreview: true
+ isPreview: false
isDeprecated: false
syntax:
content: 'to?: string | string[];'
diff --git a/docs/docs-ref-autogen/toc.yml b/docs/docs-ref-autogen/toc.yml
index 951517e4..e74d31ff 100644
--- a/docs/docs-ref-autogen/toc.yml
+++ b/docs/docs-ref-autogen/toc.yml
@@ -653,9 +653,9 @@ items:
uid: OfficeScript!OfficeScript.EmailContentType:enum
- name: EmailImportance
uid: OfficeScript!OfficeScript.EmailImportance:enum
+ - name: DownloadFileProperties
+ uid: OfficeScript!OfficeScript.DownloadFileProperties:interface
- name: EmailAttachment
uid: OfficeScript!OfficeScript.EmailAttachment:interface
- - name: FileProperties
- uid: OfficeScript!OfficeScript.FileProperties:interface
- name: MailProperties
uid: OfficeScript!OfficeScript.MailProperties:interface
diff --git a/docs/includes/officescript-preview.md b/docs/includes/officescript-preview.md
index 8bad4030..76d510b8 100644
--- a/docs/includes/officescript-preview.md
+++ b/docs/includes/officescript-preview.md
@@ -1,19 +1,2 @@
| Class | Fields | Description |
|:---|:---|:---|
-|*global*|[convertToPdf()](/javascript/api/office-scripts/officescript#officescript-officescript-converttopdf-function(1))|Converts the document to a PDF and returns the text encoding of it.|
-||[downloadFile(fileProperties: FileProperties)](/javascript/api/office-scripts/officescript#officescript-officescript-downloadfile-function(1))|Downloads a specified file to the default download location specified by the local machine.|
-||[getScriptName()](/javascript/api/office-scripts/officescript#officescript-officescript-getscriptname-function(1))|Get the name of the currently running script.|
-||[saveCopyAs(filename: string)](/javascript/api/office-scripts/officescript#officescript-officescript-savecopyas-function(1))|Saves a copy of the current workbook in OneDrive, in the same directory as the original file, with the specified file name.|
-||[sendMail(mailProperties: MailProperties)](/javascript/api/office-scripts/officescript#officescript-officescript-sendmail-function(1))|Send an email with an Office Script.|
-|[EmailAttachment](/javascript/api/office-scripts/officescript/officescript.emailattachment)|[content](/javascript/api/office-scripts/officescript/officescript.emailattachment#officescript-officescript-emailattachment-content-member)|The contents of the file.|
-||[name](/javascript/api/office-scripts/officescript/officescript.emailattachment#officescript-officescript-emailattachment-name-member)|The text that is displayed below the icon representing the attachment.|
-|[FileProperties](/javascript/api/office-scripts/officescript/officescript.fileproperties)|[content](/javascript/api/office-scripts/officescript/officescript.fileproperties#officescript-officescript-fileproperties-content-member)|The content of the file.|
-||[name](/javascript/api/office-scripts/officescript/officescript.fileproperties#officescript-officescript-fileproperties-name-member)|The name of the file once downloaded.|
-|[MailProperties](/javascript/api/office-scripts/officescript/officescript.mailproperties)|[attachments](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-attachments-member)|A file (such as a text file or Excel workbook) attached to a message.|
-||[bcc](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-bcc-member)|The blind carbon copy (BCC) recipient or recipients of the email.|
-||[cc](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-cc-member)|The carbon copy (CC) recipient or recipients of the email.|
-||[content](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-content-member)|The content of the email.|
-||[contentType](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-contenttype-member)|The type of the content in the email.|
-||[importance](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-importance-member)|The importance of the email.|
-||[subject](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-subject-member)|The subject of the email.|
-||[to](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-to-member)|The direct recipient or recipients of the email.|
diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv
index 77e8d3d9..ce4d52b1 100644
--- a/generate-docs/API Coverage Report.csv
+++ b/generate-docs/API Coverage Report.csv
@@ -3423,6 +3423,9 @@ ExcelScript,ExcelScript.WorksheetSearchCriteria,N/A,Interface,Good,true
ExcelScript,ExcelScript.WorksheetSearchCriteria,"completeMatch",Property,Excellent,false
ExcelScript,ExcelScript.WorksheetSearchCriteria,"matchCase",Property,Excellent,false
ExcelScript,N/A,N/A,Package,Missing,false
+OfficeScript,OfficeScript.DownloadFileProperties,N/A,Interface,Poor,false
+OfficeScript,OfficeScript.DownloadFileProperties,"content",Property,Poor,false
+OfficeScript,OfficeScript.DownloadFileProperties,"name",Property,Good,false
OfficeScript,OfficeScript.EmailAttachment,N/A,Interface,Excellent,false
OfficeScript,OfficeScript.EmailAttachment,"content",Property,Poor,false
OfficeScript,OfficeScript.EmailAttachment,"name",Property,Good,false
@@ -3433,9 +3436,6 @@ OfficeScript,OfficeScript.EmailImportance,N/A,Enum,Good,false
OfficeScript,OfficeScript.EmailImportance,"high",EnumField,Poor,false
OfficeScript,OfficeScript.EmailImportance,"low",EnumField,Poor,false
OfficeScript,OfficeScript.EmailImportance,"normal",EnumField,Fine,false
-OfficeScript,OfficeScript.FileProperties,N/A,Interface,Poor,false
-OfficeScript,OfficeScript.FileProperties,"content",Property,Poor,false
-OfficeScript,OfficeScript.FileProperties,"name",Property,Good,false
OfficeScript,OfficeScript.MailProperties,N/A,Interface,Poor,false
OfficeScript,OfficeScript.MailProperties,"attachments",Property,Great,false
OfficeScript,OfficeScript.MailProperties,"bcc",Property,Great,false
diff --git a/generate-docs/api-extractor-inputs-excelscript-release/excelscript.d.ts b/generate-docs/api-extractor-inputs-excelscript-release/excelscript.d.ts
index 9f155f42..375f7d6f 100644
--- a/generate-docs/api-extractor-inputs-excelscript-release/excelscript.d.ts
+++ b/generate-docs/api-extractor-inputs-excelscript-release/excelscript.d.ts
@@ -1882,7 +1882,7 @@ export declare namespace ExcelScript {
getEntireRow(): Range;
/**
- * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
* @param direction - The direction from the active cell.
* @param activeCell - The active cell in this range. By default, the active cell is the top-left cell of the range. An error is thrown if the active cell is not in this range.
*/
@@ -1942,7 +1942,7 @@ export declare namespace ExcelScript {
getPrecedents(): WorkbookRangeAreas;
/**
- * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
* @param direction - The direction from the active cell.
* @param activeCell - The active cell in this range. By default, the active cell is the top-left cell of the range. An error is thrown if the active cell is not in this range.
*/
diff --git a/generate-docs/api-extractor-inputs-excelscript/excelscript.d.ts b/generate-docs/api-extractor-inputs-excelscript/excelscript.d.ts
index 9f155f42..375f7d6f 100644
--- a/generate-docs/api-extractor-inputs-excelscript/excelscript.d.ts
+++ b/generate-docs/api-extractor-inputs-excelscript/excelscript.d.ts
@@ -1882,7 +1882,7 @@ export declare namespace ExcelScript {
getEntireRow(): Range;
/**
- * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that includes the current range and up to the edge of the range, based on the provided direction. This matches the Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
* @param direction - The direction from the active cell.
* @param activeCell - The active cell in this range. By default, the active cell is the top-left cell of the range. An error is thrown if the active cell is not in this range.
*/
@@ -1942,7 +1942,7 @@ export declare namespace ExcelScript {
getPrecedents(): WorkbookRangeAreas;
/**
- * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
+ * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI.
* @param direction - The direction from the active cell.
* @param activeCell - The active cell in this range. By default, the active cell is the top-left cell of the range. An error is thrown if the active cell is not in this range.
*/
diff --git a/generate-docs/api-extractor-inputs-officescript-release/officescript.d.ts b/generate-docs/api-extractor-inputs-officescript-release/officescript.d.ts
index 1367c352..a55839e7 100644
--- a/generate-docs/api-extractor-inputs-officescript-release/officescript.d.ts
+++ b/generate-docs/api-extractor-inputs-officescript-release/officescript.d.ts
@@ -1,22 +1,165 @@
export declare namespace OfficeScript {
-
+ /**
+ * Saves a copy of the current workbook in OneDrive, in the same directory as the original file, with the specified file name.
+ * This API must be called before other APIs.
+ * @param filename - The file name of the copied and saved file. The file name must end with ".xlsx".
+ * @throws `SaveCopyAsInvalidExtension` Thrown if the file name doesn't end with ".xlsx".
+ * @throws `SaveCopyAsMustBeCalledFirst` Thrown if this method is called after other APIs.
+ * @throws `SaveCopyAsFileMayAlreadyExist` Thrown if the file name of the copy already exists.
+ * @throws `SaveCopyAsInvalidCharacters` Thrown if the file name contains invalid characters.
+ * @throws `SaveCopyAsFileNotOnOneDrive` Thrown if the document is not saved to OneDrive.
+ * @throws `ExternalApiTimeout` Thrown if the API reaches the timeout limit of 30 seconds. Note that the copy may still be created.
+ */
+ export function saveCopyAs(filename: string): void;
-
+ /**
+ * Converts the document to a PDF and returns the text encoding of it.
+ * @returns The content of the workbook as a string, in PDF format.
+ * @throws `ConvertToPdfEmptyWorkbook` Thrown if the document is empty.
+ * @throws `ConvertToPdfProtectedWorkbook` Thrown if the document is protected.
+ * @throws `ExternalApiTimeout` Thrown if the API reaches the timeout limit of 30 seconds.
+ */
+ export function convertToPdf(): string;
-
+ /**
+ * Downloads a specified file to the default download location specified by the local machine.
+ * @param fileProperties - The file to download.
+ * @throws `DownloadFileNameMissing` Thrown if the name is empty.
+ * @throws `DownloadFileContentMissing` Thrown if the content is empty.
+ * @throws `DownloadFileInvalidExtension` Thrown if the file name extension is not ".txt" or ".pdf".
+ * @throws `ExternalApiTimeout` Thrown if the API reaches the timeout limit of 30 seconds.
+ */
+ export function downloadFile(fileProperties: DownloadFileProperties): void;
-
+ /**
+ * The file to download.
+ */
+ export interface DownloadFileProperties {
+ /**
+ * The name of the file once downloaded. The file extension determines the type of the file. Supported extensions are ".txt" and ".pdf". Default is ".txt".
+ */
+ name: string;
-
+ /**
+ * The content of the file.
+ */
+ content: string;
+ }
+
+ /**
+ * Send an email with an Office Script. Use `MailProperties` to specify the content and recipients of the email.
+ * @param message - The properties that define the content and recipients of the email.
+ * @throws `SendMailMaxCalls` Thrown if the maximum number of API calls is exceeded. The limit is 100 API calls.
+ * @throws `SendMailNoRecipient` Thrown if no recipient is specified.
+ * @throws `SendMailInvalidEmail` Thrown if an invalid email address is provided.
+ * @throws `SendMailExtensionNotSupported` Thrown if the attachment name extension is not ".txt" or ".pdf".
+ * @throws `ExternalApiTimeout` Thrown if the API reaches the timeout limit of 30 seconds.
+ */
+ export function sendMail(mailProperties: MailProperties): void;
+
+ /**
+ * The type of the content. Possible values are text or HTML.
+ */
+ enum EmailContentType {
+ /**
+ * The email message body is in HTML format.
+ */
+ html = "html",
+
+ /**
+ * The email message body is in plain text format.
+ */
+ text = "text",
+ }
+
+ /**
+ * The importance value of the email. Corresponds to "high", "normal", and "low" importance values available in the Outlook UI.
+ */
+ enum EmailImportance {
+ /**
+ * Email is marked as low importance.
+ */
+ low = "low",
+
+ /**
+ * Email does not have any importance specified.
+ */
+ normal = "normal",
+
+ /**
+ * Email is marked as high importance.
+ */
+ high = "high",
+ }
+
+ /**
+ * The attachment to send with the email.
+ * A value must be specified for at least one of the `to`, `cc`, or `bcc` parameters.
+ * If no recipient is specified, the following error is shown: "The message has no recipient. Please enter a value for at least one of the "to", "cc", or "bcc" parameters."
+ */
+ export interface EmailAttachment {
+ /**
+ * The text that is displayed below the icon representing the attachment. This string doesn't need to match the file name.
+ */
+ name: string;
+ /**
+ * The contents of the file.
+ */
+ content: string;
+ }
+
+ /**
+ * The properties of the email to be sent.
+ */
+ export interface MailProperties {
+ /**
+ * The subject of the email. Optional.
+ */
+ subject?: string;
-
+ /**
+ * The content of the email. Optional.
+ */
+ content?: string;
-
+ /**
+ * The type of the content in the email. Possible values are text or HTML. Optional.
+ */
+ contentType?: EmailContentType;
-
+ /**
+ * The importance of the email. The possible values are `low`, `normal`, and `high`. Default value is `normal`. Optional.
+ */
+ importance?: EmailImportance;
-
+ /**
+ * The direct recipient or recipients of the email. Optional.
+ */
+ to?: string | string[];
+
+ /**
+ * The carbon copy (CC) recipient or recipients of the email. Optional.
+ */
+ cc?: string | string[];
+
+ /**
+ * The blind carbon copy (BCC) recipient or recipients of the email. Optional.
+ */
+ bcc?: string | string[];
+
+ /**
+ * A file (such as a text file or Excel workbook) attached to a message. Optional.
+ */
+ attachments?: EmailAttachment | EmailAttachment[];
+ }
-
+ /**
+ * Metadata about the script.
+ */
+ export namespace Metadata {
+ /**
+ * Get the name of the currently running script.
+ */
+ export function getScriptName(): string;
}
}
\ No newline at end of file
diff --git a/generate-docs/api-extractor-inputs-officescript/officescript.d.ts b/generate-docs/api-extractor-inputs-officescript/officescript.d.ts
index 7b8516d9..a55839e7 100644
--- a/generate-docs/api-extractor-inputs-officescript/officescript.d.ts
+++ b/generate-docs/api-extractor-inputs-officescript/officescript.d.ts
@@ -1,123 +1,93 @@
export declare namespace OfficeScript {
/**
* Saves a copy of the current workbook in OneDrive, in the same directory as the original file, with the specified file name.
- * @beta
+ * This API must be called before other APIs.
* @param filename - The file name of the copied and saved file. The file name must end with ".xlsx".
-
- * **Throws**: `InvalidExtensionError` The error thrown if the file name doesn't end with ".xlsx".
-
- * **Throws**: `SaveCopyAsFileMayAlreadyExistError` The error thrown if the file name of the copy already exists.
-
- * **Throws**: `SaveCopyAsErrorInvalidCharacters` The error thrown if the file name contains invalid characters.
-
- * **Throws**: `SaveCopyAsFileNotOnOneDriveError` The error thrown if the document is not saved to OneDrive.
-
- * **Throws**: `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds. Note that the copy may still be created.
+ * @throws `SaveCopyAsInvalidExtension` Thrown if the file name doesn't end with ".xlsx".
+ * @throws `SaveCopyAsMustBeCalledFirst` Thrown if this method is called after other APIs.
+ * @throws `SaveCopyAsFileMayAlreadyExist` Thrown if the file name of the copy already exists.
+ * @throws `SaveCopyAsInvalidCharacters` Thrown if the file name contains invalid characters.
+ * @throws `SaveCopyAsFileNotOnOneDrive` Thrown if the document is not saved to OneDrive.
+ * @throws `ExternalApiTimeout` Thrown if the API reaches the timeout limit of 30 seconds. Note that the copy may still be created.
*/
export function saveCopyAs(filename: string): void;
/**
* Converts the document to a PDF and returns the text encoding of it.
- * Note: Recent changes made to the workbook in Excel on the web, through Office Scripts or the Excel UI, may not be captured in the PDF.
- * @beta
* @returns The content of the workbook as a string, in PDF format.
-
- * **Throws**: `ConvertToPdfEmptyWorkbook` The error thrown if the document is empty.
-
- * **Throws**: `ConvertToPdfProtectedWorkbook` The error thrown if the document is protected.
-
- * **Throws**: `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds.
+ * @throws `ConvertToPdfEmptyWorkbook` Thrown if the document is empty.
+ * @throws `ConvertToPdfProtectedWorkbook` Thrown if the document is protected.
+ * @throws `ExternalApiTimeout` Thrown if the API reaches the timeout limit of 30 seconds.
*/
export function convertToPdf(): string;
/**
* Downloads a specified file to the default download location specified by the local machine.
- * @beta
* @param fileProperties - The file to download.
-
- * **Throws**: `DownloadFileNameMissing` The error thrown if the name is empty.
-
- * **Throws**: `DownloadFileContentMissing` The error thrown if the content is empty.
-
- * **Throws**: `DownloadFileInvalidExtension` The error thrown if the file name extension is not ".txt" or ".pdf".
-
- * **Throws**: `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds.
+ * @throws `DownloadFileNameMissing` Thrown if the name is empty.
+ * @throws `DownloadFileContentMissing` Thrown if the content is empty.
+ * @throws `DownloadFileInvalidExtension` Thrown if the file name extension is not ".txt" or ".pdf".
+ * @throws `ExternalApiTimeout` Thrown if the API reaches the timeout limit of 30 seconds.
*/
- export function downloadFile(fileProperties: FileProperties): void;
+ export function downloadFile(fileProperties: DownloadFileProperties): void;
/**
* The file to download.
- * @beta
*/
- export interface FileProperties {
+ export interface DownloadFileProperties {
/**
* The name of the file once downloaded. The file extension determines the type of the file. Supported extensions are ".txt" and ".pdf". Default is ".txt".
- * @beta
*/
name: string;
/**
* The content of the file.
- * @beta
*/
content: string;
}
/**
* Send an email with an Office Script. Use `MailProperties` to specify the content and recipients of the email.
- * @beta
* @param message - The properties that define the content and recipients of the email.
-
- * **Throws**: `SendMailErrorMaxCalls` The error thrown if the maximum number of API calls is exceeded. The limit is 100 API calls.
-
- * **Throws**: `SendMailNoRecipient` The error thrown if no recipient is specified.
-
- * **Throws**: `SendMailInvalidEmail` The error thrown if an invalid email address is provided.
-
- * **Throws**: `SendMailExtensionNotSupported` The error thrown if the attachment name extension is not ".txt" or ".pdf".
-
- * **Throws**: `ExternalApiTimeout` The error thrown if the API reaches the timeout limit of 30 seconds.
+ * @throws `SendMailMaxCalls` Thrown if the maximum number of API calls is exceeded. The limit is 100 API calls.
+ * @throws `SendMailNoRecipient` Thrown if no recipient is specified.
+ * @throws `SendMailInvalidEmail` Thrown if an invalid email address is provided.
+ * @throws `SendMailExtensionNotSupported` Thrown if the attachment name extension is not ".txt" or ".pdf".
+ * @throws `ExternalApiTimeout` Thrown if the API reaches the timeout limit of 30 seconds.
*/
export function sendMail(mailProperties: MailProperties): void;
/**
* The type of the content. Possible values are text or HTML.
- * @beta
*/
enum EmailContentType {
/**
* The email message body is in HTML format.
- * @beta
*/
html = "html",
/**
* The email message body is in plain text format.
- * @beta
*/
text = "text",
}
/**
* The importance value of the email. Corresponds to "high", "normal", and "low" importance values available in the Outlook UI.
- * @beta
*/
enum EmailImportance {
/**
* Email is marked as low importance.
- * @beta
*/
low = "low",
/**
* Email does not have any importance specified.
- * @beta
*/
normal = "normal",
/**
* Email is marked as high importance.
- * @beta
*/
high = "high",
}
@@ -126,83 +96,69 @@ export declare namespace OfficeScript {
* The attachment to send with the email.
* A value must be specified for at least one of the `to`, `cc`, or `bcc` parameters.
* If no recipient is specified, the following error is shown: "The message has no recipient. Please enter a value for at least one of the "to", "cc", or "bcc" parameters."
- * @beta
*/
export interface EmailAttachment {
/**
* The text that is displayed below the icon representing the attachment. This string doesn't need to match the file name.
- * @beta
*/
name: string;
/**
* The contents of the file.
- * @beta
*/
content: string;
}
/**
* The properties of the email to be sent.
- * @beta
*/
export interface MailProperties {
/**
* The subject of the email. Optional.
- * @beta
*/
subject?: string;
/**
* The content of the email. Optional.
- * @beta
*/
content?: string;
/**
* The type of the content in the email. Possible values are text or HTML. Optional.
- * @beta
*/
contentType?: EmailContentType;
/**
* The importance of the email. The possible values are `low`, `normal`, and `high`. Default value is `normal`. Optional.
- * @beta
*/
importance?: EmailImportance;
/**
* The direct recipient or recipients of the email. Optional.
- * @beta
*/
to?: string | string[];
/**
* The carbon copy (CC) recipient or recipients of the email. Optional.
- * @beta
*/
cc?: string | string[];
/**
* The blind carbon copy (BCC) recipient or recipients of the email. Optional.
- * @beta
*/
bcc?: string | string[];
/**
* A file (such as a text file or Excel workbook) attached to a message. Optional.
- * @beta
*/
attachments?: EmailAttachment | EmailAttachment[];
}
/**
* Metadata about the script.
- * @beta
*/
export namespace Metadata {
/**
* Get the name of the currently running script.
- * @beta
*/
export function getScriptName(): string;
}
diff --git a/generate-docs/package-lock.json b/generate-docs/package-lock.json
index 39c7a386..6b512524 100644
--- a/generate-docs/package-lock.json
+++ b/generate-docs/package-lock.json
@@ -350,9 +350,9 @@
"license": "MIT"
},
"node_modules/js-yaml": {
- "version": "4.1.0",
- "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
- "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+ "version": "4.1.1",
+ "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.1.tgz",
+ "integrity": "sha512-qQKT4zQxXl8lLwBtHMWwaTcGfFOZviOJet3Oy/xmGk2gZH677CJM9EvtfdSkgWcATZhj/55JZ0rmy3myCT5lsA==",
"license": "MIT",
"dependencies": {
"argparse": "^2.0.1"
@@ -434,13 +434,13 @@
}
},
"node_modules/reference-coverage-tester": {
- "version": "0.4.0",
- "resolved": "https://registry.npmjs.org/reference-coverage-tester/-/reference-coverage-tester-0.4.0.tgz",
- "integrity": "sha512-yQSLsAh4Q5wpkn/90+jGScTJ/emBHpMfofhshAzG7OOQCi1+qg1Zxzy7dwBDusF5+bbhKFfTxTK9pDKF7zGhUQ==",
+ "version": "0.4.1",
+ "resolved": "https://registry.npmjs.org/reference-coverage-tester/-/reference-coverage-tester-0.4.1.tgz",
+ "integrity": "sha512-zzHbL7G6GSlxYhkYYAu2t2+mu2a2YzAXh4OVvVDBKJmvghLVjH8XqV1OYu81ufTtfDeI31D3zXd3Sitg9GKStA==",
"license": "MIT",
"dependencies": {
"fs-extra": "11.3.0",
- "js-yaml": "4.1.0"
+ "js-yaml": "^4.1.1"
},
"bin": {
"reference-coverage-tester": "bin/reference-coverage-tester"