@types/office-js-preview 1.0.693 → 1.0.695
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.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +406 -38
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Wed, 18 Mar 2026 20:45:13 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -3212,7 +3212,7 @@ declare namespace Office {
|
|
|
3212
3212
|
* @param shortcuts An object of custom shortcuts with keys being the IDs of the actions and values being the shortcut combinations. For example, `{"SetItalic": "Ctrl+1", "SetBold": "Ctrl+2"}`.
|
|
3213
3213
|
* To learn how to specify a valid action ID and a key combination, see {@link https://learn.microsoft.com/office/dev/add-ins/design/keyboard-shortcuts | Add custom keyboard shortcuts to your Office Add-ins}. (Note that a key combination can be `null`, in which case, the action keeps the key combination specified in the JSON file.)
|
|
3214
3214
|
* @returns A promise that resolves when every custom shortcut assignment in `shortcuts` has been registered. Even if there is a conflict with existing shortcuts, the customized shortcut will be registered.
|
|
3215
|
-
* Otherwise, the promise will be rejected with error code and error message. An
|
|
3215
|
+
* Otherwise, the promise will be rejected with an error code and error message. An `OfficeExtension.ErrorCodes.invalidArgument` error code is returned if any action ID in `shortcuts` doesn't exist, or if shortcut combination is invalid.
|
|
3216
3216
|
*/
|
|
3217
3217
|
replaceShortcuts(shortcuts: {[actionId: string]: string}): Promise<void>;
|
|
3218
3218
|
/**
|
|
@@ -11616,7 +11616,7 @@ declare namespace Office {
|
|
|
11616
11616
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
11617
11617
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
11618
11618
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
11619
|
-
* the failure.
|
|
11619
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
11620
11620
|
*/
|
|
11621
11621
|
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
11622
11622
|
/**
|
|
@@ -11634,7 +11634,7 @@ declare namespace Office {
|
|
|
11634
11634
|
*
|
|
11635
11635
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
11636
11636
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
11637
|
-
* the failure.
|
|
11637
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
11638
11638
|
*/
|
|
11639
11639
|
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
11640
11640
|
/**
|
|
@@ -13408,13 +13408,43 @@ declare namespace Office {
|
|
|
13408
13408
|
*/
|
|
13409
13409
|
contentId: string;
|
|
13410
13410
|
/**
|
|
13411
|
-
* Gets the
|
|
13411
|
+
* Gets the identifier of an attachment. The value varies depending on the Outlook client.
|
|
13412
|
+
*
|
|
13413
|
+
* - In Outlook on the web and the new Outlook on Windows, the identifier is the Exchange Web Services (EWS) ID.
|
|
13414
|
+
* For inline attachments, the initial identifier is a temporary attachment ID, prefixed with `addinId`, while the attachment is uploaded to the server.
|
|
13415
|
+
* Once the upload completes, the attachment receives an EWS ID. For details, see the notes in the Remarks section.
|
|
13416
|
+
*
|
|
13417
|
+
* - In Outlook on Windows (classic) and on Mac, the identifier for inline and non-inline attachments is the index of the attachment.
|
|
13418
|
+
*
|
|
13419
|
+
* @remarks
|
|
13420
|
+
*
|
|
13421
|
+
* **Important**: Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
13422
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
13423
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
13424
|
+
* For more information on the changes to how inline images are handled, see
|
|
13425
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
13412
13426
|
*/
|
|
13413
13427
|
id: string;
|
|
13414
13428
|
/**
|
|
13415
13429
|
* Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.
|
|
13416
13430
|
*/
|
|
13417
13431
|
isInline: boolean;
|
|
13432
|
+
/**
|
|
13433
|
+
* In Outlook on the web and the new Outlook on Windows, indicates whether an inline attachment in a message has been uploaded to the server and assigned an Exchange Web Services (EWS) ID.
|
|
13434
|
+
*
|
|
13435
|
+
* @remarks
|
|
13436
|
+
*
|
|
13437
|
+
* **Important**:
|
|
13438
|
+
*
|
|
13439
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in Outlook on the web and the new Outlook on Windows
|
|
13440
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
13441
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID in the `id` property and their `isServiceAccessible` property is set to `true`.
|
|
13442
|
+
* The temporary attachment ID is only supported for the duration of the current compose session. For more information on the changes to how inline images are handled, see
|
|
13443
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
13444
|
+
*
|
|
13445
|
+
* - In Outlook on Windows (classic) and on Mac, the `isServiceAccessible` property always returns `false` since the attachment ID is the index of the attachment.
|
|
13446
|
+
*/
|
|
13447
|
+
isServiceAccessible: boolean;
|
|
13418
13448
|
/**
|
|
13419
13449
|
* Gets the name of the attachment.
|
|
13420
13450
|
*
|
|
@@ -16560,6 +16590,12 @@ declare namespace Office {
|
|
|
16560
16590
|
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16561
16591
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
16562
16592
|
*
|
|
16593
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
16594
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
16595
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
16596
|
+
* For more information on the changes to how inline images are handled, see
|
|
16597
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
16598
|
+
*
|
|
16563
16599
|
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16564
16600
|
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
16565
16601
|
*
|
|
@@ -16574,7 +16610,8 @@ declare namespace Office {
|
|
|
16574
16610
|
*
|
|
16575
16611
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
16576
16612
|
*
|
|
16577
|
-
* @param attachmentId - The identifier of the attachment you want to get.
|
|
16613
|
+
* @param attachmentId - The identifier of the attachment you want to get. In Outlook on the web and the new Outlook on Windows, the temporary attachment ID that's
|
|
16614
|
+
* locally generated for inline images that haven't been uploaded to the server yet are supported for the duration of the current compose session.
|
|
16578
16615
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16579
16616
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16580
16617
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -16597,6 +16634,12 @@ declare namespace Office {
|
|
|
16597
16634
|
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
16598
16635
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
16599
16636
|
*
|
|
16637
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
16638
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
16639
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
16640
|
+
* For more information on the changes to how inline images are handled, see
|
|
16641
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
16642
|
+
*
|
|
16600
16643
|
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
16601
16644
|
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
16602
16645
|
*
|
|
@@ -16611,7 +16654,8 @@ declare namespace Office {
|
|
|
16611
16654
|
*
|
|
16612
16655
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
16613
16656
|
*
|
|
16614
|
-
* @param attachmentId - The identifier of the attachment you want to get.
|
|
16657
|
+
* @param attachmentId - The identifier of the attachment you want to get. In Outlook on the web and the new Outlook on Windows, the temporary attachment ID that's
|
|
16658
|
+
* locally generated for inline images that haven't been uploaded to the server yet are supported for the duration of the current compose session.
|
|
16615
16659
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
16616
16660
|
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
16617
16661
|
* an error code with the reason for the failure.
|
|
@@ -16627,14 +16671,22 @@ declare namespace Office {
|
|
|
16627
16671
|
*
|
|
16628
16672
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16629
16673
|
*
|
|
16630
|
-
* **Important**:
|
|
16674
|
+
* **Important**:
|
|
16675
|
+
*
|
|
16676
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
16677
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
16678
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
16679
|
+
* For more information on the changes to how inline images are handled, see
|
|
16680
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
16681
|
+
*
|
|
16682
|
+
* - In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
|
|
16631
16683
|
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
16632
16684
|
*
|
|
16633
16685
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
16634
16686
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
16635
16687
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16636
16688
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
16637
|
-
* the failure.
|
|
16689
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
16638
16690
|
*/
|
|
16639
16691
|
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
16640
16692
|
/**
|
|
@@ -16647,12 +16699,20 @@ declare namespace Office {
|
|
|
16647
16699
|
*
|
|
16648
16700
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
16649
16701
|
*
|
|
16650
|
-
* **Important**:
|
|
16702
|
+
* **Important**:
|
|
16703
|
+
*
|
|
16704
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
16705
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
16706
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
16707
|
+
* For more information on the changes to how inline images are handled, see
|
|
16708
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
16709
|
+
*
|
|
16710
|
+
* - In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
|
|
16651
16711
|
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
16652
16712
|
*
|
|
16653
16713
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
16654
16714
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
16655
|
-
* the failure.
|
|
16715
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
16656
16716
|
*/
|
|
16657
16717
|
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
16658
16718
|
/**
|
|
@@ -20009,6 +20069,12 @@ declare namespace Office {
|
|
|
20009
20069
|
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
20010
20070
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
20011
20071
|
*
|
|
20072
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in Outlook on the web and the new Outlook on Windows
|
|
20073
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20074
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID in the `id` property and their `isServiceAccessible` property is set to `true`.
|
|
20075
|
+
* The temporary attachment ID is only supported for the duration of the current compose session. For more information on the changes to how inline images are handled, see
|
|
20076
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20077
|
+
*
|
|
20012
20078
|
* - Bitmap (BMP) images aren't supported if they're added as inline attachments.
|
|
20013
20079
|
*
|
|
20014
20080
|
* - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
|
|
@@ -20035,9 +20101,10 @@ declare namespace Office {
|
|
|
20035
20101
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
20036
20102
|
* `isInline`: If true, indicates that the attachment will be shown inline as an image in the message body and won't be displayed in the attachment list.
|
|
20037
20103
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
20038
|
-
* type `Office.AsyncResult`. On success, the attachment identifier
|
|
20039
|
-
*
|
|
20040
|
-
* the
|
|
20104
|
+
* type `Office.AsyncResult`. On success, the attachment identifier is provided in the `asyncResult.value` property. The identifier varies depending on the Outlook client.
|
|
20105
|
+
* In Outlook on the web and the new Outlook on Windows, the Exchange Web Services (EWS) ID is returned. If `isInline` is set to `true`, a temporary attachment ID prefixed with
|
|
20106
|
+
* `addinId` is initially returned while the attachment is uploaded to the server. Once the upload completes, the attachment is then assigned an EWS ID. For details, see the notes in the Remarks section.
|
|
20107
|
+
* In Outlook on Windows (classic) and on Mac, the index of the attachment is returned for inline and non-inline attachments. If uploading the attachment fails, a description of the error is provided in `asyncResult.error`.
|
|
20041
20108
|
*/
|
|
20042
20109
|
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
20043
20110
|
/**
|
|
@@ -20057,6 +20124,12 @@ declare namespace Office {
|
|
|
20057
20124
|
* - This method isn't supported in Outlook on iOS or Android. For more information on supported APIs in Outlook mobile, see
|
|
20058
20125
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
20059
20126
|
*
|
|
20127
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in Outlook on the web and the new Outlook on Windows
|
|
20128
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20129
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID in the `id` property and their `isServiceAccessible` property is set to `true`.
|
|
20130
|
+
* The temporary attachment ID is only supported for the duration of the current compose session. For more information on the changes to how inline images are handled, see
|
|
20131
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20132
|
+
*
|
|
20060
20133
|
* - Bitmap (BMP) images aren't supported if they're added as inline attachments.
|
|
20061
20134
|
*
|
|
20062
20135
|
* - In recent builds of classic Outlook on Windows, a bug was introduced that incorrectly appends an `Authorization: Bearer` header to
|
|
@@ -20080,9 +20153,10 @@ declare namespace Office {
|
|
|
20080
20153
|
* @param uri - The URI that provides the location of the file to attach to the message or appointment. The maximum length is 2048 characters.
|
|
20081
20154
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
20082
20155
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
20083
|
-
* type `Office.AsyncResult`. On success, the attachment identifier
|
|
20084
|
-
*
|
|
20085
|
-
* the
|
|
20156
|
+
* type `Office.AsyncResult`. On success, the attachment identifier is provided in the `asyncResult.value` property. The identifier varies depending on the Outlook client.
|
|
20157
|
+
* In Outlook on the web and the new Outlook on Windows, the Exchange Web Services (EWS) ID is returned. If `isInline` is set to `true`, a temporary attachment ID prefixed with
|
|
20158
|
+
* `addinId` is initially returned while the attachment is uploaded to the server. Once the upload completes, the attachment is then assigned an EWS ID. For details, see the notes in the Remarks section.
|
|
20159
|
+
* In Outlook on Windows (classic) and on Mac, the index of the attachment is returned for inline and non-inline attachments. If uploading the attachment fails, a description of the error is provided in `asyncResult.error`.
|
|
20086
20160
|
*/
|
|
20087
20161
|
addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
20088
20162
|
/**
|
|
@@ -20105,6 +20179,12 @@ declare namespace Office {
|
|
|
20105
20179
|
* - Adding an inline Base64 file to a message in compose mode is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
20106
20180
|
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
20107
20181
|
*
|
|
20182
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20183
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20184
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20185
|
+
* For more information on the changes to how inline images are handled, see
|
|
20186
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20187
|
+
*
|
|
20108
20188
|
* - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
|
|
20109
20189
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
20110
20190
|
*
|
|
@@ -20128,9 +20208,11 @@ declare namespace Office {
|
|
|
20128
20208
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
20129
20209
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
20130
20210
|
* `isInline`: If true, indicates that the attachment will be shown inline as an image in the message body and won't be displayed in the attachment list.
|
|
20131
|
-
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
20132
|
-
*
|
|
20133
|
-
*
|
|
20211
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of type `Office.AsyncResult`.
|
|
20212
|
+
* On success, the attachment identifier is provided in the `asyncResult.value` property. The identifier varies depending on the Outlook client.
|
|
20213
|
+
* In Outlook on the web and the new Outlook on Windows, the Exchange Web Services (EWS) ID is returned. If `isInline` is set to `true`, a temporary attachment ID prefixed with
|
|
20214
|
+
* `addinId` is initially returned while the attachment is uploaded to the server. Once the upload completes, the attachment is then assigned an EWS ID. For details, see the notes in the Remarks section.
|
|
20215
|
+
* In Outlook on Windows (classic) and on Mac, the index of the attachment is returned for inline and non-inline attachments. If uploading the attachment fails, a description of the error is provided in `asyncResult.error`.
|
|
20134
20216
|
*/
|
|
20135
20217
|
addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
20136
20218
|
/**
|
|
@@ -20153,6 +20235,12 @@ declare namespace Office {
|
|
|
20153
20235
|
* - Adding an inline Base64 file to a message in compose mode is supported in Outlook on Android and on iOS. For more information on supported APIs in
|
|
20154
20236
|
* Outlook mobile, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}.
|
|
20155
20237
|
*
|
|
20238
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20239
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20240
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20241
|
+
* For more information on the changes to how inline images are handled, see
|
|
20242
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20243
|
+
*
|
|
20156
20244
|
* - If you're using a data URL API (for example, `readAsDataURL`), you need to strip out the data URL prefix, then send the rest of the string to this API.
|
|
20157
20245
|
* For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
|
|
20158
20246
|
*
|
|
@@ -20173,9 +20261,11 @@ declare namespace Office {
|
|
|
20173
20261
|
*
|
|
20174
20262
|
* @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
|
|
20175
20263
|
* @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
|
|
20176
|
-
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
20177
|
-
*
|
|
20178
|
-
*
|
|
20264
|
+
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of type `Office.AsyncResult`.
|
|
20265
|
+
* On success, the attachment identifier is provided in the `asyncResult.value` property. The identifier varies depending on the Outlook client.
|
|
20266
|
+
* In Outlook on the web and the new Outlook on Windows, the Exchange Web Services (EWS) ID is returned. If `isInline` is set to `true`, a temporary attachment ID prefixed with
|
|
20267
|
+
* `addinId` is initially returned while the attachment is uploaded to the server. Once the upload completes, the attachment is then assigned an EWS ID. For details, see the notes in the Remarks section.
|
|
20268
|
+
* In Outlook on Windows (classic) and on Mac, the index of the attachment is returned for inline and non-inline attachments. If uploading the attachment fails, a description of the error is provided in `asyncResult.error`.
|
|
20179
20269
|
*/
|
|
20180
20270
|
addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
20181
20271
|
/**
|
|
@@ -20458,6 +20548,12 @@ declare namespace Office {
|
|
|
20458
20548
|
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
20459
20549
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
20460
20550
|
*
|
|
20551
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20552
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20553
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20554
|
+
* For more information on the changes to how inline images are handled, see
|
|
20555
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20556
|
+
*
|
|
20461
20557
|
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
20462
20558
|
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
20463
20559
|
*
|
|
@@ -20472,7 +20568,8 @@ declare namespace Office {
|
|
|
20472
20568
|
*
|
|
20473
20569
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
20474
20570
|
*
|
|
20475
|
-
* @param attachmentId - The identifier of the attachment you want to get.
|
|
20571
|
+
* @param attachmentId - The identifier of the attachment you want to get. In Outlook on the web and the new Outlook on Windows, the temporary attachment ID that's
|
|
20572
|
+
* locally generated for inline images that haven't been uploaded to the server yet are supported for the duration of the current compose session.
|
|
20476
20573
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
20477
20574
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
20478
20575
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
@@ -20495,6 +20592,12 @@ declare namespace Office {
|
|
|
20495
20592
|
* - The `getAttachmentContentAsync` method gets the attachment with the specified identifier from the item. As a best practice, you should get
|
|
20496
20593
|
* the attachment's identifier from a `getAttachmentsAsync` call, then in the same session, use that identifier to retrieve the attachment.
|
|
20497
20594
|
*
|
|
20595
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20596
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20597
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20598
|
+
* For more information on the changes to how inline images are handled, see
|
|
20599
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20600
|
+
*
|
|
20498
20601
|
* - In Outlook on the web and the {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
20499
20602
|
* `getAttachmentContentAsync` doesn't support attachments that were added using the **Upload and share** option.
|
|
20500
20603
|
*
|
|
@@ -20509,7 +20612,8 @@ declare namespace Office {
|
|
|
20509
20612
|
*
|
|
20510
20613
|
* - `InvalidAttachmentId`: The attachment identifier does not exist.
|
|
20511
20614
|
*
|
|
20512
|
-
* @param attachmentId - The identifier of the attachment you want to get.
|
|
20615
|
+
* @param attachmentId - The identifier of the attachment you want to get. In Outlook on the web and the new Outlook on Windows, the temporary attachment ID that's
|
|
20616
|
+
* locally generated for inline images that haven't been uploaded to the server yet are supported for the duration of the current compose session.
|
|
20513
20617
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
20514
20618
|
* `asyncResult`, which is an `Office.AsyncResult` object. If the call fails, the `asyncResult.error` property will contain
|
|
20515
20619
|
* an error code with the reason for the failure.
|
|
@@ -20525,14 +20629,22 @@ declare namespace Office {
|
|
|
20525
20629
|
*
|
|
20526
20630
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
20527
20631
|
*
|
|
20528
|
-
* **Important**:
|
|
20632
|
+
* **Important**:
|
|
20633
|
+
*
|
|
20634
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20635
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20636
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20637
|
+
* For more information on the changes to how inline images are handled, see
|
|
20638
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20639
|
+
*
|
|
20640
|
+
* - In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
|
|
20529
20641
|
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
20530
20642
|
*
|
|
20531
20643
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
20532
20644
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
20533
20645
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
20534
20646
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
20535
|
-
* the failure.
|
|
20647
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects is returned in the `asyncResult.value` property.
|
|
20536
20648
|
*/
|
|
20537
20649
|
getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
20538
20650
|
/**
|
|
@@ -20545,12 +20657,20 @@ declare namespace Office {
|
|
|
20545
20657
|
*
|
|
20546
20658
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
20547
20659
|
*
|
|
20548
|
-
* **Important**:
|
|
20660
|
+
* **Important**:
|
|
20661
|
+
*
|
|
20662
|
+
* - Starting March 30, 2026, after the call to `addFileAttachmentAsync` or `addFileAttachmentFromBase64Async` with `isInline` set to `true` completes, inline images in messages in Outlook on the web and the new Outlook on Windows
|
|
20663
|
+
* are locally assigned a temporary attachment ID while they're uploaded to the server. A temporary attachment ID is prefixed with `addinId`. Once the images are
|
|
20664
|
+
* uploaded to the server, they are then assigned an Exchange Web Services (EWS) ID. The temporary attachment ID is only supported for the duration of the current compose session.
|
|
20665
|
+
* For more information on the changes to how inline images are handled, see
|
|
20666
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-attachment-ids-for-inline-images-in-outlook-add-ins/ | Changes to attachment IDs for inline images in Outlook add-ins}.
|
|
20667
|
+
*
|
|
20668
|
+
* - In Outlook on the web and the new Outlook on Windows, users can select the **Upload and share** option to upload an attachment to OneDrive and
|
|
20549
20669
|
* include a link to the file in the mail item. However, since only a link is included, `getAttachmentsAsync` doesn't return this attachment.
|
|
20550
20670
|
*
|
|
20551
20671
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
20552
20672
|
* type `Office.AsyncResult`. If the call fails, the `asyncResult.error` property will contain an error code with the reason for
|
|
20553
|
-
* the failure.
|
|
20673
|
+
* the failure. If the call succeeds, an array of `AttachmentDetailsCompose` objects are returned in the `asyncResult.value` property.
|
|
20554
20674
|
*/
|
|
20555
20675
|
getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void): void;
|
|
20556
20676
|
/**
|
|
@@ -35480,6 +35600,48 @@ declare namespace Excel {
|
|
|
35480
35600
|
function run<T>(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;
|
|
35481
35601
|
function postprocessBindingDescriptor(response: any): any;
|
|
35482
35602
|
function getDataCommonPostprocess(response: any, callArgs: any): any;
|
|
35603
|
+
/**
|
|
35604
|
+
* Provides information about the ranges that raised the `onCalculationBusy` event, which triggers when the calculation is in progress in a worksheet.
|
|
35605
|
+
*
|
|
35606
|
+
* @remarks
|
|
35607
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35608
|
+
* @beta
|
|
35609
|
+
*/
|
|
35610
|
+
interface WorksheetCalculationBusyEventArgs {
|
|
35611
|
+
/**
|
|
35612
|
+
* The address of the ranges that began calculation.
|
|
35613
|
+
If multiple ranges began calculation, the string is a comma-separated list of those range addresses.
|
|
35614
|
+
*
|
|
35615
|
+
* @remarks
|
|
35616
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35617
|
+
* @beta
|
|
35618
|
+
*/
|
|
35619
|
+
address: string;
|
|
35620
|
+
/**
|
|
35621
|
+
* The source of the event. It can be local or remote (through co-authoring).
|
|
35622
|
+
*
|
|
35623
|
+
* @remarks
|
|
35624
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35625
|
+
* @beta
|
|
35626
|
+
*/
|
|
35627
|
+
source: Excel.EventSource | "Local" | "Remote";
|
|
35628
|
+
/**
|
|
35629
|
+
* Gets the type of the event. See `Excel.EventType` for details.
|
|
35630
|
+
*
|
|
35631
|
+
* @remarks
|
|
35632
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35633
|
+
* @beta
|
|
35634
|
+
*/
|
|
35635
|
+
type: "WorksheetCalculationBusy";
|
|
35636
|
+
/**
|
|
35637
|
+
* The ID of the worksheet within which the calculation occurred.
|
|
35638
|
+
*
|
|
35639
|
+
* @remarks
|
|
35640
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35641
|
+
* @beta
|
|
35642
|
+
*/
|
|
35643
|
+
worksheetId: string;
|
|
35644
|
+
}
|
|
35483
35645
|
/**
|
|
35484
35646
|
* Provides information about the local image.
|
|
35485
35647
|
*
|
|
@@ -39281,6 +39443,9 @@ declare namespace Excel {
|
|
|
39281
39443
|
interface WorksheetFormulaChangedEventArgs {
|
|
39282
39444
|
/**
|
|
39283
39445
|
* Gets an array of `FormulaChangedEventDetail` objects, which contain the details about the all of the changed formulas.
|
|
39446
|
+
|
|
39447
|
+
If the number of changed formulas or the size of the changed formula text exceeds a size limit, `formulaDetails`
|
|
39448
|
+
returns undefined. This indicates that something on the sheet has changed, but the details cannot be reported.
|
|
39284
39449
|
*
|
|
39285
39450
|
* @remarks
|
|
39286
39451
|
* [Api set: ExcelApi 1.13]
|
|
@@ -40937,6 +41102,14 @@ declare namespace Excel {
|
|
|
40937
41102
|
* [Api set: ExcelApi 1.9]
|
|
40938
41103
|
*/
|
|
40939
41104
|
getSelectedRanges(): Excel.RangeAreas;
|
|
41105
|
+
/**
|
|
41106
|
+
* Returns whether the workbook is currently in preview mode.
|
|
41107
|
+
*
|
|
41108
|
+
* @remarks
|
|
41109
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
41110
|
+
* @beta
|
|
41111
|
+
*/
|
|
41112
|
+
inPreviewMode(): OfficeExtension.ClientResult<boolean>;
|
|
40940
41113
|
/**
|
|
40941
41114
|
* Inserts the specified worksheets from a source workbook into the current workbook.
|
|
40942
41115
|
|
|
@@ -41603,6 +41776,27 @@ declare namespace Excel {
|
|
|
41603
41776
|
* @eventproperty
|
|
41604
41777
|
*/
|
|
41605
41778
|
readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;
|
|
41779
|
+
/**
|
|
41780
|
+
* Occurs when cells in the worksheet are being calculated asynchronously.
|
|
41781
|
+
|
|
41782
|
+
This event is triggered at the end of a calculation cycle, similar to the `onCalculated` event.
|
|
41783
|
+
Ordinarily, when calculation completes for a cell, the `onCalculated` event is triggered.
|
|
41784
|
+
However, if the calculation places a transient pending value (such as "#BUSY!") in the
|
|
41785
|
+
cell, then `onCalculationBusy` is triggered instead to indicate that the cell's state has changed,
|
|
41786
|
+
although calculation of the final value is not yet complete. When a subsequent
|
|
41787
|
+
calculation cycle completes the calculation for that cell, the `onCalculated` event is
|
|
41788
|
+
then triggered.
|
|
41789
|
+
|
|
41790
|
+
Formula features such as JavaScript User-Defined Functions and =PY formulas
|
|
41791
|
+
may trigger this event.
|
|
41792
|
+
*
|
|
41793
|
+
* @remarks
|
|
41794
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
41795
|
+
*
|
|
41796
|
+
* @eventproperty
|
|
41797
|
+
* @beta
|
|
41798
|
+
*/
|
|
41799
|
+
readonly onCalculationBusy: OfficeExtension.EventHandlers<Excel.WorksheetCalculationBusyEventArgs>;
|
|
41606
41800
|
/**
|
|
41607
41801
|
* Occurs when data changes in a specific worksheet.
|
|
41608
41802
|
*
|
|
@@ -41651,6 +41845,9 @@ declare namespace Excel {
|
|
|
41651
41845
|
readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;
|
|
41652
41846
|
/**
|
|
41653
41847
|
* Occurs when one or more formulas are changed in this worksheet. This event is for when the formula itself changes, not the data value resulting from the formula's calculation.
|
|
41848
|
+
|
|
41849
|
+
The event is only triggered when the cell already contains a formula.
|
|
41850
|
+
The new cell value may not include a formula. This event is not triggered when a formula is entered into a cell that did not previously contain a formula.
|
|
41654
41851
|
*
|
|
41655
41852
|
* @remarks
|
|
41656
41853
|
* [Api set: ExcelApi 1.13]
|
|
@@ -41904,6 +42101,27 @@ declare namespace Excel {
|
|
|
41904
42101
|
* @eventproperty
|
|
41905
42102
|
*/
|
|
41906
42103
|
readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;
|
|
42104
|
+
/**
|
|
42105
|
+
* Occurs when cells in the worksheet are being calculated asynchronously.
|
|
42106
|
+
|
|
42107
|
+
This event is triggered at the end of a calculation cycle, similar to the `onCalculated` event.
|
|
42108
|
+
Ordinarily, when calculation completes for a cell, the `onCalculated` event is triggered.
|
|
42109
|
+
However, if the calculation places a transient pending value (such as "#BUSY!") in the
|
|
42110
|
+
cell, then `onCalculationBusy` is triggered instead to indicate that the cell's state has changed,
|
|
42111
|
+
although calculation of the final value is not yet complete. When a subsequent
|
|
42112
|
+
calculation cycle completes the calculation for that cell, the `onCalculated` event is
|
|
42113
|
+
then triggered.
|
|
42114
|
+
|
|
42115
|
+
Formula features such as JavaScript User-Defined Functions and =PY formulas
|
|
42116
|
+
may trigger this event.
|
|
42117
|
+
*
|
|
42118
|
+
* @remarks
|
|
42119
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
42120
|
+
*
|
|
42121
|
+
* @eventproperty
|
|
42122
|
+
* @beta
|
|
42123
|
+
*/
|
|
42124
|
+
readonly onCalculationBusy: OfficeExtension.EventHandlers<Excel.WorksheetCalculationBusyEventArgs>;
|
|
41907
42125
|
/**
|
|
41908
42126
|
* Occurs when any worksheet in the workbook is changed.
|
|
41909
42127
|
*
|
|
@@ -42679,7 +42897,8 @@ declare namespace Excel {
|
|
|
42679
42897
|
readonly valueTypes: Excel.RangeValueType[][];
|
|
42680
42898
|
/**
|
|
42681
42899
|
* Represents the raw values of the specified range. The data returned could be a string, number, or Boolean. Cells that contain an error will return the error string.
|
|
42682
|
-
|
|
42900
|
+
If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula.
|
|
42901
|
+
Locale-shaped strings (such as the date "19-8-2025" in nl-NL or fr-FR, format DD-MM-YYYY) are stored as text instead of as dates. To ensure dates are stored as dates, use a locale-aware API like `formulasLocal` or use a locale-neutral format like ISO (YYYY-MM-DD) or a numeric date serial.
|
|
42683
42902
|
*
|
|
42684
42903
|
* @remarks
|
|
42685
42904
|
* [Api set: ExcelApi 1.1]
|
|
@@ -47510,7 +47729,7 @@ declare namespace Excel {
|
|
|
47510
47729
|
* @param sourceData The `Range` object corresponding to the source data.
|
|
47511
47730
|
* @param seriesBy Optional. Specifies the way columns or rows are used as data series on the chart. See `Excel.ChartSeriesBy` for details.
|
|
47512
47731
|
*/
|
|
47513
|
-
add(type: "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel", sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): Excel.Chart;
|
|
47732
|
+
add(type: "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx", sourceData: Range, seriesBy?: "Auto" | "Columns" | "Rows"): Excel.Chart;
|
|
47514
47733
|
/**
|
|
47515
47734
|
* Returns the number of charts in the worksheet.
|
|
47516
47735
|
*
|
|
@@ -47693,7 +47912,7 @@ declare namespace Excel {
|
|
|
47693
47912
|
* @remarks
|
|
47694
47913
|
* [Api set: ExcelApi 1.7]
|
|
47695
47914
|
*/
|
|
47696
|
-
chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
|
|
47915
|
+
chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";
|
|
47697
47916
|
/**
|
|
47698
47917
|
* Specifies the way that blank cells are plotted on a chart.
|
|
47699
47918
|
*
|
|
@@ -48253,7 +48472,7 @@ declare namespace Excel {
|
|
|
48253
48472
|
* @remarks
|
|
48254
48473
|
* [Api set: ExcelApi 1.7]
|
|
48255
48474
|
*/
|
|
48256
|
-
chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
|
|
48475
|
+
chartType: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";
|
|
48257
48476
|
/**
|
|
48258
48477
|
* Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts.
|
|
48259
48478
|
Throws an `InvalidArgument` error on invalid charts.
|
|
@@ -64065,7 +64284,87 @@ declare namespace Excel {
|
|
|
64065
64284
|
* @remarks
|
|
64066
64285
|
* [Api set: ExcelApi 1.9]
|
|
64067
64286
|
*/
|
|
64068
|
-
funnel = "Funnel"
|
|
64287
|
+
funnel = "Funnel",
|
|
64288
|
+
/**
|
|
64289
|
+
* @remarks
|
|
64290
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64291
|
+
*/
|
|
64292
|
+
columnClusteredEx = "ColumnClusteredEx",
|
|
64293
|
+
/**
|
|
64294
|
+
* @remarks
|
|
64295
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64296
|
+
*/
|
|
64297
|
+
columnStackedEx = "ColumnStackedEx",
|
|
64298
|
+
/**
|
|
64299
|
+
* @remarks
|
|
64300
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64301
|
+
*/
|
|
64302
|
+
columnStacked100Ex = "ColumnStacked100Ex",
|
|
64303
|
+
/**
|
|
64304
|
+
* @remarks
|
|
64305
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64306
|
+
*/
|
|
64307
|
+
lineEx = "LineEx",
|
|
64308
|
+
/**
|
|
64309
|
+
* @remarks
|
|
64310
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64311
|
+
*/
|
|
64312
|
+
lineStackedEx = "LineStackedEx",
|
|
64313
|
+
/**
|
|
64314
|
+
* @remarks
|
|
64315
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64316
|
+
*/
|
|
64317
|
+
lineStacked100Ex = "LineStacked100Ex",
|
|
64318
|
+
/**
|
|
64319
|
+
* @remarks
|
|
64320
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64321
|
+
*/
|
|
64322
|
+
pieEx = "PieEx",
|
|
64323
|
+
/**
|
|
64324
|
+
* @remarks
|
|
64325
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64326
|
+
*/
|
|
64327
|
+
doughnutEx = "DoughnutEx",
|
|
64328
|
+
/**
|
|
64329
|
+
* @remarks
|
|
64330
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64331
|
+
*/
|
|
64332
|
+
barClusteredEx = "BarClusteredEx",
|
|
64333
|
+
/**
|
|
64334
|
+
* @remarks
|
|
64335
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64336
|
+
*/
|
|
64337
|
+
barStackedEx = "BarStackedEx",
|
|
64338
|
+
/**
|
|
64339
|
+
* @remarks
|
|
64340
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64341
|
+
*/
|
|
64342
|
+
barStacked100Ex = "BarStacked100Ex",
|
|
64343
|
+
/**
|
|
64344
|
+
* @remarks
|
|
64345
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64346
|
+
*/
|
|
64347
|
+
areaEx = "AreaEx",
|
|
64348
|
+
/**
|
|
64349
|
+
* @remarks
|
|
64350
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64351
|
+
*/
|
|
64352
|
+
areaStackedEx = "AreaStackedEx",
|
|
64353
|
+
/**
|
|
64354
|
+
* @remarks
|
|
64355
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64356
|
+
*/
|
|
64357
|
+
areaStacked100Ex = "AreaStacked100Ex",
|
|
64358
|
+
/**
|
|
64359
|
+
* @remarks
|
|
64360
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64361
|
+
*/
|
|
64362
|
+
xyscatterEx = "XYScatterEx",
|
|
64363
|
+
/**
|
|
64364
|
+
* @remarks
|
|
64365
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
64366
|
+
*/
|
|
64367
|
+
bubbleEx = "BubbleEx"
|
|
64069
64368
|
}
|
|
64070
64369
|
/**
|
|
64071
64370
|
* @remarks
|
|
@@ -66967,6 +67266,62 @@ declare namespace Excel {
|
|
|
66967
67266
|
* [Api set: ExcelApi 1.7]
|
|
66968
67267
|
*/
|
|
66969
67268
|
worksheetMoved = "WorksheetMoved",
|
|
67269
|
+
/**
|
|
67270
|
+
* ShapeAdded represents the type of event registered when a shape has been added to a ShapeCollection.
|
|
67271
|
+
* @remarks
|
|
67272
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67273
|
+
* @beta
|
|
67274
|
+
*/
|
|
67275
|
+
shapeAdded = "ShapeAdded",
|
|
67276
|
+
/**
|
|
67277
|
+
* ShapeDeleted represents the type of event registered when a shape has been deleted from a ShapeCollection.
|
|
67278
|
+
* @remarks
|
|
67279
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67280
|
+
* @beta
|
|
67281
|
+
*/
|
|
67282
|
+
shapeDeleted = "ShapeDeleted",
|
|
67283
|
+
/**
|
|
67284
|
+
* PivotTableAdded represents the type of event registered when a PivotTable has been added to a PivotTableCollection.
|
|
67285
|
+
* @remarks
|
|
67286
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67287
|
+
* @beta
|
|
67288
|
+
*/
|
|
67289
|
+
pivotTableAdded = "PivotTableAdded",
|
|
67290
|
+
/**
|
|
67291
|
+
* PivotTableDeleted represents the type of event registered when a PivotTable has been deleted from a PivotTableCollection.
|
|
67292
|
+
* @remarks
|
|
67293
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67294
|
+
* @beta
|
|
67295
|
+
*/
|
|
67296
|
+
pivotTableDeleted = "PivotTableDeleted",
|
|
67297
|
+
/**
|
|
67298
|
+
* NamedItemAdded represents the type of event registered when a NamedItem has been added to a NamedItemCollection.
|
|
67299
|
+
* @remarks
|
|
67300
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67301
|
+
* @beta
|
|
67302
|
+
*/
|
|
67303
|
+
namedItemAdded = "NamedItemAdded",
|
|
67304
|
+
/**
|
|
67305
|
+
* NamedItemDeleted represents the type of event registered when a NamedItem has been deleted from a NamedItemCollection.
|
|
67306
|
+
* @remarks
|
|
67307
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67308
|
+
* @beta
|
|
67309
|
+
*/
|
|
67310
|
+
namedItemDeleted = "NamedItemDeleted",
|
|
67311
|
+
/**
|
|
67312
|
+
* WorksheetNavigationObjectChanged represents the type of event registered when a navigation object has changed on a worksheet.
|
|
67313
|
+
* @remarks
|
|
67314
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67315
|
+
* @beta
|
|
67316
|
+
*/
|
|
67317
|
+
worksheetNavigationObjectChanged = "WorksheetNavigationObjectChanged",
|
|
67318
|
+
/**
|
|
67319
|
+
* WorkbookNavigationObjectChanged represents the type of event registered when a navigation object has changed on a workbook.
|
|
67320
|
+
* @remarks
|
|
67321
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67322
|
+
* @beta
|
|
67323
|
+
*/
|
|
67324
|
+
workbookNavigationObjectChanged = "WorkbookNavigationObjectChanged",
|
|
66970
67325
|
/**
|
|
66971
67326
|
* WorksheetRowHeightChanged represents the type of event registered when the height of a worksheet row is changed.
|
|
66972
67327
|
* @remarks
|
|
@@ -67030,7 +67385,20 @@ declare namespace Excel {
|
|
|
67030
67385
|
* @remarks
|
|
67031
67386
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67032
67387
|
*/
|
|
67033
|
-
augmentationLoopUploadStatusChanged = "AugmentationLoopUploadStatusChanged"
|
|
67388
|
+
augmentationLoopUploadStatusChanged = "AugmentationLoopUploadStatusChanged",
|
|
67389
|
+
/**
|
|
67390
|
+
* `WorksheetCalculationBusy` represents the type of event registered on a `Worksheet` or `WorksheetCollection` and occurs when a cell enters a busy calculation state.
|
|
67391
|
+
* @remarks
|
|
67392
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67393
|
+
* @beta
|
|
67394
|
+
*/
|
|
67395
|
+
worksheetCalculationBusy = "WorksheetCalculationBusy",
|
|
67396
|
+
/**
|
|
67397
|
+
* `WorkbookPreviewDirtied` represents the type of event registered when workbook preview mode has been dirtied.
|
|
67398
|
+
* @remarks
|
|
67399
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
67400
|
+
*/
|
|
67401
|
+
workbookPreviewDirtied = "WorkbookPreviewDirtied"
|
|
67034
67402
|
}
|
|
67035
67403
|
/**
|
|
67036
67404
|
* @remarks
|
|
@@ -75725,7 +76093,7 @@ declare namespace Excel {
|
|
|
75725
76093
|
* @remarks
|
|
75726
76094
|
* [Api set: ExcelApi 1.7]
|
|
75727
76095
|
*/
|
|
75728
|
-
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
|
|
76096
|
+
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";
|
|
75729
76097
|
/**
|
|
75730
76098
|
* Specifies the way that blank cells are plotted on a chart.
|
|
75731
76099
|
*
|
|
@@ -75950,7 +76318,7 @@ declare namespace Excel {
|
|
|
75950
76318
|
* @remarks
|
|
75951
76319
|
* [Api set: ExcelApi 1.7]
|
|
75952
76320
|
*/
|
|
75953
|
-
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
|
|
76321
|
+
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";
|
|
75954
76322
|
/**
|
|
75955
76323
|
* Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts.
|
|
75956
76324
|
Throws an `InvalidArgument` error on invalid charts.
|
|
@@ -82477,7 +82845,7 @@ declare namespace Excel {
|
|
|
82477
82845
|
* @remarks
|
|
82478
82846
|
* [Api set: ExcelApi 1.7]
|
|
82479
82847
|
*/
|
|
82480
|
-
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
|
|
82848
|
+
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";
|
|
82481
82849
|
/**
|
|
82482
82850
|
* Specifies the way that blank cells are plotted on a chart.
|
|
82483
82851
|
*
|
|
@@ -82723,7 +83091,7 @@ declare namespace Excel {
|
|
|
82723
83091
|
* @remarks
|
|
82724
83092
|
* [Api set: ExcelApi 1.7]
|
|
82725
83093
|
*/
|
|
82726
|
-
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel";
|
|
83094
|
+
chartType?: Excel.ChartType | "Invalid" | "ColumnClustered" | "ColumnStacked" | "ColumnStacked100" | "3DColumnClustered" | "3DColumnStacked" | "3DColumnStacked100" | "BarClustered" | "BarStacked" | "BarStacked100" | "3DBarClustered" | "3DBarStacked" | "3DBarStacked100" | "LineStacked" | "LineStacked100" | "LineMarkers" | "LineMarkersStacked" | "LineMarkersStacked100" | "PieOfPie" | "PieExploded" | "3DPieExploded" | "BarOfPie" | "XYScatterSmooth" | "XYScatterSmoothNoMarkers" | "XYScatterLines" | "XYScatterLinesNoMarkers" | "AreaStacked" | "AreaStacked100" | "3DAreaStacked" | "3DAreaStacked100" | "DoughnutExploded" | "RadarMarkers" | "RadarFilled" | "Surface" | "SurfaceWireframe" | "SurfaceTopView" | "SurfaceTopViewWireframe" | "Bubble" | "Bubble3DEffect" | "StockHLC" | "StockOHLC" | "StockVHLC" | "StockVOHLC" | "CylinderColClustered" | "CylinderColStacked" | "CylinderColStacked100" | "CylinderBarClustered" | "CylinderBarStacked" | "CylinderBarStacked100" | "CylinderCol" | "ConeColClustered" | "ConeColStacked" | "ConeColStacked100" | "ConeBarClustered" | "ConeBarStacked" | "ConeBarStacked100" | "ConeCol" | "PyramidColClustered" | "PyramidColStacked" | "PyramidColStacked100" | "PyramidBarClustered" | "PyramidBarStacked" | "PyramidBarStacked100" | "PyramidCol" | "3DColumn" | "Line" | "3DLine" | "3DPie" | "Pie" | "XYScatter" | "3DArea" | "Area" | "Doughnut" | "Radar" | "Histogram" | "Boxwhisker" | "Pareto" | "RegionMap" | "Treemap" | "Waterfall" | "Sunburst" | "Funnel" | "ColumnClusteredEx" | "ColumnStackedEx" | "ColumnStacked100Ex" | "LineEx" | "LineStackedEx" | "LineStacked100Ex" | "PieEx" | "DoughnutEx" | "BarClusteredEx" | "BarStackedEx" | "BarStacked100Ex" | "AreaEx" | "AreaStackedEx" | "AreaStacked100Ex" | "XYScatterEx" | "BubbleEx";
|
|
82727
83095
|
/**
|
|
82728
83096
|
* Represents the doughnut hole size of a chart series. Only valid on doughnut and doughnut exploded charts.
|
|
82729
83097
|
Throws an `InvalidArgument` error on invalid charts.
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.695",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "b1d1d8057440806e82a2b6649222a27c6ee0b1b80514d1364779d2c88ed759e9",
|
|
50
50
|
"typeScriptVersion": "5.2",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|