diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 05a1655c13..0c13640c74 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -18521,7 +18521,7 @@ declare namespace Excel { context: RequestContext; /** * - * Turn on/off JavaScript events in current taskpane or content add-in. + * Toggle JavaScript events in the current task pane or content add-in. * * [Api set: ExcelApi 1.8] */ @@ -18928,9 +18928,6 @@ declare namespace Excel { * An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. * * [Api set: ExcelApi 1.1] - * - * @remarks - * Our {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | how-to guide on working with worksheets} has detailed walkthroughs and code samples. */ class Worksheet extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -19646,9 +19643,6 @@ declare namespace Excel { * Range represents a set of one or more contiguous cells such as a cell, a row, a column, block of cells, etc. * * [Api set: ExcelApi 1.1] - * - * @remarks - * Our {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-ranges | how-to guide on working with ranges} has detailed walkthroughs, images, and code samples. */ class Range extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -21196,9 +21190,6 @@ declare namespace Excel { * Represents an Excel table. * * [Api set: ExcelApi 1.1] - * - * @remarks - * Our {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | how-to guide on working with tables} has detailed walkthroughs, images, and code samples. */ class Table extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -21828,7 +21819,7 @@ declare namespace Excel { prompt: Excel.DataValidationPrompt; /** * - * Data Validation rule that contains different type of data validation criteria. + * Data validation rule that contains different type of data validation criteria. * * [Api set: ExcelApi 1.8] */ @@ -21963,19 +21954,19 @@ declare namespace Excel { interface BasicDataValidation { /** * - * Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and NotBetween, specifies the lower bound operand. - * For example, setting formula1 to 10 and operator to GreaterThan means that valid data for the range must be greater than 10. - * When setting the value, it can be passed in as a number, a range object, or a string formula (where the string is either a stringified number, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). - * When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. + * Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and NotBetween, specifies the lower bound operand. + For example, setting formula1 to 10 and operator to GreaterThan means that valid data for the range must be greater than 10. + When setting the value, it can be passed in as a number, a range object, or a string formula (where the string is either a stringified number, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. * * [Api set: ExcelApi 1.8] */ formula1: string | number | Range; /** * - * With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary operators, such as GreaterThan. - * When setting the value, it can be passed in as a number, a range object, or a string formula (where the string is either a stringified number, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). - * When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. + * With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary operators, such as GreaterThan. + When setting the value, it can be passed in as a number, a range object, or a string formula (where the string is either a stringified number, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. * * [Api set: ExcelApi 1.8] */ @@ -21997,18 +21988,18 @@ declare namespace Excel { interface DateTimeDataValidation { /** * - * Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and NotBetween, specifies the lower bound operand. - * When setting the value, it can be passed in as a Date, a Range object, or a string formula (where the string is either a stringified date/time in ISO8601 format, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). - * When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. + * Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell). With the ternary operators Between and NotBetween, specifies the lower bound operand. + When setting the value, it can be passed in as a Date, a Range object, or a string formula (where the string is either a stringified date/time in ISO8601 format, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. * * [Api set: ExcelApi 1.8] */ formula1: string | Date | Range; /** * - * With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary operators, such as GreaterThan. - * When setting the value, it can be passed in as a Date, a Range object, or a string (where the string is either a stringified date/time in ISO8601 format, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). - * When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. + * With the ternary operators Between and NotBetween, specifies the upper bound operand. Is not used with the binary operators, such as GreaterThan. + When setting the value, it can be passed in as a Date, a Range object, or a string (where the string is either a stringified date/time in ISO8601 format, a cell reference like "=A1", or a formula like "=MIN(A1, B1)"). + When retrieving the value, it will always be returned as a string formula, for example: "=10", "=A1", "=SUM(A1:B5)", etc. * * [Api set: ExcelApi 1.8] */ @@ -22052,7 +22043,7 @@ declare namespace Excel { interface CustomDataValidation { /** * - * Custom data validation formula, it is to create special rules, such as preventing duplicates, or limiting the total in a range of cells. + * A custom data validation formula. This creates special input rules, such as preventing duplicates, or limiting the total in a range of cells. * * [Api set: ExcelApi 1.8] */ @@ -22074,14 +22065,14 @@ declare namespace Excel { message: string; /** * - * It determines show error alert dialog or not when users enter invalid data, it defaults to true. + * Determines whether to show an error alert dialog or not when a user enters invalid data. The default is true. * * [Api set: ExcelApi 1.8] */ showAlert: boolean; /** * - * Represents Data validation alert type, please see Excel.DataValidationAlertStyle for details. + * Represents data validation alert type, please see Excel.DataValidationAlertStyle for details. * * [Api set: ExcelApi 1.8] */ @@ -22110,7 +22101,7 @@ declare namespace Excel { message: string; /** * - * It determines showing the prompt or not when user selects a cell with the data validation. + * Determines whether or not to show the prompt when user selects a cell with data validation. * * [Api set: ExcelApi 1.8] */ @@ -22786,9 +22777,6 @@ declare namespace Excel { * Represents a chart object in a workbook. * * [Api set: ExcelApi 1.1] - * - * @remarks - * Our {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | how-to guide on working with charts} has detailed walkthroughs, images, and code samples. */ class Chart extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -22837,7 +22825,7 @@ declare namespace Excel { readonly series: Excel.ChartSeriesCollection; /** * - * Represents the title of the specified chart, including the text, visibility, position, and formating of the title. Read-only. + * Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. Read-only. * * [Api set: ExcelApi 1.1] */ @@ -22930,7 +22918,7 @@ declare namespace Excel { showAllFieldButtons: boolean; /** * - * Represents whether to to show the data labels when the value is greater than the maximum value on the value axis. + * Represents whether to show the data labels when the value is greater than the maximum value on the value axis. If value axis became smaller than the size of data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only. * @@ -23356,7 +23344,7 @@ declare namespace Excel { name: string; /** * - * Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. + * Specifies how bars and columns are positioned. Can be a value between –100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. * * [Api set: ExcelApi 1.8] */ @@ -23489,7 +23477,7 @@ declare namespace Excel { context: RequestContext; /** * - * Represents the fill format of a chart series, which includes background formating information. Read-only. + * Represents the fill format of a chart series, which includes background formatting information. Read-only. * * [Api set: ExcelApi 1.1] */ @@ -23724,7 +23712,7 @@ declare namespace Excel { readonly border: Excel.ChartBorder; /** * - * Represents the fill format of a chart, which includes background formating information. Read-only. + * Represents the fill format of a chart, which includes background formatting information. Read-only. * * [Api set: ExcelApi 1.1] */ @@ -25091,14 +25079,14 @@ declare namespace Excel { context: RequestContext; /** * - * Represents the height of the legendEntry on the chart Legend. + * Represents the height of the legendEntry on the chart legend. * * [Api set: ExcelApi 1.8] */ readonly height: number; /** * - * Represents the index of the LegendEntry in the Chart Legend. + * Represents the index of the legendEntry in the chart legend. * * [Api set: ExcelApi 1.8] */ @@ -25241,7 +25229,7 @@ declare namespace Excel { readonly border: Excel.ChartBorder; /** * - * Represents the fill format of an object, which includes background formating information. Read-only. + * Represents the fill format of an object, which includes background formatting information. Read-only. * * [Api set: ExcelApi 1.1] */ @@ -25529,7 +25517,7 @@ declare namespace Excel { readonly border: Excel.ChartBorder; /** * - * Represents the fill format of an object, which includes background formating information. Read-only. + * Represents the fill format of an object, which includes background formatting information. Read-only. * * [Api set: ExcelApi 1.1] */ @@ -26472,7 +26460,7 @@ declare namespace Excel { readonly border: Excel.ChartBorder; /** * - * Represents the fill format of an object, which includes background formating information. + * Represents the fill format of an object, which includes background formatting information. * * [Api set: ExcelApi 1.8] */ @@ -27301,9 +27289,6 @@ declare namespace Excel { * Represents an Excel PivotTable. * * [Api set: ExcelApi 1.3] - * - * @remarks - * Our {@link https://docs.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | how-to guide on working with PivotTables} has detailed walkthroughs, images, and code samples. */ class PivotTable extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -28117,7 +28102,7 @@ declare namespace Excel { position: number; /** * - * Determines whether the data should be sown as a specific summary calculation or not. + * Determines whether the data should be shown as a specific summary calculation or not. * * [Api set: ExcelApi 1.8] */ @@ -28183,14 +28168,14 @@ declare namespace Excel { interface ShowAsRule { /** * - * The Base PivotField to base the ShowAs calculation, if applicable based on the ShowAsCalculation type, else null. + * The base PivotField to base the ShowAs calculation, if applicable based on the ShowAsCalculation type, else null. * * [Api set: ExcelApi 1.8] */ baseField?: Excel.PivotField; /** * - * The Base Item to base the ShowAs calculation on, if applicable based on the ShowAsCalculation type, else null. + * The base Item to base the ShowAs calculation on, if applicable based on the ShowAsCalculation type, else null. * * [Api set: ExcelApi 1.8] */ @@ -29974,7 +29959,7 @@ declare namespace Excel { formula?: string; /** * - * What the icon conditional formula should be based on. + * What the criterion conditional formula should be based on. * * [Api set: ExcelApi 1.6] */ @@ -31514,8 +31499,23 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ enum CalculationMode { + /** + * + * The default recalculation behavior where Excel calculates new formula results every time the relevant data is changed. + * + */ automatic = "Automatic", + /** + * + * Calculates new formula results every time the relevant data is changed, unless the formula is in a data table. + * + */ automaticExceptTables = "AutomaticExceptTables", + /** + * + * Calculations only occur when the user or add-in requests them. + * + */ manual = "Manual", } /** @@ -36355,7 +36355,7 @@ declare namespace Excel { interface RuntimeUpdateData { /** * - * Turn on/off JavaScript events in current taskpane or content add-in. + * Toggle JavaScript events in the current task pane or content add-in. * * [Api set: ExcelApi 1.8] */ @@ -36755,7 +36755,7 @@ declare namespace Excel { prompt?: Excel.DataValidationPrompt; /** * - * Data Validation rule that contains different type of data validation criteria. + * Data validation rule that contains different type of data validation criteria. * * [Api set: ExcelApi 1.8] */ @@ -36992,7 +36992,7 @@ declare namespace Excel { plotArea?: Excel.Interfaces.ChartPlotAreaUpdateData; /** * - * Represents the title of the specified chart, including the text, visibility, position, and formating of the title. + * Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. * * [Api set: ExcelApi 1.1] */ @@ -37071,7 +37071,7 @@ declare namespace Excel { showAllFieldButtons?: boolean; /** * - * Represents whether to to show the data labels when the value is greater than the maximum value on the value axis. + * Represents whether to show the data labels when the value is greater than the maximum value on the value axis. If value axis became smaller than the size of data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only. * @@ -37239,7 +37239,7 @@ declare namespace Excel { name?: string; /** * - * Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. + * Specifies how bars and columns are positioned. Can be a value between –100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. * * [Api set: ExcelApi 1.8] */ @@ -37669,7 +37669,7 @@ declare namespace Excel { format?: Excel.Interfaces.ChartDataLabelFormatUpdateData; /** * - * Represents whether data labels automatically generates appropriate text based on context. + * Represents whether data labels automatically generate appropriate text based on context. * * [Api set: ExcelApi 1.8] */ @@ -38654,7 +38654,7 @@ declare namespace Excel { position?: number; /** * - * Determines whether the data should be sown as a specific summary calculation or not. + * Determines whether the data should be shown as a specific summary calculation or not. * * [Api set: ExcelApi 1.8] */ @@ -39493,7 +39493,7 @@ declare namespace Excel { interface RuntimeData { /** * - * Turn on/off JavaScript events in current taskpane or content add-in. + * Toggle JavaScript events in the current task pane or content add-in. * * [Api set: ExcelApi 1.8] */ @@ -40328,7 +40328,7 @@ declare namespace Excel { prompt?: Excel.DataValidationPrompt; /** * - * Data Validation rule that contains different type of data validation criteria. + * Data validation rule that contains different type of data validation criteria. * * [Api set: ExcelApi 1.8] */ @@ -40602,7 +40602,7 @@ declare namespace Excel { series?: Excel.Interfaces.ChartSeriesData[]; /** * - * Represents the title of the specified chart, including the text, visibility, position, and formating of the title. Read-only. + * Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. Read-only. * * [Api set: ExcelApi 1.1] */ @@ -40688,7 +40688,7 @@ declare namespace Excel { showAllFieldButtons?: boolean; /** * - * Represents whether to to show the data labels when the value is greater than the maximum value on the value axis. + * Represents whether to show the data labels when the value is greater than the maximum value on the value axis. If value axis became smaller than the size of data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only. * @@ -40870,7 +40870,7 @@ declare namespace Excel { name?: string; /** * - * Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. + * Specifies how bars and columns are positioned. Can be a value between –100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. * * [Api set: ExcelApi 1.8] */ @@ -41211,7 +41211,7 @@ declare namespace Excel { position?: Excel.ChartAxisPosition | "Automatic" | "Maximum" | "Minimum" | "Custom"; /** * - * Represents the specified axis position where the other axis crosses at. Read Only. Set to this property should use SetPositionAt(double) method. + * Represents the specified axis position where the other axis crosses at. You should use the SetPositionAt(double) method to set this property. * * [Api set: ExcelApi 1.8] */ @@ -41363,7 +41363,7 @@ declare namespace Excel { format?: Excel.Interfaces.ChartDataLabelFormatData; /** * - * Represents whether data labels automatically generates appropriate text based on context. + * Represents whether data labels automatically generate appropriate text based on context. * * [Api set: ExcelApi 1.8] */ @@ -41721,14 +41721,14 @@ declare namespace Excel { interface ChartLegendEntryData { /** * - * Represents the height of the legendEntry on the chart Legend. + * Represents the height of the legendEntry on the chart legend. * * [Api set: ExcelApi 1.8] */ height?: number; /** * - * Represents the index of the LegendEntry in the Chart Legend. + * Represents the index of the legendEntry in the chart legend. * * [Api set: ExcelApi 1.8] */ @@ -42574,7 +42574,7 @@ declare namespace Excel { position?: number; /** * - * Determines whether the data should be sown as a specific summary calculation or not. + * Determines whether the data should be shown as a specific summary calculation or not. * * [Api set: ExcelApi 1.8] */ @@ -43513,7 +43513,7 @@ declare namespace Excel { $all?: boolean; /** * - * Turn on/off JavaScript events in current taskpane or content add-in. + * Toggle JavaScript events in the current task pane or content add-in. * * [Api set: ExcelApi 1.8] */ @@ -44868,7 +44868,7 @@ declare namespace Excel { prompt?: boolean; /** * - * Data Validation rule that contains different type of data validation criteria. + * Data validation rule that contains different type of data validation criteria. * * [Api set: ExcelApi 1.8] */ @@ -45207,7 +45207,7 @@ declare namespace Excel { series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions; /** * - * For EACH ITEM in the collection: Represents the title of the specified chart, including the text, visibility, position, and formating of the title. + * For EACH ITEM in the collection: Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. * * [Api set: ExcelApi 1.1] */ @@ -45300,7 +45300,7 @@ declare namespace Excel { showAllFieldButtons?: boolean; /** * - * For EACH ITEM in the collection: Represents whether to to show the data labels when the value is greater than the maximum value on the value axis. + * For EACH ITEM in the collection: Represents whether to show the data labels when the value is greater than the maximum value on the value axis. If value axis became smaller than the size of data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only. * @@ -45381,7 +45381,7 @@ declare namespace Excel { series?: Excel.Interfaces.ChartSeriesCollectionLoadOptions; /** * - * Represents the title of the specified chart, including the text, visibility, position, and formating of the title. + * Represents the title of the specified chart, including the text, visibility, position, and formatting of the title. * * [Api set: ExcelApi 1.1] */ @@ -45474,7 +45474,7 @@ declare namespace Excel { showAllFieldButtons?: boolean; /** * - * Represents whether to to show the data labels when the value is greater than the maximum value on the value axis. + * Represents whether to show the data labels when the value is greater than the maximum value on the value axis. If value axis became smaller than the size of data points, you can use this property to set whether to show the data labels. This property applies to 2-D charts only. * @@ -45657,7 +45657,7 @@ declare namespace Excel { name?: boolean; /** * - * For EACH ITEM in the collection: Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. + * For EACH ITEM in the collection: Specifies how bars and columns are positioned. Can be a value between –100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. * * [Api set: ExcelApi 1.8] */ @@ -45836,7 +45836,7 @@ declare namespace Excel { name?: boolean; /** * - * Specifies how bars and columns are positioned. Can be a value between – 100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. + * Specifies how bars and columns are positioned. Can be a value between –100 and 100. Applies only to 2-D bar and 2-D column charts. Read/Write. * * [Api set: ExcelApi 1.8] */ @@ -46282,7 +46282,7 @@ declare namespace Excel { position?: boolean; /** * - * Represents the specified axis position where the other axis crosses at. Read Only. Set to this property should use SetPositionAt(double) method. + * Represents the specified axis position where the other axis crosses at. You should use the SetPositionAt(double) method to set this property. * * [Api set: ExcelApi 1.8] */ @@ -46458,7 +46458,7 @@ declare namespace Excel { format?: Excel.Interfaces.ChartDataLabelFormatLoadOptions; /** * - * Represents whether data labels automatically generates appropriate text based on context. + * Represents whether data labels automatically generate appropriate text based on context. * * [Api set: ExcelApi 1.8] */ @@ -46845,14 +46845,14 @@ declare namespace Excel { $all?: boolean; /** * - * Represents the height of the legendEntry on the chart Legend. + * Represents the height of the legendEntry on the chart legend. * * [Api set: ExcelApi 1.8] */ height?: boolean; /** * - * Represents the index of the LegendEntry in the Chart Legend. + * Represents the index of the legendEntry in the chart legend. * * [Api set: ExcelApi 1.8] */ @@ -46896,14 +46896,14 @@ declare namespace Excel { $all?: boolean; /** * - * For EACH ITEM in the collection: Represents the height of the legendEntry on the chart Legend. + * For EACH ITEM in the collection: Represents the height of the legendEntry on the chart legend. * * [Api set: ExcelApi 1.8] */ height?: boolean; /** * - * For EACH ITEM in the collection: Represents the index of the LegendEntry in the Chart Legend. + * For EACH ITEM in the collection: Represents the index of the legendEntry in the chart legend. * * [Api set: ExcelApi 1.8] */ @@ -48064,7 +48064,7 @@ declare namespace Excel { position?: boolean; /** * - * For EACH ITEM in the collection: Determines whether the data should be sown as a specific summary calculation or not. + * For EACH ITEM in the collection: Determines whether the data should be shown as a specific summary calculation or not. * * [Api set: ExcelApi 1.8] */ @@ -48122,7 +48122,7 @@ declare namespace Excel { position?: boolean; /** * - * Determines whether the data should be sown as a specific summary calculation or not. + * Determines whether the data should be shown as a specific summary calculation or not. * * [Api set: ExcelApi 1.8] */