diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index d42c08296a..d023db1ac5 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -18618,6 +18618,9 @@ declare namespace Excel { constructor(url?: string | Session); readonly workbook: Workbook; readonly application: Application; + /** + * [Api set: ExcelApi 1.5] + */ readonly runtime: Runtime; } interface RunOptions extends OfficeExtension.RunOptions { @@ -18655,18 +18658,6 @@ declare namespace Excel { /** * Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. * - * @remarks - * - * In addition to this signature, the method also has the following signatures: - * - * `run(object: OfficeExtension.ClientObject, batch: (context: Excel.RequestContext) => Promise): Promise;` - * - * `run(objects: OfficeExtension.ClientObject[], batch: (context: Excel.RequestContext) => Promise): Promise;` - * - * `run(options: Excel.RunOptions, batch: (context: Excel.RequestContext) => Promise): Promise;` - * - * `run(batch: (context: Excel.RequestContext) => Promise): Promise;` - * * @param context - A previously-created object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. */ @@ -19185,40 +19176,35 @@ declare namespace Excel { * * Provides information about the row-sorted event and its related worksheet. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface WorksheetRowSortedEventArgs { /** * * Gets the range address that represents the sorted areas of a specific worksheet. Only rows changed as a result of the sort operation are returned. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ address: string; /** * * Gets the source of the event. See Excel.EventSource for details. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ source: Excel.EventSource | "Local" | "Remote"; /** * * Gets the type of the event. See Excel.EventType for details. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ type: "WorksheetRowSorted"; /** * * Gets the id of the worksheet where the sorting happened. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ worksheetId: string; } @@ -19226,40 +19212,35 @@ declare namespace Excel { * * Provides information about the column-sorted event and its related worksheet. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface WorksheetColumnSortedEventArgs { /** * * Gets the range address that represents the sorted areas of a specific worksheet. Only columns changed as a result of the sort operation are returned. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ address: string; /** * * Gets the source of the event. See Excel.EventSource for details. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ source: Excel.EventSource | "Local" | "Remote"; /** * * Gets the type of the event. See Excel.EventType for details. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ type: "WorksheetColumnSorted"; /** * * Gets the id of the worksheet where the sorting happened. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ worksheetId: string; } @@ -19296,48 +19277,42 @@ declare namespace Excel { * * Provides information about the left-clicked/tapped event and its related worksheet. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface WorksheetSingleClickedEventArgs { /** * * Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ address: string; /** * - * The distance, in points, from the left-clicked/tapped point to the left (or right for RTL) gridline edge of the left-clicked/tapped cell. + * The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ offsetX: number; /** * * The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ offsetY: number; /** * * Gets the type of the event. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ type: "WorksheetSingleClicked"; /** * * Gets the id of the worksheet in which the cell was left-clicked/tapped. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ worksheetId: string; } @@ -19579,6 +19554,14 @@ declare namespace Excel { * [Api set: ExcelApi 1.8] */ interface WorksheetCalculatedEventArgs { + /** + * + * The address of the ranges that completed calculation. + If multiple ranges completed calculation, the string is a comma-separated list of those range addresses. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + */ + address: string; /** * * Gets the type of the event. See Excel.EventType for details. @@ -19588,7 +19571,7 @@ declare namespace Excel { type: "WorksheetCalculated"; /** * - * Gets the id of the worksheet that is calculated. + * Gets the id of the worksheet in which the calculation occurred. * * [Api set: ExcelApi 1.8] */ @@ -19797,6 +19780,14 @@ declare namespace Excel { class Application extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; + /** + * + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly cultureInfo: Excel.CultureInfo; /** * * Returns the Iterative Calculation settings. @@ -19827,6 +19818,31 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ readonly calculationState: Excel.CalculationState | "Done" | "Calculating" | "Pending"; + /** + * + * Gets the string used as the decimal separator for numeric values. This is based on Excel's local settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly decimalSeparator: string; + /** + * + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on Excel's local settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly thousandsSeparator: string; + /** + * + * Specifies whether the system separators of Microsoft Excel are enabled. + System separators include the decimal separator and thousands separator. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly useSystemSeparators: boolean; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * * @remarks @@ -19999,8 +20015,7 @@ declare namespace Excel { * * Represents a collection of Comments associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly comments: Excel.CommentCollection; /** @@ -20035,8 +20050,7 @@ declare namespace Excel { * * Represents a collection of PivotTableStyles associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly pivotTableStyles: Excel.PivotTableStyleCollection; /** @@ -20071,16 +20085,14 @@ declare namespace Excel { * * Represents a collection of SlicerStyles associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly slicerStyles: Excel.SlicerStyleCollection; /** * * Represents a collection of Slicers associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly slicers: Excel.SlicerCollection; /** @@ -20094,8 +20106,7 @@ declare namespace Excel { * * Represents a collection of TableStyles associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly tableStyles: Excel.TableStyleCollection; /** @@ -20109,8 +20120,7 @@ declare namespace Excel { * * Represents a collection of TimelineStyles associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly timelineStyles: Excel.TimelineStyleCollection; /** @@ -20245,16 +20255,14 @@ declare namespace Excel { * * Gets the currently active slicer in the workbook. If there is no active slicer, an `ItemNotFound` exception is thrown. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getActiveSlicer(): Excel.Slicer; /** * * Gets the currently active slicer in the workbook. If there is no active slicer, a null object is returned. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getActiveSlicerOrNullObject(): Excel.Slicer; /** @@ -20462,7 +20470,7 @@ declare namespace Excel { readonly autoFilter: Excel.AutoFilter; /** * - * Returns collection of charts that are part of the worksheet. Read-only. + * Returns a collection of charts that are part of the worksheet. Read-only. * * [Api set: ExcelApi 1.1] */ @@ -20471,8 +20479,7 @@ declare namespace Excel { * * Returns a collection of all the Comments objects on the worksheet. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly comments: Excel.CommentCollection; /** @@ -20526,10 +20533,9 @@ declare namespace Excel { readonly shapes: Excel.ShapeCollection; /** * - * Returns collection of slicers that are part of the worksheet. Read-only. + * Returns a collection of slicers that are part of the worksheet. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly slicers: Excel.SlicerCollection; /** @@ -20654,7 +20660,7 @@ declare namespace Excel { calculate(markAllDirty: boolean): void; /** * - * Copies a worksheet and places it at the specified position. + * Copies a worksheet and places it at the specified position. * * [Api set: ExcelApi 1.7] * @@ -20665,7 +20671,7 @@ declare namespace Excel { copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet; /** * - * Copies a worksheet and places it at the specified position. + * Copies a worksheet and places it at the specified position. * * [Api set: ExcelApi 1.7] * @@ -20817,8 +20823,7 @@ declare namespace Excel { The acceptable argument range is between 0 and 8. A value of 0 does not change the current display. A value greater than the current number of levels displays all the levels. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param rowLevels The number of row levels of an outline to display. * @param columnLevels The number of column levels of an outline to display. @@ -20876,10 +20881,9 @@ declare namespace Excel { * * Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @eventproperty - * @beta */ readonly onColumnSorted: OfficeExtension.EventHandlers; /** @@ -20924,10 +20928,9 @@ declare namespace Excel { * * Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @eventproperty - * @beta */ readonly onRowSorted: OfficeExtension.EventHandlers; /** @@ -20941,16 +20944,15 @@ declare namespace Excel { readonly onSelectionChanged: OfficeExtension.EventHandlers; /** * - * Occurs when left-clicked/tapped operation happens in the worksheet. This event will not be fired when clicking in the following cases: - * + * Occurs when a left-clicked/tapped action happens in the worksheet. This event will not be fired when clicking in the following cases: + - The user drags the mouse for multi-selection. - + - The user selects a cell in the mode when cell arguments are selected for formula references. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @eventproperty - * @beta */ readonly onSingleClicked: OfficeExtension.EventHandlers; /** @@ -21120,10 +21122,9 @@ declare namespace Excel { * * Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @eventproperty - * @beta */ readonly onColumnSorted: OfficeExtension.EventHandlers; /** @@ -21177,10 +21178,9 @@ declare namespace Excel { * * Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @eventproperty - * @beta */ readonly onRowSorted: OfficeExtension.EventHandlers; /** @@ -21195,15 +21195,12 @@ declare namespace Excel { /** * * Occurs when left-clicked/tapped operation happens in the worksheet collection. This event will not be fired when clicking in the following cases: - * - The user drags the mouse for multi-selection. - - The user selects a cell in the mode when cell arguments are selected for formula references. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @eventproperty - * @beta */ readonly onSingleClicked: OfficeExtension.EventHandlers; /** @@ -21579,8 +21576,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly height: number; /** @@ -21615,8 +21611,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly left: number; /** @@ -21696,8 +21691,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly top: number; /** @@ -21719,8 +21713,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly width: number; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. @@ -21740,26 +21733,28 @@ declare namespace Excel { /** * * Fills range from the current range to the destination range using the specified AutoFill logic. - The destination range can be null, or can extend the source either horizontally or vertically. - Discontiguous ranges are not supported. - For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + The destination range can be null, or can extend the source either horizontally or vertically. + Discontiguous ranges are not supported. + + For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. * - * [Api set: ExcelApi 1.9, ExcelApi BETA (PREVIEW ONLY) for null `destinationRange`] + * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`] * - * @param destinationRange The destination range to autofill. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). + * @param destinationRange The destination range to autofill. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). * @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". */ autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void; /** * * Fills range from the current range to the destination range using the specified AutoFill logic. - The destination range can be null, or can extend the source either horizontally or vertically. - Discontiguous ranges are not supported. - For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + The destination range can be null, or can extend the source either horizontally or vertically. + Discontiguous ranges are not supported. + + For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. * - * [Api set: ExcelApi 1.9, ExcelApi BETA (PREVIEW ONLY) for null `destinationRange`] + * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`] * - * @param destinationRange The destination range to autofill. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). + * @param destinationRange The destination range to autofill. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). * @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". */ autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void; @@ -22197,8 +22192,7 @@ declare namespace Excel { * * Groups columns and rows for an outline. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param groupOption Specifies how the range can be grouped by rows or columns. An `InvalidArgument` error is thrown when the group option differs from the range's @@ -22210,7 +22204,7 @@ declare namespace Excel { * * Groups columns and rows for an outline. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @param groupOption Specifies how the range can be grouped by rows or columns. An `InvalidArgument` error is thrown when the group option differs from the range's @@ -22222,8 +22216,7 @@ declare namespace Excel { * * Hide details of the row or column group. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param groupOption Specifies whether to hide details of grouped rows or grouped columns. */ @@ -22232,7 +22225,7 @@ declare namespace Excel { * * Hide details of the row or column group. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @param groupOption Specifies whether to hide details of grouped rows or grouped columns. */ @@ -22264,6 +22257,17 @@ declare namespace Excel { * @param across Optional. Set true to merge cells in each row of the specified range as separate merged cells. The default value is false. */ merge(across?: boolean): void; + /** + * + * Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells. + The destination range will be expanded automatically if it is smaller than the current range. Any cells in the destination range that are outside of the original range's area are not changed. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * + * @param destinationRange destinationRange Specifies the range to where the information in this range will be moved. + */ + moveTo(destinationRange: Range | string): void; /** * * Removes duplicate values from the range specified by the columns. @@ -22339,8 +22343,7 @@ declare namespace Excel { * * Show details of the row or column group. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param groupOption Specifies whether to show details of grouped rows or grouped columns. */ @@ -22349,7 +22352,7 @@ declare namespace Excel { * * Show details of the row or column group. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @param groupOption Specifies whether to show details of grouped rows or grouped columns. */ @@ -22358,8 +22361,7 @@ declare namespace Excel { * * Ungroups columns and rows for an outline. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param groupOption Specifies how the range can be ungrouped by rows or columns. */ @@ -22368,7 +22370,7 @@ declare namespace Excel { * * Ungroups columns and rows for an outline. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApi 1.10] * * @param groupOption Specifies how the range can be ungrouped by rows or columns. */ @@ -24428,7 +24430,7 @@ declare namespace Excel { showTotals: boolean; /** * - * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -26440,7 +26442,7 @@ declare namespace Excel { showAxisFieldButtons: boolean; /** * - * Specifies whether or not to display the legend field buttons on a PivotChart + * Specifies whether or not to display the legend field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -26454,7 +26456,7 @@ declare namespace Excel { showReportFilterFieldButtons: boolean; /** * - * Specifies whether or not to display the show value field buttons on a PivotChart + * Specifies whether or not to display the show value field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -31110,6 +31112,112 @@ declare namespace Excel { */ toJSON(): Excel.Interfaces.AutoFilterData; } + /** + * + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + class CultureInfo extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly numberFormatInfo: Excel.NumberFormatInfo; + /** + * + * Gets the culture name in the format languagecode2-country/regioncode2 (e.g. "zh-cn" or "en-us"). This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CultureInfoLoadOptions): Excel.CultureInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CultureInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CultureInfo; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.CultureInfo object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CultureInfoData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CultureInfoData; + } + /** + * + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + class NumberFormatInfo extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Gets the string used as the decimal separator for numeric values. This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly numberDecimalSeparator: string; + /** + * + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly numberGroupSeparator: string; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.NumberFormatInfoLoadOptions): Excel.NumberFormatInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.NumberFormatInfo; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.NumberFormatInfo; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.NumberFormatInfo object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.NumberFormatInfoData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.NumberFormatInfoData; + } /** * * Represents a cell icon. @@ -31604,8 +31712,7 @@ declare namespace Excel { * * Specifies whether the field list can be shown in the UI. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ enableFieldList: boolean; /** @@ -35355,8 +35462,7 @@ declare namespace Excel { * * Represents a collection of TableStyles. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class TableStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -35367,8 +35473,7 @@ declare namespace Excel { * * Creates a blank TableStyle with the specified name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name The unique name for the new TableStyle. Will throw an invalid argument exception if the name is already in use. * @param makeUniqueName Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed. @@ -35379,16 +35484,14 @@ declare namespace Excel { * * Gets the number of table styles in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getCount(): OfficeExtension.ClientResult; /** * * Gets the default TableStyle for the parent object's scope. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * @returns The TableStyle object that is the current default TableStyle. */ getDefault(): Excel.TableStyle; @@ -35396,8 +35499,7 @@ declare namespace Excel { * * Gets a TableStyle by name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name Name of the TableStyle to be retrieved. * @returns The TableStyle object whose name matches the input. @@ -35407,8 +35509,7 @@ declare namespace Excel { * * Gets a TableStyle by name. If the TableStyle does not exist, will return a null object. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name Name of the TableStyle to be retrieved. * @returns The TableStyle object whose name matches the input. @@ -35418,8 +35519,7 @@ declare namespace Excel { * * Sets the default TableStyle for use in the parent object's scope. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param newDefaultStyle The TableStyle object or name of the TableStyle object that should be the new default. */ @@ -35452,8 +35552,7 @@ declare namespace Excel { * * Represents a TableStyle, which defines the style elements by region of the Table. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class TableStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -35462,16 +35561,14 @@ declare namespace Excel { * * Gets the name of the TableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name: string; /** * * Specifies whether this TableStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly readOnly: boolean; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. @@ -35492,16 +35589,14 @@ declare namespace Excel { * * Deletes the TableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ delete(): void; /** * * Creates a duplicate of this TableStyle with copies of all the style elements. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * @returns The new TableStyle object that has been duplicated from this TableStyle. */ duplicate(): Excel.TableStyle; @@ -35536,8 +35631,7 @@ declare namespace Excel { * * Represents a collection of PivotTable styles. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class PivotTableStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -35548,8 +35642,7 @@ declare namespace Excel { * * Creates a blank PivotTableStyle with the specified name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name The unique name for the new PivotTableStyle. Will throw an invalid argument exception if the name is already in use. * @param makeUniqueName Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed. @@ -35560,16 +35653,14 @@ declare namespace Excel { * * Gets the number of PivotTable styles in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getCount(): OfficeExtension.ClientResult; /** * * Gets the default PivotTableStyle for the parent object's scope. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * @returns The PivotTableStyle object that is the current default PivotTableStyle. */ getDefault(): Excel.PivotTableStyle; @@ -35577,8 +35668,7 @@ declare namespace Excel { * * Gets a PivotTableStyle by name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name Name of the PivotTableStyle to be retrieved. * @returns The PivotTableStyle object whose name matches the input. @@ -35588,8 +35678,7 @@ declare namespace Excel { * * Gets a PivotTableStyle by name. If the PivotTableStyle does not exist, will return a null object. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name Name of the PivotTableStyle to be retrieved. * @returns The PivotTableStyle object whose name matches the input. @@ -35599,8 +35688,7 @@ declare namespace Excel { * * Sets the default PivotTableStyle for use in the parent object's scope. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param newDefaultStyle The PivotTableStyle object or name of the PivotTableStyle object that should be the new default. */ @@ -35633,8 +35721,7 @@ declare namespace Excel { * * Represents a PivotTable Style, which defines style elements by PivotTable region. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class PivotTableStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -35643,16 +35730,14 @@ declare namespace Excel { * * Gets the name of the PivotTableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name: string; /** * * Specifies whether this PivotTableStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly readOnly: boolean; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. @@ -35673,16 +35758,14 @@ declare namespace Excel { * * Deletes the PivotTableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ delete(): void; /** * * Creates a duplicate of this PivotTableStyle with copies of all the style elements. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * @returns The new PivotTableStyle object that has been duplicated from this PivotTableStyle. */ duplicate(): Excel.PivotTableStyle; @@ -35717,8 +35800,7 @@ declare namespace Excel { * * Represents a collection of SlicerStyle objects. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class SlicerStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -35729,8 +35811,7 @@ declare namespace Excel { * * Creates a blank SlicerStyle with the specified name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name The unique name for the new SlicerStyle. Will throw an invalid argument exception if the name is already in use. * @param makeUniqueName Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed. @@ -35741,16 +35822,14 @@ declare namespace Excel { * * Gets the number of slicer styles in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getCount(): OfficeExtension.ClientResult; /** * * Gets the default SlicerStyle for the parent object's scope. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * @returns The SlicerStyle object that is the current default SlicerStyle. */ getDefault(): Excel.SlicerStyle; @@ -35758,8 +35837,7 @@ declare namespace Excel { * * Gets a SlicerStyle by name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name Name of the SlicerStyle to be retrieved. * @returns The SlicerStyle object whose name matches the input. @@ -35769,8 +35847,7 @@ declare namespace Excel { * * Gets a SlicerStyle by name. If the SlicerStyle does not exist, will return a null object. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name Name of the SlicerStyle to be retrieved. * @returns The SlicerStyle object whose name matches the input. @@ -35780,8 +35857,7 @@ declare namespace Excel { * * Sets the default SlicerStyle for use in the parent object's scope. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param newDefaultStyle The SlicerStyle object or name of the SlicerStyle object that should be the new default. */ @@ -35814,8 +35890,7 @@ declare namespace Excel { * * Represents a Slicer Style, which defines style elements by region of the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class SlicerStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -35824,16 +35899,14 @@ declare namespace Excel { * * Gets the name of the SlicerStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name: string; /** * * Specifies whether this SlicerStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly readOnly: boolean; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. @@ -35854,16 +35927,14 @@ declare namespace Excel { * * Deletes the SlicerStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ delete(): void; /** * * Creates a duplicate of this SlicerStyle with copies of all the style elements. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * @returns The new SlicerStyle object that has been duplicated from this SlicerStyle. */ duplicate(): Excel.SlicerStyle; @@ -35898,8 +35969,7 @@ declare namespace Excel { * * Represents a collection of TimelineStyles. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class TimelineStyleCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -35910,8 +35980,7 @@ declare namespace Excel { * * Creates a blank TimelineStyle with the specified name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name The unique name for the new TimelineStyle. Will throw an invalid argument exception if the name is already in use. * @param makeUniqueName Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed. @@ -35922,16 +35991,14 @@ declare namespace Excel { * * Gets the number of timeline styles in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getCount(): OfficeExtension.ClientResult; /** * * Gets the default TimelineStyle for the parent object's scope. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * @returns The TimelineStyle object that is the current default TimelineStyle. */ getDefault(): Excel.TimelineStyle; @@ -35939,8 +36006,7 @@ declare namespace Excel { * * Gets a TimelineStyle by name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name Name of the TimelineStyle to be retrieved. * @returns The TimelineStyle object whose name matches the input. @@ -35950,8 +36016,7 @@ declare namespace Excel { * * Gets a TimelineStyle by name. If the TimelineStyle does not exist, will return a null object. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param name Name of the TimelineStyle to be retrieved. * @returns The TimelineStyle object whose name matches the input. @@ -35961,8 +36026,7 @@ declare namespace Excel { * * Sets the default TimelineStyle for use in the parent object's scope. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param newDefaultStyle The TimelineStyle object or name of the TimelineStyle object that should be the new default. */ @@ -35995,8 +36059,7 @@ declare namespace Excel { * * Represents a Timeline style, which defines style elements by region in the Timeline. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class TimelineStyle extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -36005,16 +36068,14 @@ declare namespace Excel { * * Gets the name of the TimelineStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name: string; /** * * Specifies whether this TimelineStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly readOnly: boolean; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. @@ -36035,16 +36096,14 @@ declare namespace Excel { * * Deletes the TableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ delete(): void; /** * * Creates a duplicate of this TimelineStyle with copies of all the style elements. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * @returns The new TimelineStyle object that has been duplicated from this TimelineStyle. */ duplicate(): Excel.TimelineStyle; @@ -36859,8 +36918,7 @@ declare namespace Excel { * * Represents the content contained within a comment or comment reply. Rich content incudes the text string and any other objects contained within the comment body, such as mentions. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface CommentRichContent { /** @@ -36868,7 +36926,6 @@ declare namespace Excel { * An array containing all the entities (e.g. people) mentioned within the comment. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta */ mentions?: Excel.CommentMention[]; richContent: string; @@ -36877,8 +36934,7 @@ declare namespace Excel { * * Represents a collection of comment objects that are part of the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class CommentCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -36889,11 +36945,10 @@ declare namespace Excel { * * Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. - * @param content The comment's content. This can be either a string or CommentRichContent object. Strings are used for plain text. CommentRichContent objects allow for other comment features, such as mentions. [Api set: ExcelApi BETA (PREVIEW ONLY) for string, ExcelApi Preview for CommentRichContent object] + * @param content The comment's content. This can be either a string or CommentRichContent object. Strings are used for plain text. CommentRichContent objects allow for other comment features, such as mentions. [Api set: ExcelApi 1.10 for string, ExcelApi Preview for CommentRichContent object] * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. */ add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment; @@ -36901,11 +36956,10 @@ declare namespace Excel { * * Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. - * @param content The comment's content. This can be either a string or CommentRichContent object. Strings are used for plain text. CommentRichContent objects allow for other comment features, such as mentions. [Api set: ExcelApi BETA (PREVIEW ONLY) for string, ExcelApi Preview for CommentRichContent object] + * @param content The comment's content. This can be either a string or CommentRichContent object. Strings are used for plain text. CommentRichContent objects allow for other comment features, such as mentions. [Api set: ExcelApi 1.10 for string, ExcelApi Preview for CommentRichContent object] * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. */ add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.Comment; @@ -36913,16 +36967,14 @@ declare namespace Excel { * * Gets the number of comments in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getCount(): OfficeExtension.ClientResult; /** * * Gets a comment from the collection based on its ID. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param commentId The identifier for the comment. */ @@ -36931,8 +36983,7 @@ declare namespace Excel { * * Gets a comment from the collection based on its position. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param index Index value of the object to be retrieved. Zero-indexed. */ @@ -36941,8 +36992,7 @@ declare namespace Excel { * * Gets the comment from the specified cell. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param cellAddress The cell which the comment is on. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. */ @@ -36951,8 +37001,7 @@ declare namespace Excel { * * Gets the comment to which the given reply is connected. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param replyId The identifier of comment reply. */ @@ -36985,8 +37034,7 @@ declare namespace Excel { * * Represents a comment in the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class Comment extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -36995,48 +37043,42 @@ declare namespace Excel { * * Represents a collection of reply objects associated with the comment. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly replies: Excel.CommentReplyCollection; /** * * Gets the email of the comment's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly authorEmail: string; /** * * Gets the name of the comment's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly authorName: string; /** * * Gets or sets the comment's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content: string; /** * * Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly creationDate: Date; /** * * Represents the comment identifier. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly id: string; /** @@ -37081,16 +37123,14 @@ declare namespace Excel { * * Deletes the comment and all the connected replies. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ delete(): void; /** * * Gets the cell where this comment is located. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getLocation(): Excel.Range; /** @@ -37134,8 +37174,7 @@ declare namespace Excel { * * Represents a collection of comment reply objects that are part of the comment. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class CommentReplyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -37146,10 +37185,9 @@ declare namespace Excel { * * Creates a comment reply for comment. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * - * @param content The comment's content. This can be either a string or Interface CommentRichContent (e.g. for comments with mentions). [Api set: ExcelApi BETA (PREVIEW ONLY) for string, ExcelApi Preview for CommentRichContent object] + * @param content The comment's content. This can be either a string or Interface CommentRichContent (e.g. for comments with mentions). [Api set: ExcelApi 1.10 for string, ExcelApi Preview for CommentRichContent object] * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. */ add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply; @@ -37157,10 +37195,9 @@ declare namespace Excel { * * Creates a comment reply for comment. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * - * @param content The comment's content. This can be either a string or Interface CommentRichContent (e.g. for comments with mentions). [Api set: ExcelApi BETA (PREVIEW ONLY) for string, ExcelApi Preview for CommentRichContent object] + * @param content The comment's content. This can be either a string or Interface CommentRichContent (e.g. for comments with mentions). [Api set: ExcelApi 1.10 for string, ExcelApi Preview for CommentRichContent object] * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. */ add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply; @@ -37168,16 +37205,14 @@ declare namespace Excel { * * Gets the number of comment replies in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getCount(): OfficeExtension.ClientResult; /** * * Returns a comment reply identified by its ID. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param commentReplyId The identifier for the comment reply. */ @@ -37186,8 +37221,7 @@ declare namespace Excel { * * Gets a comment reply based on its position in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param index The index value of the comment reply to be retrieved. The collection uses zero-based indexing. */ @@ -37220,8 +37254,7 @@ declare namespace Excel { * * Represents a comment reply in the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class CommentReply extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -37230,40 +37263,35 @@ declare namespace Excel { * * Gets the email of the comment reply's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly authorEmail: string; /** * * Gets the name of the comment reply's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly authorName: string; /** * * Gets or sets the comment reply's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content: string; /** * * Gets the creation time of the comment reply. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly creationDate: Date; /** * * Represents the comment reply identifier. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly id: string; /** @@ -37308,24 +37336,21 @@ declare namespace Excel { * * Deletes the comment reply. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ delete(): void; /** * * Gets the cell where this comment reply is located. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getLocation(): Excel.Range; /** * * Gets the parent comment of this reply. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getParentComment(): Excel.Comment; /** @@ -37648,8 +37673,7 @@ declare namespace Excel { * * Represents how the object is attached to the cells below it. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ placement: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; /** @@ -37715,8 +37739,7 @@ declare namespace Excel { * Copies and pastes a Shape object. The pasted shape is copied to the same pixel location as this shape. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param destinationSheet The sheet to which the shape object will be pasted. The default value is the copied Shape's worksheet. */ @@ -38798,8 +38821,7 @@ declare namespace Excel { * * Represents a slicer object in the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class Slicer extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -38808,24 +38830,21 @@ declare namespace Excel { * * Represents the collection of SlicerItems that are part of the slicer. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly slicerItems: Excel.SlicerItemCollection; /** * * Represents the worksheet containing the slicer. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly worksheet: Excel.Worksheet; /** * * Represents the caption of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ caption: string; /** @@ -38833,24 +38852,21 @@ declare namespace Excel { * Represents the height, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ height: number; /** * * Represents the unique id of slicer. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly id: string; /** * * True if all filters currently applied on the slicer are cleared. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly isFilterCleared: boolean; /** @@ -38858,16 +38874,14 @@ declare namespace Excel { * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ left: number; /** * * Represents the name of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name: string; /** @@ -38882,16 +38896,14 @@ declare namespace Excel { * * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; /** * * Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ style: string; /** @@ -38899,8 +38911,7 @@ declare namespace Excel { * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ top: number; /** @@ -38908,8 +38919,7 @@ declare namespace Excel { * Represents the width, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ width: number; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. @@ -38930,24 +38940,21 @@ declare namespace Excel { * * Clears all the filters currently applied on the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ clearFilters(): void; /** * * Deletes the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ delete(): void; /** * * Returns an array of selected items' keys. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getSelectedItems(): OfficeExtension.ClientResult; /** @@ -38955,8 +38962,7 @@ declare namespace Excel { * Selects slicer items based on their keys. The previous selections are cleared. All items will be selected by default if the array is empty. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param items Optional. The specified slicer item names to be selected. */ @@ -38992,8 +38998,7 @@ declare namespace Excel { * * Represents a collection of all the slicer objects on the workbook or a worksheet. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class SlicerCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -39004,8 +39009,7 @@ declare namespace Excel { * * Adds a new slicer to the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param slicerSource The data source that the new slicer will be based on. It can be a PivotTable object, a Table object or a string. When a PivotTable object is passed, the data source is the source of the PivotTable object. When a Table object is passed, the data source is the Table object. When a string is passed, it is interpreted as the name/id of a PivotTable/Table. * @param sourceField The field in the data source to filter by. It can be a PivotField object, a TableColumn object, the id of a PivotField or the id/name of TableColumn. @@ -39017,16 +39021,14 @@ declare namespace Excel { * * Returns the number of slicers in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getCount(): OfficeExtension.ClientResult; /** * * Gets a slicer object using its name or id. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param key The name or id of the slicer. */ @@ -39035,8 +39037,7 @@ declare namespace Excel { * * Gets a slicer based on its position in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param index Index value of the object to be retrieved. Zero-indexed. */ @@ -39045,8 +39046,7 @@ declare namespace Excel { * * Gets a slicer using its name or id. If the slicer does not exist, will return a null object. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param key Name or Id of the slicer to be retrieved. */ @@ -39079,8 +39079,7 @@ declare namespace Excel { * * Represents a slicer item in a slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class SlicerItem extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -39089,8 +39088,7 @@ declare namespace Excel { * * True if the slicer item has data. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly hasData: boolean; /** @@ -39099,24 +39097,21 @@ declare namespace Excel { Setting this value will not clear other SlicerItems' selected state. By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ isSelected: boolean; /** * * Represents the unique value representing the slicer item. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly key: string; /** * * Represents the title displayed in the UI. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readonly name: string; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. @@ -39164,8 +39159,7 @@ declare namespace Excel { * * Represents a collection of all the slicer item objects on the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ class SlicerItemCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -39176,16 +39170,14 @@ declare namespace Excel { * * Returns the number of slicer items in the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ getCount(): OfficeExtension.ClientResult; /** * * Gets a slicer item object using its key or name. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param key The key or name of the slicer item. */ @@ -39194,8 +39186,7 @@ declare namespace Excel { * * Gets a slicer item based on its position in the collection. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param index Index value of the object to be retrieved. Zero-indexed. */ @@ -39204,8 +39195,7 @@ declare namespace Excel { * * Gets a slicer item using its key or name. If the slicer item does not exist, will return a null object. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] * * @param key Key or name of the slicer to be retrieved. */ @@ -41389,8 +41379,7 @@ declare namespace Excel { flashFill = "FlashFill" } /** - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ enum GroupOption { /** @@ -41619,8 +41608,7 @@ declare namespace Excel { curve = "Curve" } /** - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ enum ContentType { /** @@ -42003,8 +41991,7 @@ declare namespace Excel { * * Specifies the slicer sort behavior for Slicer.sortBy API. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ enum SlicerSortType { /** @@ -46331,7 +46318,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -46878,7 +46865,7 @@ declare namespace Excel { showAxisFieldButtons?: boolean; /** * - * Specifies whether or not to display the legend field buttons on a PivotChart + * Specifies whether or not to display the legend field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -46892,7 +46879,7 @@ declare namespace Excel { showReportFilterFieldButtons?: boolean; /** * - * Specifies whether or not to display the show value field buttons on a PivotChart + * Specifies whether or not to display the show value field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -48700,8 +48687,7 @@ declare namespace Excel { * * Specifies whether the field list can be shown in the UI. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ enableFieldList?: boolean; /** @@ -49693,8 +49679,7 @@ declare namespace Excel { * * Gets the name of the TableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; } @@ -49708,8 +49693,7 @@ declare namespace Excel { * * Gets the name of the PivotTableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; } @@ -49723,8 +49707,7 @@ declare namespace Excel { * * Gets the name of the SlicerStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; } @@ -49738,8 +49721,7 @@ declare namespace Excel { * * Gets the name of the TimelineStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; } @@ -50008,8 +49990,7 @@ declare namespace Excel { * * Gets or sets the comment's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content?: string; /** @@ -50031,8 +50012,7 @@ declare namespace Excel { * * Gets or sets the comment reply's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content?: string; } @@ -50111,8 +50091,7 @@ declare namespace Excel { * * Represents how the object is attached to the cells below it. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; /** @@ -50412,16 +50391,14 @@ declare namespace Excel { * * Represents the worksheet containing the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ worksheet?: Excel.Interfaces.WorksheetUpdateData; /** * * Represents the caption of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ caption?: string; /** @@ -50429,8 +50406,7 @@ declare namespace Excel { * Represents the height, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ height?: number; /** @@ -50438,16 +50414,14 @@ declare namespace Excel { * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ left?: number; /** * * Represents the name of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; /** @@ -50462,16 +50436,14 @@ declare namespace Excel { * * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; /** * * Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ style?: string; /** @@ -50479,8 +50451,7 @@ declare namespace Excel { * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ top?: number; /** @@ -50488,8 +50459,7 @@ declare namespace Excel { * Represents the width, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ width?: number; } @@ -50505,8 +50475,7 @@ declare namespace Excel { Setting this value will not clear other SlicerItems' selected state. By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ isSelected?: boolean; } @@ -50526,6 +50495,14 @@ declare namespace Excel { } /** An interface describing the data returned by calling `application.toJSON()`. */ interface ApplicationData { + /** + * + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cultureInfo?: Excel.Interfaces.CultureInfoData; /** * * Returns the Iterative Calculation settings. @@ -50556,6 +50533,31 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ calculationState?: Excel.CalculationState | "Done" | "Calculating" | "Pending"; + /** + * + * Gets the string used as the decimal separator for numeric values. This is based on Excel's local settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + decimalSeparator?: string; + /** + * + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on Excel's local settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + thousandsSeparator?: string; + /** + * + * Specifies whether the system separators of Microsoft Excel are enabled. + System separators include the decimal separator and thousands separator. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + useSystemSeparators?: boolean; } /** An interface describing the data returned by calling `iterativeCalculation.toJSON()`. */ interface IterativeCalculationData { @@ -50594,8 +50596,7 @@ declare namespace Excel { * * Represents a collection of Comments associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ comments?: Excel.Interfaces.CommentData[]; /** @@ -50616,8 +50617,7 @@ declare namespace Excel { * * Represents a collection of PivotTableStyles associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ pivotTableStyles?: Excel.Interfaces.PivotTableStyleData[]; /** @@ -50652,16 +50652,14 @@ declare namespace Excel { * * Represents a collection of SlicerStyles associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ slicerStyles?: Excel.Interfaces.SlicerStyleData[]; /** * * Represents a collection of Slicers associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ slicers?: Excel.Interfaces.SlicerData[]; /** @@ -50675,8 +50673,7 @@ declare namespace Excel { * * Represents a collection of TableStyles associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ tableStyles?: Excel.Interfaces.TableStyleData[]; /** @@ -50690,8 +50687,7 @@ declare namespace Excel { * * Represents a collection of TimelineStyles associated with the workbook. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ timelineStyles?: Excel.Interfaces.TimelineStyleData[]; /** @@ -50793,7 +50789,7 @@ declare namespace Excel { autoFilter?: Excel.Interfaces.AutoFilterData; /** * - * Returns collection of charts that are part of the worksheet. Read-only. + * Returns a collection of charts that are part of the worksheet. Read-only. * * [Api set: ExcelApi 1.1] */ @@ -50802,8 +50798,7 @@ declare namespace Excel { * * Returns a collection of all the Comments objects on the worksheet. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ comments?: Excel.Interfaces.CommentData[]; /** @@ -50850,10 +50845,9 @@ declare namespace Excel { shapes?: Excel.Interfaces.ShapeData[]; /** * - * Returns collection of slicers that are part of the worksheet. Read-only. + * Returns a collection of slicers that are part of the worksheet. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ slicers?: Excel.Interfaces.SlicerData[]; /** @@ -51071,8 +51065,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ height?: number; /** @@ -51107,8 +51100,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ left?: number; /** @@ -51188,8 +51180,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ top?: number; /** @@ -51211,8 +51202,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ width?: number; } @@ -51621,7 +51611,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -52242,7 +52232,7 @@ declare namespace Excel { showAxisFieldButtons?: boolean; /** * - * Specifies whether or not to display the legend field buttons on a PivotChart + * Specifies whether or not to display the legend field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -52256,7 +52246,7 @@ declare namespace Excel { showReportFilterFieldButtons?: boolean; /** * - * Specifies whether or not to display the show value field buttons on a PivotChart + * Specifies whether or not to display the show value field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -54234,6 +54224,44 @@ declare namespace Excel { */ isDataFiltered?: boolean; } + /** An interface describing the data returned by calling `cultureInfo.toJSON()`. */ + interface CultureInfoData { + /** + * + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + numberFormatInfo?: Excel.Interfaces.NumberFormatInfoData; + /** + * + * Gets the culture name in the format languagecode2-country/regioncode2 (e.g. "zh-cn" or "en-us"). This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + } + /** An interface describing the data returned by calling `numberFormatInfo.toJSON()`. */ + interface NumberFormatInfoData { + /** + * + * Gets the string used as the decimal separator for numeric values. This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + numberDecimalSeparator?: string; + /** + * + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + numberGroupSeparator?: string; + } /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ interface CustomXmlPartScopedCollectionData { items?: Excel.Interfaces.CustomXmlPartData[]; @@ -54342,8 +54370,7 @@ declare namespace Excel { * * Specifies whether the field list can be shown in the UI. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ enableFieldList?: boolean; /** @@ -55454,16 +55481,14 @@ declare namespace Excel { * * Gets the name of the TableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; /** * * Specifies whether this TableStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -55477,16 +55502,14 @@ declare namespace Excel { * * Gets the name of the PivotTableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; /** * * Specifies whether this PivotTableStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -55500,16 +55523,14 @@ declare namespace Excel { * * Gets the name of the SlicerStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; /** * * Specifies whether this SlicerStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -55523,16 +55544,14 @@ declare namespace Excel { * * Gets the name of the TimelineStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; /** * * Specifies whether this TimelineStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -55818,48 +55837,42 @@ declare namespace Excel { * * Represents a collection of reply objects associated with the comment. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ replies?: Excel.Interfaces.CommentReplyData[]; /** * * Gets the email of the comment's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorEmail?: string; /** * * Gets the name of the comment's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorName?: string; /** * * Gets or sets the comment's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content?: string; /** * * Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ creationDate?: Date; /** * * Represents the comment identifier. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: string; /** @@ -55897,40 +55910,35 @@ declare namespace Excel { * * Gets the email of the comment reply's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorEmail?: string; /** * * Gets the name of the comment reply's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorName?: string; /** * * Gets or sets the comment reply's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content?: string; /** * * Gets the creation time of the comment reply. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ creationDate?: Date; /** * * Represents the comment reply identifier. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: string; /** @@ -56054,8 +56062,7 @@ declare namespace Excel { * * Represents how the object is attached to the cells below it. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; /** @@ -56462,24 +56469,21 @@ declare namespace Excel { * * Represents the collection of SlicerItems that are part of the slicer. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ slicerItems?: Excel.Interfaces.SlicerItemData[]; /** * * Represents the worksheet containing the slicer. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ worksheet?: Excel.Interfaces.WorksheetData; /** * * Represents the caption of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ caption?: string; /** @@ -56487,24 +56491,21 @@ declare namespace Excel { * Represents the height, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ height?: number; /** * * Represents the unique id of slicer. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: string; /** * * True if all filters currently applied on the slicer are cleared. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ isFilterCleared?: boolean; /** @@ -56512,16 +56513,14 @@ declare namespace Excel { * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ left?: number; /** * * Represents the name of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; /** @@ -56536,16 +56535,14 @@ declare namespace Excel { * * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; /** * * Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ style?: string; /** @@ -56553,8 +56550,7 @@ declare namespace Excel { * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ top?: number; /** @@ -56562,8 +56558,7 @@ declare namespace Excel { * Represents the width, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ width?: number; } @@ -56577,8 +56572,7 @@ declare namespace Excel { * * True if the slicer item has data. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ hasData?: boolean; /** @@ -56587,24 +56581,21 @@ declare namespace Excel { Setting this value will not clear other SlicerItems' selected state. By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ isSelected?: boolean; /** * * Represents the unique value representing the slicer item. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ key?: string; /** * * Represents the title displayed in the UI. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: string; } @@ -56661,6 +56652,14 @@ declare namespace Excel { $all?: boolean; /** * + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + cultureInfo?: Excel.Interfaces.CultureInfoLoadOptions; + /** + * * Returns the Iterative Calculation settings. In Excel on Windows and Mac, the settings will apply to the Excel Application. In Excel on the web and other platforms, the settings will apply to the active workbook. @@ -56689,6 +56688,31 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ calculationState?: boolean; + /** + * + * Gets the string used as the decimal separator for numeric values. This is based on Excel's local settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + decimalSeparator?: boolean; + /** + * + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on Excel's local settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + thousandsSeparator?: boolean; + /** + * + * Specifies whether the system separators of Microsoft Excel are enabled. + System separators include the decimal separator and thousands separator. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + useSystemSeparators?: boolean; } /** * @@ -56878,7 +56902,7 @@ declare namespace Excel { autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; /** * - * Returns collection of charts that are part of the worksheet. + * Returns a collection of charts that are part of the worksheet. * * [Api set: ExcelApi 1.1] */ @@ -57001,7 +57025,7 @@ declare namespace Excel { autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; /** * - * For EACH ITEM in the collection: Returns collection of charts that are part of the worksheet. + * For EACH ITEM in the collection: Returns a collection of charts that are part of the worksheet. * * [Api set: ExcelApi 1.1] */ @@ -57244,8 +57268,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ height?: boolean; /** @@ -57280,8 +57303,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ left?: boolean; /** @@ -57361,8 +57383,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ top?: boolean; /** @@ -57384,8 +57405,7 @@ declare namespace Excel { * * Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ width?: boolean; } @@ -58064,7 +58084,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * For EACH ITEM in the collection: Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * For EACH ITEM in the collection: Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -58188,7 +58208,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * For EACH ITEM in the collection: Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * For EACH ITEM in the collection: Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -58313,7 +58333,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -59341,7 +59361,7 @@ declare namespace Excel { showAxisFieldButtons?: boolean; /** * - * Specifies whether or not to display the legend field buttons on a PivotChart + * Specifies whether or not to display the legend field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -59355,7 +59375,7 @@ declare namespace Excel { showReportFilterFieldButtons?: boolean; /** * - * Specifies whether or not to display the show value field buttons on a PivotChart + * Specifies whether or not to display the show value field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -62200,6 +62220,64 @@ declare namespace Excel { */ isDataFiltered?: boolean; } + /** + * + * Provides information based on current system culture settings. This includes the culture names, number formatting, and other culturally dependent settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CultureInfoLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + numberFormatInfo?: Excel.Interfaces.NumberFormatInfoLoadOptions; + /** + * + * Gets the culture name in the format languagecode2-country/regioncode2 (e.g. "zh-cn" or "en-us"). This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + } + /** + * + * Defines the culturally appropriate format of displaying numbers. This is based on current system culture settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface NumberFormatInfoLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Gets the string used as the decimal separator for numeric values. This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + numberDecimalSeparator?: boolean; + /** + * + * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on current system settings. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + numberGroupSeparator?: boolean; + } /** * * A scoped collection of custom XML parts. @@ -62411,8 +62489,7 @@ declare namespace Excel { * * Specifies whether the field list can be shown in the UI. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ enableFieldList?: boolean; /** @@ -64310,8 +64387,7 @@ declare namespace Excel { * * Represents a collection of TableStyles. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface TableStyleCollectionLoadOptions { /** @@ -64322,16 +64398,14 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the name of the TableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** * * For EACH ITEM in the collection: Specifies whether this TableStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -64339,8 +64413,7 @@ declare namespace Excel { * * Represents a TableStyle, which defines the style elements by region of the Table. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface TableStyleLoadOptions { /** @@ -64351,16 +64424,14 @@ declare namespace Excel { * * Gets the name of the TableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** * * Specifies whether this TableStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -64368,8 +64439,7 @@ declare namespace Excel { * * Represents a collection of PivotTable styles. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface PivotTableStyleCollectionLoadOptions { /** @@ -64380,16 +64450,14 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the name of the PivotTableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** * * For EACH ITEM in the collection: Specifies whether this PivotTableStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -64397,8 +64465,7 @@ declare namespace Excel { * * Represents a PivotTable Style, which defines style elements by PivotTable region. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface PivotTableStyleLoadOptions { /** @@ -64409,16 +64476,14 @@ declare namespace Excel { * * Gets the name of the PivotTableStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** * * Specifies whether this PivotTableStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -64426,8 +64491,7 @@ declare namespace Excel { * * Represents a collection of SlicerStyle objects. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface SlicerStyleCollectionLoadOptions { /** @@ -64438,16 +64502,14 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the name of the SlicerStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** * * For EACH ITEM in the collection: Specifies whether this SlicerStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -64455,8 +64517,7 @@ declare namespace Excel { * * Represents a Slicer Style, which defines style elements by region of the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface SlicerStyleLoadOptions { /** @@ -64467,16 +64528,14 @@ declare namespace Excel { * * Gets the name of the SlicerStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** * * Specifies whether this SlicerStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -64484,8 +64543,7 @@ declare namespace Excel { * * Represents a collection of TimelineStyles. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface TimelineStyleCollectionLoadOptions { /** @@ -64496,16 +64554,14 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the name of the TimelineStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** * * For EACH ITEM in the collection: Specifies whether this TimelineStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -64513,8 +64569,7 @@ declare namespace Excel { * * Represents a Timeline style, which defines style elements by region in the Timeline. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface TimelineStyleLoadOptions { /** @@ -64525,16 +64580,14 @@ declare namespace Excel { * * Gets the name of the TimelineStyle. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** * * Specifies whether this TimelineStyle object is read-only. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ readOnly?: boolean; } @@ -64961,8 +65014,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ height?: boolean; /** @@ -64997,8 +65049,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ left?: boolean; /** @@ -65078,8 +65129,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ top?: boolean; /** @@ -65101,8 +65151,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ width?: boolean; } @@ -65110,8 +65159,7 @@ declare namespace Excel { * * Represents a collection of comment objects that are part of the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface CommentCollectionLoadOptions { /** @@ -65122,40 +65170,35 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the email of the comment's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorEmail?: boolean; /** * * For EACH ITEM in the collection: Gets the name of the comment's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorName?: boolean; /** * * For EACH ITEM in the collection: Gets or sets the comment's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content?: boolean; /** * * For EACH ITEM in the collection: Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ creationDate?: boolean; /** * * For EACH ITEM in the collection: Represents the comment identifier. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: boolean; /** @@ -65187,8 +65230,7 @@ declare namespace Excel { * * Represents a comment in the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface CommentLoadOptions { /** @@ -65199,40 +65241,35 @@ declare namespace Excel { * * Gets the email of the comment's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorEmail?: boolean; /** * * Gets the name of the comment's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorName?: boolean; /** * * Gets or sets the comment's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content?: boolean; /** * * Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ creationDate?: boolean; /** * * Represents the comment identifier. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: boolean; /** @@ -65264,8 +65301,7 @@ declare namespace Excel { * * Represents a collection of comment reply objects that are part of the comment. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface CommentReplyCollectionLoadOptions { /** @@ -65276,40 +65312,35 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the email of the comment reply's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorEmail?: boolean; /** * * For EACH ITEM in the collection: Gets the name of the comment reply's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorName?: boolean; /** * * For EACH ITEM in the collection: Gets or sets the comment reply's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content?: boolean; /** * * For EACH ITEM in the collection: Gets the creation time of the comment reply. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ creationDate?: boolean; /** * * For EACH ITEM in the collection: Represents the comment reply identifier. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: boolean; /** @@ -65341,8 +65372,7 @@ declare namespace Excel { * * Represents a comment reply in the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface CommentReplyLoadOptions { /** @@ -65353,40 +65383,35 @@ declare namespace Excel { * * Gets the email of the comment reply's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorEmail?: boolean; /** * * Gets the name of the comment reply's author. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ authorName?: boolean; /** * * Gets or sets the comment reply's content. The string is plain text. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ content?: boolean; /** * * Gets the creation time of the comment reply. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ creationDate?: boolean; /** * * Represents the comment reply identifier. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: boolean; /** @@ -65557,8 +65582,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Represents how the object is attached to the cells below it. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ placement?: boolean; /** @@ -65750,8 +65774,7 @@ declare namespace Excel { * * Represents how the object is attached to the cells below it. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ placement?: boolean; /** @@ -66027,8 +66050,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Represents how the object is attached to the cells below it. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ placement?: boolean; /** @@ -66467,8 +66489,7 @@ declare namespace Excel { * * Represents a slicer object in the workbook. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface SlicerLoadOptions { /** @@ -66479,16 +66500,14 @@ declare namespace Excel { * * Represents the worksheet containing the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ worksheet?: Excel.Interfaces.WorksheetLoadOptions; /** * * Represents the caption of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ caption?: boolean; /** @@ -66496,24 +66515,21 @@ declare namespace Excel { * Represents the height, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ height?: boolean; /** * * Represents the unique id of slicer. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: boolean; /** * * True if all filters currently applied on the slicer are cleared. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ isFilterCleared?: boolean; /** @@ -66521,16 +66537,14 @@ declare namespace Excel { * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ left?: boolean; /** * * Represents the name of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** @@ -66545,16 +66559,14 @@ declare namespace Excel { * * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ sortBy?: boolean; /** * * Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ style?: boolean; /** @@ -66562,8 +66574,7 @@ declare namespace Excel { * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ top?: boolean; /** @@ -66571,8 +66582,7 @@ declare namespace Excel { * Represents the width, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ width?: boolean; } @@ -66580,8 +66590,7 @@ declare namespace Excel { * * Represents a collection of all the slicer objects on the workbook or a worksheet. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface SlicerCollectionLoadOptions { /** @@ -66592,16 +66601,14 @@ declare namespace Excel { * * For EACH ITEM in the collection: Represents the worksheet containing the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ worksheet?: Excel.Interfaces.WorksheetLoadOptions; /** * * For EACH ITEM in the collection: Represents the caption of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ caption?: boolean; /** @@ -66609,24 +66616,21 @@ declare namespace Excel { * For EACH ITEM in the collection: Represents the height, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ height?: boolean; /** * * For EACH ITEM in the collection: Represents the unique id of slicer. Read-only. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ id?: boolean; /** * * For EACH ITEM in the collection: True if all filters currently applied on the slicer are cleared. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ isFilterCleared?: boolean; /** @@ -66634,16 +66638,14 @@ declare namespace Excel { * For EACH ITEM in the collection: Represents the distance, in points, from the left side of the slicer to the left of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ left?: boolean; /** * * For EACH ITEM in the collection: Represents the name of slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; /** @@ -66658,16 +66660,14 @@ declare namespace Excel { * * For EACH ITEM in the collection: Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ sortBy?: boolean; /** * * For EACH ITEM in the collection: Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ style?: boolean; /** @@ -66675,8 +66675,7 @@ declare namespace Excel { * For EACH ITEM in the collection: Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ top?: boolean; /** @@ -66684,8 +66683,7 @@ declare namespace Excel { * For EACH ITEM in the collection: Represents the width, in points, of the slicer. Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ width?: boolean; } @@ -66693,8 +66691,7 @@ declare namespace Excel { * * Represents a slicer item in a slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface SlicerItemLoadOptions { /** @@ -66705,8 +66702,7 @@ declare namespace Excel { * * True if the slicer item has data. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ hasData?: boolean; /** @@ -66715,24 +66711,21 @@ declare namespace Excel { Setting this value will not clear other SlicerItems' selected state. By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ isSelected?: boolean; /** * * Represents the unique value representing the slicer item. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ key?: boolean; /** * * Represents the title displayed in the UI. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; } @@ -66740,8 +66733,7 @@ declare namespace Excel { * * Represents a collection of all the slicer item objects on the slicer. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ interface SlicerItemCollectionLoadOptions { /** @@ -66752,8 +66744,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: True if the slicer item has data. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ hasData?: boolean; /** @@ -66762,24 +66753,21 @@ declare namespace Excel { Setting this value will not clear other SlicerItems' selected state. By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ isSelected?: boolean; /** * * For EACH ITEM in the collection: Represents the unique value representing the slicer item. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ key?: boolean; /** * * For EACH ITEM in the collection: Represents the title displayed in the UI. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApi 1.10] */ name?: boolean; } diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 7d40fe94d7..014b071c39 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -16367,6 +16367,9 @@ declare namespace Excel { constructor(url?: string | Session); readonly workbook: Workbook; readonly application: Application; + /** + * [Api set: ExcelApi 1.5] + */ readonly runtime: Runtime; } interface RunOptions extends OfficeExtension.RunOptions { @@ -16404,18 +16407,6 @@ declare namespace Excel { /** * Executes a batch script that performs actions on the Excel object model, using the RequestContext of a previously-created object. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released. * - * @remarks - * - * In addition to this signature, the method also has the following signatures: - * - * `run(object: OfficeExtension.ClientObject, batch: (context: Excel.RequestContext) => Promise): Promise;` - * - * `run(objects: OfficeExtension.ClientObject[], batch: (context: Excel.RequestContext) => Promise): Promise;` - * - * `run(options: Excel.RunOptions, batch: (context: Excel.RequestContext) => Promise): Promise;` - * - * `run(batch: (context: Excel.RequestContext) => Promise): Promise;` - * * @param context - A previously-created object. The batch will use the same RequestContext as the passed-in object, which means that any changes applied to the object will be picked up by "context.sync()". * @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in. */ @@ -16790,6 +16781,78 @@ declare namespace Excel { */ worksheetId: string; } + /** + * + * Provides information about the row-sorted event and its related worksheet. + * + * [Api set: ExcelApi 1.10] + */ + interface WorksheetRowSortedEventArgs { + /** + * + * Gets the range address that represents the sorted areas of a specific worksheet. Only rows changed as a result of the sort operation are returned. + * + * [Api set: ExcelApi 1.10] + */ + address: string; + /** + * + * Gets the source of the event. See Excel.EventSource for details. + * + * [Api set: ExcelApi 1.10] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * + * Gets the type of the event. See Excel.EventType for details. + * + * [Api set: ExcelApi 1.10] + */ + type: "WorksheetRowSorted"; + /** + * + * Gets the id of the worksheet where the sorting happened. + * + * [Api set: ExcelApi 1.10] + */ + worksheetId: string; + } + /** + * + * Provides information about the column-sorted event and its related worksheet. + * + * [Api set: ExcelApi 1.10] + */ + interface WorksheetColumnSortedEventArgs { + /** + * + * Gets the range address that represents the sorted areas of a specific worksheet. Only columns changed as a result of the sort operation are returned. + * + * [Api set: ExcelApi 1.10] + */ + address: string; + /** + * + * Gets the source of the event. See Excel.EventSource for details. + * + * [Api set: ExcelApi 1.10] + */ + source: Excel.EventSource | "Local" | "Remote"; + /** + * + * Gets the type of the event. See Excel.EventType for details. + * + * [Api set: ExcelApi 1.10] + */ + type: "WorksheetColumnSorted"; + /** + * + * Gets the id of the worksheet where the sorting happened. + * + * [Api set: ExcelApi 1.10] + */ + worksheetId: string; + } /** * * Provides information about the worksheet that raised the SelectionChanged event. @@ -16819,6 +16882,49 @@ declare namespace Excel { */ worksheetId: string; } + /** + * + * Provides information about the left-clicked/tapped event and its related worksheet. + * + * [Api set: ExcelApi 1.10] + */ + interface WorksheetSingleClickedEventArgs { + /** + * + * Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet. + * + * [Api set: ExcelApi 1.10] + */ + address: string; + /** + * + * The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell. + * + * [Api set: ExcelApi 1.10] + */ + offsetX: number; + /** + * + * The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell. + * + * [Api set: ExcelApi 1.10] + */ + offsetY: number; + /** + * + * Gets the type of the event. + * + * [Api set: ExcelApi 1.10] + */ + type: "WorksheetSingleClicked"; + /** + * + * Gets the id of the worksheet in which the cell was left-clicked/tapped. + * + * [Api set: ExcelApi 1.10] + */ + worksheetId: string; + } /** * * Provides information about the table that raised the SelectionChanged event. @@ -17066,7 +17172,7 @@ declare namespace Excel { type: "WorksheetCalculated"; /** * - * Gets the id of the worksheet that is calculated. + * Gets the id of the worksheet in which the calculation occurred. * * [Api set: ExcelApi 1.8] */ @@ -17473,6 +17579,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ readonly bindings: Excel.BindingCollection; + /** + * + * Represents a collection of Comments associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly comments: Excel.CommentCollection; /** * * Represents the collection of custom XML parts contained by this workbook. Read-only. @@ -17501,6 +17614,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ readonly names: Excel.NamedItemCollection; + /** + * + * Represents a collection of PivotTableStyles associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly pivotTableStyles: Excel.PivotTableStyleCollection; /** * * Represents a collection of PivotTables associated with the workbook. Read-only. @@ -17529,6 +17649,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.4] */ readonly settings: Excel.SettingCollection; + /** + * + * Represents a collection of SlicerStyles associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly slicerStyles: Excel.SlicerStyleCollection; + /** + * + * Represents a collection of Slicers associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly slicers: Excel.SlicerCollection; /** * * Represents a collection of styles associated with the workbook. Read-only. @@ -17536,6 +17670,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ readonly styles: Excel.StyleCollection; + /** + * + * Represents a collection of TableStyles associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly tableStyles: Excel.TableStyleCollection; /** * * Represents a collection of tables associated with the workbook. Read-only. @@ -17543,6 +17684,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ readonly tables: Excel.TableCollection; + /** + * + * Represents a collection of TimelineStyles associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly timelineStyles: Excel.TimelineStyleCollection; /** * * Represents a collection of worksheets associated with the workbook. Read-only. @@ -17644,6 +17792,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ getActiveChartOrNullObject(): Excel.Chart; + /** + * + * Gets the currently active slicer in the workbook. If there is no active slicer, an `ItemNotFound` exception is thrown. + * + * [Api set: ExcelApi 1.10] + */ + getActiveSlicer(): Excel.Slicer; + /** + * + * Gets the currently active slicer in the workbook. If there is no active slicer, a null object is returned. + * + * [Api set: ExcelApi 1.10] + */ + getActiveSlicerOrNullObject(): Excel.Slicer; /** * * True if the workbook is being edited by multiple users (co-authoring). @@ -17821,11 +17983,18 @@ declare namespace Excel { readonly autoFilter: Excel.AutoFilter; /** * - * Returns collection of charts that are part of the worksheet. Read-only. + * Returns a collection of charts that are part of the worksheet. Read-only. * * [Api set: ExcelApi 1.1] */ readonly charts: Excel.ChartCollection; + /** + * + * Returns a collection of all the Comments objects on the worksheet. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly comments: Excel.CommentCollection; /** * * Gets an object that can be used to manipulate frozen panes on the worksheet. Read-only. @@ -17875,6 +18044,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ readonly shapes: Excel.ShapeCollection; + /** + * + * Returns a collection of slicers that are part of the worksheet. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly slicers: Excel.SlicerCollection; /** * * Collection of tables that are part of the worksheet. Read-only. @@ -17997,8 +18173,8 @@ declare namespace Excel { calculate(markAllDirty: boolean): void; /** * - * Copies a worksheet and places it at the specified position. - * + * Copies a worksheet and places it at the specified position. + * * [Api set: ExcelApi 1.7] * * @param positionType The location in the workbook to place the newly created worksheet. The default value is "None", which inserts the worksheet at the beginning of the worksheet. @@ -18008,8 +18184,8 @@ declare namespace Excel { copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet; /** * - * Copies a worksheet and places it at the specified position. - * + * Copies a worksheet and places it at the specified position. + * * [Api set: ExcelApi 1.7] * * @param positionType The location in the workbook to place the newly created worksheet. The default value is "None", which inserts the worksheet at the beginning of the worksheet. @@ -18152,6 +18328,20 @@ declare namespace Excel { * @returns The number of replacements performed. */ replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult; + /** + * + * Shows row or column groups by their outline levels. + Outlines group and summarize a list of data in the worksheet. + The `rowLevels` and `columnLevels` parameters specify how many levels of the outline will be displayed. + The acceptable argument range is between 0 and 8. + A value of 0 does not change the current display. A value greater than the current number of levels displays all the levels. + * + * [Api set: ExcelApi 1.10] + * + * @param rowLevels The number of row levels of an outline to display. + * @param columnLevels The number of column levels of an outline to display. + */ + showOutlineLevels(rowLevels: number, columnLevels: number): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -18200,6 +18390,15 @@ declare namespace Excel { * @eventproperty */ readonly onChanged: OfficeExtension.EventHandlers; + /** + * + * Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. + * + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onColumnSorted: OfficeExtension.EventHandlers; /** * * Occurs when the worksheet is deactivated. @@ -18218,6 +18417,15 @@ declare namespace Excel { * @eventproperty */ readonly onFormatChanged: OfficeExtension.EventHandlers; + /** + * + * Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. + * + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onRowSorted: OfficeExtension.EventHandlers; /** * * Occurs when the selection changes on a specific worksheet. @@ -18227,6 +18435,19 @@ declare namespace Excel { * @eventproperty */ readonly onSelectionChanged: OfficeExtension.EventHandlers; + /** + * + * Occurs when a left-clicked/tapped action happens in the worksheet. This event will not be fired when clicking in the following cases: + + - The user drags the mouse for multi-selection. + + - The user selects a cell in the mode when cell arguments are selected for formula references. + * + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onSingleClicked: OfficeExtension.EventHandlers; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) * Whereas the original Excel.Worksheet object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetData`) that contains shallow copies of any loaded child properties from the original object. @@ -18359,6 +18580,15 @@ declare namespace Excel { * @eventproperty */ readonly onChanged: OfficeExtension.EventHandlers; + /** + * + * Occurs when one or more columns have been sorted. This happens as the result of a left-to-right sort operation. + * + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onColumnSorted: OfficeExtension.EventHandlers; /** * * Occurs when any worksheet in the workbook is deactivated. @@ -18386,6 +18616,15 @@ declare namespace Excel { * @eventproperty */ readonly onFormatChanged: OfficeExtension.EventHandlers; + /** + * + * Occurs when one or more rows have been sorted. This happens as the result of a top-to-bottom sort operation. + * + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onRowSorted: OfficeExtension.EventHandlers; /** * * Occurs when the selection changes on any worksheet. @@ -18395,6 +18634,17 @@ declare namespace Excel { * @eventproperty */ readonly onSelectionChanged: OfficeExtension.EventHandlers; + /** + * + * Occurs when left-clicked/tapped operation happens in the worksheet collection. This event will not be fired when clicking in the following cases: + - The user drags the mouse for multi-selection. + - The user selects a cell in the mode when cell arguments are selected for formula references. + * + * [Api set: ExcelApi 1.10] + * + * @eventproperty + */ + readonly onSingleClicked: OfficeExtension.EventHandlers; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) * Whereas the original `Excel.WorksheetCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. @@ -18754,6 +19004,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ formulasR1C1: any[][]; + /** + * + * Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly height: number; /** * * Represents if all cells of the current range are hidden. Read-only. @@ -18782,6 +19039,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ readonly isEntireRow: boolean; + /** + * + * Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly left: number; /** * * Represents the data type state of each cell. Read-only. @@ -18845,6 +19109,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ readonly text: string[][]; + /** + * + * Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly top: number; /** * * Represents the type of data of each cell. Read-only. @@ -18860,6 +19131,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ values: any[][]; + /** + * + * Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly width: number; /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * * @remarks @@ -18877,24 +19155,28 @@ declare namespace Excel { /** * * Fills range from the current range to the destination range using the specified AutoFill logic. - The destination range can be null, or can extend the source either horizontally or vertically. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). - For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + The destination range can be null, or can extend the source either horizontally or vertically. + Discontiguous ranges are not supported. + + For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. * * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`] * - * @param destinationRange The destination range to autofill. Discontiguous ranges are not supported. + * @param destinationRange The destination range to autofill. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). * @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". */ autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void; /** * * Fills range from the current range to the destination range using the specified AutoFill logic. - The destination range can be null, or can extend the source either horizontally or vertically. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). - For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. + The destination range can be null, or can extend the source either horizontally or vertically. + Discontiguous ranges are not supported. + + For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}. * * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`] * - * @param destinationRange The destination range to autofill. Discontiguous ranges are not supported. + * @param destinationRange The destination range to autofill. If the destination range is null, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI’s range fill handle). * @param autoFillType The type of autofill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault". */ autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void; @@ -19294,6 +19576,48 @@ declare namespace Excel { * [Api set: ExcelApi 1.3] */ getVisibleView(): Excel.RangeView; + /** + * + * Groups columns and rows for an outline. + * + * [Api set: ExcelApi 1.10] + * + * @param groupOption Specifies how the range can be grouped by rows or columns. + An `InvalidArgument` error is thrown when the group option differs from the range's + `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns" + or `range.isEntireColumn` is true and `groupOption` is "ByRows"). + */ + group(groupOption: Excel.GroupOption): void; + /** + * + * Groups columns and rows for an outline. + * + * [Api set: ExcelApi 1.10] + * + * @param groupOption Specifies how the range can be grouped by rows or columns. + An `InvalidArgument` error is thrown when the group option differs from the range's + `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns" + or `range.isEntireColumn` is true and `groupOption` is "ByRows"). + */ + group(groupOption: "ByRows" | "ByColumns"): void; + /** + * + * Hide details of the row or column group. + * + * [Api set: ExcelApi 1.10] + * + * @param groupOption Specifies whether to hide details of grouped rows or grouped columns. + */ + hideGroupDetails(groupOption: Excel.GroupOption): void; + /** + * + * Hide details of the row or column group. + * + * [Api set: ExcelApi 1.10] + * + * @param groupOption Specifies whether to hide details of grouped rows or grouped columns. + */ + hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void; /** * * Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space. Returns a new Range object at the now blank space. @@ -19392,6 +19716,42 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ showCard(): void; + /** + * + * Show details of the row or column group. + * + * [Api set: ExcelApi 1.10] + * + * @param groupOption Specifies whether to show details of grouped rows or grouped columns. + */ + showGroupDetails(groupOption: Excel.GroupOption): void; + /** + * + * Show details of the row or column group. + * + * [Api set: ExcelApi 1.10] + * + * @param groupOption Specifies whether to show details of grouped rows or grouped columns. + */ + showGroupDetails(groupOption: "ByRows" | "ByColumns"): void; + /** + * + * Ungroups columns and rows for an outline. + * + * [Api set: ExcelApi 1.10] + * + * @param groupOption Specifies how the range can be ungrouped by rows or columns. + */ + ungroup(groupOption: Excel.GroupOption): void; + /** + * + * Ungroups columns and rows for an outline. + * + * [Api set: ExcelApi 1.10] + * + * @param groupOption Specifies how the range can be ungrouped by rows or columns. + */ + ungroup(groupOption: "ByRows" | "ByColumns"): void; /** * * Unmerge the range cells into separate cells. @@ -19825,7 +20185,7 @@ declare namespace Excel { interface SearchCriteria { /** * - * Specifies whether the match needs to be complete or partial. A complete match matches the entire contents of the cell. Default is false (partial). + * Specifies whether the match needs to be complete or partial. A complete match matches the entire contents of the cell. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). Default is false (partial). * * [Api set: ExcelApi 1.9] */ @@ -19854,7 +20214,7 @@ declare namespace Excel { interface WorksheetSearchCriteria { /** * - * Specifies whether the match needs to be complete or partial. A complete match matches the entire contents of the cell. Default is false (partial). + * Specifies whether the match needs to be complete or partial. A complete match matches the entire contents of the cell. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). Default is false (partial). * * [Api set: ExcelApi 1.9] */ @@ -19876,7 +20236,7 @@ declare namespace Excel { interface ReplaceCriteria { /** * - * Specifies whether the match needs to be complete or partial. Default is false (partial). + * Specifies whether the match needs to be complete or partial. A complete match matches the entire contents of the cell. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). Default is false (partial). * * [Api set: ExcelApi 1.9] */ @@ -21437,7 +21797,7 @@ declare namespace Excel { showTotals: boolean; /** * - * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -23419,7 +23779,7 @@ declare namespace Excel { showAxisFieldButtons: boolean; /** * - * Specifies whether or not to display the legend field buttons on a PivotChart + * Specifies whether or not to display the legend field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -23433,7 +23793,7 @@ declare namespace Excel { showReportFilterFieldButtons: boolean; /** * - * Specifies whether or not to display the show value field buttons on a PivotChart + * Specifies whether or not to display the show value field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -28560,6 +28920,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ autoFormat: boolean; + /** + * + * Specifies whether the field list can be shown in the UI. + * + * [Api set: ExcelApi 1.10] + */ + enableFieldList: boolean; /** * * This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null. @@ -32290,6 +32657,682 @@ declare namespace Excel { */ toJSON(): Excel.Interfaces.StyleCollectionData; } + /** + * + * Represents a collection of TableStyles. + * + * [Api set: ExcelApi 1.10] + */ + class TableStyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.TableStyle[]; + /** + * + * Creates a blank TableStyle with the specified name. + * + * [Api set: ExcelApi 1.10] + * + * @param name The unique name for the new TableStyle. Will throw an invalid argument exception if the name is already in use. + * @param makeUniqueName Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed. + * @returns The newly created TableStyle. + */ + add(name: string, makeUniqueName?: boolean): Excel.TableStyle; + /** + * + * Gets the number of table styles in the collection. + * + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Gets the default TableStyle for the parent object's scope. + * + * [Api set: ExcelApi 1.10] + * @returns The TableStyle object that is the current default TableStyle. + */ + getDefault(): Excel.TableStyle; + /** + * + * Gets a TableStyle by name. + * + * [Api set: ExcelApi 1.10] + * + * @param name Name of the TableStyle to be retrieved. + * @returns The TableStyle object whose name matches the input. + */ + getItem(name: string): Excel.TableStyle; + /** + * + * Gets a TableStyle by name. If the TableStyle does not exist, will return a null object. + * + * [Api set: ExcelApi 1.10] + * + * @param name Name of the TableStyle to be retrieved. + * @returns The TableStyle object whose name matches the input. + */ + getItemOrNullObject(name: string): Excel.TableStyle; + /** + * + * Sets the default TableStyle for use in the parent object's scope. + * + * [Api set: ExcelApi 1.10] + * + * @param newDefaultStyle The TableStyle object or name of the TableStyle object that should be the new default. + */ + setDefault(newDefaultStyle: TableStyle | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TableStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `Excel.TableStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.TableStyleCollectionData; + } + /** + * + * Represents a TableStyle, which defines the style elements by region of the Table. + * + * [Api set: ExcelApi 1.10] + */ + class TableStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Gets the name of the TableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * + * Specifies whether this TableStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly readOnly: boolean; + /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * + * @remarks + * + * This method has the following additional signature: + * + * `set(properties: Excel.TableStyle): void` + * + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TableStyle): void; + /** + * + * Deletes the TableStyle. + * + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * + * Creates a duplicate of this TableStyle with copies of all the style elements. + * + * [Api set: ExcelApi 1.10] + * @returns The new TableStyle object that has been duplicated from this TableStyle. + */ + duplicate(): Excel.TableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TableStyleLoadOptions): Excel.TableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TableStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.TableStyle object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TableStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TableStyleData; + } + /** + * + * Represents a collection of PivotTable styles. + * + * [Api set: ExcelApi 1.10] + */ + class PivotTableStyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.PivotTableStyle[]; + /** + * + * Creates a blank PivotTableStyle with the specified name. + * + * [Api set: ExcelApi 1.10] + * + * @param name The unique name for the new PivotTableStyle. Will throw an invalid argument exception if the name is already in use. + * @param makeUniqueName Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed. + * @returns The newly created PivotTableStyle. + */ + add(name: string, makeUniqueName?: boolean): Excel.PivotTableStyle; + /** + * + * Gets the number of PivotTable styles in the collection. + * + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Gets the default PivotTableStyle for the parent object's scope. + * + * [Api set: ExcelApi 1.10] + * @returns The PivotTableStyle object that is the current default PivotTableStyle. + */ + getDefault(): Excel.PivotTableStyle; + /** + * + * Gets a PivotTableStyle by name. + * + * [Api set: ExcelApi 1.10] + * + * @param name Name of the PivotTableStyle to be retrieved. + * @returns The PivotTableStyle object whose name matches the input. + */ + getItem(name: string): Excel.PivotTableStyle; + /** + * + * Gets a PivotTableStyle by name. If the PivotTableStyle does not exist, will return a null object. + * + * [Api set: ExcelApi 1.10] + * + * @param name Name of the PivotTableStyle to be retrieved. + * @returns The PivotTableStyle object whose name matches the input. + */ + getItemOrNullObject(name: string): Excel.PivotTableStyle; + /** + * + * Sets the default PivotTableStyle for use in the parent object's scope. + * + * [Api set: ExcelApi 1.10] + * + * @param newDefaultStyle The PivotTableStyle object or name of the PivotTableStyle object that should be the new default. + */ + setDefault(newDefaultStyle: PivotTableStyle | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotTableStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.PivotTableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.PivotTableStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `Excel.PivotTableStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.PivotTableStyleCollectionData; + } + /** + * + * Represents a PivotTable Style, which defines style elements by PivotTable region. + * + * [Api set: ExcelApi 1.10] + */ + class PivotTableStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Gets the name of the PivotTableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * + * Specifies whether this PivotTableStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly readOnly: boolean; + /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * + * @remarks + * + * This method has the following additional signature: + * + * `set(properties: Excel.PivotTableStyle): void` + * + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.PivotTableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.PivotTableStyle): void; + /** + * + * Deletes the PivotTableStyle. + * + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * + * Creates a duplicate of this PivotTableStyle with copies of all the style elements. + * + * [Api set: ExcelApi 1.10] + * @returns The new PivotTableStyle object that has been duplicated from this PivotTableStyle. + */ + duplicate(): Excel.PivotTableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.PivotTableStyleLoadOptions): Excel.PivotTableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.PivotTableStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.PivotTableStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.PivotTableStyle object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.PivotTableStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.PivotTableStyleData; + } + /** + * + * Represents a collection of SlicerStyle objects. + * + * [Api set: ExcelApi 1.10] + */ + class SlicerStyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.SlicerStyle[]; + /** + * + * Creates a blank SlicerStyle with the specified name. + * + * [Api set: ExcelApi 1.10] + * + * @param name The unique name for the new SlicerStyle. Will throw an invalid argument exception if the name is already in use. + * @param makeUniqueName Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed. + * @returns The newly created SlicerStyle. + */ + add(name: string, makeUniqueName?: boolean): Excel.SlicerStyle; + /** + * + * Gets the number of slicer styles in the collection. + * + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Gets the default SlicerStyle for the parent object's scope. + * + * [Api set: ExcelApi 1.10] + * @returns The SlicerStyle object that is the current default SlicerStyle. + */ + getDefault(): Excel.SlicerStyle; + /** + * + * Gets a SlicerStyle by name. + * + * [Api set: ExcelApi 1.10] + * + * @param name Name of the SlicerStyle to be retrieved. + * @returns The SlicerStyle object whose name matches the input. + */ + getItem(name: string): Excel.SlicerStyle; + /** + * + * Gets a SlicerStyle by name. If the SlicerStyle does not exist, will return a null object. + * + * [Api set: ExcelApi 1.10] + * + * @param name Name of the SlicerStyle to be retrieved. + * @returns The SlicerStyle object whose name matches the input. + */ + getItemOrNullObject(name: string): Excel.SlicerStyle; + /** + * + * Sets the default SlicerStyle for use in the parent object's scope. + * + * [Api set: ExcelApi 1.10] + * + * @param newDefaultStyle The SlicerStyle object or name of the SlicerStyle object that should be the new default. + */ + setDefault(newDefaultStyle: SlicerStyle | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `Excel.SlicerStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.SlicerStyleCollectionData; + } + /** + * + * Represents a Slicer Style, which defines style elements by region of the slicer. + * + * [Api set: ExcelApi 1.10] + */ + class SlicerStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Gets the name of the SlicerStyle. + * + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * + * Specifies whether this SlicerStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly readOnly: boolean; + /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * + * @remarks + * + * This method has the following additional signature: + * + * `set(properties: Excel.SlicerStyle): void` + * + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.SlicerStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.SlicerStyle): void; + /** + * + * Deletes the SlicerStyle. + * + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * + * Creates a duplicate of this SlicerStyle with copies of all the style elements. + * + * [Api set: ExcelApi 1.10] + * @returns The new SlicerStyle object that has been duplicated from this SlicerStyle. + */ + duplicate(): Excel.SlicerStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerStyleLoadOptions): Excel.SlicerStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SlicerStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.SlicerStyle object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SlicerStyleData; + } + /** + * + * Represents a collection of TimelineStyles. + * + * [Api set: ExcelApi 1.10] + */ + class TimelineStyleCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.TimelineStyle[]; + /** + * + * Creates a blank TimelineStyle with the specified name. + * + * [Api set: ExcelApi 1.10] + * + * @param name The unique name for the new TimelineStyle. Will throw an invalid argument exception if the name is already in use. + * @param makeUniqueName Optional, defaults to false. If true, will append numbers to the name in order to make it unique, if needed. + * @returns The newly created TimelineStyle. + */ + add(name: string, makeUniqueName?: boolean): Excel.TimelineStyle; + /** + * + * Gets the number of timeline styles in the collection. + * + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Gets the default TimelineStyle for the parent object's scope. + * + * [Api set: ExcelApi 1.10] + * @returns The TimelineStyle object that is the current default TimelineStyle. + */ + getDefault(): Excel.TimelineStyle; + /** + * + * Gets a TimelineStyle by name. + * + * [Api set: ExcelApi 1.10] + * + * @param name Name of the TimelineStyle to be retrieved. + * @returns The TimelineStyle object whose name matches the input. + */ + getItem(name: string): Excel.TimelineStyle; + /** + * + * Gets a TimelineStyle by name. If the TimelineStyle does not exist, will return a null object. + * + * [Api set: ExcelApi 1.10] + * + * @param name Name of the TimelineStyle to be retrieved. + * @returns The TimelineStyle object whose name matches the input. + */ + getItemOrNullObject(name: string): Excel.TimelineStyle; + /** + * + * Sets the default TimelineStyle for use in the parent object's scope. + * + * [Api set: ExcelApi 1.10] + * + * @param newDefaultStyle The TimelineStyle object or name of the TimelineStyle object that should be the new default. + */ + setDefault(newDefaultStyle: TimelineStyle | string): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TimelineStyleCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.TimelineStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TimelineStyleCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.TimelineStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `Excel.TimelineStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TimelineStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.TimelineStyleCollectionData; + } + /** + * + * Represents a Timeline style, which defines style elements by region in the Timeline. + * + * [Api set: ExcelApi 1.10] + */ + class TimelineStyle extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Gets the name of the TimelineStyle. + * + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * + * Specifies whether this TimelineStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly readOnly: boolean; + /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * + * @remarks + * + * This method has the following additional signature: + * + * `set(properties: Excel.TimelineStyle): void` + * + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TimelineStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.TimelineStyle): void; + /** + * + * Deletes the TableStyle. + * + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * + * Creates a duplicate of this TimelineStyle with copies of all the style elements. + * + * [Api set: ExcelApi 1.10] + * @returns The new TimelineStyle object that has been duplicated from this TimelineStyle. + */ + duplicate(): Excel.TimelineStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.TimelineStyleLoadOptions): Excel.TimelineStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.TimelineStyle; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.TimelineStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.TimelineStyle object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.TimelineStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.TimelineStyleData; + } /** * * Represents layout and print settings that are not dependent any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area. @@ -33037,6 +34080,406 @@ declare namespace Excel { */ toJSON(): Excel.Interfaces.RangeCollectionData; } + /** + * + * Represents the content contained within a comment or comment reply. Rich content incudes the text string and any other objects contained within the comment body, such as mentions. + * + * [Api set: ExcelApi 1.10] + */ + interface CommentRichContent { + } + /** + * + * Represents a collection of comment objects that are part of the workbook. + * + * [Api set: ExcelApi 1.10] + */ + class CommentCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Comment[]; + /** + * + * Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * + * [Api set: ExcelApi 1.10] + * + * @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * @param content The comment's content. This can be either a string or CommentRichContent object. Strings are used for plain text. CommentRichContent objects allow for other comment features, such as mentions. [Api set: ExcelApi 1.10 for string, ExcelApi Preview for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. + */ + add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment; + /** + * + * Creates a new comment with the given content on the given cell. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * + * [Api set: ExcelApi 1.10] + * + * @param cellAddress The cell to which the comment is added. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + * @param content The comment's content. This can be either a string or CommentRichContent object. Strings are used for plain text. CommentRichContent objects allow for other comment features, such as mentions. [Api set: ExcelApi 1.10 for string, ExcelApi Preview for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. + */ + add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.Comment; + /** + * + * Gets the number of comments in the collection. + * + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Gets a comment from the collection based on its ID. Read-only. + * + * [Api set: ExcelApi 1.10] + * + * @param commentId The identifier for the comment. + */ + getItem(commentId: string): Excel.Comment; + /** + * + * Gets a comment from the collection based on its position. + * + * [Api set: ExcelApi 1.10] + * + * @param index Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Comment; + /** + * + * Gets the comment from the specified cell. + * + * [Api set: ExcelApi 1.10] + * + * @param cellAddress The cell which the comment is on. This can be a Range object or a string. If it's a string, it must contain the full address, including the sheet name. An `InvalidArgument` error is thrown if the provided range is larger than one cell. + */ + getItemByCell(cellAddress: Range | string): Excel.Comment; + /** + * + * Gets the comment to which the given reply is connected. + * + * [Api set: ExcelApi 1.10] + * + * @param replyId The identifier of comment reply. + */ + getItemByReplyId(replyId: string): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `Excel.CommentCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.CommentCollectionData; + } + /** + * + * Represents a comment in the workbook. + * + * [Api set: ExcelApi 1.10] + */ + class Comment extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Represents a collection of reply objects associated with the comment. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly replies: Excel.CommentReplyCollection; + /** + * + * Gets the email of the comment's author. + * + * [Api set: ExcelApi 1.10] + */ + readonly authorEmail: string; + /** + * + * Gets the name of the comment's author. + * + * [Api set: ExcelApi 1.10] + */ + readonly authorName: string; + /** + * + * Gets or sets the comment's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content: string; + /** + * + * Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date. + * + * [Api set: ExcelApi 1.10] + */ + readonly creationDate: Date; + /** + * + * Represents the comment identifier. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly id: string; + /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * + * @remarks + * + * This method has the following additional signature: + * + * `set(properties: Excel.Comment): void` + * + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Comment): void; + /** + * + * Deletes the comment and all the connected replies. + * + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * + * Gets the cell where this comment is located. + * + * [Api set: ExcelApi 1.10] + */ + getLocation(): Excel.Range; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CommentLoadOptions): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Comment; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.Comment object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CommentData; + } + /** + * + * Represents a collection of comment reply objects that are part of the comment. + * + * [Api set: ExcelApi 1.10] + */ + class CommentReplyCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.CommentReply[]; + /** + * + * Creates a comment reply for comment. + * + * [Api set: ExcelApi 1.10] + * + * @param content The comment's content. This can be either a string or Interface CommentRichContent (e.g. for comments with mentions). [Api set: ExcelApi 1.10 for string, ExcelApi Preview for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. + */ + add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply; + /** + * + * Creates a comment reply for comment. + * + * [Api set: ExcelApi 1.10] + * + * @param content The comment's content. This can be either a string or Interface CommentRichContent (e.g. for comments with mentions). [Api set: ExcelApi 1.10 for string, ExcelApi Preview for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.plain`. + */ + add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply; + /** + * + * Gets the number of comment replies in the collection. + * + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Returns a comment reply identified by its ID. Read-only. + * + * [Api set: ExcelApi 1.10] + * + * @param commentReplyId The identifier for the comment reply. + */ + getItem(commentReplyId: string): Excel.CommentReply; + /** + * + * Gets a comment reply based on its position in the collection. + * + * [Api set: ExcelApi 1.10] + * + * @param index The index value of the comment reply to be retrieved. The collection uses zero-based indexing. + */ + getItemAt(index: number): Excel.CommentReply; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentReplyCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentReplyCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `Excel.CommentReplyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentReplyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.CommentReplyCollectionData; + } + /** + * + * Represents a comment reply in the workbook. + * + * [Api set: ExcelApi 1.10] + */ + class CommentReply extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Gets the email of the comment reply's author. + * + * [Api set: ExcelApi 1.10] + */ + readonly authorEmail: string; + /** + * + * Gets the name of the comment reply's author. + * + * [Api set: ExcelApi 1.10] + */ + readonly authorName: string; + /** + * + * Gets or sets the comment reply's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content: string; + /** + * + * Gets the creation time of the comment reply. + * + * [Api set: ExcelApi 1.10] + */ + readonly creationDate: Date; + /** + * + * Represents the comment reply identifier. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly id: string; + /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * + * @remarks + * + * This method has the following additional signature: + * + * `set(properties: Excel.CommentReply): void` + * + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.CommentReply): void; + /** + * + * Deletes the comment reply. + * + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * + * Gets the cell where this comment reply is located. + * + * [Api set: ExcelApi 1.10] + */ + getLocation(): Excel.Range; + /** + * + * Gets the parent comment of this reply. + * + * [Api set: ExcelApi 1.10] + */ + getParentComment(): Excel.Comment; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.CommentReply; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.CommentReply; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.CommentReply object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.CommentReplyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.CommentReplyData; + } /** * * Represents a collection of all the shapes in the worksheet. @@ -33306,6 +34749,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ name: string; + /** + * + * Represents how the object is attached to the cells below it. + * + * [Api set: ExcelApi 1.10] + */ + placement: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; /** * * Represents the rotation, in degrees, of the shape. @@ -33364,6 +34814,16 @@ declare namespace Excel { set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.Shape): void; + /** + * + * Copies and pastes a Shape object. + The pasted shape is copied to the same pixel location as this shape. + * + * [Api set: ExcelApi 1.10] + * + * @param destinationSheet The sheet to which the shape object will be pasted. The default value is the copied Shape's worksheet. + */ + copyTo(destinationSheet?: Worksheet | string): Excel.Shape; /** * * Removes the shape from the worksheet. @@ -34437,6 +35897,405 @@ declare namespace Excel { */ toJSON(): Excel.Interfaces.ShapeFontData; } + /** + * + * Represents a slicer object in the workbook. + * + * [Api set: ExcelApi 1.10] + */ + class Slicer extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * Represents the collection of SlicerItems that are part of the slicer. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly slicerItems: Excel.SlicerItemCollection; + /** + * + * Represents the worksheet containing the slicer. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly worksheet: Excel.Worksheet; + /** + * + * Represents the caption of slicer. + * + * [Api set: ExcelApi 1.10] + */ + caption: string; + /** + * + * Represents the height, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + height: number; + /** + * + * Represents the unique id of slicer. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readonly id: string; + /** + * + * True if all filters currently applied on the slicer are cleared. + * + * [Api set: ExcelApi 1.10] + */ + readonly isFilterCleared: boolean; + /** + * + * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + left: number; + /** + * + * Represents the name of slicer. + * + * [Api set: ExcelApi 1.10] + */ + name: string; + /** + * + * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * [Api set: ExcelApi 1.10] + */ + sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; + /** + * + * Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * [Api set: ExcelApi 1.10] + */ + style: string; + /** + * + * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + top: number; + /** + * + * Represents the width, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + width: number; + /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * + * @remarks + * + * This method has the following additional signature: + * + * `set(properties: Excel.Slicer): void` + * + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.SlicerUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.Slicer): void; + /** + * + * Clears all the filters currently applied on the slicer. + * + * [Api set: ExcelApi 1.10] + */ + clearFilters(): void; + /** + * + * Deletes the slicer. + * + * [Api set: ExcelApi 1.10] + */ + delete(): void; + /** + * + * Returns an array of selected items' keys. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + getSelectedItems(): OfficeExtension.ClientResult; + /** + * + * Selects slicer items based on their keys. The previous selections are cleared. + All items will be selected by default if the array is empty. + * + * [Api set: ExcelApi 1.10] + * + * @param items Optional. The specified slicer item names to be selected. + */ + selectItems(items?: string[]): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerLoadOptions): Excel.Slicer; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.Slicer; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.Slicer; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.Slicer object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SlicerData; + } + /** + * + * Represents a collection of all the slicer objects on the workbook or a worksheet. + * + * [Api set: ExcelApi 1.10] + */ + class SlicerCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.Slicer[]; + /** + * + * Adds a new slicer to the workbook. + * + * [Api set: ExcelApi 1.10] + * + * @param slicerSource The data source that the new slicer will be based on. It can be a PivotTable object, a Table object or a string. When a PivotTable object is passed, the data source is the source of the PivotTable object. When a Table object is passed, the data source is the Table object. When a string is passed, it is interpreted as the name/id of a PivotTable/Table. + * @param sourceField The field in the data source to filter by. It can be a PivotField object, a TableColumn object, the id of a PivotField or the id/name of TableColumn. + * @param slicerDestination Optional. The worksheet where the new slicer will be created in. It can be a Worksheet object or the name/id of a worksheet. This parameter can be omitted if the slicer collection is retrieved from worksheet. + * @returns The new slicer. + */ + add(slicerSource: string | PivotTable | Table, sourceField: string | PivotField | number | TableColumn, slicerDestination?: string | Worksheet): Excel.Slicer; + /** + * + * Returns the number of slicers in the collection. + * + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Gets a slicer object using its name or id. + * + * [Api set: ExcelApi 1.10] + * + * @param key The name or id of the slicer. + */ + getItem(key: string): Excel.Slicer; + /** + * + * Gets a slicer based on its position in the collection. + * + * [Api set: ExcelApi 1.10] + * + * @param index Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.Slicer; + /** + * + * Gets a slicer using its name or id. If the slicer does not exist, will return a null object. + * + * [Api set: ExcelApi 1.10] + * + * @param key Name or Id of the slicer to be retrieved. + */ + getItemOrNullObject(key: string): Excel.Slicer; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `Excel.SlicerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.SlicerCollectionData; + } + /** + * + * Represents a slicer item in a slicer. + * + * [Api set: ExcelApi 1.10] + */ + class SlicerItem extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * + * True if the slicer item has data. + * + * [Api set: ExcelApi 1.10] + */ + readonly hasData: boolean; + /** + * + * True if the slicer item is selected. + Setting this value will not clear other SlicerItems' selected state. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * [Api set: ExcelApi 1.10] + */ + isSelected: boolean; + /** + * + * Represents the unique value representing the slicer item. + * + * [Api set: ExcelApi 1.10] + */ + readonly key: string; + /** + * + * Represents the title displayed in the UI. + * + * [Api set: ExcelApi 1.10] + */ + readonly name: string; + /** Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * + * @remarks + * + * This method has the following additional signature: + * + * `set(properties: Excel.SlicerItem): void` + * + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.SlicerItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Excel.SlicerItem): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerItemLoadOptions): Excel.SlicerItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Excel.SlicerItem; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original Excel.SlicerItem object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerItemData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.SlicerItemData; + } + /** + * + * Represents a collection of all the slicer item objects on the slicer. + * + * [Api set: ExcelApi 1.10] + */ + class SlicerItemCollection extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** Gets the loaded child items in this collection. */ + readonly items: Excel.SlicerItem[]; + /** + * + * Returns the number of slicer items in the slicer. + * + * [Api set: ExcelApi 1.10] + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Gets a slicer item object using its key or name. + * + * [Api set: ExcelApi 1.10] + * + * @param key The key or name of the slicer item. + */ + getItem(key: string): Excel.SlicerItem; + /** + * + * Gets a slicer item based on its position in the collection. + * + * [Api set: ExcelApi 1.10] + * + * @param index Index value of the object to be retrieved. Zero-indexed. + */ + getItemAt(index: number): Excel.SlicerItem; + /** + * + * Gets a slicer item using its key or name. If the slicer item does not exist, will return a null object. + * + * [Api set: ExcelApi 1.10] + * + * @param key Key or name of the slicer to be retrieved. + */ + getItemOrNullObject(key: string): Excel.SlicerItem; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Excel.Interfaces.SlicerItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SlicerItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Excel.SlicerItemCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. + */ + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SlicerItemCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.) + * Whereas the original `Excel.SlicerItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SlicerItemCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.SlicerItemCollectionData; + } /** * [Api set: ExcelApi 1.7] */ @@ -36556,6 +38415,23 @@ declare namespace Excel { growthTrend = "GrowthTrend", flashFill = "FlashFill" } + /** + * [Api set: ExcelApi 1.10] + */ + enum GroupOption { + /** + * + * Group by rows. + * + */ + byRows = "ByRows", + /** + * + * Group by columns. + * + */ + byColumns = "ByColumns" + } /** * [Api set: ExcelApi 1.9] */ @@ -36768,6 +38644,23 @@ declare namespace Excel { elbow = "Elbow", curve = "Curve" } + /** + * [Api set: ExcelApi 1.10] + */ + enum ContentType { + /** + * + * Indicates plain format type of the comment content. + * + */ + plain = "Plain", + /** + * + * Comment content containing mentions. + * + */ + mention = "Mention" + } /** * [Api set: ExcelApi 1.9] */ @@ -37131,6 +39024,32 @@ declare namespace Excel { */ prompt = "Prompt" } + /** + * + * Specifies the slicer sort behavior for Slicer.sortBy API. + * + * [Api set: ExcelApi 1.10] + */ + enum SlicerSortType { + /** + * + * Sort slicer items in the order provided by the data source. + * + */ + dataSourceOrder = "DataSourceOrder", + /** + * + * Sort slicer items in ascending order by item captions. + * + */ + ascending = "Ascending", + /** + * + * Sort slicer items in descending order by item captions. + * + */ + descending = "Descending" + } /** * [Api set: ExcelApi 1.9] */ @@ -41428,7 +43347,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -41975,7 +43894,7 @@ declare namespace Excel { showAxisFieldButtons?: boolean; /** * - * Specifies whether or not to display the legend field buttons on a PivotChart + * Specifies whether or not to display the legend field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -41989,7 +43908,7 @@ declare namespace Excel { showReportFilterFieldButtons?: boolean; /** * - * Specifies whether or not to display the show value field buttons on a PivotChart + * Specifies whether or not to display the show value field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -43793,6 +45712,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ autoFormat?: boolean; + /** + * + * Specifies whether the field list can be shown in the UI. + * + * [Api set: ExcelApi 1.10] + */ + enableFieldList?: boolean; /** * * This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null. @@ -44772,6 +46698,62 @@ declare namespace Excel { interface StyleCollectionUpdateData { items?: Excel.Interfaces.StyleData[]; } + /** An interface for updating data on the TableStyleCollection object, for use in `tableStyleCollection.set({ ... })`. */ + interface TableStyleCollectionUpdateData { + items?: Excel.Interfaces.TableStyleData[]; + } + /** An interface for updating data on the TableStyle object, for use in `tableStyle.set({ ... })`. */ + interface TableStyleUpdateData { + /** + * + * Gets the name of the TableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface for updating data on the PivotTableStyleCollection object, for use in `pivotTableStyleCollection.set({ ... })`. */ + interface PivotTableStyleCollectionUpdateData { + items?: Excel.Interfaces.PivotTableStyleData[]; + } + /** An interface for updating data on the PivotTableStyle object, for use in `pivotTableStyle.set({ ... })`. */ + interface PivotTableStyleUpdateData { + /** + * + * Gets the name of the PivotTableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface for updating data on the SlicerStyleCollection object, for use in `slicerStyleCollection.set({ ... })`. */ + interface SlicerStyleCollectionUpdateData { + items?: Excel.Interfaces.SlicerStyleData[]; + } + /** An interface for updating data on the SlicerStyle object, for use in `slicerStyle.set({ ... })`. */ + interface SlicerStyleUpdateData { + /** + * + * Gets the name of the SlicerStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface for updating data on the TimelineStyleCollection object, for use in `timelineStyleCollection.set({ ... })`. */ + interface TimelineStyleCollectionUpdateData { + items?: Excel.Interfaces.TimelineStyleData[]; + } + /** An interface for updating data on the TimelineStyle object, for use in `timelineStyle.set({ ... })`. */ + interface TimelineStyleUpdateData { + /** + * + * Gets the name of the TimelineStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + } /** An interface for updating data on the PageLayout object, for use in `pageLayout.set({ ... })`. */ interface PageLayoutUpdateData { /** @@ -45027,6 +47009,34 @@ declare namespace Excel { interface RangeCollectionUpdateData { items?: Excel.Interfaces.RangeData[]; } + /** An interface for updating data on the CommentCollection object, for use in `commentCollection.set({ ... })`. */ + interface CommentCollectionUpdateData { + items?: Excel.Interfaces.CommentData[]; + } + /** An interface for updating data on the Comment object, for use in `comment.set({ ... })`. */ + interface CommentUpdateData { + /** + * + * Gets or sets the comment's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content?: string; + } + /** An interface for updating data on the CommentReplyCollection object, for use in `commentReplyCollection.set({ ... })`. */ + interface CommentReplyCollectionUpdateData { + items?: Excel.Interfaces.CommentReplyData[]; + } + /** An interface for updating data on the CommentReply object, for use in `commentReply.set({ ... })`. */ + interface CommentReplyUpdateData { + /** + * + * Gets or sets the comment reply's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content?: string; + } /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */ interface ShapeCollectionUpdateData { items?: Excel.Interfaces.ShapeData[]; @@ -45098,6 +47108,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ name?: string; + /** + * + * Represents how the object is attached to the cells below it. + * + * [Api set: ExcelApi 1.10] + */ + placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; /** * * Represents the rotation, in degrees, of the shape. @@ -45389,6 +47406,96 @@ declare namespace Excel { */ underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; } + /** An interface for updating data on the Slicer object, for use in `slicer.set({ ... })`. */ + interface SlicerUpdateData { + /** + * + * Represents the worksheet containing the slicer. + * + * [Api set: ExcelApi 1.10] + */ + worksheet?: Excel.Interfaces.WorksheetUpdateData; + /** + * + * Represents the caption of slicer. + * + * [Api set: ExcelApi 1.10] + */ + caption?: string; + /** + * + * Represents the height, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + height?: number; + /** + * + * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + left?: number; + /** + * + * Represents the name of slicer. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * + * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * [Api set: ExcelApi 1.10] + */ + sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; + /** + * + * Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * [Api set: ExcelApi 1.10] + */ + style?: string; + /** + * + * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + top?: number; + /** + * + * Represents the width, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + width?: number; + } + /** An interface for updating data on the SlicerCollection object, for use in `slicerCollection.set({ ... })`. */ + interface SlicerCollectionUpdateData { + items?: Excel.Interfaces.SlicerData[]; + } + /** An interface for updating data on the SlicerItem object, for use in `slicerItem.set({ ... })`. */ + interface SlicerItemUpdateData { + /** + * + * True if the slicer item is selected. + Setting this value will not clear other SlicerItems' selected state. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * [Api set: ExcelApi 1.10] + */ + isSelected?: boolean; + } + /** An interface for updating data on the SlicerItemCollection object, for use in `slicerItemCollection.set({ ... })`. */ + interface SlicerItemCollectionUpdateData { + items?: Excel.Interfaces.SlicerItemData[]; + } /** An interface describing the data returned by calling `runtime.toJSON()`. */ interface RuntimeData { /** @@ -45467,6 +47574,13 @@ declare namespace Excel { bindings?: Excel.Interfaces.BindingData[]; /** * + * Represents a collection of Comments associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + comments?: Excel.Interfaces.CommentData[]; + /** + * * Represents the collection of custom XML parts contained by this workbook. Read-only. * * [Api set: ExcelApi 1.5] @@ -45481,6 +47595,13 @@ declare namespace Excel { names?: Excel.Interfaces.NamedItemData[]; /** * + * Represents a collection of PivotTableStyles associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + pivotTableStyles?: Excel.Interfaces.PivotTableStyleData[]; + /** + * * Represents a collection of PivotTables associated with the workbook. Read-only. * * [Api set: ExcelApi 1.3] @@ -45509,6 +47630,20 @@ declare namespace Excel { settings?: Excel.Interfaces.SettingData[]; /** * + * Represents a collection of SlicerStyles associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + slicerStyles?: Excel.Interfaces.SlicerStyleData[]; + /** + * + * Represents a collection of Slicers associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + slicers?: Excel.Interfaces.SlicerData[]; + /** + * * Represents a collection of styles associated with the workbook. Read-only. * * [Api set: ExcelApi 1.7] @@ -45516,6 +47651,13 @@ declare namespace Excel { styles?: Excel.Interfaces.StyleData[]; /** * + * Represents a collection of TableStyles associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + tableStyles?: Excel.Interfaces.TableStyleData[]; + /** + * * Represents a collection of tables associated with the workbook. Read-only. * * [Api set: ExcelApi 1.1] @@ -45523,6 +47665,13 @@ declare namespace Excel { tables?: Excel.Interfaces.TableData[]; /** * + * Represents a collection of TimelineStyles associated with the workbook. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + timelineStyles?: Excel.Interfaces.TimelineStyleData[]; + /** + * * Represents a collection of worksheets associated with the workbook. Read-only. * * [Api set: ExcelApi 1.1] @@ -45612,13 +47761,20 @@ declare namespace Excel { autoFilter?: Excel.Interfaces.AutoFilterData; /** * - * Returns collection of charts that are part of the worksheet. Read-only. + * Returns a collection of charts that are part of the worksheet. Read-only. * * [Api set: ExcelApi 1.1] */ charts?: Excel.Interfaces.ChartData[]; /** * + * Returns a collection of all the Comments objects on the worksheet. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + comments?: Excel.Interfaces.CommentData[]; + /** + * * Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks. * * [Api set: ExcelApi 1.9] @@ -45661,6 +47817,13 @@ declare namespace Excel { shapes?: Excel.Interfaces.ShapeData[]; /** * + * Returns a collection of slicers that are part of the worksheet. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + slicers?: Excel.Interfaces.SlicerData[]; + /** + * * Collection of tables that are part of the worksheet. Read-only. * * [Api set: ExcelApi 1.1] @@ -45860,6 +48023,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ formulasR1C1?: any[][]; + /** + * + * Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + height?: number; /** * * Represents if all cells of the current range are hidden. Read-only. @@ -45888,6 +48058,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ isEntireRow?: boolean; + /** + * + * Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + left?: number; /** * * Represents the data type state of each cell. Read-only. @@ -45951,6 +48128,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ text?: string[][]; + /** + * + * Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + top?: number; /** * * Represents the type of data of each cell. Read-only. @@ -45966,6 +48150,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ values?: any[][]; + /** + * + * Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + width?: number; } /** An interface describing the data returned by calling `rangeAreas.toJSON()`. */ interface RangeAreasData { @@ -46372,7 +48563,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -46993,7 +49184,7 @@ declare namespace Excel { showAxisFieldButtons?: boolean; /** * - * Specifies whether or not to display the legend field buttons on a PivotChart + * Specifies whether or not to display the legend field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -47007,7 +49198,7 @@ declare namespace Excel { showReportFilterFieldButtons?: boolean; /** * - * Specifies whether or not to display the show value field buttons on a PivotChart + * Specifies whether or not to display the show value field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -49089,6 +51280,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ autoFormat?: boolean; + /** + * + * Specifies whether the field list can be shown in the UI. + * + * [Api set: ExcelApi 1.10] + */ + enableFieldList?: boolean; /** * * This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null. @@ -50187,6 +52385,90 @@ declare namespace Excel { interface StyleCollectionData { items?: Excel.Interfaces.StyleData[]; } + /** An interface describing the data returned by calling `tableStyleCollection.toJSON()`. */ + interface TableStyleCollectionData { + items?: Excel.Interfaces.TableStyleData[]; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + interface TableStyleData { + /** + * + * Gets the name of the TableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * + * Specifies whether this TableStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** An interface describing the data returned by calling `pivotTableStyleCollection.toJSON()`. */ + interface PivotTableStyleCollectionData { + items?: Excel.Interfaces.PivotTableStyleData[]; + } + /** An interface describing the data returned by calling `pivotTableStyle.toJSON()`. */ + interface PivotTableStyleData { + /** + * + * Gets the name of the PivotTableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * + * Specifies whether this PivotTableStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** An interface describing the data returned by calling `slicerStyleCollection.toJSON()`. */ + interface SlicerStyleCollectionData { + items?: Excel.Interfaces.SlicerStyleData[]; + } + /** An interface describing the data returned by calling `slicerStyle.toJSON()`. */ + interface SlicerStyleData { + /** + * + * Gets the name of the SlicerStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * + * Specifies whether this SlicerStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** An interface describing the data returned by calling `timelineStyleCollection.toJSON()`. */ + interface TimelineStyleCollectionData { + items?: Excel.Interfaces.TimelineStyleData[]; + } + /** An interface describing the data returned by calling `timelineStyle.toJSON()`. */ + interface TimelineStyleData { + /** + * + * Gets the name of the TimelineStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * + * Specifies whether this TimelineStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } /** An interface describing the data returned by calling `pageLayout.toJSON()`. */ interface PageLayoutData { /** @@ -50459,6 +52741,97 @@ declare namespace Excel { interface RangeCollectionData { items?: Excel.Interfaces.RangeData[]; } + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + interface CommentCollectionData { + items?: Excel.Interfaces.CommentData[]; + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + interface CommentData { + /** + * + * Represents a collection of reply objects associated with the comment. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + replies?: Excel.Interfaces.CommentReplyData[]; + /** + * + * Gets the email of the comment's author. + * + * [Api set: ExcelApi 1.10] + */ + authorEmail?: string; + /** + * + * Gets the name of the comment's author. + * + * [Api set: ExcelApi 1.10] + */ + authorName?: string; + /** + * + * Gets or sets the comment's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content?: string; + /** + * + * Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date. + * + * [Api set: ExcelApi 1.10] + */ + creationDate?: Date; + /** + * + * Represents the comment identifier. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: string; + } + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + interface CommentReplyCollectionData { + items?: Excel.Interfaces.CommentReplyData[]; + } + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + interface CommentReplyData { + /** + * + * Gets the email of the comment reply's author. + * + * [Api set: ExcelApi 1.10] + */ + authorEmail?: string; + /** + * + * Gets the name of the comment reply's author. + * + * [Api set: ExcelApi 1.10] + */ + authorName?: string; + /** + * + * Gets or sets the comment reply's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content?: string; + /** + * + * Gets the creation time of the comment reply. + * + * [Api set: ExcelApi 1.10] + */ + creationDate?: Date; + /** + * + * Represents the comment reply identifier. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: string; + } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ interface ShapeCollectionData { items?: Excel.Interfaces.ShapeData[]; @@ -50551,6 +52924,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ name?: string; + /** + * + * Represents how the object is attached to the cells below it. + * + * [Api set: ExcelApi 1.10] + */ + placement?: Excel.Placement | "TwoCell" | "OneCell" | "Absolute"; /** * * Represents the rotation, in degrees, of the shape. @@ -50949,6 +53329,138 @@ declare namespace Excel { */ underline?: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"; } + /** An interface describing the data returned by calling `slicer.toJSON()`. */ + interface SlicerData { + /** + * + * Represents the collection of SlicerItems that are part of the slicer. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + slicerItems?: Excel.Interfaces.SlicerItemData[]; + /** + * + * Represents the worksheet containing the slicer. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + worksheet?: Excel.Interfaces.WorksheetData; + /** + * + * Represents the caption of slicer. + * + * [Api set: ExcelApi 1.10] + */ + caption?: string; + /** + * + * Represents the height, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + height?: number; + /** + * + * Represents the unique id of slicer. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: string; + /** + * + * True if all filters currently applied on the slicer are cleared. + * + * [Api set: ExcelApi 1.10] + */ + isFilterCleared?: boolean; + /** + * + * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + left?: number; + /** + * + * Represents the name of slicer. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + /** + * + * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * [Api set: ExcelApi 1.10] + */ + sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending"; + /** + * + * Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * [Api set: ExcelApi 1.10] + */ + style?: string; + /** + * + * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + top?: number; + /** + * + * Represents the width, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + width?: number; + } + /** An interface describing the data returned by calling `slicerCollection.toJSON()`. */ + interface SlicerCollectionData { + items?: Excel.Interfaces.SlicerData[]; + } + /** An interface describing the data returned by calling `slicerItem.toJSON()`. */ + interface SlicerItemData { + /** + * + * True if the slicer item has data. + * + * [Api set: ExcelApi 1.10] + */ + hasData?: boolean; + /** + * + * True if the slicer item is selected. + Setting this value will not clear other SlicerItems' selected state. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * [Api set: ExcelApi 1.10] + */ + isSelected?: boolean; + /** + * + * Represents the unique value representing the slicer item. + * + * [Api set: ExcelApi 1.10] + */ + key?: string; + /** + * + * Represents the title displayed in the UI. + * + * [Api set: ExcelApi 1.10] + */ + name?: string; + } + /** An interface describing the data returned by calling `slicerItemCollection.toJSON()`. */ + interface SlicerItemCollectionData { + items?: Excel.Interfaces.SlicerItemData[]; + } /** An interface describing the data returned by calling `functionResult.toJSON()`. */ interface FunctionResultData { /** @@ -51207,7 +53719,7 @@ declare namespace Excel { autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; /** * - * Returns collection of charts that are part of the worksheet. + * Returns a collection of charts that are part of the worksheet. * * [Api set: ExcelApi 1.1] */ @@ -51330,7 +53842,7 @@ declare namespace Excel { autoFilter?: Excel.Interfaces.AutoFilterLoadOptions; /** * - * For EACH ITEM in the collection: Returns collection of charts that are part of the worksheet. + * For EACH ITEM in the collection: Returns a collection of charts that are part of the worksheet. * * [Api set: ExcelApi 1.1] */ @@ -51559,6 +54071,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ formulasR1C1?: boolean; + /** + * + * Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + height?: boolean; /** * * Represents if all cells of the current range are hidden. Read-only. @@ -51587,6 +54106,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ isEntireRow?: boolean; + /** + * + * Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + left?: boolean; /** * * Represents the data type state of each cell. Read-only. @@ -51650,6 +54176,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ text?: boolean; + /** + * + * Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + top?: boolean; /** * * Represents the type of data of each cell. Read-only. @@ -51665,6 +54198,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ values?: boolean; + /** + * + * Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + width?: boolean; } /** * @@ -52341,7 +54881,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * For EACH ITEM in the collection: Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * For EACH ITEM in the collection: Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -52465,7 +55005,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * For EACH ITEM in the collection: Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * For EACH ITEM in the collection: Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -52590,7 +55130,7 @@ declare namespace Excel { showTotals?: boolean; /** * - * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleStyleDark1" through "TableStyleStyleDark11". A custom user-defined style present in the workbook can also be specified. + * Constant value that represents the Table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. * * [Api set: ExcelApi 1.1] */ @@ -53618,7 +56158,7 @@ declare namespace Excel { showAxisFieldButtons?: boolean; /** * - * Specifies whether or not to display the legend field buttons on a PivotChart + * Specifies whether or not to display the legend field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -53632,7 +56172,7 @@ declare namespace Excel { showReportFilterFieldButtons?: boolean; /** * - * Specifies whether or not to display the show value field buttons on a PivotChart + * Specifies whether or not to display the show value field buttons on a PivotChart. * * [Api set: ExcelApi 1.9] */ @@ -56684,6 +59224,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ autoFormat?: boolean; + /** + * + * Specifies whether the field list can be shown in the UI. + * + * [Api set: ExcelApi 1.10] + */ + enableFieldList?: boolean; /** * * This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null. @@ -58575,6 +61122,214 @@ declare namespace Excel { */ wrapText?: boolean; } + /** + * + * Represents a collection of TableStyles. + * + * [Api set: ExcelApi 1.10] + */ + interface TableStyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the name of the TableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * For EACH ITEM in the collection: Specifies whether this TableStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * + * Represents a TableStyle, which defines the style elements by region of the Table. + * + * [Api set: ExcelApi 1.10] + */ + interface TableStyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Gets the name of the TableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * Specifies whether this TableStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * + * Represents a collection of PivotTable styles. + * + * [Api set: ExcelApi 1.10] + */ + interface PivotTableStyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the name of the PivotTableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * For EACH ITEM in the collection: Specifies whether this PivotTableStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * + * Represents a PivotTable Style, which defines style elements by PivotTable region. + * + * [Api set: ExcelApi 1.10] + */ + interface PivotTableStyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Gets the name of the PivotTableStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * Specifies whether this PivotTableStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * + * Represents a collection of SlicerStyle objects. + * + * [Api set: ExcelApi 1.10] + */ + interface SlicerStyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the name of the SlicerStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * For EACH ITEM in the collection: Specifies whether this SlicerStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * + * Represents a Slicer Style, which defines style elements by region of the slicer. + * + * [Api set: ExcelApi 1.10] + */ + interface SlicerStyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Gets the name of the SlicerStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * Specifies whether this SlicerStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * + * Represents a collection of TimelineStyles. + * + * [Api set: ExcelApi 1.10] + */ + interface TimelineStyleCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the name of the TimelineStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * For EACH ITEM in the collection: Specifies whether this TimelineStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } + /** + * + * Represents a Timeline style, which defines style elements by region in the Timeline. + * + * [Api set: ExcelApi 1.10] + */ + interface TimelineStyleLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Gets the name of the TimelineStyle. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * Specifies whether this TimelineStyle object is read-only. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + readOnly?: boolean; + } /** * * Represents layout and print settings that are not dependent any printer-specific implementation. These settings include margins, orientation, page numbering, title rows, and print area. @@ -58984,6 +61739,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.2] */ formulasR1C1?: boolean; + /** + * + * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from top edge of the range to bottom edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + height?: boolean; /** * * For EACH ITEM in the collection: Represents if all cells of the current range are hidden. Read-only. @@ -59012,6 +61774,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.7] */ isEntireRow?: boolean; + /** + * + * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from left edge of the worksheet to left edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + left?: boolean; /** * * For EACH ITEM in the collection: Represents the data type state of each cell. Read-only. @@ -59075,6 +61844,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ text?: boolean; + /** + * + * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from top edge of the worksheet to top edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + top?: boolean; /** * * For EACH ITEM in the collection: Represents the type of data of each cell. Read-only. @@ -59090,6 +61866,201 @@ declare namespace Excel { * [Api set: ExcelApi 1.1] */ values?: boolean; + /** + * + * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from left edge of the range to right edge of the range. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + width?: boolean; + } + /** + * + * Represents a collection of comment objects that are part of the workbook. + * + * [Api set: ExcelApi 1.10] + */ + interface CommentCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the email of the comment's author. + * + * [Api set: ExcelApi 1.10] + */ + authorEmail?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the name of the comment's author. + * + * [Api set: ExcelApi 1.10] + */ + authorName?: boolean; + /** + * + * For EACH ITEM in the collection: Gets or sets the comment's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date. + * + * [Api set: ExcelApi 1.10] + */ + creationDate?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the comment identifier. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + } + /** + * + * Represents a comment in the workbook. + * + * [Api set: ExcelApi 1.10] + */ + interface CommentLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Gets the email of the comment's author. + * + * [Api set: ExcelApi 1.10] + */ + authorEmail?: boolean; + /** + * + * Gets the name of the comment's author. + * + * [Api set: ExcelApi 1.10] + */ + authorName?: boolean; + /** + * + * Gets or sets the comment's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content?: boolean; + /** + * + * Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date. + * + * [Api set: ExcelApi 1.10] + */ + creationDate?: boolean; + /** + * + * Represents the comment identifier. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + } + /** + * + * Represents a collection of comment reply objects that are part of the comment. + * + * [Api set: ExcelApi 1.10] + */ + interface CommentReplyCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * + * [Api set: ExcelApi 1.10] + */ + authorEmail?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * + * [Api set: ExcelApi 1.10] + */ + authorName?: boolean; + /** + * + * For EACH ITEM in the collection: Gets or sets the comment reply's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the creation time of the comment reply. + * + * [Api set: ExcelApi 1.10] + */ + creationDate?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the comment reply identifier. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + } + /** + * + * Represents a comment reply in the workbook. + * + * [Api set: ExcelApi 1.10] + */ + interface CommentReplyLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Gets the email of the comment reply's author. + * + * [Api set: ExcelApi 1.10] + */ + authorEmail?: boolean; + /** + * + * Gets the name of the comment reply's author. + * + * [Api set: ExcelApi 1.10] + */ + authorName?: boolean; + /** + * + * Gets or sets the comment reply's content. The string is plain text. + * + * [Api set: ExcelApi 1.10] + */ + content?: boolean; + /** + * + * Gets the creation time of the comment reply. + * + * [Api set: ExcelApi 1.10] + */ + creationDate?: boolean; + /** + * + * Represents the comment reply identifier. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: boolean; } /** * @@ -59230,6 +62201,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ name?: boolean; + /** + * + * For EACH ITEM in the collection: Represents how the object is attached to the cells below it. + * + * [Api set: ExcelApi 1.10] + */ + placement?: boolean; /** * * For EACH ITEM in the collection: Represents the rotation, in degrees, of the shape. @@ -59415,6 +62393,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ name?: boolean; + /** + * + * Represents how the object is attached to the cells below it. + * + * [Api set: ExcelApi 1.10] + */ + placement?: boolean; /** * * Represents the rotation, in degrees, of the shape. @@ -59684,6 +62669,13 @@ declare namespace Excel { * [Api set: ExcelApi 1.9] */ name?: boolean; + /** + * + * For EACH ITEM in the collection: Represents how the object is attached to the cells below it. + * + * [Api set: ExcelApi 1.10] + */ + placement?: boolean; /** * * For EACH ITEM in the collection: Represents the rotation, in degrees, of the shape. @@ -60116,6 +63108,276 @@ declare namespace Excel { */ underline?: boolean; } + /** + * + * Represents a slicer object in the workbook. + * + * [Api set: ExcelApi 1.10] + */ + interface SlicerLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * Represents the worksheet containing the slicer. + * + * [Api set: ExcelApi 1.10] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * + * Represents the caption of slicer. + * + * [Api set: ExcelApi 1.10] + */ + caption?: boolean; + /** + * + * Represents the height, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + height?: boolean; + /** + * + * Represents the unique id of slicer. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + /** + * + * True if all filters currently applied on the slicer are cleared. + * + * [Api set: ExcelApi 1.10] + */ + isFilterCleared?: boolean; + /** + * + * Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + left?: boolean; + /** + * + * Represents the name of slicer. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * [Api set: ExcelApi 1.10] + */ + sortBy?: boolean; + /** + * + * Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * [Api set: ExcelApi 1.10] + */ + style?: boolean; + /** + * + * Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + top?: boolean; + /** + * + * Represents the width, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + width?: boolean; + } + /** + * + * Represents a collection of all the slicer objects on the workbook or a worksheet. + * + * [Api set: ExcelApi 1.10] + */ + interface SlicerCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the worksheet containing the slicer. + * + * [Api set: ExcelApi 1.10] + */ + worksheet?: Excel.Interfaces.WorksheetLoadOptions; + /** + * + * For EACH ITEM in the collection: Represents the caption of slicer. + * + * [Api set: ExcelApi 1.10] + */ + caption?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the height, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + height?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the unique id of slicer. Read-only. + * + * [Api set: ExcelApi 1.10] + */ + id?: boolean; + /** + * + * For EACH ITEM in the collection: True if all filters currently applied on the slicer are cleared. + * + * [Api set: ExcelApi 1.10] + */ + isFilterCleared?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the distance, in points, from the left side of the slicer to the left of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + left?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the name of slicer. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending". + * + * [Api set: ExcelApi 1.10] + */ + sortBy?: boolean; + /** + * + * For EACH ITEM in the collection: Constant value that represents the Slicer style. Possible values are: "SlicerStyleLight1" through "SlicerStyleLight6", "TableStyleOther1" through "TableStyleOther2", "SlicerStyleDark1" through "SlicerStyleDark6". A custom user-defined style present in the workbook can also be specified. + * + * [Api set: ExcelApi 1.10] + */ + style?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the distance, in points, from the top edge of the slicer to the top of the worksheet. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value as input. + * + * [Api set: ExcelApi 1.10] + */ + top?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the width, in points, of the slicer. + Throws an "The argument is invalid or missing or has an incorrect format." exception when set with negative value or zero as input. + * + * [Api set: ExcelApi 1.10] + */ + width?: boolean; + } + /** + * + * Represents a slicer item in a slicer. + * + * [Api set: ExcelApi 1.10] + */ + interface SlicerItemLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * True if the slicer item has data. + * + * [Api set: ExcelApi 1.10] + */ + hasData?: boolean; + /** + * + * True if the slicer item is selected. + Setting this value will not clear other SlicerItems' selected state. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * [Api set: ExcelApi 1.10] + */ + isSelected?: boolean; + /** + * + * Represents the unique value representing the slicer item. + * + * [Api set: ExcelApi 1.10] + */ + key?: boolean; + /** + * + * Represents the title displayed in the UI. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + } + /** + * + * Represents a collection of all the slicer item objects on the slicer. + * + * [Api set: ExcelApi 1.10] + */ + interface SlicerItemCollectionLoadOptions { + /** + Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`). + */ + $all?: boolean; + /** + * + * For EACH ITEM in the collection: True if the slicer item has data. + * + * [Api set: ExcelApi 1.10] + */ + hasData?: boolean; + /** + * + * For EACH ITEM in the collection: True if the slicer item is selected. + Setting this value will not clear other SlicerItems' selected state. + By default, if the slicer item is the only one selected, when it is deselected, all items will be selected. + * + * [Api set: ExcelApi 1.10] + */ + isSelected?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the unique value representing the slicer item. + * + * [Api set: ExcelApi 1.10] + */ + key?: boolean; + /** + * + * For EACH ITEM in the collection: Represents the title displayed in the UI. + * + * [Api set: ExcelApi 1.10] + */ + name?: boolean; + } /** * * An object containing the result of a function-evaluation operation @@ -60172,7 +63434,7 @@ declare namespace Word { */ class Application extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Creates a new document by using an optional base64 encoded .docx file. @@ -60202,7 +63464,7 @@ declare namespace Word { */ class Body extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the collection of rich text content control objects in the body. Read-only. @@ -60618,7 +63880,7 @@ declare namespace Word { */ class ContentControl extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the collection of content control objects in the content control. Read-only. @@ -61135,7 +64397,7 @@ declare namespace Word { */ class ContentControlCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.ContentControl[]; /** @@ -61246,7 +64508,7 @@ declare namespace Word { */ class CustomProperty extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the key of the custom property. Read only. @@ -61332,7 +64594,7 @@ declare namespace Word { */ class CustomPropertyCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.CustomProperty[]; /** @@ -61417,7 +64679,7 @@ declare namespace Word { */ class Document extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only. @@ -61524,7 +64786,7 @@ declare namespace Word { */ class DocumentCreated extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc.. Read-only. @@ -61631,7 +64893,7 @@ declare namespace Word { */ class DocumentProperties extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the collection of custom properties of the document. Read only. @@ -61815,7 +65077,7 @@ declare namespace Word { */ class Font extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets or sets a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. @@ -61951,7 +65213,7 @@ declare namespace Word { */ class InlinePicture extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the parent paragraph that contains the inline image. Read-only. @@ -62311,7 +65573,7 @@ declare namespace Word { */ class InlinePictureCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.InlinePicture[]; /** @@ -62368,7 +65630,7 @@ declare namespace Word { */ class List extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets paragraphs in the list. Read-only. @@ -62565,7 +65827,7 @@ declare namespace Word { */ class ListCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.List[]; /** @@ -62649,7 +65911,7 @@ declare namespace Word { */ class ListItem extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets or sets the level of the item in the list. @@ -62755,7 +66017,7 @@ declare namespace Word { */ class Paragraph extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the collection of content control objects in the paragraph. Read-only. @@ -63349,7 +66611,7 @@ declare namespace Word { */ class ParagraphCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Paragraph[]; /** @@ -63420,7 +66682,7 @@ declare namespace Word { */ 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. */ - context: RequestContext; + context: RequestContext; /** * * Gets the collection of content control objects in the range. Read-only. @@ -63951,7 +67213,7 @@ declare namespace Word { */ class RangeCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Range[]; /** @@ -64008,7 +67270,7 @@ declare namespace Word { */ class SearchOptions extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; matchWildCards: boolean; /** * @@ -64112,7 +67374,7 @@ declare namespace Word { */ class Section extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the body object of the section. This does not include the header/footer and other section metadata. Read-only. @@ -64227,7 +67489,7 @@ declare namespace Word { */ class SectionCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Section[]; /** @@ -64284,7 +67546,7 @@ declare namespace Word { */ 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. */ - context: RequestContext; + context: RequestContext; /** * * Gets the font. Use this to get and set font name, size, color, and other properties. Read-only. @@ -64846,7 +68108,7 @@ declare namespace Word { */ class TableCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.Table[]; /** @@ -64903,7 +68165,7 @@ declare namespace Word { */ class TableRow extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets cells. Read-only. @@ -65180,7 +68442,7 @@ declare namespace Word { */ class TableRowCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.TableRow[]; /** @@ -65237,7 +68499,7 @@ declare namespace Word { */ class TableCell extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets the body object of the cell. Read-only. @@ -65500,7 +68762,7 @@ declare namespace Word { */ class TableCellCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** Gets the loaded child items in this collection. */ readonly items: Word.TableCell[]; /** @@ -65557,7 +68819,7 @@ declare namespace Word { */ class TableBorder extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ - context: RequestContext; + context: RequestContext; /** * * Gets or sets the table border color.