From 512557d9bb20db95ed24c5115f699be8b83de849 Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Fri, 6 Dec 2019 15:50:44 -0800 Subject: [PATCH] [office-js, office-js-preview] Excel updates from CDN (ExcelApiOnline 1.1) (#40830) * Excel updates * Adressing text issues * Adressing text issues --- types/office-js-preview/index.d.ts | 346 +++++++++++++++++++++++------ types/office-js/index.d.ts | 230 +++++++++++++++++-- 2 files changed, 483 insertions(+), 93 deletions(-) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 48bbfcaa76..fa97e05de9 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -20181,6 +20181,14 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ readonly comments: Excel.CommentCollection; + /** + * + * Returns a collection of worksheet-level custom properties. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly customProperties: Excel.WorksheetCustomPropertyCollection; /** * * Gets an object that can be used to manipulate frozen panes on the worksheet. Read-only. @@ -20683,8 +20691,8 @@ declare namespace Excel { /** * * Inserts the specified worksheets of a workbook into the current workbook. - * - * **Note**: This API is currently only supported for Office on Windows and Mac. + + **Note**: This API is currently only supported for Office on Windows and Mac. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @beta @@ -20699,8 +20707,8 @@ declare namespace Excel { /** * * Inserts the specified worksheets of a workbook into the current workbook. - * - * **Note**: This API is currently only supported for Office on Windows and Mac. + + **Note**: This API is currently only supported for Office on Windows and Mac. * * [Api set: ExcelApi BETA (PREVIEW ONLY)] * @@ -21961,8 +21969,7 @@ declare namespace Excel { * 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 + * [Api set: ExcelApiOnline 1.1] * * @param destinationRange destinationRange Specifies the range to where the information in this range will be moved. */ @@ -22507,7 +22514,9 @@ 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. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). 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] */ @@ -22536,7 +22545,9 @@ 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. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). 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] */ @@ -22558,7 +22569,9 @@ declare namespace Excel { interface ReplaceCriteria { /** * - * 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). + * 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] */ @@ -25178,10 +25191,9 @@ declare namespace Excel { set(properties: Excel.RangeFormat): void; /** * - * Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250. + * Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250 and is measured in characters.. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] * * @param amount The number of character spaces by which the current indent is adjusted. This value should be between -250 and 250. **Note**: If the amount would raise the indent level above 250, the indent level stays with 250. @@ -30937,7 +30949,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.2] */ - set: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; + set: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; } /** * @@ -32866,6 +32878,123 @@ declare namespace Excel { */ filter = "Filter" } + /** + * + * Represents a worksheet-level custom property. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + class WorksheetCustomProperty 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 key of the custom property. Read only. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly key: string; + /** + * + * Gets the value of the custom property. Read only. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly value: 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.WorksheetCustomPropertyLoadOptions): Excel.WorksheetCustomProperty; + /** + * 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.WorksheetCustomProperty; + /** + * 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.WorksheetCustomProperty; + /** + * 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.WorksheetCustomProperty object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetCustomPropertyData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Excel.Interfaces.WorksheetCustomPropertyData; + } + /** + * + * Contains the collection of worksheet-level custom property. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + class WorksheetCustomPropertyCollection 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.WorksheetCustomProperty[]; + /** + * + * Gets the number of custom properties on this worksheet. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * + * Gets a custom property object by its key, which is case-insensitive. Throws if the custom property does not exist. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * + * @param key The key that identifies the custom property object. + */ + getItem(key: string): Excel.WorksheetCustomProperty; + /** + * + * Gets a custom property object by its key, which is case-insensitive. Returns a null object if the custom property does not exist. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + * + * @param key The key that identifies the custom property object. + */ + getItemOrNullObject(key: string): Excel.WorksheetCustomProperty; + /** + * 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.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection; + /** + * 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.WorksheetCustomPropertyCollection; + /** + * 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.WorksheetCustomPropertyCollection; + /** + * 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.WorksheetCustomPropertyCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.WorksheetCustomPropertyCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData; + } /** * * Represents workbook properties. @@ -33924,7 +34053,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.6] */ - style: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; + style: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; /** 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 @@ -36584,32 +36713,28 @@ declare namespace Excel { * * Represents the entity that is mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ interface CommentMention { /** * * Gets or sets the email address of the entity that is mentioned in comment. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ email: string; /** * - * Gets or sets the id of the entity. This is aligned with the id information in `CommentRichContent.richContent`. + * Gets or sets the id of the entity. This matches one of the ids in `CommentRichContent.richContent`. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ id: number; /** * * Gets or sets the name of the entity that is mentioned in comment. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ name: string; } @@ -36617,14 +36742,14 @@ 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 1.10] + * [Api set: ExcelApiOnline 1.1] */ interface CommentRichContent { /** * * An array containing all the entities (e.g. people) mentioned within the comment. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * [Api set: ExcelApiOnline 1.1] */ mentions?: Excel.CommentMention[]; richContent: string; @@ -36647,8 +36772,8 @@ declare namespace Excel { * [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`. + * @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, ExcelApiOnline 1.1 for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, ExcelApiOnline 1.1 for Enum ContentType.Mention] */ add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment; /** @@ -36658,8 +36783,8 @@ declare namespace Excel { * [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`. + * @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, ExcelApiOnline 1.1 for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, ExcelApiOnline 1.1 for Enum ContentType.Mention] */ add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.Comment; /** @@ -36784,8 +36909,7 @@ declare namespace Excel { * * Gets the entities (e.g. people) that are mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ readonly mentions: Excel.CommentMention[]; /** @@ -36800,8 +36924,7 @@ declare namespace Excel { * * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ readonly richContent: 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. @@ -36836,8 +36959,7 @@ declare namespace Excel { * * Updates the comment content with a specially formatted string and a list of mentions. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] * * @param contentWithMentions The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel. */ @@ -36886,8 +37008,8 @@ declare namespace Excel { * * [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`. + * @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, ExcelApiOnline 1.1 for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, ExcelApiOnline 1.1 for Enum ContentType.Mention] */ add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply; /** @@ -36896,8 +37018,8 @@ declare namespace Excel { * * [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`. + * @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, ExcelApiOnline 1.1 for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, ExcelApiOnline 1.1 for Enum ContentType.Mention] */ add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply; /** @@ -36997,8 +37119,7 @@ declare namespace Excel { * * Gets the entities (e.g. people) that are mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ readonly mentions: Excel.CommentMention[]; /** @@ -37013,8 +37134,7 @@ declare namespace Excel { * * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ readonly richContent: 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. @@ -37056,8 +37176,7 @@ declare namespace Excel { * * Updates the comment content with a specially formatted string and a list of mentions. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] * * @param contentWithMentions The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel. */ @@ -40317,9 +40436,7 @@ declare namespace Excel { fiveQuarters = "FiveQuarters", threeStars = "ThreeStars", threeTriangles = "ThreeTriangles", - fiveBoxes = "FiveBoxes", - linkedEntityFinanceIcon = "LinkedEntityFinanceIcon", - linkedEntityMapIcon = "LinkedEntityMapIcon" + fiveBoxes = "FiveBoxes" } /** * [Api set: ExcelApi 1.2] @@ -48593,6 +48710,10 @@ declare namespace Excel { */ visible?: boolean; } + /** An interface for updating data on the WorksheetCustomPropertyCollection object, for use in `worksheetCustomPropertyCollection.set({ ... })`. */ + interface WorksheetCustomPropertyCollectionUpdateData { + items?: Excel.Interfaces.WorksheetCustomPropertyData[]; + } /** An interface for updating data on the DocumentProperties object, for use in `documentProperties.set({ ... })`. */ interface DocumentPropertiesUpdateData { /** @@ -49006,7 +49127,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.6] */ - style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; + style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; } /** An interface for updating data on the ColorScaleConditionalFormat object, for use in `colorScaleConditionalFormat.set({ ... })`. */ interface ColorScaleConditionalFormatUpdateData { @@ -50502,6 +50623,14 @@ declare namespace Excel { comments?: Excel.Interfaces.CommentData[]; /** * + * Returns a collection of worksheet-level custom properties. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[]; + /** + * * Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks. * * [Api set: ExcelApi 1.9] @@ -54346,6 +54475,29 @@ declare namespace Excel { */ visible?: boolean; } + /** An interface describing the data returned by calling `worksheetCustomProperty.toJSON()`. */ + interface WorksheetCustomPropertyData { + /** + * + * Gets the key of the custom property. Read only. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + key?: string; + /** + * + * Gets the value of the custom property. Read only. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + value?: string; + } + /** An interface describing the data returned by calling `worksheetCustomPropertyCollection.toJSON()`. */ + interface WorksheetCustomPropertyCollectionData { + items?: Excel.Interfaces.WorksheetCustomPropertyData[]; + } /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ interface DocumentPropertiesData { /** @@ -54808,7 +54960,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.6] */ - style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; + style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; } /** An interface describing the data returned by calling `colorScaleConditionalFormat.toJSON()`. */ interface ColorScaleConditionalFormatData { @@ -55578,8 +55730,7 @@ declare namespace Excel { * * Gets the entities (e.g. people) that are mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ mentions?: Excel.CommentMention[]; /** @@ -55594,8 +55745,7 @@ declare namespace Excel { * * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ richContent?: string; } @@ -55644,8 +55794,7 @@ declare namespace Excel { * * Gets the entities (e.g. people) that are mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ mentions?: Excel.CommentMention[]; /** @@ -55660,8 +55809,7 @@ declare namespace Excel { * * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ richContent?: string; } @@ -62707,6 +62855,64 @@ declare namespace Excel { */ visible?: boolean; } + /** + * + * Represents a worksheet-level custom property. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface WorksheetCustomPropertyLoadOptions { + /** + 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 key of the custom property. Read only. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + key?: boolean; + /** + * + * Gets the value of the custom property. Read only. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + value?: boolean; + } + /** + * + * Contains the collection of worksheet-level custom property. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + interface WorksheetCustomPropertyCollectionLoadOptions { + /** + 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 key of the custom property. Read only. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + key?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the value of the custom property. Read only. + * + * [Api set: ExcelApi BETA (PREVIEW ONLY)] + * @beta + */ + value?: boolean; + } /** * * Represents workbook properties. @@ -64904,8 +65110,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the entities (e.g. people) that are mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ mentions?: boolean; /** @@ -64920,8 +65125,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ richContent?: boolean; } @@ -64975,8 +65179,7 @@ declare namespace Excel { * * Gets the entities (e.g. people) that are mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ mentions?: boolean; /** @@ -64991,8 +65194,7 @@ declare namespace Excel { * * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ richContent?: boolean; } @@ -65046,8 +65248,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the entities (e.g. people) that are mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ mentions?: boolean; /** @@ -65062,8 +65263,7 @@ declare namespace Excel { * * For EACH ITEM in the collection: Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ richContent?: boolean; } @@ -65117,8 +65317,7 @@ declare namespace Excel { * * Gets the entities (e.g. people) that are mentioned in comments. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ mentions?: boolean; /** @@ -65133,8 +65332,7 @@ declare namespace Excel { * * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. * - * [Api set: ExcelApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: ExcelApiOnline 1.1] */ richContent?: boolean; } diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 811802eaf7..f35e8185b7 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -21138,6 +21138,16 @@ 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: ExcelApiOnline 1.1] + * + * @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. @@ -21678,7 +21688,9 @@ 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. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). 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] */ @@ -21707,7 +21719,9 @@ 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. A partial match matches a substring within the content of the cell (e.g., `cat` partially matches `caterpillar` and `scatter`). 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] */ @@ -21729,7 +21743,9 @@ declare namespace Excel { interface ReplaceCriteria { /** * - * 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). + * 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] */ @@ -24319,6 +24335,17 @@ declare namespace Excel { set(properties: Interfaces.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Excel.RangeFormat): void; + /** + * + * Adjusts the indentation of the range formatting. The indent value ranges from 0 to 250 and is measured in characters.. + * + * [Api set: ExcelApiOnline 1.1] + * + * @param amount The number of character spaces by which the current indent is adjusted. This value should be between -250 and 250. + **Note**: If the amount would raise the indent level above 250, the indent level stays with 250. + Similarly, if the amount would lower the indent level below 0, the indent level stays 0. + */ + adjustIndent(amount: number): void; /** * * Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns. @@ -29943,7 +29970,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.2] */ - set: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; + set: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; } /** * @@ -32917,7 +32944,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.6] */ - style: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; + style: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; /** 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 @@ -35573,13 +35600,50 @@ declare namespace Excel { */ toJSON(): Excel.Interfaces.RangeCollectionData; } + /** + * + * Represents the entity that is mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + interface CommentMention { + /** + * + * Gets or sets the email address of the entity that is mentioned in comment. + * + * [Api set: ExcelApiOnline 1.1] + */ + email: string; + /** + * + * Gets or sets the id of the entity. This matches one of the ids in `CommentRichContent.richContent`. + * + * [Api set: ExcelApiOnline 1.1] + */ + id: number; + /** + * + * Gets or sets the name of the entity that is mentioned in comment. + * + * [Api set: ExcelApiOnline 1.1] + */ + name: string; + } /** * * 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] + * [Api set: ExcelApiOnline 1.1] */ interface CommentRichContent { + /** + * + * An array containing all the entities (e.g. people) mentioned within the comment. + * + * [Api set: ExcelApiOnline 1.1] + */ + mentions?: Excel.CommentMention[]; + richContent: string; } /** * @@ -35599,8 +35663,8 @@ declare namespace Excel { * [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`. + * @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, ExcelApiOnline 1.1 for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, ExcelApiOnline 1.1 for Enum ContentType.Mention] */ add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment; /** @@ -35610,8 +35674,8 @@ declare namespace Excel { * [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`. + * @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, ExcelApiOnline 1.1 for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, ExcelApiOnline 1.1 for Enum ContentType.Mention] */ add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.Comment; /** @@ -35732,6 +35796,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ readonly id: string; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + readonly mentions: Excel.CommentMention[]; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApiOnline 1.1] + */ + readonly richContent: 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 @@ -35760,6 +35838,15 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ getLocation(): Excel.Range; + /** + * + * Updates the comment content with a specially formatted string and a list of mentions. + * + * [Api set: ExcelApiOnline 1.1] + * + * @param contentWithMentions The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel. + */ + updateMentions(contentWithMentions: Excel.CommentRichContent): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -35804,8 +35891,8 @@ declare namespace Excel { * * [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`. + * @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, ExcelApiOnline 1.1 for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, ExcelApiOnline 1.1 for Enum ContentType.Mention] */ add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply; /** @@ -35814,8 +35901,8 @@ declare namespace Excel { * * [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`. + * @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, ExcelApiOnline 1.1 for CommentRichContent object] + * @param contentType Optional. The type of content contained within the comment. The default value is enum `ContentType.Plain`. [Api set: ExcelApi 1.10 for Enum ContentType.Plain, ExcelApiOnline 1.1 for Enum ContentType.Mention] */ add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply; /** @@ -35911,6 +35998,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ readonly id: string; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + readonly mentions: Excel.CommentMention[]; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApiOnline 1.1] + */ + readonly richContent: 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 @@ -35946,6 +36047,15 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ getParentComment(): Excel.Comment; + /** + * + * Updates the comment content with a specially formatted string and a list of mentions. + * + * [Api set: ExcelApiOnline 1.1] + * + * @param contentWithMentions The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel. + */ + updateMentions(contentWithMentions: Excel.CommentRichContent): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -39166,9 +39276,7 @@ declare namespace Excel { fiveQuarters = "FiveQuarters", threeStars = "ThreeStars", threeTriangles = "ThreeTriangles", - fiveBoxes = "FiveBoxes", - linkedEntityFinanceIcon = "LinkedEntityFinanceIcon", - linkedEntityMapIcon = "LinkedEntityMapIcon" + fiveBoxes = "FiveBoxes" } /** * [Api set: ExcelApi 1.2] @@ -47829,7 +47937,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.6] */ - style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; + style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; } /** An interface for updating data on the ColorScaleConditionalFormat object, for use in `colorScaleConditionalFormat.set({ ... })`. */ interface ColorScaleConditionalFormatUpdateData { @@ -53516,7 +53624,7 @@ declare namespace Excel { * * [Api set: ExcelApi 1.6] */ - style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes" | "LinkedEntityFinanceIcon" | "LinkedEntityMapIcon"; + style?: Excel.IconSet | "Invalid" | "ThreeArrows" | "ThreeArrowsGray" | "ThreeFlags" | "ThreeTrafficLights1" | "ThreeTrafficLights2" | "ThreeSigns" | "ThreeSymbols" | "ThreeSymbols2" | "FourArrows" | "FourArrowsGray" | "FourRedToBlack" | "FourRating" | "FourTrafficLights" | "FiveArrows" | "FiveArrowsGray" | "FiveRating" | "FiveQuarters" | "ThreeStars" | "ThreeTriangles" | "FiveBoxes"; } /** An interface describing the data returned by calling `colorScaleConditionalFormat.toJSON()`. */ interface ColorScaleConditionalFormatData { @@ -54282,6 +54390,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ id?: string; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + mentions?: Excel.CommentMention[]; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApiOnline 1.1] + */ + richContent?: string; } /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ interface CommentReplyCollectionData { @@ -54324,6 +54446,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ id?: string; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + mentions?: Excel.CommentMention[]; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApiOnline 1.1] + */ + richContent?: string; } /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ interface ShapeCollectionData { @@ -63413,6 +63549,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ id?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + mentions?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApiOnline 1.1] + */ + richContent?: boolean; } /** * @@ -63460,6 +63610,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ id?: boolean; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + mentions?: boolean; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApiOnline 1.1] + */ + richContent?: boolean; } /** * @@ -63507,6 +63671,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ id?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + mentions?: boolean; + /** + * + * For EACH ITEM in the collection: Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApiOnline 1.1] + */ + richContent?: boolean; } /** * @@ -63554,6 +63732,20 @@ declare namespace Excel { * [Api set: ExcelApi 1.10] */ id?: boolean; + /** + * + * Gets the entities (e.g. people) that are mentioned in comments. + * + * [Api set: ExcelApiOnline 1.1] + */ + mentions?: boolean; + /** + * + * Gets the rich comment content (e.g. mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content. + * + * [Api set: ExcelApiOnline 1.1] + */ + richContent?: boolean; } /** *