@types/office-js 1.0.516 → 1.0.518

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +366 -164
  3. office-js/package.json +2 -2
office-js/index.d.ts CHANGED
@@ -7195,7 +7195,11 @@ declare namespace Office {
7195
7195
  *
7196
7196
  * @remarks
7197
7197
  *
7198
- * **Important**: The `isDarkTheme` property isn't yet supported in Outlook.
7198
+ * **Important**: The `isDarkTheme` property isn't supported in Outlook. To determine the current theme in Outlook,
7199
+ * use the `body*Color` and `control*Color` properties instead. To automatically detect theme changes, use the
7200
+ * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailbox#outlook-office-mailbox-addhandlerasync-member(1) | addHandlerAsync}
7201
+ * method to create an event handler for the {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | OfficeThemeChanged}
7202
+ * event.
7199
7203
  */
7200
7204
  isDarkTheme: boolean;
7201
7205
  /**
@@ -7203,7 +7207,11 @@ declare namespace Office {
7203
7207
  *
7204
7208
  * @remarks
7205
7209
  *
7206
- * **Important**: The `themeId` property isn't yet supported in Outlook.
7210
+ * **Important**: The `themeId` property isn't supported in Outlook. To determine the current theme in Outlook,
7211
+ * use the `body*Color` and `control*Color` properties instead. To automatically detect theme changes, use the
7212
+ * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailbox#outlook-office-mailbox-addhandlerasync-member(1) | addHandlerAsync}
7213
+ * method to create an event handler for the {@link https://learn.microsoft.com/javascript/api/office/office.eventtype#fields | OfficeThemeChanged}
7214
+ * event.
7207
7215
  */
7208
7216
  themeId: ThemeId;
7209
7217
  }
@@ -8905,6 +8913,36 @@ declare namespace Office {
8905
8913
  */
8906
8914
  Item = "item"
8907
8915
  }
8916
+ /**
8917
+ * Specifies the portion of a message's body displayed for replies to a conversation thread with more than one message.
8918
+ *
8919
+ * @remarks
8920
+ *
8921
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
8922
+ *
8923
+ * **Important**: This enum is only supported in Outlook on the web and new Outlook on Windows. On these platforms, users can organize their messages as
8924
+ * conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**. This user setting affects the portion of the body of a message that's displayed.
8925
+ *
8926
+ * The `BodyMode` enum supports the following message organization settings.
8927
+ *
8928
+ * - Conversations: **Group messages by conversation** > **All messages from the selected conversation** or **Show email grouped by conversation** > **Newest on top**\/**Newest on bottom**
8929
+ *
8930
+ * - Individual messages: **Do not group messages** > **Only a single message** or **Show email as individual messages**
8931
+ *
8932
+ * For more information, see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}.
8933
+ */
8934
+ enum BodyMode {
8935
+ /**
8936
+ * The entire body of a message, including previous messages from the same conversation thread.
8937
+ */
8938
+ FullBody = 0,
8939
+ /**
8940
+ * The body mode depends on the user's current setting for message organization (that is, messages are organized as conversations or individual messages).
8941
+ * If messages are organized by conversation, it specifies only the current body of the reply. Conversely, if messages are organized as individual
8942
+ * messages, it specifies the entire body of a message, including previous messages from the same conversation thread.
8943
+ */
8944
+ HostConfig = 1
8945
+ }
8908
8946
  /**
8909
8947
  * Specifies the category color.
8910
8948
  *
@@ -12931,6 +12969,9 @@ declare namespace Office {
12931
12969
  * @remarks
12932
12970
  * [Api set: Mailbox 1.1]
12933
12971
  *
12972
+ * To learn how to get or set the body of a mail item, see
12973
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/insert-data-in-the-body | Get or set the body of a message or appointment in Outlook}.
12974
+ *
12934
12975
  * **Known issue with HTML table border colors**
12935
12976
  *
12936
12977
  * Outlook on Windows: If you're setting various cell borders to different colors in an HTML table in Compose mode, a cell's borders may not reflect
@@ -13033,9 +13074,7 @@ declare namespace Office {
13033
13074
  */
13034
13075
  appendOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13035
13076
  /**
13036
- * Returns the current body in a specified format.
13037
- *
13038
- * This method returns the entire current body in the format specified by `coercionType`.
13077
+ * Returns the entire current body in the format specified by `coercionType`.
13039
13078
  *
13040
13079
  * @remarks
13041
13080
  * [Api set: Mailbox 1.3]
@@ -13054,17 +13093,28 @@ declare namespace Office {
13054
13093
  * if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
13055
13094
  * Otherwise, you may receive an unexpected value, such as an empty string.
13056
13095
  *
13096
+ * - In Outlook on the web and new Outlook on Windows, users can organize their messages as conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**
13097
+ * (see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}).
13098
+ * This setting affects how much of a message's body is displayed to the user (that is, the entire conversation thread of a message or just the current message).
13099
+ * In Message Compose mode, particularly for replies to a conversation thread with more than one message, if you want the returned body to reflect the user's setting,
13100
+ * specify the `bodyMode: Office.MailboxEnums.BodyMode.HostConfig` parameter in your `getAsync` call. If messages are grouped by conversation,
13101
+ * only the body of the current reply is returned. Conversely, if messages are displayed individually, the entire conversation thread is returned.
13102
+ *
13103
+ * - The `bodyMode` option isn't supported on a message that's loaded using the `loadItemByIdAsync` method. For more information, see
13104
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
13105
+ *
13057
13106
  * @param coercionType - The format for the returned body.
13058
- * @param options - An object literal that contains one or more of the following properties:-
13059
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13107
+ * @param options - An object literal that contains one or more of the following properties.
13108
+ * `asyncContext`: Any data you want to access in the callback function.
13109
+ * `bodyMode`: In Outlook on the web and new Outlook on Windows, specifies whether only the body of the current message or the entire body of a message conversation is returned.
13110
+ * If a value isn't specified, `bodyMode` defaults to `Office.MailboxEnums.BodyMode.FullBody`, which returns the entire body of a message conversation. The `bodyMode` property only
13111
+ * applies to replies on the Message Compose surface. It's ignored in Outlook on Windows (classic), on Mac, and on mobile devices.
13060
13112
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
13061
- * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
13113
+ * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
13062
13114
  */
13063
- getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
13115
+ getAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
13064
13116
  /**
13065
- * Returns the current body in a specified format.
13066
- *
13067
- * This method returns the entire current body in the format specified by `coercionType`.
13117
+ * Returns the entire current body in the format specified by `coercionType`.
13068
13118
  *
13069
13119
  * @remarks
13070
13120
  * [Api set: Mailbox 1.3]
@@ -13083,9 +13133,16 @@ declare namespace Office {
13083
13133
  * if the body contains formatted elements, such as tables, lists, and links, specify `Office.CoercionType.Html` in the `getAsync` call.
13084
13134
  * Otherwise, you may receive an unexpected value, such as an empty string.
13085
13135
  *
13136
+ * - In Outlook on the web and new Outlook on Windows, users can organize their messages as conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**
13137
+ * (see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}).
13138
+ * This setting affects how much of a message's body is displayed to the user (that is, the entire conversation thread of a message or just the current message).
13139
+ * In Message Compose mode, particularly for replies to a conversation thread with more than one message, if you want the returned body to reflect the user's setting,
13140
+ * specify the `bodyMode: Office.MailboxEnums.BodyMode.HostConfig` parameter in your `getAsync` call. If messages are grouped by conversation,
13141
+ * only the body of the current reply is returned. Conversely, if messages are displayed individually, the entire conversation thread is returned.
13142
+ *
13086
13143
  * @param coercionType - The format for the returned body.
13087
13144
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
13088
- * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
13145
+ * of type Office.AsyncResult. The body is provided in the requested format in the `asyncResult.value` property.
13089
13146
  */
