@types/office-js 1.0.315 → 1.0.317

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 +108 -108
  3. office-js/package.json +2 -2
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 31 Jan 2023 21:32:38 GMT
11
+ * Last updated: Tue, 07 Mar 2023 22:32:37 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
office-js/index.d.ts CHANGED
@@ -9921,13 +9921,13 @@ declare namespace Office {
9921
9921
  /**
9922
9922
  * Adds a file to a message or appointment as an attachment.
9923
9923
  *
9924
- * The `addFileAttachmentFromBase64Async` method uploads the file from the base64 encoding and attaches it to the item in the compose form.
9924
+ * The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
9925
9925
  * This method returns the attachment identifier in the `asyncResult.value` object.
9926
9926
  *
9927
9927
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
9928
9928
  *
9929
9929
  * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
9930
- * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of base64 string>`, remove `data:image/svg+xml;base64,`.
9930
+ * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
9931
9931
  *
9932
9932
  * @remarks
9933
9933
  * [Api set: Mailbox 1.8]
@@ -9940,16 +9940,16 @@ declare namespace Office {
9940
9940
  *
9941
9941
  * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
9942
9942
  *
9943
- * - `FileTypeNotSupported`: The attachment has an extension that is not allowed.
9943
+ * - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
9944
9944
  *
9945
9945
  * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
9946
9946
  *
9947
- * **Note**: If you're adding an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the
9947
+ * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
9948
9948
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
9949
- * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image will not render in the body once it's inserted.
9949
+ * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
9950
9950
  * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
9951
9951
  *
9952
- * @param base64File - The base64 encoded content of an image or file to be added to an email or event.
9952
+ * @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).
9953
9953
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
9954
9954
  * @param options - An object literal that contains one or more of the following properties:-
9955
9955
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -9965,13 +9965,13 @@ declare namespace Office {
9965
9965
  /**
9966
9966
  * Adds a file to a message or appointment as an attachment.
9967
9967
  *
9968
- * The `addFileAttachmentFromBase64Async` method uploads the file from the base64 encoding and attaches it to the item in the compose form.
9968
+ * The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
9969
9969
  * This method returns the attachment identifier in the `asyncResult.value` object.
9970
9970
  *
9971
9971
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
9972
9972
  *
9973
9973
  * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
9974
- * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of base64 string>`, remove `data:image/svg+xml;base64,`.
9974
+ * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
9975
9975
  *
9976
9976
  * @remarks
9977
9977
  * [Api set: Mailbox 1.8]
@@ -9984,16 +9984,16 @@ declare namespace Office {
9984
9984
  *
9985
9985
  * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
9986
9986
  *
9987
- * - `FileTypeNotSupported`: The attachment has an extension that is not allowed.
9987
+ * - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
9988
9988
  *
9989
9989
  * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
9990
9990
  *
9991
- * **Note**: If you're adding an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the
9991
+ * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
9992
9992
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
9993
- * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image will not render in the body once it's inserted.
9993
+ * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
9994
9994
  * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
9995
9995
  *
9996
- * @param base64File - The base64 encoded content of an image or file to be added to an email or event.
9996
+ * @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).
9997
9997
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
9998
9998
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
9999
9999
  * of type `Office.AsyncResult`.
@@ -14973,13 +14973,13 @@ declare namespace Office {
14973
14973
  /**
14974
14974
  * Adds a file to a message or appointment as an attachment.
14975
14975
  *
14976
- * The `addFileAttachmentFromBase64Async` method uploads the file from the base64 encoding and attaches it to the item in the compose form.
14976
+ * The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
14977
14977
  * This method returns the attachment identifier in the `asyncResult.value` object.
14978
14978
  *
14979
14979
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
14980
14980
  *
14981
14981
  * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
14982
- * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of base64 string>`, remove `data:image/svg+xml;base64,`.
14982
+ * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
14983
14983
  *
14984
14984
  * @remarks
14985
14985
  * [Api set: Mailbox 1.8]
@@ -14992,16 +14992,16 @@ declare namespace Office {
14992
14992
  *
14993
14993
  * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
14994
14994
  *
14995
- * - `FileTypeNotSupported`: The attachment has an extension that is not allowed.
14995
+ * - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
14996
14996
  *
14997
14997
  * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
14998
14998
  *
14999
- * **Note**: If you're adding an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the
14999
+ * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
15000
15000
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
15001
- * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image will not render in the body once it's inserted.
15001
+ * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
15002
15002
  * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
15003
15003
  *
15004
- * @param base64File - The base64-encoded content of an image or file to be added to an email or event.
15004
+ * @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).
15005
15005
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
15006
15006
  * @param options - An object literal that contains one or more of the following properties:-
15007
15007
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -15014,13 +15014,13 @@ declare namespace Office {
15014
15014
  /**
15015
15015
  * Adds a file to a message or appointment as an attachment.
15016
15016
  *
15017
- * The `addFileAttachmentFromBase64Async` method uploads the file from the base64 encoding and attaches it to the item in the compose form.
15017
+ * The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
15018
15018
  * This method returns the attachment identifier in the `asyncResult.value` object.
15019
15019
  *
15020
15020
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
15021
15021
  *
15022
15022
  * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
15023
- * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of base64 string>`, remove `data:image/svg+xml;base64,`.
15023
+ * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
15024
15024
  *
15025
15025
  * @remarks
15026
15026
  * [Api set: Mailbox 1.8]
@@ -15033,16 +15033,16 @@ declare namespace Office {
15033
15033
  *
15034
15034
  * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
15035
15035
  *
15036
- * - `FileTypeNotSupported`: The attachment has an extension that is not allowed.
15036
+ * - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
15037
15037
  *
15038
15038
  * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
15039
15039
  *
15040
- * **Note**: If you're adding an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the
15040
+ * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
15041
15041
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
15042
- * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image will not render in the body once it's inserted.
15042
+ * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
15043
15043
  * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
15044
15044
  *
15045
- * @param base64File - The base64-encoded content of an image or file to be added to an email or event.
15045
+ * @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).
15046
15046
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
15047
15047
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15048
15048
  * type Office.AsyncResult. On success, the attachment identifier will be provided in the `asyncResult.value` property.
@@ -24169,7 +24169,7 @@ declare namespace Excel {
24169
24169
  compact?: CompactLayout;
24170
24170
  }
24171
24171
  /**
24172
- * Represents a card layout best used for an entity.
24172
+ * Represents a card layout that is best used for an array.
24173
24173
  *
24174
24174
  * @remarks
24175
24175
  * [Api set: ExcelApi 1.16]
@@ -26267,12 +26267,12 @@ declare namespace Excel {
26267
26267
  /**
26268
26268
  * Notifies when a worksheet is moved within a workbook.
26269
26269
 
26270
- If a worksheet is moved from one position within the workbook to another
26271
- via the Excel UI, then this API will trigger an event. Note that if
26272
- the position of a worksheet changes as a result of moving a different worksheet,
26273
- then this event won't trigger for both position changes. This event only triggers
26274
- for the primary worksheet move, and not any worksheet position changes that occur
26275
- as a result of that primary move.
26270
+ If a worksheet is moved from one position within the workbook to another
26271
+ via the Excel UI, then this API will trigger an event. Note that if
26272
+ the position of a worksheet changes as a result of moving a different worksheet,
26273
+ then this event won't trigger for both position changes. This event only triggers
26274
+ for the primary worksheet move, and not any worksheet position changes that occur
26275
+ as a result of that primary move.
26276
26276
  *
26277
26277
  * @remarks
26278
26278
  * [Api set: ExcelApiOnline 1.1]
@@ -26809,8 +26809,8 @@ declare namespace Excel {
26809
26809
  /**
26810
26810
  * Equals comparator criterion.
26811
26811
 
26812
- Required Criteria: {`comparator`}.
26813
- Optional Criteria: {`wholeDays`, `exclusive`}.
26812
+ Required Criteria: {`comparator`}.
26813
+ Optional Criteria: {`wholeDays`, `exclusive`}.
26814
26814
  * @remarks
26815
26815
  * [Api set: ExcelApi 1.12]
26816
26816
  */
@@ -26818,8 +26818,8 @@ declare namespace Excel {
26818
26818
  /**
26819
26819
  * Date is before comparator date.
26820
26820
 
26821
- Required Criteria: {`comparator`}.
26822
- Optional Criteria: {`wholeDays`}.
26821
+ Required Criteria: {`comparator`}.
26822
+ Optional Criteria: {`wholeDays`}.
26823
26823
  * @remarks
26824
26824
  * [Api set: ExcelApi 1.12]
26825
26825
  */
@@ -26827,8 +26827,8 @@ declare namespace Excel {
26827
26827
  /**
26828
26828
  * Date is before or equal to comparator date.
26829
26829
 
26830
- Required Criteria: {`comparator`}.
26831
- Optional Criteria: {`wholeDays`}.
26830
+ Required Criteria: {`comparator`}.
26831
+ Optional Criteria: {`wholeDays`}.
26832
26832
  * @remarks
26833
26833
  * [Api set: ExcelApi 1.12]
26834
26834
  */
@@ -26836,8 +26836,8 @@ declare namespace Excel {
26836
26836
  /**
26837
26837
  * Date is after comparator date.
26838
26838
 
26839
- Required Criteria: {`comparator`}.
26840
- Optional Criteria: {`wholeDays`}.
26839
+ Required Criteria: {`comparator`}.
26840
+ Optional Criteria: {`wholeDays`}.
26841
26841
  * @remarks
26842
26842
  * [Api set: ExcelApi 1.12]
26843
26843
  */
@@ -26845,8 +26845,8 @@ declare namespace Excel {
26845
26845
  /**
26846
26846
  * Date is after or equal to comparator date.
26847
26847
 
26848
- Required Criteria: {`comparator`}.
26849
- Optional Criteria: {`wholeDays`}.
26848
+ Required Criteria: {`comparator`}.
26849
+ Optional Criteria: {`wholeDays`}.
26850
26850
  * @remarks
26851
26851
  * [Api set: ExcelApi 1.12]
26852
26852
  */
@@ -26854,8 +26854,8 @@ declare namespace Excel {
26854
26854
  /**
26855
26855
  * Between `lowerBound` and `upperBound` dates.
26856
26856
 
26857
- Required Criteria: {`lowerBound`, `upperBound`}.
26858
- Optional Criteria: {`wholeDays`, `exclusive`}.
26857
+ Required Criteria: {`lowerBound`, `upperBound`}.
26858
+ Optional Criteria: {`wholeDays`, `exclusive`}.
26859
26859
  * @remarks
26860
26860
  * [Api set: ExcelApi 1.12]
26861
26861
  */
@@ -27071,8 +27071,8 @@ declare namespace Excel {
27071
27071
  /**
27072
27072
  * Equals comparator criterion.
27073
27073
 
27074
- Required Criteria: {`comparator`}.
27075
- Optional Criteria: {`exclusive`}.
27074
+ Required Criteria: {`comparator`}.
27075
+ Optional Criteria: {`exclusive`}.
27076
27076
  * @remarks
27077
27077
  * [Api set: ExcelApi 1.12]
27078
27078
  */
@@ -27080,8 +27080,8 @@ declare namespace Excel {
27080
27080
  /**
27081
27081
  * Label begins with substring criterion.
27082
27082
 
27083
- Required Criteria: {`substring`}.
27084
- Optional Criteria: {`exclusive`}.
27083
+ Required Criteria: {`substring`}.
27084
+ Optional Criteria: {`exclusive`}.
27085
27085
  * @remarks
27086
27086
  * [Api set: ExcelApi 1.12]
27087
27087
  */
@@ -27089,8 +27089,8 @@ declare namespace Excel {
27089
27089
  /**
27090
27090
  * Label ends with substring criterion.
27091
27091
 
27092
- Required Criteria: {`substring`}.
27093
- Optional Criteria: {`exclusive`}.
27092
+ Required Criteria: {`substring`}.
27093
+ Optional Criteria: {`exclusive`}.
27094
27094
  * @remarks
27095
27095
  * [Api set: ExcelApi 1.12]
27096
27096
  */
@@ -27098,8 +27098,8 @@ declare namespace Excel {
27098
27098
  /**
27099
27099
  * Label contains substring criterion.
27100
27100
 
27101
- Required Criteria: {`substring`}.
27102
- Optional Criteria: {`exclusive`}.
27101
+ Required Criteria: {`substring`}.
27102
+ Optional Criteria: {`exclusive`}.
27103
27103
  * @remarks
27104
27104
  * [Api set: ExcelApi 1.12]
27105
27105
  */
@@ -27107,7 +27107,7 @@ declare namespace Excel {
27107
27107
  /**
27108
27108
  * Greater than comparator criterion.
27109
27109
 
27110
- Required Criteria: {`comparator`}.
27110
+ Required Criteria: {`comparator`}.
27111
27111
  * @remarks
27112
27112
  * [Api set: ExcelApi 1.12]
27113
27113
  */
@@ -27115,7 +27115,7 @@ declare namespace Excel {
27115
27115
  /**
27116
27116
  * Greater than or equal to comparator criterion.
27117
27117
 
27118
- Required Criteria: {`comparator`}.
27118
+ Required Criteria: {`comparator`}.
27119
27119
  * @remarks
27120
27120
  * [Api set: ExcelApi 1.12]
27121
27121
  */
@@ -27123,7 +27123,7 @@ declare namespace Excel {
27123
27123
  /**
27124
27124
  * Less than comparator criterion.
27125
27125
 
27126
- Required Criteria: {`comparator`}.
27126
+ Required Criteria: {`comparator`}.
27127
27127
  * @remarks
27128
27128
  * [Api set: ExcelApi 1.12]
27129
27129
  */
@@ -27131,7 +27131,7 @@ declare namespace Excel {
27131
27131
  /**
27132
27132
  * Less than or equal to comparator criterion.
27133
27133
 
27134
- Required Criteria: {`comparator`}.
27134
+ Required Criteria: {`comparator`}.
27135
27135
  * @remarks
27136
27136
  * [Api set: ExcelApi 1.12]
27137
27137
  */
@@ -27139,8 +27139,8 @@ declare namespace Excel {
27139
27139
  /**
27140
27140
  * Between `lowerBound` and `upperBound` criteria.
27141
27141
 
27142
- Required Criteria: {`lowerBound`, `upperBound`}.
27143
- Optional Criteria: {`exclusive`}.
27142
+ Required Criteria: {`lowerBound`, `upperBound`}.
27143
+ Optional Criteria: {`exclusive`}.
27144
27144
  * @remarks
27145
27145
  * [Api set: ExcelApi 1.12]
27146
27146
  */
@@ -27453,8 +27453,8 @@ declare namespace Excel {
27453
27453
  /**
27454
27454
  * Equals comparator criterion.
27455
27455
 
27456
- Required Criteria: {`value`, `comparator`}.
27457
- Optional Criteria: {`exclusive`}.
27456
+ Required Criteria: {`value`, `comparator`}.
27457
+ Optional Criteria: {`exclusive`}.
27458
27458
  * @remarks
27459
27459
  * [Api set: ExcelApi 1.12]
27460
27460
  */
@@ -27462,7 +27462,7 @@ declare namespace Excel {
27462
27462
  /**
27463
27463
  * Greater than comparator criterion.
27464
27464
 
27465
- Required Criteria: {`value`, `comparator`}.
27465
+ Required Criteria: {`value`, `comparator`}.
27466
27466
  * @remarks
27467
27467
  * [Api set: ExcelApi 1.12]
27468
27468
  */
@@ -27470,7 +27470,7 @@ declare namespace Excel {
27470
27470
  /**
27471
27471
  * Greater than or equal to comparator criterion.
27472
27472
 
27473
- Required Criteria: {`value`, `comparator`}.
27473
+ Required Criteria: {`value`, `comparator`}.
27474
27474
  * @remarks
27475
27475
  * [Api set: ExcelApi 1.12]
27476
27476
  */
@@ -27478,7 +27478,7 @@ declare namespace Excel {
27478
27478
  /**
27479
27479
  * Less than comparator criterion.
27480
27480
 
27481
- Required Criteria: {`value`, `comparator`}.
27481
+ Required Criteria: {`value`, `comparator`}.
27482
27482
  * @remarks
27483
27483
  * [Api set: ExcelApi 1.12]
27484
27484
  */
@@ -27486,7 +27486,7 @@ declare namespace Excel {
27486
27486
  /**
27487
27487
  * Less than or equal to comparator criterion.
27488
27488
 
27489
- Required Criteria: {`value`, `comparator`}.
27489
+ Required Criteria: {`value`, `comparator`}.
27490
27490
  * @remarks
27491
27491
  * [Api set: ExcelApi 1.12]
27492
27492
  */
@@ -27494,8 +27494,8 @@ declare namespace Excel {
27494
27494
  /**
27495
27495
  * Between `lowerBound` and `upperBound` criteria.
27496
27496
 
27497
- Required Criteria: {`value`, `lowerBound`, `upperBound`}.
27498
- Optional Criteria: {`exclusive`}.
27497
+ Required Criteria: {`value`, `lowerBound`, `upperBound`}.
27498
+ Optional Criteria: {`exclusive`}.
27499
27499
  * @remarks
27500
27500
  * [Api set: ExcelApi 1.12]
27501
27501
  */
@@ -27503,7 +27503,7 @@ declare namespace Excel {
27503
27503
  /**
27504
27504
  * In top N (`threshold`) [items, percent, sum] of value category.
27505
27505
 
27506
- Required Criteria: {`value`, `threshold`, `selectionType`}.
27506
+ Required Criteria: {`value`, `threshold`, `selectionType`}.
27507
27507
  * @remarks
27508
27508
  * [Api set: ExcelApi 1.12]
27509
27509
  */
@@ -27511,7 +27511,7 @@ declare namespace Excel {
27511
27511
  /**
27512
27512
  * In bottom N (`threshold`) [items, percent, sum] of value category.
27513
27513
 
27514
- Required Criteria: {`value`, `threshold`, `selectionType`}.
27514
+ Required Criteria: {`value`, `threshold`, `selectionType`}.
27515
27515
  * @remarks
27516
27516
  * [Api set: ExcelApi 1.12]
27517
27517
  */
@@ -30098,9 +30098,9 @@ declare namespace Excel {
30098
30098
  /**
30099
30099
  * Occurs when a left-clicked/tapped action happens in the worksheet. This event will not be fired when clicking in the following cases:
30100
30100
 
30101
- - The user drags the mouse for multi-selection.
30101
+ - The user drags the mouse for multi-selection.
30102
30102
 
30103
- - The user selects a cell in the mode when cell arguments are selected for formula references.
30103
+ - The user selects a cell in the mode when cell arguments are selected for formula references.
30104
30104
  *
30105
30105
  * @remarks
30106
30106
  * [Api set: ExcelApi 1.10]
@@ -30438,7 +30438,7 @@ declare namespace Excel {
30438
30438
  /**
30439
30439
  * Specifies if the password can be used to unlock worksheet protection.
30440
30440
  This method doesn't change the worksheet protection state.
30441
- If a password is inputted but no password is required to unlock worksheet protection, this method will return false.
30441
+ If a password is input but no password is required to unlock worksheet protection, this method will return false.
30442
30442
  *
30443
30443
  * @remarks
30444
30444
  * [Api set: ExcelApiOnline 1.1]
@@ -31032,10 +31032,10 @@ declare namespace Excel {
31032
31032
  set(properties: Excel.Range): void;
31033
31033
  /**
31034
31034
  * Fills a range from the current range to the destination range using the specified AutoFill logic.
31035
- The destination range can be `null` or can extend the source range either horizontally or vertically.
31036
- Discontiguous ranges are not supported.
31035
+ The destination range can be `null` or can extend the source range either horizontally or vertically.
31036
+ Discontiguous ranges are not supported.
31037
31037
 
31038
- For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
31038
+ For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
31039
31039
  *
31040
31040
  * @remarks
31041
31041
  * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
@@ -31046,10 +31046,10 @@ declare namespace Excel {
31046
31046
  autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;
31047
31047
  /**
31048
31048
  * Fills a range from the current range to the destination range using the specified AutoFill logic.
31049
- The destination range can be `null` or can extend the source range either horizontally or vertically.
31050
- Discontiguous ranges are not supported.
31049
+ The destination range can be `null` or can extend the source range either horizontally or vertically.
31050
+ Discontiguous ranges are not supported.
31051
31051
 
31052
- For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
31052
+ For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
31053
31053
  *
31054
31054
  * @remarks
31055
31055
  * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
@@ -31101,8 +31101,8 @@ declare namespace Excel {
31101
31101
  */
31102
31102
  convertToLinkedDataType(serviceID: number, languageCulture: string): void;
31103
31103
  /**
31104
- * Copies cell data or formatting from the source range or `RangeAreas` to the current range.
31105
- The destination range can be a different size than the source range or `RangeAreas`. The destination will be expanded automatically if it is smaller than the source.
31104
+ * Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range can be a different size than the source range or `RangeAreas`. The destination is expanded automatically if it's smaller than the source.
31105
+ Note: Like the copy functionality in the Excel UI, if the destination range is an exact multiple greater than the source range in either rows or columns, then the source content is replicated multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range.
31106
31106
  *
31107
31107
  * @remarks
31108
31108
  * [Api set: ExcelApi 1.9]
@@ -31114,8 +31114,8 @@ declare namespace Excel {
31114
31114
  */
31115
31115
  copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;
31116
31116
  /**
31117
- * Copies cell data or formatting from the source range or `RangeAreas` to the current range.
31118
- The destination range can be a different size than the source range or `RangeAreas`. The destination will be expanded automatically if it is smaller than the source.
31117
+ * Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range can be a different size than the source range or `RangeAreas`. The destination is expanded automatically if it's smaller than the source.
31118
+ Note: Like the copy functionality in the Excel UI, if the destination range is an exact multiple greater than the source range in either rows or columns, then the source content is replicated multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range.
31119
31119
  *
31120
31120
  * @remarks
31121
31121
  * [Api set: ExcelApi 1.9]
@@ -31262,7 +31262,7 @@ declare namespace Excel {
31262
31262
  getDependents(): Excel.WorkbookRangeAreas;
31263
31263
  /**
31264
31264
  * 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.
31265
- *
31265
+ *
31266
31266
  * @remarks
31267
31267
  * [Api set: ExcelApi 1.13]
31268
31268
  */
@@ -40537,7 +40537,7 @@ declare namespace Excel {
40537
40537
  */
40538
40538
  date: string;
40539
40539
  /**
40540
- * How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specifity is set to "month", the filter operation will keep all rows with a date in the month of April 2005.
40540
+ * How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is set to "month", the filter operation will keep all rows with a date in the month of April 2005.
40541
40541
  *
40542
40542
  * @remarks
40543
40543
  * [Api set: ExcelApi 1.2]
@@ -41428,9 +41428,9 @@ declare namespace Excel {
41428
41428
  /**
41429
41429
  * The alt text description of the PivotTable.
41430
41430
 
41431
- Alt text provides alternative, text-based representations of the information contained in the PivotTable.
41432
- This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
41433
- A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
41431
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable.
41432
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
41433
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
41434
41434
  *
41435
41435
  * @remarks
41436
41436
  * [Api set: ExcelApi 1.13]
@@ -41439,9 +41439,9 @@ declare namespace Excel {
41439
41439
  /**
41440
41440
  * The alt text title of the PivotTable.
41441
41441
 
41442
- Alt text provides alternative, text-based representations of the information contained in the PivotTable.
41443
- This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
41444
- A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
41442
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable.
41443
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
41444
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
41445
41445
  *
41446
41446
  * @remarks
41447
41447
  * [Api set: ExcelApi 1.13]
@@ -42771,7 +42771,7 @@ declare namespace Excel {
42771
42771
  descending = "Descending"
42772
42772
  }
42773
42773
  /**
42774
- * Aggregation function for the DataPivotField.
42774
+ * Aggregation function for the `DataPivotHierarchy`.
42775
42775
  *
42776
42776
  * @remarks
42777
42777
  * [Api set: ExcelApi 1.8]
@@ -46656,7 +46656,7 @@ declare namespace Excel {
46656
46656
  toJSON(): Excel.Interfaces.PageBreakCollectionData;
46657
46657
  }
46658
46658
  /**
46659
- * Represents a collection of all the data connections that are part of the workbook or worksheet.
46659
+ * Represents a collection of all the data connections that are part of the workbook.
46660
46660
  *
46661
46661
  * @remarks
46662
46662
  * [Api set: ExcelApi 1.7]
@@ -63073,9 +63073,9 @@ declare namespace Excel {
63073
63073
  /**
63074
63074
  * The alt text description of the PivotTable.
63075
63075
 
63076
- Alt text provides alternative, text-based representations of the information contained in the PivotTable.
63077
- This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
63078
- A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
63076
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable.
63077
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
63078
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
63079
63079
  *
63080
63080
  * @remarks
63081
63081
  * [Api set: ExcelApi 1.13]
@@ -63084,9 +63084,9 @@ declare namespace Excel {
63084
63084
  /**
63085
63085
  * The alt text title of the PivotTable.
63086
63086
 
63087
- Alt text provides alternative, text-based representations of the information contained in the PivotTable.
63088
- This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
63089
- A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
63087
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable.
63088
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
63089
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
63090
63090
  *
63091
63091
  * @remarks
63092
63092
  * [Api set: ExcelApi 1.13]
@@ -69223,9 +69223,9 @@ declare namespace Excel {
69223
69223
  /**
69224
69224
  * The alt text description of the PivotTable.
69225
69225
 
69226
- Alt text provides alternative, text-based representations of the information contained in the PivotTable.
69227
- This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
69228
- A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
69226
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable.
69227
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
69228
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
69229
69229
  *
69230
69230
  * @remarks
69231
69231
  * [Api set: ExcelApi 1.13]
@@ -69234,9 +69234,9 @@ declare namespace Excel {
69234
69234
  /**
69235
69235
  * The alt text title of the PivotTable.
69236
69236
 
69237
- Alt text provides alternative, text-based representations of the information contained in the PivotTable.
69238
- This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
69239
- A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
69237
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable.
69238
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
69239
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
69240
69240
  *
69241
69241
  * @remarks
69242
69242
  * [Api set: ExcelApi 1.13]
@@ -78125,9 +78125,9 @@ declare namespace Excel {
78125
78125
  /**
78126
78126
  * The alt text description of the PivotTable.
78127
78127
 
78128
- Alt text provides alternative, text-based representations of the information contained in the PivotTable.
78129
- This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
78130
- A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
78128
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable.
78129
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
78130
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
78131
78131
  *
78132
78132
  * @remarks
78133
78133
  * [Api set: ExcelApi 1.13]
@@ -78136,9 +78136,9 @@ declare namespace Excel {
78136
78136
  /**
78137
78137
  * The alt text title of the PivotTable.
78138
78138
 
78139
- Alt text provides alternative, text-based representations of the information contained in the PivotTable.
78140
- This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
78141
- A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
78139
+ Alt text provides alternative, text-based representations of the information contained in the PivotTable.
78140
+ This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
78141
+ A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
78142
78142
  *
78143
78143
  * @remarks
78144
78144
  * [Api set: ExcelApi 1.13]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.315",
3
+ "version": "1.0.317",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "6591a77cf83f6778dc0b8e1d2a068bfbaeaae5aa0f9d7d0d1f551c4c8ef08eee",
48
+ "typesPublisherContentHash": "712921af1c8058579edecbad22236dff326c9c1b19af52298741d5ae0df45d17",
49
49
  "typeScriptVersion": "4.2"
50
50
  }