13090
13147
  getAsync(coercionType: Office.CoercionType | string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
13091
13148
  /**
@@ -13358,20 +13415,36 @@ declare namespace Office {
13358
13415
  * - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
13359
13416
  * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
13360
13417
  *
13418
+ * - In Outlook on the web and new Outlook on Windows, users can organize their messages as conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**
13419
+ * (see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}).
13420
+ * This setting affects how much of a message's body is displayed to the user (that is, the entire conversation thread of a message or just the current message).
13421
+ * In Message Compose mode, particularly for replies to a conversation thread with more than one message, if you want to honor the user's settings when
13422
+ * setting the body of a message, specify the `bodyMode: Office.MailboxEnums.BodyMode.HostConfig` parameter in your `setAsync` call. If messages are grouped by conversation,
13423
+ * only the body of the current reply is set. Conversely, if messages are displayed individually, the entire body, including previous messages
13424
+ * in the conversation thread, is replaced.
13425
+ *
13426
+ * - In Outlook on the web and new Outlook on Windows, if the `bodyMode` property isn't specified or is set to `Office.MailboxEnums.BodyMode.FullBody`, the entire body of a message,
13427
+ * including previous messages from the conversation thread, is replaced. This applies even if a user's messages are organized by conversation. In this scenario, the user's
13428
+ * setting is temporarily changed to **Individual messages: Do not group messages** > **Only a single message** or **Show email as individual messages** during the `setAsync` call.
13429
+ * A notification is shown to the user to alert them to this change. Once the call completes, the user's setting is reinstated.
13430
+ *
13361
13431
  * **Errors**:
13362
13432
  *
13363
13433
  * - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
13364
13434
  *
13365
13435
  * - `InvalidFormatError`: The `options.coercionType` parameter is set to `Office.CoercionType.Html` and the message body is in plain text.
13366
13436
  *
13367
- * @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters.
13368
- * @param options - An object literal that contains one or more of the following properties:-
13369
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
13370
- * `coercionType`: The desired format for the body. The string in the `data` parameter will be converted to this format.
13437
+ * @param data - The string that replaces the existing body. The string is limited to 1,000,000 characters.
13438
+ * @param options - An object literal that contains one or more of the following properties.
13439
+ * `asyncContext`: Any data you want to access in the callback function.
13440
+ * `coercionType`: The desired format for the body. The string in the `data` parameter is converted to this format.
13441
+ * `bodyMode`: In Outlook on the web and new Outlook on Windows, specifies whether only the body of the current message or the entire body of a message conversation is set.
13442
+ * If a value isn't specified, `bodyMode` defaults to `Office.MailboxEnums.BodyMode.FullBody`, which replaces the entire body, including previous messages in the conversation thread.
13443
+ * The `bodyMode` property only applies to replies on the Message Compose surface. It's ignored in Outlook on Windows (classic), on Mac, and on mobile devices.
13371
13444
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
13372
- * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
13445
+ * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
13373
13446
  */
13374
- setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13447
+ setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13375
13448
  /**
13376
13449
  * Replaces the entire body with the specified text.
13377
13450
  *
@@ -13412,6 +13485,19 @@ declare namespace Office {
13412
13485
  * - The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
13413
13486
  * For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select | Activate your Outlook add-in on multiple messages}.
13414
13487
  *
13488
+ * - In Outlook on the web and new Outlook on Windows, users can organize their messages as conversations or individual messages in **Settings** > **Mail** > **Layout** > **Message organization**
13489
+ * (see {@link https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042 | Change how the message list is displayed in Outlook}).
13490
+ * This setting affects how much of a message's body is displayed to the user (that is, the entire conversation thread of a message or just the current message).
13491
+ * In Message Compose mode, particularly for replies in a conversation thread with more than one message, if you want to honor the user's settings when
13492
+ * setting the body of a message, specify the `bodyMode: Office.MailboxEnums.BodyMode.HostConfig` parameter in your `setAsync` call. If messages are grouped by conversation,
13493
+ * only the body of the current reply is set. Conversely, if messages are displayed individually, the entire body, including previous messages
13494
+ * in the conversation thread, is replaced.
13495
+ *
13496
+ * - In Outlook on the web and new Outlook on Windows, if the `bodyMode` property isn't specified or is set to `Office.MailboxEnums.BodyMode.FullBody`, the entire body of a message,
13497
+ * including previous messages from the conversation thread, is replaced. This applies even if a user's messages are organized by conversation. In this scenario, the user's
13498
+ * setting is temporarily changed to **Individual messages: Do not group messages** > **Only a single message** or **Show email as individual messages** during the `setAsync` call.
13499
+ * A notification is shown to the user to alert them to this change. Once the call completes, the user's setting is reinstated.
13500
+ *
13415
13501
  * **Errors**:
13416
13502
  *
13417
13503
  * - `DataExceedsMaximumSize`: The data parameter is longer than 1,000,000 characters.
@@ -13420,7 +13506,7 @@ declare namespace Office {
13420
13506
  *
13421
13507
  * @param data - The string that will replace the existing body. The string is limited to 1,000,000 characters.
13422
13508
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
13423
- * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
13509
+ * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
13424
13510
  */
13425
13511
  setAsync(data: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13426
13512
  /**
@@ -32083,7 +32169,9 @@ declare namespace Excel {
32083
32169
  * [Api set: ExcelApiOnline 1.1]
32084
32170
  *
32085
32171
  * @param key The title of the `AllowEditRange`.
32086
- * @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
32172
+ * @returns The `AllowEditRange` with the title.
32173
+ If there is no `AllowEditRange` with the given title, then this method returns an object with its `isNullObject` property set to `true`.
32174
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
32087
32175
  */
32088
32176
  getItemOrNullObject(key: string): Excel.AllowEditRange;
32089
32177
  /**
@@ -32578,7 +32666,8 @@ declare namespace Excel {
32578
32666
  */
32579
32667
  getItem(key: string): Excel.LinkedWorkbook;
32580
32668
  /**
32581
- * Gets information about a linked workbook by its URL. If the workbook does not exist, then this method returns an object with its `isNullObject` property set to `true`.
32669
+ * Gets information about a linked workbook by its URL.
32670
+ If the workbook does not exist, then this method returns an object with its `isNullObject` property set to `true`.
32582
32671
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
32583
32672
  *
32584
32673
  * @remarks
@@ -35263,7 +35352,8 @@ declare namespace Excel {
35263
35352
  */
35264
35353
  getActiveChart(): Excel.Chart;
35265
35354
  /**
35266
- * Gets the currently active chart in the workbook. If there is no active chart, then this method returns an object with its `isNullObject` property set to `true`.
35355
+ * Gets the currently active chart in the workbook.
35356
+ If there is no active chart, then this method returns an object with its `isNullObject` property set to `true`.
35267
35357
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
35268
35358
  *
35269
35359
  * @remarks
@@ -35271,14 +35361,16 @@ declare namespace Excel {
35271
35361
  */
35272
35362
  getActiveChartOrNullObject(): Excel.Chart;
35273
35363
  /**
35274
- * Gets the active shape in the workbook. If there is no active shape, an `ItemNotFound` error is thrown.
35364
+ * Gets the active shape in the workbook.
35365
+ Throws an `ItemNotFound` if there is no active shape.
35275
35366
  *
35276
35367
  * @remarks
35277
35368
  * [Api set: ExcelApi 1.19]
35278
35369
  */
35279
35370
  getActiveShape(): Excel.Shape;
35280
35371
  /**
35281
- * Gets the active shape in the workbook. If there is no active shape, then this method returns an object with its `isNullObject` property set to `true`.
35372
+ * Gets the active shape in the workbook.
35373
+ If there is no active shape, then this method returns an object with its `isNullObject` property set to `true`.
35282
35374
  For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
35283
35375
  *
35284
35376
  * @remarks
@@ -35293,7 +35385,8 @@ declare namespace Excel {
35293
35385
  */
35294
35386
  getActiveSlicer(): Excel.Slicer;
35295
35387
  /**
35296
- * Gets the currently active slicer in the workbook. If there is no active slicer, then this method returns an object with its `isNullObject` property set to `true`.
35388
+ * Gets the currently active slicer in the workbook.
35389
+ If there is no active slicer, then this method returns an object with its `isNullObject` property set to `true`.
35297
35390
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
35298
35391
  *
35299
35392
  * @remarks
@@ -35789,7 +35882,8 @@ declare namespace Excel {
35789
35882
  *
35790
35883
  * @param text The string to find.
35791
35884
  * @param criteria Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive.
35792
- * @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
35885
+ * @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria.
35886
+ If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
35793
35887
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
35794
35888
  */
35795
35889
  findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;
@@ -35813,7 +35907,8 @@ declare namespace Excel {
35813
35907
  */
35814
35908
  getNext(visibleOnly?: boolean): Excel.Worksheet;
35815
35909
  /**
35816
- * Gets the worksheet that follows this one. If there are no worksheets following this one, then this method returns an object with its `isNullObject` property set to `true`.
35910
+ * Gets the worksheet that follows this one.
35911
+ If there are no worksheets following this one, then this method returns an object with its `isNullObject` property set to `true`.
35817
35912
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
35818
35913
  *
35819
35914
  * @remarks
@@ -35832,7 +35927,8 @@ declare namespace Excel {
35832
35927
  */
35833
35928
  getPrevious(visibleOnly?: boolean): Excel.Worksheet;
35834
35929
  /**
35835
- * Gets the worksheet that precedes this one. If there are no previous worksheets, then this method returns an object with its `isNullObject` property set to `true`.
35930
+ * Gets the worksheet that precedes this one.
35931
+ If there are no previous worksheets, then this method returns an object with its `isNullObject` property set to `true`.
35836
35932
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
35837
35933
  *
35838
35934
  * @remarks
@@ -35881,7 +35977,9 @@ declare namespace Excel {
35881
35977
  */
35882
35978
  getUsedRange(valuesOnly?: boolean): Excel.Range;
35883
35979
  /**
35884
- * The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
35980
+ * The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.
35981
+ If the entire worksheet is blank, then this method returns an object with its `isNullObject` property set to `true`.
35982
+ For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
35885
35983
  *
35886
35984
  * @remarks
35887
35985
  * [Api set: ExcelApi 1.4]
@@ -36127,7 +36225,8 @@ declare namespace Excel {
36127
36225
  */
36128
36226
  getItem(key: string): Excel.Worksheet;
36129
36227
  /**
36130
- * Gets a worksheet object using its name or ID. If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
36228
+ * Gets a worksheet object using its name or ID.
36229
+ If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
36131
36230
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
36132
36231
  *
36133
36232
  * @remarks
@@ -37221,7 +37320,7 @@ declare namespace Excel {
37221
37320
  getColumnsBefore(count?: number): Excel.Range;
37222
37321
  /**
37223
37322
  * Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.
37224
- Note: This API returns an `ItemNotFound` error if no dependents are found.
37323
+ Throws an `ItemNotFound` error if no dependents are found.
37225
37324
  *
37226
37325
  * @remarks
37227
37326
  * [Api set: ExcelApi 1.15]
@@ -37229,7 +37328,7 @@ declare namespace Excel {
37229
37328
  getDependents(): Excel.WorkbookRangeAreas;
37230
37329
  /**
37231
37330
  * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.
37232
- Note: This API returns an `ItemNotFound` error if no dependents are found.
37331
+ Throws an `ItemNotFound` error if no dependents are found.
37233
37332
  *
37234
37333
  * @remarks
37235
37334
  * [Api set: ExcelApi 1.13]
@@ -37237,7 +37336,7 @@ declare namespace Excel {
37237
37336
  getDirectDependents(): Excel.WorkbookRangeAreas;
37238
37337
  /**
37239
37338
  * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.
37240
- Note: This API returns an `ItemNotFound` error if no precedents are found.
37339
+ Throws an `ItemNotFound` error if no precedents are found.
37241
37340
  *
37242
37341
  * @remarks
37243
37342
  * [Api set: ExcelApi 1.12]
@@ -37305,7 +37404,8 @@ declare namespace Excel {
37305
37404
  */
37306
37405
  getIntersection(anotherRange: Range | string): Excel.Range;
37307
37406
  /**
37308
- * Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
37407
+ * Gets the range object that represents the rectangular intersection of the given ranges.
37408
+ If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
37309
37409
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
37310
37410
  *
37311
37411
  * @remarks
@@ -37336,7 +37436,8 @@ declare namespace Excel {
37336
37436
  */
37337
37437
  getLastRow(): Excel.Range;
37338
37438
  /**
37339
- * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
37439
+ * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result.
37440
+ If the `RangeAreas` object doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
37340
37441
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
37341
37442
  *
37342
37443
  * @remarks
@@ -37365,7 +37466,7 @@ declare namespace Excel {
37365
37466
  getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;
37366
37467
  /**
37367
37468
  * Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.
37368
- Note: This API returns an `ItemNotFound` error if no precedents are found.
37469
+ Throws an `ItemNotFound` error if no precedents are found.
37369
37470
  *
37370
37471
  * @remarks
37371
37472
  * [Api set: ExcelApi 1.14]
@@ -37542,7 +37643,8 @@ declare namespace Excel {
37542
37643
  */
37543
37644
  getUsedRange(valuesOnly?: boolean): Excel.Range;
37544
37645
  /**
37545
- * Returns the used range of the given range object. If there are no used cells within the range, then this method returns an object with its `isNullObject` property set to `true`.
37646
+ * Returns the used range of the given range object.
37647
+ If there are no used cells within the range, then this method returns an object with its `isNullObject` property set to `true`.
37546
37648
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
37547
37649
  *
37548
37650
  * @remarks
@@ -38042,7 +38144,8 @@ declare namespace Excel {
38042
38144
  */
38043
38145
  getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;
38044
38146
  /**
38045
- * Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
38147
+ * Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.
38148
+ If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
38046
38149
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38047
38150
  *
38048
38151
  * @remarks
@@ -38082,7 +38185,8 @@ declare namespace Excel {
38082
38185
  */
38083
38186
  getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
38084
38187
  /**
38085
- * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
38188
+ * Returns a `RangeAreas` object that represents all the cells that match the specified type and value.
38189
+ If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
38086
38190
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38087
38191
  *
38088
38192
  * @remarks
@@ -38093,7 +38197,8 @@ declare namespace Excel {
38093
38197
  */
38094
38198
  getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
38095
38199
  /**
38096
- * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
38200
+ * Returns a `RangeAreas` object that represents all the cells that match the specified type and value.
38201
+ If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
38097
38202
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38098
38203
  *
38099
38204
  * @remarks
@@ -38222,7 +38327,8 @@ declare namespace Excel {
38222
38327
  */
38223
38328
  getRangeAreasBySheet(key: string): Excel.RangeAreas;
38224
38329
  /**
38225
- * Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
38330
+ * Returns the `RangeAreas` object based on worksheet name or ID in the collection.
38331
+ If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
38226
38332
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38227
38333
  *
38228
38334
  * @remarks
@@ -39009,7 +39115,8 @@ declare namespace Excel {
39009
39115
  */
39010
39116
  getItem(key: string): Excel.Setting;
39011
39117
  /**
39012
- * Gets a setting entry via the key. If the setting does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39118
+ * Gets a setting entry via the key.
39119
+ If the setting does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39013
39120
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39014
39121
  *
39015
39122
  * @remarks
@@ -39168,7 +39275,8 @@ declare namespace Excel {
39168
39275
  */
39169
39276
  getItem(name: string): Excel.NamedItem;
39170
39277
  /**
39171
- * Gets a `NamedItem` object using its name. If the object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39278
+ * Gets a `NamedItem` object using its name.
39279
+ If the object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39172
39280
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39173
39281
  *
39174
39282
  * @remarks
@@ -39225,7 +39333,8 @@ declare namespace Excel {
39225
39333
  */
39226
39334
  readonly worksheet: Excel.Worksheet;
39227
39335
  /**
39228
- * Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
39336
+ * Returns the worksheet to which the named item is scoped.
39337
+ If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
39229
39338
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39230
39339
  *
39231
39340
  * @remarks
@@ -39323,7 +39432,8 @@ declare namespace Excel {
39323
39432
  */
39324
39433
  getRange(): Excel.Range;
39325
39434
  /**
39326
- * Returns the range object that is associated with the name. If the named item's type is not a range, then this method returns an object with its `isNullObject` property set to `true`.
39435
+ * Returns the range object that is associated with the name.
39436
+ If the named item's type is not a range, then this method returns an object with its `isNullObject` property set to `true`.
39327
39437
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39328
39438
  *
39329
39439
  * @remarks
@@ -39635,7 +39745,8 @@ declare namespace Excel {
39635
39745
  */
39636
39746
  getItemAt(index: number): Excel.Binding;
39637
39747
  /**
39638
- * Gets a binding object by ID. If the binding object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39748
+ * Gets a binding object by ID.
39749
+ If the binding object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39639
39750
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39640
39751
  *
39641
39752
  * @remarks
@@ -39722,7 +39833,8 @@ declare namespace Excel {
39722
39833
  */
39723
39834
  getItemAt(index: number): Excel.Table;
39724
39835
  /**
39725
- * Gets a table by name or ID. If the table doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
39836
+ * Gets a table by name or ID.
39837
+ If the table doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
39726
39838
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39727
39839
  *
39728
39840
  * @remarks
@@ -40160,7 +40272,8 @@ declare namespace Excel {
40160
40272
  */
40161
40273
  getItemAt(index: number): Excel.TableColumn;
40162
40274
  /**
40163
- * Gets a column object by name or ID. If the column doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
40275
+ * Gets a column object by name or ID.
40276
+ If the column doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
40164
40277
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
40165
40278
  *
40166
40279
  * @remarks
@@ -41614,7 +41727,8 @@ declare namespace Excel {
41614
41727
  */
41615
41728
  getItemAt(index: number): Excel.Chart;
41616
41729
  /**
41617
- * Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. If the chart doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
41730
+ * Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned.
41731
+ If the chart doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
41618
41732
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
41619
41733
  *
41620
41734
  * @remarks
@@ -41893,7 +42007,8 @@ declare namespace Excel {
41893
42007
  */
41894
42008
  getDataTable(): Excel.ChartDataTable;
41895
42009
  /**
41896
- * Gets the data table on the chart. If the chart doesn't allow a data table, then this method returns an object with its `isNullObject` property set to `true`.
42010
+ * Gets the data table on the chart.
42011
+ If the chart doesn't allow a data table, then this method returns an object with its `isNullObject` property set to `true`.
41897
42012
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
41898
42013
  *
41899
42014
  * @remarks
@@ -43665,7 +43780,9 @@ declare namespace Excel {
43665
43780
  */
43666
43781
  separator: string;
43667
43782
  /**
43668
- * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
43783
+ * Specifies if the data labels are shown as a callout with the tail anchor attached to the data point.
43784
+ If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout".
43785
+ See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
43669
43786
  *
43670
43787
  * @remarks
43671
43788
  * [Api set: ExcelApi 1.19]
@@ -43686,7 +43803,7 @@ declare namespace Excel {
43686
43803
  */
43687
43804
  showCategoryName: boolean;
43688
43805
  /**
43689
- * Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
43806
+ * Specifies if leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
43690
43807
  *
43691
43808
  * @remarks
43692
43809
  * [Api set: ExcelApi 1.19]
@@ -43809,14 +43926,16 @@ declare namespace Excel {
43809
43926
  */
43810
43927
  geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
43811
43928
  /**
43812
- * Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
43929
+ * Returns the height, in points, of the chart data label.
43930
+ Value is `null` if the chart data label is not visible.
43813
43931
  *
43814
43932
  * @remarks
43815
43933
  * [Api set: ExcelApi 1.8]
43816
43934
  */
43817
43935
  readonly height: number;
43818
43936
  /**
43819
- * Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
43937
+ * Represents the horizontal alignment for chart data label.
43938
+ See `Excel.ChartTextHorizontalAlignment` for details.
43820
43939
  This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
43821
43940
  *
43822
43941
  * @remarks
@@ -43838,14 +43957,15 @@ declare namespace Excel {
43838
43957
  */
43839
43958
  linkNumberFormat: boolean;
43840
43959
  /**
43841
- * String value that represents the format code for data label.
43960
+ * Specifies the format code for data label.
43842
43961
  *
43843
43962
  * @remarks
43844
43963
  * [Api set: ExcelApi 1.8]
43845
43964
  */
43846
43965
  numberFormat: string;
43847
43966
  /**
43848
- * Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details.
43967
+ * Value that represents the position of the data label.
43968
+ See `Excel.ChartDataLabelPosition` for details.
43849
43969
  *
43850
43970
  * @remarks
43851
43971
  * [Api set: ExcelApi 1.7]
@@ -43859,7 +43979,9 @@ declare namespace Excel {
43859
43979
  */
43860
43980
  separator: string;
43861
43981
  /**
43862
- * Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
43982
+ * Specifies if the data label is shown as a callout with the tail anchor attached to the data point.
43983
+ If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout".
43984
+ See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
43863
43985
  *
43864
43986
  * @remarks
43865
43987
  * [Api set: ExcelApi 1.19]
@@ -43915,7 +44037,8 @@ declare namespace Excel {
43915
44037
  */
43916
44038
  text: string;
43917
44039
  /**
43918
- * Represents the angle to which the text is oriented for the chart data label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
44040
+ * Represents the angle to which the text is oriented for the chart data label.
44041
+ The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
43919
44042
  *
43920
44043
  * @remarks
43921
44044
  * [Api set: ExcelApi 1.8]
@@ -43929,7 +44052,8 @@ declare namespace Excel {
43929
44052
  */
43930
44053
  top: number;
43931
44054
  /**
43932
- * Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details.
44055
+ * Represents the vertical alignment of chart data label.
44056
+ See `Excel.ChartTextVerticalAlignment` for details.
43933
44057
  This property is valid only when `TextOrientation` of data label is 0.
43934
44058
  *
43935
44059
  * @remarks
@@ -43937,7 +44061,8 @@ declare namespace Excel {
43937
44061
  */
43938
44062
  verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
43939
44063
  /**
43940
- * Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible.
44064
+ * Returns the width, in points, of the chart data label.
44065
+ Value is `null` if the chart data label is not visible.
43941
44066
  *
43942
44067
  * @remarks
43943
44068
  * [Api set: ExcelApi 1.8]
@@ -44088,14 +44213,16 @@ declare namespace Excel {
44088
44213
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
44089
44214
  context: RequestContext;
44090
44215
  /**
44091
- * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
44216
+ * Specifies the distance, in points, from the anchor to the left edge of the chart data label.
44217
+ Note that when getting the value, it may differ slightly from the set value.
44092
44218
  *
44093
44219
  * @remarks
44094
44220
  * [Api set: ExcelApi 1.19]
44095
44221
  */
44096
44222
  left: number;
44097
44223
  /**
44098
- * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
44224
+ * Specifies the distance, in points, from the anchor to the top edge of the chart data label.
44225
+ Note that when getting the value, it may differ slightly from the set value.
44099
44226
  *
44100
44227
  * @remarks
44101
44228
  * [Api set: ExcelApi 1.19]
@@ -47386,7 +47513,8 @@ declare namespace Excel {
47386
47513
  */
47387
47514
  getFirst(): Excel.PivotTable;
47388
47515
  /**
47389
- * Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection.
47516
+ * Gets the first PivotTable in the collection.
47517
+ The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection.
47390
47518
  If the collection is empty, then this method returns an object with its `isNullObject` property set to `true`.
47391
47519
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
47392
47520
  *
@@ -47404,7 +47532,8 @@ declare namespace Excel {
47404
47532
  */
47405
47533
  getItem(key: string): Excel.PivotTable;
47406
47534
  /**
47407
- * Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
47535
+ * Gets a PivotTable by name.
47536
+ If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
47408
47537
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
47409
47538
  *
47410
47539
  * @remarks
@@ -47477,7 +47606,8 @@ declare namespace Excel {
47477
47606
  */
47478
47607
  getItem(name: string): Excel.PivotTable;
47479
47608
  /**
47480
- * Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
47609
+ * Gets a PivotTable by name.
47610
+ If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
47481
47611
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
47482
47612
  *
47483
47613
  * @remarks
@@ -47634,7 +47764,8 @@ declare namespace Excel {
47634
47764
  */
47635
47765
  delete(): void;
47636
47766
  /**
47637
- * Returns the string representation of the data source for the PivotTable. This method currently supports string representations for table and range objects.
47767
+ * Returns the string representation of the data source for the PivotTable.
47768
+ This method currently supports string representations for table and range objects.
47638
47769
  Otherwise, it returns an empty string.
47639
47770
  *
47640
47771
  * @remarks
@@ -47745,7 +47876,8 @@ declare namespace Excel {
47745
47876
  */
47746
47877
  fillEmptyCells: boolean;
47747
47878
  /**
47748
- * This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.
47879
+ * This property indicates the PivotLayoutType of all fields on the PivotTable.
47880
+ If fields have different states, this will be null.
47749
47881
  *
47750
47882
  * @remarks
47751
47883
  * [Api set: ExcelApi 1.8]
@@ -47780,7 +47912,8 @@ declare namespace Excel {
47780
47912
  */
47781
47913
  showRowGrandTotals: boolean;
47782
47914
  /**
47783
- * This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different states, this will be `null`.
47915
+ * This property indicates the `SubtotalLocationType` of all fields on the PivotTable.
47916
+ If fields have different states, this will be `null`.
47784
47917
  *
47785
47918
  * @remarks
47786
47919
  * [Api set: ExcelApi 1.8]
@@ -47955,7 +48088,8 @@ declare namespace Excel {
47955
48088
  */
47956
48089
  getItem(name: string): Excel.PivotHierarchy;
47957
48090
  /**
47958
- * Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48091
+ * Gets a PivotHierarchy by name.
48092
+ If the PivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
47959
48093
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
47960
48094
  *
47961
48095
  * @remarks
@@ -48089,7 +48223,8 @@ declare namespace Excel {
48089
48223
  */
48090
48224
  getItem(name: string): Excel.RowColumnPivotHierarchy;
48091
48225
  /**
48092
- * Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48226
+ * Gets a RowColumnPivotHierarchy by name.
48227
+ If the RowColumnPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48093
48228
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
48094
48229
  *
48095
48230
  * @remarks
@@ -48244,7 +48379,8 @@ declare namespace Excel {
48244
48379
  */
48245
48380
  getItem(name: string): Excel.FilterPivotHierarchy;
48246
48381
  /**
48247
- * Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48382
+ * Gets a FilterPivotHierarchy by name.
48383
+ If the FilterPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48248
48384
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
48249
48385
  *
48250
48386
  * @remarks
@@ -48405,7 +48541,8 @@ declare namespace Excel {
48405
48541
  */
48406
48542
  getItem(name: string): Excel.DataPivotHierarchy;
48407
48543
  /**
48408
- * Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48544
+ * Gets a DataPivotHierarchy by name.
48545
+ If the DataPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48409
48546
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
48410
48547
  *
48411
48548
  * @remarks
@@ -48600,7 +48737,8 @@ declare namespace Excel {
48600
48737
  */
48601
48738
  getItem(name: string): Excel.PivotField;
48602
48739
  /**
48603
- * Gets a PivotField by name. If the PivotField does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48740
+ * Gets a PivotField by name.
48741
+ If the PivotField does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48604
48742
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
48605
48743
  *
48606
48744
  * @remarks
@@ -48842,7 +48980,8 @@ declare namespace Excel {
48842
48980
  */
48843
48981
  getItem(name: string): Excel.PivotItem;
48844
48982
  /**
48845
- * Gets a PivotItem by name. If the PivotItem does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48983
+ * Gets a PivotItem by name.
48984
+ If the PivotItem does not exist, then this method returns an object with its `isNullObject` property set to `true`.
48846
48985
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
48847
48986
  *
48848
48987
  * @remarks
@@ -49368,7 +49507,8 @@ declare namespace Excel {
49368
49507
  */
49369
49508
  getItem(key: string): Excel.WorksheetCustomProperty;
49370
49509
  /**
49371
- * Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
49510
+ * Gets a custom property object by its key, which is case-insensitive.
49511
+ If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
49372
49512
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
49373
49513
  *
49374
49514
  * @remarks
@@ -49646,7 +49786,8 @@ declare namespace Excel {
49646
49786
  */
49647
49787
  getItem(key: string): Excel.CustomProperty;
49648
49788
  /**
49649
- * Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
49789
+ * Gets a custom property object by its key, which is case-insensitive.
49790
+ If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
49650
49791
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
49651
49792
  *
49652
49793
  * @remarks
@@ -50024,7 +50165,8 @@ declare namespace Excel {
50024
50165
  */
50025
50166
  getRange(): Excel.Range;
50026
50167
  /**
50027
- * Returns the range to which the conditional format is applied. If the conditional format is applied to multiple ranges, then this method returns an object with its `isNullObject` property set to `true`.
50168
+ * Returns the range to which the conditional format is applied.
50169
+ If the conditional format is applied to multiple ranges, then this method returns an object with its `isNullObject` property set to `true`.
50028
50170
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
50029
50171
  *
50030
50172
  * @remarks
@@ -51731,7 +51873,8 @@ declare namespace Excel {
51731
51873
  */
51732
51874
  getItem(name: string): Excel.TableStyle;
51733
51875
  /**
51734
- * Gets a `TableStyle` by name. If the table style does not exist, then this method returns an object with its `isNullObject` property set to `true`.
51876
+ * Gets a `TableStyle` by name.
51877
+ If the table style does not exist, then this method returns an object with its `isNullObject` property set to `true`.
51735
51878
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
51736
51879
  *
51737
51880
  * @remarks
@@ -51895,7 +52038,8 @@ declare namespace Excel {
51895
52038
  */
51896
52039
  getItem(name: string): Excel.PivotTableStyle;
51897
52040
  /**
51898
- * Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
52041
+ * Gets a `PivotTableStyle` by name.
52042
+ If the `PivotTableStyle` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
51899
52043
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
51900
52044
  *
51901
52045
  * @remarks
@@ -52059,7 +52203,8 @@ declare namespace Excel {
52059
52203
  */
52060
52204
  getItem(name: string): Excel.SlicerStyle;
52061
52205
  /**
52062
- * Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
52206
+ * Gets a `SlicerStyle` by name.
52207
+ If the slicer style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
52063
52208
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
52064
52209
  *
52065
52210
  * @remarks
@@ -52223,7 +52368,8 @@ declare namespace Excel {
52223
52368
  */
52224
52369
  getItem(name: string): Excel.TimelineStyle;
52225
52370
  /**
52226
- * Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
52371
+ * Gets a `TimelineStyle` by name.
52372
+ If the timeline style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
52227
52373
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
52228
52374
  *
52229
52375
  * @remarks
@@ -52505,7 +52651,8 @@ declare namespace Excel {
52505
52651
  */
52506
52652
  getPrintArea(): Excel.RangeAreas;
52507
52653
  /**
52508
- * Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. If there is no print area, then this method returns an object with its `isNullObject` property set to `true`.
52654
+ * Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.
52655
+ If there is no print area, then this method returns an object with its `isNullObject` property set to `true`.
52509
52656
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
52510
52657
  *
52511
52658
  * @remarks
@@ -52520,7 +52667,8 @@ declare namespace Excel {
52520
52667
  */
52521
52668
  getPrintTitleColumns(): Excel.Range;
52522
52669
  /**
52523
- * Gets the range object representing the title columns. If not set, then this method returns an object with its `isNullObject` property set to `true`.
52670
+ * Gets the range object representing the title columns.
52671
+ If not set, then this method returns an object with its `isNullObject` property set to `true`.
52524
52672
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
52525
52673
  *
52526
52674
  * @remarks
@@ -52535,7 +52683,8 @@ declare namespace Excel {
52535
52683
  */
52536
52684
  getPrintTitleRows(): Excel.Range;
52537
52685
  /**
52538
- * Gets the range object representing the title rows. If not set, then this method returns an object with its `isNullObject` property set to `true`.
52686
+ * Gets the range object representing the title rows.
52687
+ If not set, then this method returns an object with its `isNullObject` property set to `true`.
52539
52688
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
52540
52689
  *
52541
52690
  * @remarks
@@ -53912,9 +54061,9 @@ declare namespace Excel {
53912
54061
  */
53913
54062
  readonly connectionSiteCount: number;
53914
54063
  /**
53915
- * Gets the display name of the shape. A newly created shape has a generated name
53916
- that is localized and may not match its `name`. In this scenario, you can use
53917
- this API to get the name that is displayed in the UI.
54064
+ * Gets the display name of the shape.
54065
+ A newly created shape has a generated name that is localized and may not match its `name`.
54066
+ In this scenario, you can use this API to get the name that is displayed in the UI.
53918
54067
  *
53919
54068
  * @remarks
53920
54069
  * [Api set: ExcelApi 1.15]
@@ -55119,7 +55268,7 @@ declare namespace Excel {
55119
55268
  */
55120
55269
  caption: string;
55121
55270
  /**
55122
- * Represents the height, in points, of the slicer.
55271
+ * Specifies the height, in points, of the slicer.
55123
55272
  Throws an `InvalidArgument` exception when set with a negative value or zero as an input.
55124
55273
  *
55125
55274
  * @remarks
@@ -55156,14 +55305,16 @@ declare namespace Excel {
55156
55305
  */
55157
55306
  name: string;
55158
55307
  /**
55159
- * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending".
55308
+ * Specifies the sort order of the items in the slicer.
55309
+ Possible values are: "DataSourceOrder", "Ascending", "Descending".
55160
55310
  *
55161
55311
  * @remarks
55162
55312
  * [Api set: ExcelApi 1.10]
55163
55313
  */
55164
55314
  sortBy: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";
55165
55315
  /**
55166
- * 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.
55316
+ * Constant value that represents the slicer style.
55317
+ 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.
55167
55318
  *
55168
55319
  * @remarks
55169
55320
  * [Api set: ExcelApi 1.10]
@@ -55300,7 +55451,8 @@ declare namespace Excel {
55300
55451
  */
55301
55452
  getItemAt(index: number): Excel.Slicer;
55302
55453
  /**
55303
- * Gets a slicer using its name or ID. If the slicer doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
55454
+ * Gets a slicer using its name or ID.
55455
+ If the slicer doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
55304
55456
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
55305
55457
  *
55306
55458
  * @remarks
@@ -55444,7 +55596,8 @@ declare namespace Excel {
55444
55596
  */
55445
55597
  getItemAt(index: number): Excel.SlicerItem;
55446
55598
  /**
55447
- * Gets a slicer item using its key or name. If the slicer item doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
55599
+ * Gets a slicer item using its key or name.
55600
+ If the slicer item doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
55448
55601
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
55449
55602
  *
55450
55603
  * @remarks
@@ -55705,7 +55858,7 @@ declare namespace Excel {
55705
55858
  getItemByName(name: string): Excel.LinkedEntityDataDomain;
55706
55859
  /**
55707
55860
  * Gets a linked entity data domain by its `name`.
55708
- If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
55861
+ If the linked entity data domain does not exist, then this method returns an object with its `isNullObject` property set to `true`.
55709
55862
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
55710
55863
  *
55711
55864
  * @remarks
@@ -55717,7 +55870,7 @@ declare namespace Excel {
55717
55870
  getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;
55718
55871
  /**
55719
55872
  * Gets a linked entity data domain by its `id`.
55720
- If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
55873
+ If the linked entity data domain does not exist, then this method returns an object with its `isNullObject` property set to `true`.
55721
55874
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
55722
55875
  *
55723
55876
  * @remarks
@@ -63199,7 +63352,7 @@ declare namespace Excel {
63199
63352
  */
63200
63353
  readonly authorName: string;
63201
63354
  /**
63202
- * Gets or sets the text of the note.
63355
+ * Specifies the text of the note.
63203
63356
  *
63204
63357
  * @remarks
63205
63358
  * [Api set: ExcelApi 1.18]
@@ -69077,7 +69230,7 @@ declare namespace Excel {
69077
69230
  */
69078
69231
  showCategoryName?: boolean;
69079
69232
  /**
69080
- * Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
69233
+ * Specifies if leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
69081
69234
  *
69082
69235
  * @remarks
69083
69236
  * [Api set: ExcelApi 1.19]
@@ -69159,7 +69312,8 @@ declare namespace Excel {
69159
69312
  */
69160
69313
  geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
69161
69314
  /**
69162
- * Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
69315
+ * Represents the horizontal alignment for chart data label.
69316
+ See `Excel.ChartTextHorizontalAlignment` for details.
69163
69317
  This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
69164
69318
  *
69165
69319
  * @remarks
@@ -69181,14 +69335,15 @@ declare namespace Excel {
69181
69335
  */
69182
69336
  linkNumberFormat?: boolean;
69183
69337
  /**
69184
- * String value that represents the format code for data label.
69338
+ * Specifies the format code for data label.
69185
69339
  *
69186
69340
  * @remarks
69187
69341
  * [Api set: ExcelApi 1.8]
69188
69342
  */
69189
69343
  numberFormat?: string;
69190
69344
  /**
69191
- * Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details.
69345
+ * Value that represents the position of the data label.
69346
+ See `Excel.ChartDataLabelPosition` for details.
69192
69347
  *
69193
69348
  * @remarks
69194
69349
  * [Api set: ExcelApi 1.7]
@@ -69251,7 +69406,8 @@ declare namespace Excel {
69251
69406
  */
69252
69407
  text?: string;
69253
69408
  /**
69254
- * Represents the angle to which the text is oriented for the chart data label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
69409
+ * Represents the angle to which the text is oriented for the chart data label.
69410
+ The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
69255
69411
  *
69256
69412
  * @remarks
69257
69413
  * [Api set: ExcelApi 1.8]
@@ -69265,7 +69421,8 @@ declare namespace Excel {
69265
69421
  */
69266
69422
  top?: number;
69267
69423
  /**
69268
- * Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details.
69424
+ * Represents the vertical alignment of chart data label.
69425
+ See `Excel.ChartTextVerticalAlignment` for details.
69269
69426
  This property is valid only when `TextOrientation` of data label is 0.
69270
69427
  *
69271
69428
  * @remarks
@@ -69293,14 +69450,16 @@ declare namespace Excel {
69293
69450
  /** An interface for updating data on the `ChartDataLabelAnchor` object, for use in `chartDataLabelAnchor.set({ ... })`. */
69294
69451
  interface ChartDataLabelAnchorUpdateData {
69295
69452
  /**
69296
- * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
69453
+ * Specifies the distance, in points, from the anchor to the left edge of the chart data label.
69454
+ Note that when getting the value, it may differ slightly from the set value.
69297
69455
  *
69298
69456
  * @remarks
69299
69457
  * [Api set: ExcelApi 1.19]
69300
69458
  */
69301
69459
  left?: number;
69302
69460
  /**
69303
- * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
69461
+ * Specifies the distance, in points, from the anchor to the top edge of the chart data label.
69462
+ Note that when getting the value, it may differ slightly from the set value.
69304
69463
  *
69305
69464
  * @remarks
69306
69465
  * [Api set: ExcelApi 1.19]
@@ -70261,7 +70420,8 @@ declare namespace Excel {
70261
70420
  */
70262
70421
  fillEmptyCells?: boolean;
70263
70422
  /**
70264
- * This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.
70423
+ * This property indicates the PivotLayoutType of all fields on the PivotTable.
70424
+ If fields have different states, this will be null.
70265
70425
  *
70266
70426
  * @remarks
70267
70427
  * [Api set: ExcelApi 1.8]
@@ -70296,7 +70456,8 @@ declare namespace Excel {
70296
70456
  */
70297
70457
  showRowGrandTotals?: boolean;
70298
70458
  /**
70299
- * This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different states, this will be `null`.
70459
+ * This property indicates the `SubtotalLocationType` of all fields on the PivotTable.
70460
+ If fields have different states, this will be `null`.
70300
70461
  *
70301
70462
  * @remarks
70302
70463
  * [Api set: ExcelApi 1.8]
@@ -71995,7 +72156,7 @@ declare namespace Excel {
71995
72156
  */
71996
72157
  caption?: string;
71997
72158
  /**
71998
- * Represents the height, in points, of the slicer.
72159
+ * Specifies the height, in points, of the slicer.
71999
72160
  Throws an `InvalidArgument` exception when set with a negative value or zero as an input.
72000
72161
  *
72001
72162
  * @remarks
@@ -72018,14 +72179,16 @@ declare namespace Excel {
72018
72179
  */
72019
72180
  name?: string;
72020
72181
  /**
72021
- * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending".
72182
+ * Specifies the sort order of the items in the slicer.
72183
+ Possible values are: "DataSourceOrder", "Ascending", "Descending".
72022
72184
  *
72023
72185
  * @remarks
72024
72186
  * [Api set: ExcelApi 1.10]
72025
72187
  */
72026
72188
  sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";
72027
72189
  /**
72028
- * 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.
72190
+ * Constant value that represents the slicer style.
72191
+ 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.
72029
72192
  *
72030
72193
  * @remarks
72031
72194
  * [Api set: ExcelApi 1.10]
@@ -72106,7 +72269,7 @@ declare namespace Excel {
72106
72269
  /** An interface for updating data on the `Note` object, for use in `note.set({ ... })`. */
72107
72270
  interface NoteUpdateData {
72108
72271
  /**
72109
- * Gets or sets the text of the note.
72272
+ * Specifies the text of the note.
72110
72273
  *
72111
72274
  * @remarks
72112
72275
  * [Api set: ExcelApi 1.18]
@@ -75082,7 +75245,9 @@ declare namespace Excel {
75082
75245
  */
75083
75246
  separator?: string;
75084
75247
  /**
75085
- * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
75248
+ * Specifies if the data labels are shown as a callout with the tail anchor attached to the data point.
75249
+ If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout".
75250
+ See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
75086
75251
  *
75087
75252
  * @remarks
75088
75253
  * [Api set: ExcelApi 1.19]
@@ -75103,7 +75268,7 @@ declare namespace Excel {
75103
75268
  */
75104
75269
  showCategoryName?: boolean;
75105
75270
  /**
75106
- * Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
75271
+ * Specifies if leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
75107
75272
  *
75108
75273
  * @remarks
75109
75274
  * [Api set: ExcelApi 1.19]
@@ -75185,14 +75350,16 @@ declare namespace Excel {
75185
75350
  */
75186
75351
  geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
75187
75352
  /**
75188
- * Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
75353
+ * Returns the height, in points, of the chart data label.
75354
+ Value is `null` if the chart data label is not visible.
75189
75355
  *
75190
75356
  * @remarks
75191
75357
  * [Api set: ExcelApi 1.8]
75192
75358
  */
75193
75359
  height?: number;
75194
75360
  /**
75195
- * Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
75361
+ * Represents the horizontal alignment for chart data label.
75362
+ See `Excel.ChartTextHorizontalAlignment` for details.
75196
75363
  This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
75197
75364
  *
75198
75365
  * @remarks
@@ -75214,14 +75381,15 @@ declare namespace Excel {
75214
75381
  */
75215
75382
  linkNumberFormat?: boolean;
75216
75383
  /**
75217
- * String value that represents the format code for data label.
75384
+ * Specifies the format code for data label.
75218
75385
  *
75219
75386
  * @remarks
75220
75387
  * [Api set: ExcelApi 1.8]
75221
75388
  */
75222
75389
  numberFormat?: string;
75223
75390
  /**
75224
- * Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details.
75391
+ * Value that represents the position of the data label.
75392
+ See `Excel.ChartDataLabelPosition` for details.
75225
75393
  *
75226
75394
  * @remarks
75227
75395
  * [Api set: ExcelApi 1.7]
@@ -75235,7 +75403,9 @@ declare namespace Excel {
75235
75403
  */
75236
75404
  separator?: string;
75237
75405
  /**
75238
- * Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
75406
+ * Specifies if the data label is shown as a callout with the tail anchor attached to the data point.
75407
+ If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout".
75408
+ See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
75239
75409
  *
75240
75410
  * @remarks
75241
75411
  * [Api set: ExcelApi 1.19]
@@ -75291,7 +75461,8 @@ declare namespace Excel {
75291
75461
  */
75292
75462
  text?: string;
75293
75463
  /**
75294
- * Represents the angle to which the text is oriented for the chart data label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
75464
+ * Represents the angle to which the text is oriented for the chart data label.
75465
+ The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
75295
75466
  *
75296
75467
  * @remarks
75297
75468
  * [Api set: ExcelApi 1.8]
@@ -75305,7 +75476,8 @@ declare namespace Excel {
75305
75476
  */
75306
75477
  top?: number;
75307
75478
  /**
75308
- * Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details.
75479
+ * Represents the vertical alignment of chart data label.
75480
+ See `Excel.ChartTextVerticalAlignment` for details.
75309
75481
  This property is valid only when `TextOrientation` of data label is 0.
75310
75482
  *
75311
75483
  * @remarks
@@ -75313,7 +75485,8 @@ declare namespace Excel {
75313
75485
  */
75314
75486
  verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
75315
75487
  /**
75316
- * Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible.
75488
+ * Returns the width, in points, of the chart data label.
75489
+ Value is `null` if the chart data label is not visible.
75317
75490
  *
75318
75491
  * @remarks
75319
75492
  * [Api set: ExcelApi 1.8]
@@ -75340,14 +75513,16 @@ declare namespace Excel {
75340
75513
  /** An interface describing the data returned by calling `chartDataLabelAnchor.toJSON()`. */
75341
75514
  interface ChartDataLabelAnchorData {
75342
75515
  /**
75343
- * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
75516
+ * Specifies the distance, in points, from the anchor to the left edge of the chart data label.
75517
+ Note that when getting the value, it may differ slightly from the set value.
75344
75518
  *
75345
75519
  * @remarks
75346
75520
  * [Api set: ExcelApi 1.19]
75347
75521
  */
75348
75522
  left?: number;
75349
75523
  /**
75350
- * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
75524
+ * Specifies the distance, in points, from the anchor to the top edge of the chart data label.
75525
+ Note that when getting the value, it may differ slightly from the set value.
75351
75526
  *
75352
75527
  * @remarks
75353
75528
  * [Api set: ExcelApi 1.19]
@@ -76581,7 +76756,8 @@ declare namespace Excel {
76581
76756
  */
76582
76757
  fillEmptyCells?: boolean;
76583
76758
  /**
76584
- * This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.
76759
+ * This property indicates the PivotLayoutType of all fields on the PivotTable.
76760
+ If fields have different states, this will be null.
76585
76761
  *
76586
76762
  * @remarks
76587
76763
  * [Api set: ExcelApi 1.8]
@@ -76616,7 +76792,8 @@ declare namespace Excel {
76616
76792
  */
76617
76793
  showRowGrandTotals?: boolean;
76618
76794
  /**
76619
- * This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different states, this will be `null`.
76795
+ * This property indicates the `SubtotalLocationType` of all fields on the PivotTable.
76796
+ If fields have different states, this will be `null`.
76620
76797
  *
76621
76798
  * @remarks
76622
76799
  * [Api set: ExcelApi 1.8]
@@ -77537,6 +77714,9 @@ declare namespace Excel {
77537
77714
  interface ConditionalRangeBorderCollectionData {
77538
77715
  items?: Excel.Interfaces.ConditionalRangeBorderData[];
77539
77716
  }
77717
+ /** An interface describing the data returned by calling `customFunctionManager.toJSON()`. */
77718
+ interface CustomFunctionManagerData {
77719
+ }
77540
77720
  /** An interface describing the data returned by calling `style.toJSON()`. */
77541
77721
  interface StyleData {
77542
77722
  /**
@@ -78254,9 +78434,9 @@ declare namespace Excel {
78254
78434
  */
78255
78435
  connectionSiteCount?: number;
78256
78436
  /**
78257
- * Gets the display name of the shape. A newly created shape has a generated name
78258
- that is localized and may not match its `name`. In this scenario, you can use
78259
- this API to get the name that is displayed in the UI.
78437
+ * Gets the display name of the shape.
78438
+ A newly created shape has a generated name that is localized and may not match its `name`.
78439
+ In this scenario, you can use this API to get the name that is displayed in the UI.
78260
78440
  *
78261
78441
  * @remarks
78262
78442
  * [Api set: ExcelApi 1.15]
@@ -78742,7 +78922,7 @@ declare namespace Excel {
78742
78922
  */
78743
78923
  caption?: string;
78744
78924
  /**
78745
- * Represents the height, in points, of the slicer.
78925
+ * Specifies the height, in points, of the slicer.
78746
78926
  Throws an `InvalidArgument` exception when set with a negative value or zero as an input.
78747
78927
  *
78748
78928
  * @remarks
@@ -78779,14 +78959,16 @@ declare namespace Excel {
78779
78959
  */
78780
78960
  name?: string;
78781
78961
  /**
78782
- * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending".
78962
+ * Specifies the sort order of the items in the slicer.
78963
+ Possible values are: "DataSourceOrder", "Ascending", "Descending".
78783
78964
  *
78784
78965
  * @remarks
78785
78966
  * [Api set: ExcelApi 1.10]
78786
78967
  */
78787
78968
  sortBy?: Excel.SlicerSortType | "DataSourceOrder" | "Ascending" | "Descending";
78788
78969
  /**
78789
- * 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.
78970
+ * Constant value that represents the slicer style.
78971
+ 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.
78790
78972
  *
78791
78973
  * @remarks
78792
78974
  * [Api set: ExcelApi 1.10]
@@ -78961,7 +79143,7 @@ declare namespace Excel {
78961
79143
  */
78962
79144
  authorName?: string;
78963
79145
  /**
78964
- * Gets or sets the text of the note.
79146
+ * Specifies the text of the note.
78965
79147
  *
78966
79148
  * @remarks
78967
79149
  * [Api set: ExcelApi 1.18]
@@ -80493,7 +80675,8 @@ declare namespace Excel {
80493
80675
  */
80494
80676
  worksheet?: Excel.Interfaces.WorksheetLoadOptions;
80495
80677
  /**
80496
- * For EACH ITEM in the collection: Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
80678
+ * For EACH ITEM in the collection: Returns the worksheet to which the named item is scoped.
80679
+ If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
80497
80680
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
80498
80681
  *
80499
80682
  * @remarks
@@ -80595,7 +80778,8 @@ declare namespace Excel {
80595
80778
  */
80596
80779
  worksheet?: Excel.Interfaces.WorksheetLoadOptions;
80597
80780
  /**
80598
- * Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
80781
+ * Returns the worksheet to which the named item is scoped.
80782
+ If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
80599
80783
  For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
80600
80784
  *
80601
80785
  * @remarks
@@ -83624,7 +83808,9 @@ declare namespace Excel {
83624
83808
  */
83625
83809
  separator?: boolean;
83626
83810
  /**
83627
- * Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
83811
+ * Specifies if the data labels are shown as a callout with the tail anchor attached to the data point.
83812
+ If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout".
83813
+ See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
83628
83814
  *
83629
83815
  * @remarks
83630
83816
  * [Api set: ExcelApi 1.19]
@@ -83645,7 +83831,7 @@ declare namespace Excel {
83645
83831
  */
83646
83832
  showCategoryName?: boolean;
83647
83833
  /**
83648
- * Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
83834
+ * Specifies if leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
83649
83835
  *
83650
83836
  * @remarks
83651
83837
  * [Api set: ExcelApi 1.19]
@@ -83736,14 +83922,16 @@ declare namespace Excel {
83736
83922
  */
83737
83923
  geometricShapeType?: boolean;
83738
83924
  /**
83739
- * Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
83925
+ * Returns the height, in points, of the chart data label.
83926
+ Value is `null` if the chart data label is not visible.
83740
83927
  *
83741
83928
  * @remarks
83742
83929
  * [Api set: ExcelApi 1.8]
83743
83930
  */
83744
83931
  height?: boolean;
83745
83932
  /**
83746
- * Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
83933
+ * Represents the horizontal alignment for chart data label.
83934
+ See `Excel.ChartTextHorizontalAlignment` for details.
83747
83935
  This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
83748
83936
  *
83749
83937
  * @remarks
@@ -83765,14 +83953,15 @@ declare namespace Excel {
83765
83953
  */
83766
83954
  linkNumberFormat?: boolean;
83767
83955
  /**
83768
- * String value that represents the format code for data label.
83956
+ * Specifies the format code for data label.
83769
83957
  *
83770
83958
  * @remarks
83771
83959
  * [Api set: ExcelApi 1.8]
83772
83960
  */
83773
83961
  numberFormat?: boolean;
83774
83962
  /**
83775
- * Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details.
83963
+ * Value that represents the position of the data label.
83964
+ See `Excel.ChartDataLabelPosition` for details.
83776
83965
  *
83777
83966
  * @remarks
83778
83967
  * [Api set: ExcelApi 1.7]
@@ -83786,7 +83975,9 @@ declare namespace Excel {
83786
83975
  */
83787
83976
  separator?: boolean;
83788
83977
  /**
83789
- * Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
83978
+ * Specifies if the data label is shown as a callout with the tail anchor attached to the data point.
83979
+ If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout".
83980
+ See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
83790
83981
  *
83791
83982
  * @remarks
83792
83983
  * [Api set: ExcelApi 1.19]
@@ -83842,7 +84033,8 @@ declare namespace Excel {
83842
84033
  */
83843
84034
  text?: boolean;
83844
84035
  /**
83845
- * Represents the angle to which the text is oriented for the chart data label. The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
84036
+ * Represents the angle to which the text is oriented for the chart data label.
84037
+ The value should either be an integer from -90 to 90 or the integer 180 for vertically-oriented text.
83846
84038
  *
83847
84039
  * @remarks
83848
84040
  * [Api set: ExcelApi 1.8]
@@ -83856,7 +84048,8 @@ declare namespace Excel {
83856
84048
  */
83857
84049
  top?: boolean;
83858
84050
  /**
83859
- * Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details.
84051
+ * Represents the vertical alignment of chart data label.
84052
+ See `Excel.ChartTextVerticalAlignment` for details.
83860
84053
  This property is valid only when `TextOrientation` of data label is 0.
83861
84054
  *
83862
84055
  * @remarks
@@ -83864,7 +84057,8 @@ declare namespace Excel {
83864
84057
  */
83865
84058
  verticalAlignment?: boolean;
83866
84059
  /**
83867
- * Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible.
84060
+ * Returns the width, in points, of the chart data label.
84061
+ Value is `null` if the chart data label is not visible.
83868
84062
  *
83869
84063
  * @remarks
83870
84064
  * [Api set: ExcelApi 1.8]
@@ -83909,14 +84103,16 @@ declare namespace Excel {
83909
84103
  */
83910
84104
  $all?: boolean;
83911
84105
  /**
83912
- * Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
84106
+ * Specifies the distance, in points, from the anchor to the left edge of the chart data label.
84107
+ Note that when getting the value, it may differ slightly from the set value.
83913
84108
  *
83914
84109
  * @remarks
83915
84110
  * [Api set: ExcelApi 1.19]
83916
84111
  */
83917
84112
  left?: boolean;
83918
84113
  /**
83919
- * Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
84114
+ * Specifies the distance, in points, from the anchor to the top edge of the chart data label.
84115
+ Note that when getting the value, it may differ slightly from the set value.
83920
84116
  *
83921
84117
  * @remarks
83922
84118
  * [Api set: ExcelApi 1.19]
@@ -85748,7 +85944,8 @@ declare namespace Excel {
85748
85944
  */
85749
85945
  fillEmptyCells?: boolean;
85750
85946
  /**
85751
- * This property indicates the PivotLayoutType of all fields on the PivotTable. If fields have different states, this will be null.
85947
+ * This property indicates the PivotLayoutType of all fields on the PivotTable.
85948
+ If fields have different states, this will be null.
85752
85949
  *
85753
85950
  * @remarks
85754
85951
  * [Api set: ExcelApi 1.8]
@@ -85783,7 +85980,8 @@ declare namespace Excel {
85783
85980
  */
85784
85981
  showRowGrandTotals?: boolean;
85785
85982
  /**
85786
- * This property indicates the `SubtotalLocationType` of all fields on the PivotTable. If fields have different states, this will be `null`.
85983
+ * This property indicates the `SubtotalLocationType` of all fields on the PivotTable.
85984
+ If fields have different states, this will be `null`.
85787
85985
  *
85788
85986
  * @remarks
85789
85987
  * [Api set: ExcelApi 1.8]
@@ -88969,9 +89167,9 @@ declare namespace Excel {
88969
89167
  */
88970
89168
  connectionSiteCount?: boolean;
88971
89169
  /**
88972
- * For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
88973
- that is localized and may not match its `name`. In this scenario, you can use
88974
- this API to get the name that is displayed in the UI.
89170
+ * For EACH ITEM in the collection: Gets the display name of the shape.
89171
+ A newly created shape has a generated name that is localized and may not match its `name`.
89172
+ In this scenario, you can use this API to get the name that is displayed in the UI.
88975
89173
  *
88976
89174
  * @remarks
88977
89175
  * [Api set: ExcelApi 1.15]
@@ -89170,9 +89368,9 @@ declare namespace Excel {
89170
89368
  */
89171
89369
  connectionSiteCount?: boolean;
89172
89370
  /**
89173
- * Gets the display name of the shape. A newly created shape has a generated name
89174
- that is localized and may not match its `name`. In this scenario, you can use
89175
- this API to get the name that is displayed in the UI.
89371
+ * Gets the display name of the shape.
89372
+ A newly created shape has a generated name that is localized and may not match its `name`.
89373
+ In this scenario, you can use this API to get the name that is displayed in the UI.
89176
89374
  *
89177
89375
  * @remarks
89178
89376
  * [Api set: ExcelApi 1.15]
@@ -89455,9 +89653,9 @@ declare namespace Excel {
89455
89653
  */
89456
89654
  connectionSiteCount?: boolean;
89457
89655
  /**
89458
- * For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
89459
- that is localized and may not match its `name`. In this scenario, you can use
89460
- this API to get the name that is displayed in the UI.
89656
+ * For EACH ITEM in the collection: Gets the display name of the shape.
89657
+ A newly created shape has a generated name that is localized and may not match its `name`.
89658
+ In this scenario, you can use this API to get the name that is displayed in the UI.
89461
89659
  *
89462
89660
  * @remarks
89463
89661
  * [Api set: ExcelApi 1.15]
@@ -89979,7 +90177,7 @@ declare namespace Excel {
89979
90177
  */
89980
90178
  caption?: boolean;
89981
90179
  /**
89982
- * Represents the height, in points, of the slicer.
90180
+ * Specifies the height, in points, of the slicer.
89983
90181
  Throws an `InvalidArgument` exception when set with a negative value or zero as an input.
89984
90182
  *
89985
90183
  * @remarks
@@ -90016,14 +90214,16 @@ declare namespace Excel {
90016
90214
  */
90017
90215
  name?: boolean;
90018
90216
  /**
90019
- * Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending".
90217
+ * Specifies the sort order of the items in the slicer.
90218
+ Possible values are: "DataSourceOrder", "Ascending", "Descending".
90020
90219
  *
90021
90220
  * @remarks
90022
90221
  * [Api set: ExcelApi 1.10]
90023
90222
  */
90024
90223
  sortBy?: boolean;
90025
90224
  /**
90026
- * 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.
90225
+ * Constant value that represents the slicer style.
90226
+ 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.
90027
90227
  *
90028
90228
  * @remarks
90029
90229
  * [Api set: ExcelApi 1.10]
@@ -90072,7 +90272,7 @@ declare namespace Excel {
90072
90272
  */
90073
90273
  caption?: boolean;
90074
90274
  /**
90075
- * For EACH ITEM in the collection: Represents the height, in points, of the slicer.
90275
+ * For EACH ITEM in the collection: Specifies the height, in points, of the slicer.
90076
90276
  Throws an `InvalidArgument` exception when set with a negative value or zero as an input.
90077
90277
  *
90078
90278
  * @remarks
@@ -90109,14 +90309,16 @@ declare namespace Excel {
90109
90309
  */
90110
90310
  name?: boolean;
90111
90311
  /**
90112
- * For EACH ITEM in the collection: Represents the sort order of the items in the slicer. Possible values are: "DataSourceOrder", "Ascending", "Descending".
90312
+ * For EACH ITEM in the collection: Specifies the sort order of the items in the slicer.
90313
+ Possible values are: "DataSourceOrder", "Ascending", "Descending".
90113
90314
  *
90114
90315
  * @remarks
90115
90316
  * [Api set: ExcelApi 1.10]
90116
90317
  */
90117
90318
  sortBy?: boolean;
90118
90319
  /**
90119
- * 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.
90320
+ * For EACH ITEM in the collection: Constant value that represents the slicer style.
90321
+ 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.
90120
90322
  *
90121
90323
  * @remarks
90122
90324
  * [Api set: ExcelApi 1.10]
@@ -90460,7 +90662,7 @@ declare namespace Excel {
90460
90662
  */
90461
90663
  authorName?: boolean;
90462
90664
  /**
90463
- * For EACH ITEM in the collection: Gets or sets the text of the note.
90665
+ * For EACH ITEM in the collection: Specifies the text of the note.
90464
90666
  *
90465
90667
  * @remarks
90466
90668
  * [Api set: ExcelApi 1.18]
@@ -90507,7 +90709,7 @@ declare namespace Excel {
90507
90709
  */
90508
90710
  authorName?: boolean;
90509
90711
  /**
90510
- * Gets or sets the text of the note.
90712
+ * Specifies the text of the note.
90511
90713
  *
90512
90714
  * @remarks
90513
90715
  * [Api set: ExcelApi 1.18]