@types/office-js-preview 1.0.263 → 1.0.267
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 +304 -106
- 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 (https://github.com/OfficeD
|
|
|
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: Mon,
|
|
11
|
+
* Last updated: Mon, 08 Nov 2021 22:01:42 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -3926,7 +3926,7 @@ declare namespace Office {
|
|
|
3926
3926
|
* <tr><th> </th><th> Office on Windows </th><th> Office on the web </th><th> Office on iPad </th><th> Office on Mac </th></tr>
|
|
3927
3927
|
* <tr><td><strong> Excel </strong></td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`, `Pdf` </td><td> </td><td> `Compressed`, `Pdf`, `Text` </td></tr>
|
|
3928
3928
|
* <tr><td><strong> PowerPoint </strong></td><td> `Compressed`, `Pdf` </td><td> `Compressed`, `Pdf` </td><td> `Compressed`, `Pdf` </td><td> `Compressed`, `Pdf` </td></tr>
|
|
3929
|
-
* <tr><td><strong> Word </strong></td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`
|
|
3929
|
+
* <tr><td><strong> Word </strong></td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`, `Pdf` </td><td> `Compressed`, `Pdf`, `Text` </td></tr>
|
|
3930
3930
|
* </table>
|
|
3931
3931
|
*
|
|
3932
3932
|
* @param fileType The format in which the file will be returned
|
|
@@ -3961,7 +3961,7 @@ declare namespace Office {
|
|
|
3961
3961
|
* <tr><th> </th><th> Office on Windows </th><th> Office on the web </th><th> Office on iPad </th><th> Office on Mac </th></tr>
|
|
3962
3962
|
* <tr><td><strong> Excel </strong></td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`, `Pdf` </td><td> </td><td> `Compressed`, `Pdf`, `Text` </td></tr>
|
|
3963
3963
|
* <tr><td><strong> PowerPoint </strong></td><td> `Compressed`, `Pdf` </td><td> `Compressed`, `Pdf` </td><td> `Compressed`, `Pdf` </td><td> `Compressed`, `Pdf` </td></tr>
|
|
3964
|
-
* <tr><td><strong> Word </strong></td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`
|
|
3964
|
+
* <tr><td><strong> Word </strong></td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`, `Pdf`, `Text` </td><td> `Compressed`, `Pdf` </td><td> `Compressed`, `Pdf`, `Text` </td></tr>
|
|
3965
3965
|
* </table>
|
|
3966
3966
|
*
|
|
3967
3967
|
* @param fileType The format in which the file will be returned
|
|
@@ -9713,13 +9713,11 @@ declare namespace Office {
|
|
|
9713
9713
|
* Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
|
|
9714
9714
|
*
|
|
9715
9715
|
* @remarks
|
|
9716
|
-
* [Api set: Mailbox
|
|
9716
|
+
* [Api set: Mailbox 1.11]
|
|
9717
9717
|
*
|
|
9718
9718
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
9719
9719
|
*
|
|
9720
9720
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
9721
|
-
*
|
|
9722
|
-
* @beta
|
|
9723
9721
|
*/
|
|
9724
9722
|
sessionData: SessionData;
|
|
9725
9723
|
/**
|
|
@@ -14787,13 +14785,11 @@ declare namespace Office {
|
|
|
14787
14785
|
* Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
|
|
14788
14786
|
*
|
|
14789
14787
|
* @remarks
|
|
14790
|
-
* [Api set: Mailbox
|
|
14788
|
+
* [Api set: Mailbox 1.11]
|
|
14791
14789
|
*
|
|
14792
14790
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
14793
14791
|
*
|
|
14794
14792
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
14795
|
-
*
|
|
14796
|
-
* @beta
|
|
14797
14793
|
*/
|
|
14798
14794
|
sessionData: SessionData;
|
|
14799
14795
|
/**
|
|
@@ -18200,20 +18196,18 @@ declare namespace Office {
|
|
|
18200
18196
|
* Provides methods to manage an item's session data.
|
|
18201
18197
|
*
|
|
18202
18198
|
* @remarks
|
|
18203
|
-
* [Api set: Mailbox
|
|
18199
|
+
* [Api set: Mailbox 1.11]
|
|
18204
18200
|
*
|
|
18205
18201
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
18206
18202
|
*
|
|
18207
18203
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18208
|
-
*
|
|
18209
|
-
* @beta
|
|
18210
18204
|
*/
|
|
18211
18205
|
interface SessionData {
|
|
18212
18206
|
/**
|
|
18213
18207
|
* Clears all session data key-value pairs.
|
|
18214
18208
|
*
|
|
18215
18209
|
* @remarks
|
|
18216
|
-
* [Api set: Mailbox
|
|
18210
|
+
* [Api set: Mailbox 1.11]
|
|
18217
18211
|
*
|
|
18218
18212
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
18219
18213
|
*
|
|
@@ -18223,15 +18217,13 @@ declare namespace Office {
|
|
|
18223
18217
|
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
18224
18218
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18225
18219
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
18226
|
-
*
|
|
18227
|
-
* @beta
|
|
18228
18220
|
*/
|
|
18229
18221
|
clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18230
18222
|
/**
|
|
18231
18223
|
* Clears all session data key-value pairs.
|
|
18232
18224
|
*
|
|
18233
18225
|
* @remarks
|
|
18234
|
-
* [Api set: Mailbox
|
|
18226
|
+
* [Api set: Mailbox 1.11]
|
|
18235
18227
|
*
|
|
18236
18228
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
18237
18229
|
*
|
|
@@ -18239,15 +18231,13 @@ declare namespace Office {
|
|
|
18239
18231
|
*
|
|
18240
18232
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18241
18233
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
18242
|
-
*
|
|
18243
|
-
* @beta
|
|
18244
18234
|
*/
|
|
18245
18235
|
clearAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18246
18236
|
/**
|
|
18247
18237
|
* Gets all session data key-value pairs.
|
|
18248
18238
|
*
|
|
18249
18239
|
* @remarks
|
|
18250
|
-
* [Api set: Mailbox
|
|
18240
|
+
* [Api set: Mailbox 1.11]
|
|
18251
18241
|
*
|
|
18252
18242
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
18253
18243
|
*
|
|
@@ -18255,15 +18245,13 @@ declare namespace Office {
|
|
|
18255
18245
|
*
|
|
18256
18246
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18257
18247
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
18258
|
-
*
|
|
18259
|
-
* @beta
|
|
18260
18248
|
*/
|
|
18261
18249
|
getAllAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18262
18250
|
/**
|
|
18263
18251
|
* Gets the session data value of the specified key.
|
|
18264
18252
|
*
|
|
18265
18253
|
* @remarks
|
|
18266
|
-
* [Api set: Mailbox
|
|
18254
|
+
* [Api set: Mailbox 1.11]
|
|
18267
18255
|
*
|
|
18268
18256
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
18269
18257
|
*
|
|
@@ -18272,15 +18260,13 @@ declare namespace Office {
|
|
|
18272
18260
|
* @param name - The session data key.
|
|
18273
18261
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
18274
18262
|
* type `Office.AsyncResult`.
|
|
18275
|
-
*
|
|
18276
|
-
* @beta
|
|
18277
18263
|
*/
|
|
18278
18264
|
getAsync(name: string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18279
18265
|
/**
|
|
18280
18266
|
* Removes a session data key-value pair.
|
|
18281
18267
|
*
|
|
18282
18268
|
* @remarks
|
|
18283
|
-
* [Api set: Mailbox
|
|
18269
|
+
* [Api set: Mailbox 1.11]
|
|
18284
18270
|
*
|
|
18285
18271
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
18286
18272
|
*
|
|
@@ -18291,15 +18277,13 @@ declare namespace Office {
|
|
|
18291
18277
|
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
18292
18278
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18293
18279
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
18294
|
-
*
|
|
18295
|
-
* @beta
|
|
18296
18280
|
*/
|
|
18297
18281
|
removeAsync(name: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18298
18282
|
/**
|
|
18299
18283
|
* Removes a session data key-value pair.
|
|
18300
18284
|
*
|
|
18301
18285
|
* @remarks
|
|
18302
|
-
* [Api set: Mailbox
|
|
18286
|
+
* [Api set: Mailbox 1.11]
|
|
18303
18287
|
*
|
|
18304
18288
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
|
|
18305
18289
|
*
|
|
@@ -18308,15 +18292,13 @@ declare namespace Office {
|
|
|
18308
18292
|
* @param name - The session data key.
|
|
18309
18293
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
|
|
18310
18294
|
* `asyncResult`, which is an `Office.AsyncResult` object.
|
|
18311
|
-
*
|
|
18312
|
-
* @beta
|
|
18313
18295
|
*/
|
|
18314
18296
|
removeAsync(name: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18315
18297
|
/**
|
|
18316
18298
|
* Sets a session data key-value pair.
|
|
18317
18299
|
*
|
|
18318
18300
|
* @remarks
|
|
18319
|
-
* [Api set: Mailbox
|
|
18301
|
+
* [Api set: Mailbox 1.11]
|
|
18320
18302
|
*
|
|
18321
18303
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
18322
18304
|
*
|
|
@@ -18328,15 +18310,13 @@ declare namespace Office {
|
|
|
18328
18310
|
* `asyncContext`: Developers can provide any object they wish to access in the callback method.
|
|
18329
18311
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
18330
18312
|
* type `Office.AsyncResult`.
|
|
18331
|
-
*
|
|
18332
|
-
* @beta
|
|
18333
18313
|
*/
|
|
18334
18314
|
setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18335
18315
|
/**
|
|
18336
18316
|
* Sets a session data key-value pair.
|
|
18337
18317
|
*
|
|
18338
18318
|
* @remarks
|
|
18339
|
-
* [Api set: Mailbox
|
|
18319
|
+
* [Api set: Mailbox 1.11]
|
|
18340
18320
|
*
|
|
18341
18321
|
* **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
|
|
18342
18322
|
*
|
|
@@ -18346,8 +18326,6 @@ declare namespace Office {
|
|
|
18346
18326
|
* @param value - The session data value as a string.
|
|
18347
18327
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
|
|
18348
18328
|
* type `Office.AsyncResult`.
|
|
18349
|
-
*
|
|
18350
|
-
* @beta
|
|
18351
18329
|
*/
|
|
18352
18330
|
setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18353
18331
|
}
|
|
@@ -19085,6 +19063,47 @@ declare namespace OfficeCore {
|
|
|
19085
19063
|
|
|
19086
19064
|
|
|
19087
19065
|
declare namespace Excel {
|
|
19066
|
+
/**
|
|
19067
|
+
* Represents a 2D array of cell values.
|
|
19068
|
+
*
|
|
19069
|
+
* @remarks
|
|
19070
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19071
|
+
* @beta
|
|
19072
|
+
*/
|
|
19073
|
+
interface ArrayCellValue {
|
|
19074
|
+
/**
|
|
19075
|
+
* Represents the type of this cell value.
|
|
19076
|
+
*
|
|
19077
|
+
* @remarks
|
|
19078
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19079
|
+
* @beta
|
|
19080
|
+
*/
|
|
19081
|
+
type: CellValueType.array | "Array";
|
|
19082
|
+
/**
|
|
19083
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
19084
|
+
*
|
|
19085
|
+
* @remarks
|
|
19086
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19087
|
+
* @beta
|
|
19088
|
+
*/
|
|
19089
|
+
basicValue?: "#VALUE!";
|
|
19090
|
+
/**
|
|
19091
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19092
|
+
*
|
|
19093
|
+
* @remarks
|
|
19094
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19095
|
+
* @beta
|
|
19096
|
+
*/
|
|
19097
|
+
basicType?: RangeValueType.error | "Error";
|
|
19098
|
+
/**
|
|
19099
|
+
* Represents the elements of the array. May not directly contain an `ArrayCellValue`.
|
|
19100
|
+
*
|
|
19101
|
+
* @remarks
|
|
19102
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19103
|
+
* @beta
|
|
19104
|
+
*/
|
|
19105
|
+
elements: CellValue[][];
|
|
19106
|
+
}
|
|
19088
19107
|
/**
|
|
19089
19108
|
* Represents types of #BLOCKED! errors.
|
|
19090
19109
|
*
|
|
@@ -19181,7 +19200,7 @@ declare namespace Excel {
|
|
|
19181
19200
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19182
19201
|
* @beta
|
|
19183
19202
|
*/
|
|
19184
|
-
|
|
19203
|
+
basicValue?: "#BLOCKED!";
|
|
19185
19204
|
/**
|
|
19186
19205
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19187
19206
|
*
|
|
@@ -19189,7 +19208,7 @@ declare namespace Excel {
|
|
|
19189
19208
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19190
19209
|
* @beta
|
|
19191
19210
|
*/
|
|
19192
|
-
|
|
19211
|
+
basicType?: RangeValueType.error | "Error";
|
|
19193
19212
|
/**
|
|
19194
19213
|
* Represents the type of `ErrorCellValue`.
|
|
19195
19214
|
*
|
|
@@ -19230,7 +19249,7 @@ declare namespace Excel {
|
|
|
19230
19249
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19231
19250
|
* @beta
|
|
19232
19251
|
*/
|
|
19233
|
-
|
|
19252
|
+
basicValue: boolean;
|
|
19234
19253
|
/**
|
|
19235
19254
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19236
19255
|
*
|
|
@@ -19238,7 +19257,7 @@ declare namespace Excel {
|
|
|
19238
19257
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19239
19258
|
* @beta
|
|
19240
19259
|
*/
|
|
19241
|
-
|
|
19260
|
+
basicType?: RangeValueType.boolean | "Boolean";
|
|
19242
19261
|
}
|
|
19243
19262
|
/**
|
|
19244
19263
|
* Represents types of #BUSY! errors.
|
|
@@ -19296,7 +19315,7 @@ declare namespace Excel {
|
|
|
19296
19315
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19297
19316
|
* @beta
|
|
19298
19317
|
*/
|
|
19299
|
-
|
|
19318
|
+
basicValue?: "#BUSY!";
|
|
19300
19319
|
/**
|
|
19301
19320
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19302
19321
|
*
|
|
@@ -19304,7 +19323,7 @@ declare namespace Excel {
|
|
|
19304
19323
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19305
19324
|
* @beta
|
|
19306
19325
|
*/
|
|
19307
|
-
|
|
19326
|
+
basicType?: RangeValueType.error | "Error";
|
|
19308
19327
|
/**
|
|
19309
19328
|
* Represents the type of `ErrorCellValue`.
|
|
19310
19329
|
*
|
|
@@ -19418,7 +19437,7 @@ declare namespace Excel {
|
|
|
19418
19437
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19419
19438
|
* @beta
|
|
19420
19439
|
*/
|
|
19421
|
-
|
|
19440
|
+
basicValue?: "#CALC!";
|
|
19422
19441
|
/**
|
|
19423
19442
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19424
19443
|
*
|
|
@@ -19426,7 +19445,7 @@ declare namespace Excel {
|
|
|
19426
19445
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19427
19446
|
* @beta
|
|
19428
19447
|
*/
|
|
19429
|
-
|
|
19448
|
+
basicType?: RangeValueType.error | "Error";
|
|
19430
19449
|
/**
|
|
19431
19450
|
* Represents the type of `ErrorCellValue`.
|
|
19432
19451
|
*
|
|
@@ -19452,6 +19471,14 @@ declare namespace Excel {
|
|
|
19452
19471
|
* @beta
|
|
19453
19472
|
*/
|
|
19454
19473
|
enum CellValueType {
|
|
19474
|
+
/**
|
|
19475
|
+
* Represents an `ArrayCellValue`.
|
|
19476
|
+
*
|
|
19477
|
+
* @remarks
|
|
19478
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19479
|
+
* @beta
|
|
19480
|
+
*/
|
|
19481
|
+
array = "Array",
|
|
19455
19482
|
/**
|
|
19456
19483
|
* Represents a `BooleanCellValue`.
|
|
19457
19484
|
*
|
|
@@ -19469,6 +19496,14 @@ declare namespace Excel {
|
|
|
19469
19496
|
*/
|
|
19470
19497
|
double = "Double",
|
|
19471
19498
|
/**
|
|
19499
|
+
* Represents an `EntityCellValue`.
|
|
19500
|
+
*
|
|
19501
|
+
* @remarks
|
|
19502
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19503
|
+
* @beta
|
|
19504
|
+
*/
|
|
19505
|
+
entity = "Entity",
|
|
19506
|
+
/**
|
|
19472
19507
|
* Represents an `EmptyCellValue`.
|
|
19473
19508
|
*
|
|
19474
19509
|
* @remarks
|
|
@@ -19518,6 +19553,34 @@ declare namespace Excel {
|
|
|
19518
19553
|
webImage = "WebImage"
|
|
19519
19554
|
}
|
|
19520
19555
|
/**
|
|
19556
|
+
* Represents the value in a cell.
|
|
19557
|
+
*
|
|
19558
|
+
* @remarks
|
|
19559
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19560
|
+
* @beta
|
|
19561
|
+
*/
|
|
19562
|
+
type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & {
|
|
19563
|
+
/**
|
|
19564
|
+
* Represents whether this `CellValue` will be used to overwrite a cell.
|
|
19565
|
+
* When false, APIs which would use this `CellValue` to overwrite a cell will instead ignore this value without throwing an error.
|
|
19566
|
+
* The default value is true.
|
|
19567
|
+
*
|
|
19568
|
+
* @remarks
|
|
19569
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19570
|
+
* @beta
|
|
19571
|
+
*/
|
|
19572
|
+
writable?: boolean;
|
|
19573
|
+
/**
|
|
19574
|
+
* Represents an explanation about why `CellValue.writable` is specified as false.
|
|
19575
|
+
* Note: This string is only available if `writable` is specified as false.
|
|
19576
|
+
*
|
|
19577
|
+
* @remarks
|
|
19578
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19579
|
+
* @beta
|
|
19580
|
+
*/
|
|
19581
|
+
writableNote?: string;
|
|
19582
|
+
};
|
|
19583
|
+
/**
|
|
19521
19584
|
* The attribution attributes object represents the set of details that can be used to describe where information came from, if the information comes from a public source.
|
|
19522
19585
|
*
|
|
19523
19586
|
* @remarks
|
|
@@ -19593,6 +19656,80 @@ declare namespace Excel {
|
|
|
19593
19656
|
logoTargetAddress?: string;
|
|
19594
19657
|
}
|
|
19595
19658
|
/**
|
|
19659
|
+
* Metadata about a property in `EntityCellValue.properties`.
|
|
19660
|
+
*
|
|
19661
|
+
* @remarks
|
|
19662
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19663
|
+
* @beta
|
|
19664
|
+
*/
|
|
19665
|
+
interface CellValuePropertyMetadata {
|
|
19666
|
+
/**
|
|
19667
|
+
* Represents which features this property is excluded from.
|
|
19668
|
+
*
|
|
19669
|
+
* @remarks
|
|
19670
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19671
|
+
* @beta
|
|
19672
|
+
*/
|
|
19673
|
+
excludeFrom?: CellValuePropertyMetadataExclusions;
|
|
19674
|
+
/**
|
|
19675
|
+
* Represents the sublabel for this property shown in card view.
|
|
19676
|
+
*
|
|
19677
|
+
* @remarks
|
|
19678
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19679
|
+
* @beta
|
|
19680
|
+
*/
|
|
19681
|
+
sublabel?: string;
|
|
19682
|
+
/**
|
|
19683
|
+
* Represents attribution information to describe the source and license requirements for using this property.
|
|
19684
|
+
*
|
|
19685
|
+
* @remarks
|
|
19686
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19687
|
+
* @beta
|
|
19688
|
+
*/
|
|
19689
|
+
attribution?: CellValueAttributionAttributes[];
|
|
19690
|
+
}
|
|
19691
|
+
/**
|
|
19692
|
+
* Represents the exclusion of a property in `EntityCellValue.properties` from features of Excel.
|
|
19693
|
+
*
|
|
19694
|
+
* @remarks
|
|
19695
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19696
|
+
* @beta
|
|
19697
|
+
*/
|
|
19698
|
+
interface CellValuePropertyMetadataExclusions {
|
|
19699
|
+
/**
|
|
19700
|
+
* True represents that the property is excluded from the properties shown by card view. False and undefined represent the default behavior of including the property.
|
|
19701
|
+
*
|
|
19702
|
+
* @remarks
|
|
19703
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19704
|
+
* @beta
|
|
19705
|
+
*/
|
|
19706
|
+
cardView?: boolean;
|
|
19707
|
+
/**
|
|
19708
|
+
* True represents that the property is excluded from the properties shown by auto complete. False and undefined represent the default behavior of including the property.
|
|
19709
|
+
*
|
|
19710
|
+
* @remarks
|
|
19711
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19712
|
+
* @beta
|
|
19713
|
+
*/
|
|
19714
|
+
autoComplete?: boolean;
|
|
19715
|
+
/**
|
|
19716
|
+
* True represents that the property is excluded from the properties used to compare cell values during recalc. False and undefined represent the default behavior of including the property.
|
|
19717
|
+
*
|
|
19718
|
+
* @remarks
|
|
19719
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19720
|
+
* @beta
|
|
19721
|
+
*/
|
|
19722
|
+
calcCompare?: boolean;
|
|
19723
|
+
/**
|
|
19724
|
+
* True represents that the property is excluded from the properties which can be accessed via the FIELDVALUE function. False and undefined represent the default behavior of including the property.
|
|
19725
|
+
*
|
|
19726
|
+
* @remarks
|
|
19727
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19728
|
+
* @beta
|
|
19729
|
+
*/
|
|
19730
|
+
dotNotation?: boolean;
|
|
19731
|
+
}
|
|
19732
|
+
/**
|
|
19596
19733
|
* Represents types of #CONNECT! errors.
|
|
19597
19734
|
*
|
|
19598
19735
|
* @remarks
|
|
@@ -19760,7 +19897,7 @@ declare namespace Excel {
|
|
|
19760
19897
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19761
19898
|
* @beta
|
|
19762
19899
|
*/
|
|
19763
|
-
|
|
19900
|
+
basicValue?: "#CONNECT!";
|
|
19764
19901
|
/**
|
|
19765
19902
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19766
19903
|
*
|
|
@@ -19768,7 +19905,7 @@ declare namespace Excel {
|
|
|
19768
19905
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19769
19906
|
* @beta
|
|
19770
19907
|
*/
|
|
19771
|
-
|
|
19908
|
+
basicType?: RangeValueType.error | "Error";
|
|
19772
19909
|
/**
|
|
19773
19910
|
* Represents the type of `ErrorCellValue`.
|
|
19774
19911
|
*
|
|
@@ -19809,7 +19946,7 @@ declare namespace Excel {
|
|
|
19809
19946
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19810
19947
|
* @beta
|
|
19811
19948
|
*/
|
|
19812
|
-
|
|
19949
|
+
basicValue?: "#DIV/0!";
|
|
19813
19950
|
/**
|
|
19814
19951
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19815
19952
|
*
|
|
@@ -19817,7 +19954,7 @@ declare namespace Excel {
|
|
|
19817
19954
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19818
19955
|
* @beta
|
|
19819
19956
|
*/
|
|
19820
|
-
|
|
19957
|
+
basicType?: RangeValueType.error | "Error";
|
|
19821
19958
|
/**
|
|
19822
19959
|
* Represents the type of `ErrorCellValue`.
|
|
19823
19960
|
*
|
|
@@ -19850,7 +19987,7 @@ declare namespace Excel {
|
|
|
19850
19987
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19851
19988
|
* @beta
|
|
19852
19989
|
*/
|
|
19853
|
-
|
|
19990
|
+
basicValue: number;
|
|
19854
19991
|
/**
|
|
19855
19992
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19856
19993
|
*
|
|
@@ -19858,7 +19995,7 @@ declare namespace Excel {
|
|
|
19858
19995
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19859
19996
|
* @beta
|
|
19860
19997
|
*/
|
|
19861
|
-
|
|
19998
|
+
basicType?: RangeValueType.double | "Double";
|
|
19862
19999
|
}
|
|
19863
20000
|
/**
|
|
19864
20001
|
* Represents the value of a cell that's empty and has no formulas or data.
|
|
@@ -19883,7 +20020,40 @@ declare namespace Excel {
|
|
|
19883
20020
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19884
20021
|
* @beta
|
|
19885
20022
|
*/
|
|
19886
|
-
|
|
20023
|
+
basicValue?: "";
|
|
20024
|
+
/**
|
|
20025
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20026
|
+
*
|
|
20027
|
+
* @remarks
|
|
20028
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20029
|
+
* @beta
|
|
20030
|
+
*/
|
|
20031
|
+
basicType?: RangeValueType.empty | "Empty";
|
|
20032
|
+
}
|
|
20033
|
+
/**
|
|
20034
|
+
* Represents an schemaless set of properties.
|
|
20035
|
+
*
|
|
20036
|
+
* @remarks
|
|
20037
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20038
|
+
* @beta
|
|
20039
|
+
*/
|
|
20040
|
+
interface EntityCellValue {
|
|
20041
|
+
/**
|
|
20042
|
+
* Represents the type of this cell value.
|
|
20043
|
+
*
|
|
20044
|
+
* @remarks
|
|
20045
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20046
|
+
* @beta
|
|
20047
|
+
*/
|
|
20048
|
+
type: CellValueType.entity | "Entity";
|
|
20049
|
+
/**
|
|
20050
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
20051
|
+
*
|
|
20052
|
+
* @remarks
|
|
20053
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20054
|
+
* @beta
|
|
20055
|
+
*/
|
|
20056
|
+
basicValue?: "#VALUE!";
|
|
19887
20057
|
/**
|
|
19888
20058
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
19889
20059
|
*
|
|
@@ -19891,7 +20061,27 @@ declare namespace Excel {
|
|
|
19891
20061
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19892
20062
|
* @beta
|
|
19893
20063
|
*/
|
|
19894
|
-
|
|
20064
|
+
basicType?: RangeValueType.error | "Error";
|
|
20065
|
+
/**
|
|
20066
|
+
* Represents the text shown when a cell with this value is rendered.
|
|
20067
|
+
*
|
|
20068
|
+
* @remarks
|
|
20069
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20070
|
+
* @beta
|
|
20071
|
+
*/
|
|
20072
|
+
text?: string;
|
|
20073
|
+
/**
|
|
20074
|
+
* Represents the properties of this entity and their metadata.
|
|
20075
|
+
*
|
|
20076
|
+
* @remarks
|
|
20077
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20078
|
+
* @beta
|
|
20079
|
+
*/
|
|
20080
|
+
properties?: {
|
|
20081
|
+
[key: string]: CellValue & {
|
|
20082
|
+
propertyMetadata?: CellValuePropertyMetadata;
|
|
20083
|
+
};
|
|
20084
|
+
};
|
|
19895
20085
|
}
|
|
19896
20086
|
/**
|
|
19897
20087
|
* Represents the types of the `ErrorCellValue` object.
|
|
@@ -19958,13 +20148,13 @@ declare namespace Excel {
|
|
|
19958
20148
|
*/
|
|
19959
20149
|
gettingData = "GettingData",
|
|
19960
20150
|
/**
|
|
19961
|
-
* Represents a `
|
|
20151
|
+
* Represents a `NotAvailableErrorCellValue`.
|
|
19962
20152
|
*
|
|
19963
20153
|
* @remarks
|
|
19964
20154
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
19965
20155
|
* @beta
|
|
19966
20156
|
*/
|
|
19967
|
-
|
|
20157
|
+
notAvailable = "NotAvailable",
|
|
19968
20158
|
/**
|
|
19969
20159
|
* Represents a `NameErrorCellValue`.
|
|
19970
20160
|
*
|
|
@@ -20015,6 +20205,14 @@ declare namespace Excel {
|
|
|
20015
20205
|
value = "Value"
|
|
20016
20206
|
}
|
|
20017
20207
|
/**
|
|
20208
|
+
* Represents a cell value which contains an error.
|
|
20209
|
+
*
|
|
20210
|
+
* @remarks
|
|
20211
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20212
|
+
* @beta
|
|
20213
|
+
*/
|
|
20214
|
+
type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
|
|
20215
|
+
/**
|
|
20018
20216
|
* Represents types of #FIELD! errors.
|
|
20019
20217
|
*
|
|
20020
20218
|
* @remarks
|
|
@@ -20070,7 +20268,7 @@ declare namespace Excel {
|
|
|
20070
20268
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20071
20269
|
* @beta
|
|
20072
20270
|
*/
|
|
20073
|
-
|
|
20271
|
+
basicValue?: "#FIELD!";
|
|
20074
20272
|
/**
|
|
20075
20273
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20076
20274
|
*
|
|
@@ -20078,7 +20276,7 @@ declare namespace Excel {
|
|
|
20078
20276
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20079
20277
|
* @beta
|
|
20080
20278
|
*/
|
|
20081
|
-
|
|
20279
|
+
basicType?: RangeValueType.error | "Error";
|
|
20082
20280
|
/**
|
|
20083
20281
|
* Represents the type of `ErrorCellValue`.
|
|
20084
20282
|
*
|
|
@@ -20120,7 +20318,7 @@ declare namespace Excel {
|
|
|
20120
20318
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20121
20319
|
* @beta
|
|
20122
20320
|
*/
|
|
20123
|
-
|
|
20321
|
+
basicValue: number;
|
|
20124
20322
|
/**
|
|
20125
20323
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20126
20324
|
*
|
|
@@ -20128,7 +20326,7 @@ declare namespace Excel {
|
|
|
20128
20326
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20129
20327
|
* @beta
|
|
20130
20328
|
*/
|
|
20131
|
-
|
|
20329
|
+
basicType?: RangeValueType.double | "Double";
|
|
20132
20330
|
/**
|
|
20133
20331
|
* Returns the number format string that is used to display this value.
|
|
20134
20332
|
* Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/review-guidelines-for-customizing-a-number-format-c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
@@ -20162,7 +20360,7 @@ declare namespace Excel {
|
|
|
20162
20360
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20163
20361
|
* @beta
|
|
20164
20362
|
*/
|
|
20165
|
-
|
|
20363
|
+
basicValue?: "#GETTING_DATA";
|
|
20166
20364
|
/**
|
|
20167
20365
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20168
20366
|
*
|
|
@@ -20170,7 +20368,7 @@ declare namespace Excel {
|
|
|
20170
20368
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20171
20369
|
* @beta
|
|
20172
20370
|
*/
|
|
20173
|
-
|
|
20371
|
+
basicType?: RangeValueType.error | "Error";
|
|
20174
20372
|
/**
|
|
20175
20373
|
* Represents the type of `ErrorCellValue`.
|
|
20176
20374
|
*
|
|
@@ -20187,7 +20385,7 @@ declare namespace Excel {
|
|
|
20187
20385
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20188
20386
|
* @beta
|
|
20189
20387
|
*/
|
|
20190
|
-
interface
|
|
20388
|
+
interface NotAvailableErrorCellValue {
|
|
20191
20389
|
/**
|
|
20192
20390
|
* Represents the type of this cell value.
|
|
20193
20391
|
*
|
|
@@ -20203,7 +20401,7 @@ declare namespace Excel {
|
|
|
20203
20401
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20204
20402
|
* @beta
|
|
20205
20403
|
*/
|
|
20206
|
-
|
|
20404
|
+
basicValue?: "#N/A!";
|
|
20207
20405
|
/**
|
|
20208
20406
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20209
20407
|
*
|
|
@@ -20211,7 +20409,7 @@ declare namespace Excel {
|
|
|
20211
20409
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20212
20410
|
* @beta
|
|
20213
20411
|
*/
|
|
20214
|
-
|
|
20412
|
+
basicType?: RangeValueType.error | "Error";
|
|
20215
20413
|
/**
|
|
20216
20414
|
* Represents the type of `ErrorCellValue`.
|
|
20217
20415
|
*
|
|
@@ -20219,7 +20417,7 @@ declare namespace Excel {
|
|
|
20219
20417
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20220
20418
|
* @beta
|
|
20221
20419
|
*/
|
|
20222
|
-
errorType?: ErrorCellValueType.
|
|
20420
|
+
errorType?: ErrorCellValueType.notAvailable | "NotAvailable";
|
|
20223
20421
|
}
|
|
20224
20422
|
/**
|
|
20225
20423
|
* Represents the value of a cell containing a #NAME? error.
|
|
@@ -20244,7 +20442,7 @@ declare namespace Excel {
|
|
|
20244
20442
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20245
20443
|
* @beta
|
|
20246
20444
|
*/
|
|
20247
|
-
|
|
20445
|
+
basicValue?: "#NAME?";
|
|
20248
20446
|
/**
|
|
20249
20447
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20250
20448
|
*
|
|
@@ -20252,7 +20450,7 @@ declare namespace Excel {
|
|
|
20252
20450
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20253
20451
|
* @beta
|
|
20254
20452
|
*/
|
|
20255
|
-
|
|
20453
|
+
basicType?: RangeValueType.error | "Error";
|
|
20256
20454
|
/**
|
|
20257
20455
|
* Represents the type of `ErrorCellValue`.
|
|
20258
20456
|
*
|
|
@@ -20285,7 +20483,7 @@ declare namespace Excel {
|
|
|
20285
20483
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20286
20484
|
* @beta
|
|
20287
20485
|
*/
|
|
20288
|
-
|
|
20486
|
+
basicValue?: "#NULL!";
|
|
20289
20487
|
/**
|
|
20290
20488
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20291
20489
|
*
|
|
@@ -20293,7 +20491,7 @@ declare namespace Excel {
|
|
|
20293
20491
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20294
20492
|
* @beta
|
|
20295
20493
|
*/
|
|
20296
|
-
|
|
20494
|
+
basicType?: RangeValueType.error | "Error";
|
|
20297
20495
|
/**
|
|
20298
20496
|
* Represents the type of `ErrorCellValue`.
|
|
20299
20497
|
*
|
|
@@ -20326,7 +20524,7 @@ declare namespace Excel {
|
|
|
20326
20524
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20327
20525
|
* @beta
|
|
20328
20526
|
*/
|
|
20329
|
-
|
|
20527
|
+
basicValue?: "#NUM!";
|
|
20330
20528
|
/**
|
|
20331
20529
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20332
20530
|
*
|
|
@@ -20334,7 +20532,7 @@ declare namespace Excel {
|
|
|
20334
20532
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20335
20533
|
* @beta
|
|
20336
20534
|
*/
|
|
20337
|
-
|
|
20535
|
+
basicType?: RangeValueType.error | "Error";
|
|
20338
20536
|
/**
|
|
20339
20537
|
* Represents the type of `ErrorCellValue`.
|
|
20340
20538
|
*
|
|
@@ -20367,7 +20565,7 @@ declare namespace Excel {
|
|
|
20367
20565
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20368
20566
|
* @beta
|
|
20369
20567
|
*/
|
|
20370
|
-
|
|
20568
|
+
vlookupColumnIndexGreaterThanNumColumns = "VlookupColumnIndexGreaterThanNumColumns",
|
|
20371
20569
|
/**
|
|
20372
20570
|
* An error caused by a row_index_num parameter of HLOOKUP that's greater than the number of rows in the table_array parameter. Displays as error type #REF! in Excel.
|
|
20373
20571
|
*
|
|
@@ -20391,15 +20589,15 @@ declare namespace Excel {
|
|
|
20391
20589
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20392
20590
|
* @beta
|
|
20393
20591
|
*/
|
|
20394
|
-
|
|
20592
|
+
subArrayStartRowOutOfBounds = "SubArrayStartRowOutOfBounds",
|
|
20395
20593
|
/**
|
|
20396
|
-
* An error caused by a
|
|
20594
|
+
* An error caused by a start_column parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
|
|
20397
20595
|
*
|
|
20398
20596
|
* @remarks
|
|
20399
20597
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20400
20598
|
* @beta
|
|
20401
20599
|
*/
|
|
20402
|
-
|
|
20600
|
+
subArrayStartColumnOutOfBounds = "SubArrayStartColumnOutOfBounds",
|
|
20403
20601
|
/**
|
|
20404
20602
|
* An error caused by an end_row parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
|
|
20405
20603
|
*
|
|
@@ -20407,15 +20605,15 @@ declare namespace Excel {
|
|
|
20407
20605
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20408
20606
|
* @beta
|
|
20409
20607
|
*/
|
|
20410
|
-
|
|
20608
|
+
subArrayEndRowOutOfBounds = "SubArrayEndRowOutOfBounds",
|
|
20411
20609
|
/**
|
|
20412
|
-
* An error caused by an
|
|
20610
|
+
* An error caused by an end_column parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
|
|
20413
20611
|
*
|
|
20414
20612
|
* @remarks
|
|
20415
20613
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20416
20614
|
* @beta
|
|
20417
20615
|
*/
|
|
20418
|
-
|
|
20616
|
+
subArrayEndColumnOutOfBounds = "SubArrayEndColumnOutOfBounds",
|
|
20419
20617
|
/**
|
|
20420
20618
|
* An error caused by an end_row parameter of SUBARRAY preceding the start_row parameter. Displays as error type #REF! in Excel.
|
|
20421
20619
|
*
|
|
@@ -20425,13 +20623,13 @@ declare namespace Excel {
|
|
|
20425
20623
|
*/
|
|
20426
20624
|
subArrayEndRowPrecedesStartRow = "SubArrayEndRowPrecedesStartRow",
|
|
20427
20625
|
/**
|
|
20428
|
-
* An error
|
|
20626
|
+
* An error caused by an end_column parameter of SUBARRAY preceding the start_column parameter. Displays as error type #REF! in Excel.
|
|
20429
20627
|
*
|
|
20430
20628
|
* @remarks
|
|
20431
20629
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20432
20630
|
* @beta
|
|
20433
20631
|
*/
|
|
20434
|
-
|
|
20632
|
+
subArrayEndColumnPrecedesStartColumn = "SubArrayEndColumnPrecedesStartColumn"
|
|
20435
20633
|
}
|
|
20436
20634
|
/**
|
|
20437
20635
|
* Represents the value of a cell containing a #REF! error.
|
|
@@ -20456,7 +20654,7 @@ declare namespace Excel {
|
|
|
20456
20654
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20457
20655
|
* @beta
|
|
20458
20656
|
*/
|
|
20459
|
-
|
|
20657
|
+
basicValue?: "#REF!";
|
|
20460
20658
|
/**
|
|
20461
20659
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20462
20660
|
*
|
|
@@ -20464,7 +20662,7 @@ declare namespace Excel {
|
|
|
20464
20662
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20465
20663
|
* @beta
|
|
20466
20664
|
*/
|
|
20467
|
-
|
|
20665
|
+
basicType?: RangeValueType.error | "Error";
|
|
20468
20666
|
/**
|
|
20469
20667
|
* Represents the type of `ErrorCellValue`.
|
|
20470
20668
|
*
|
|
@@ -20480,7 +20678,7 @@ declare namespace Excel {
|
|
|
20480
20678
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20481
20679
|
* @beta
|
|
20482
20680
|
*/
|
|
20483
|
-
errorSubType?: RefErrorCellValueSubType | "Unknown" | "
|
|
20681
|
+
errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColumnIndexGreaterThanNumColumns" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutOfBounds" | "SubArrayStartColumnOutOfBounds" | "SubArrayEndRowOutOfBounds" | "SubArrayEndColumnOutOfBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColumnPrecedesStartColumn";
|
|
20484
20682
|
}
|
|
20485
20683
|
/**
|
|
20486
20684
|
* Represents types of #SPILL! errors.
|
|
@@ -20570,7 +20768,7 @@ declare namespace Excel {
|
|
|
20570
20768
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20571
20769
|
* @beta
|
|
20572
20770
|
*/
|
|
20573
|
-
|
|
20771
|
+
basicValue?: "#SPILL!";
|
|
20574
20772
|
/**
|
|
20575
20773
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20576
20774
|
*
|
|
@@ -20578,7 +20776,7 @@ declare namespace Excel {
|
|
|
20578
20776
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20579
20777
|
* @beta
|
|
20580
20778
|
*/
|
|
20581
|
-
|
|
20779
|
+
basicType?: RangeValueType.error | "Error";
|
|
20582
20780
|
/**
|
|
20583
20781
|
* Represents the type of `ErrorCellValue`.
|
|
20584
20782
|
*
|
|
@@ -20635,7 +20833,7 @@ declare namespace Excel {
|
|
|
20635
20833
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20636
20834
|
* @beta
|
|
20637
20835
|
*/
|
|
20638
|
-
|
|
20836
|
+
basicValue: string;
|
|
20639
20837
|
/**
|
|
20640
20838
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20641
20839
|
*
|
|
@@ -20643,7 +20841,7 @@ declare namespace Excel {
|
|
|
20643
20841
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20644
20842
|
* @beta
|
|
20645
20843
|
*/
|
|
20646
|
-
|
|
20844
|
+
basicType?: RangeValueType.string | "String";
|
|
20647
20845
|
}
|
|
20648
20846
|
/**
|
|
20649
20847
|
* Represents types of #VALUE! errors.
|
|
@@ -20662,13 +20860,13 @@ declare namespace Excel {
|
|
|
20662
20860
|
*/
|
|
20663
20861
|
unknown = "Unknown",
|
|
20664
20862
|
/**
|
|
20665
|
-
* An error caused by a
|
|
20863
|
+
* An error caused by a column_index_num parameter of VLOOKUP of less than 1. Displays as error type #VALUE! in Excel.
|
|
20666
20864
|
*
|
|
20667
20865
|
* @remarks
|
|
20668
20866
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20669
20867
|
* @beta
|
|
20670
20868
|
*/
|
|
20671
|
-
|
|
20869
|
+
vlookupColumnIndexLessThanOne = "VlookupColumnIndexLessThanOne",
|
|
20672
20870
|
/**
|
|
20673
20871
|
* An error caused by VLOOKUP not finding its lookup_value parameter. Displays as error type #VALUE! in Excel.
|
|
20674
20872
|
*
|
|
@@ -20732,7 +20930,7 @@ declare namespace Excel {
|
|
|
20732
20930
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20733
20931
|
* @beta
|
|
20734
20932
|
*/
|
|
20735
|
-
|
|
20933
|
+
subArrayStartColumnMissingEndColumnNot = "SubArrayStartColumnMissingEndColumnNot",
|
|
20736
20934
|
/**
|
|
20737
20935
|
* An error caused by a `WebImageValue` with an invalid URL. Displays as error type #VALUE! in Excel.
|
|
20738
20936
|
*
|
|
@@ -20837,7 +21035,7 @@ declare namespace Excel {
|
|
|
20837
21035
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20838
21036
|
* @beta
|
|
20839
21037
|
*/
|
|
20840
|
-
|
|
21038
|
+
basicValue?: "#VALUE!";
|
|
20841
21039
|
/**
|
|
20842
21040
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20843
21041
|
*
|
|
@@ -20845,7 +21043,7 @@ declare namespace Excel {
|
|
|
20845
21043
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20846
21044
|
* @beta
|
|
20847
21045
|
*/
|
|
20848
|
-
|
|
21046
|
+
basicType?: RangeValueType.error | "Error";
|
|
20849
21047
|
/**
|
|
20850
21048
|
* Represents the type of `ErrorCellValue`.
|
|
20851
21049
|
*
|
|
@@ -20861,7 +21059,7 @@ declare namespace Excel {
|
|
|
20861
21059
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20862
21060
|
* @beta
|
|
20863
21061
|
*/
|
|
20864
|
-
errorSubType?: ValueErrorCellValueSubType | "Unknown" | "
|
|
21062
|
+
errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount";
|
|
20865
21063
|
}
|
|
20866
21064
|
/**
|
|
20867
21065
|
* Represents the value of a cell containing a type of value which cannot be serialized.
|
|
@@ -20887,7 +21085,7 @@ declare namespace Excel {
|
|
|
20887
21085
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20888
21086
|
* @beta
|
|
20889
21087
|
*/
|
|
20890
|
-
|
|
21088
|
+
basicValue: boolean | number | string;
|
|
20891
21089
|
/**
|
|
20892
21090
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20893
21091
|
*
|
|
@@ -20895,7 +21093,7 @@ declare namespace Excel {
|
|
|
20895
21093
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20896
21094
|
* @beta
|
|
20897
21095
|
*/
|
|
20898
|
-
|
|
21096
|
+
basicType: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String";
|
|
20899
21097
|
}
|
|
20900
21098
|
/**
|
|
20901
21099
|
* Represents the value of a cell containing an image downloaded from the internet.
|
|
@@ -20920,7 +21118,7 @@ declare namespace Excel {
|
|
|
20920
21118
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20921
21119
|
* @beta
|
|
20922
21120
|
*/
|
|
20923
|
-
|
|
21121
|
+
basicValue?: "#VALUE!";
|
|
20924
21122
|
/**
|
|
20925
21123
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
20926
21124
|
*
|
|
@@ -20928,7 +21126,7 @@ declare namespace Excel {
|
|
|
20928
21126
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
20929
21127
|
* @beta
|
|
20930
21128
|
*/
|
|
20931
|
-
|
|
21129
|
+
basicType?: RangeValueType.error | "Error";
|
|
20932
21130
|
/**
|
|
20933
21131
|
* Represents the URL from which the image will be downloaded.
|
|
20934
21132
|
* This image must be hosted on a server that supports HTTPS.
|
|
@@ -38097,7 +38295,7 @@ declare namespace Excel {
|
|
|
38097
38295
|
* Clears the column filter criteria of the AutoFilter.
|
|
38098
38296
|
*
|
|
38099
38297
|
* @remarks
|
|
38100
|
-
* [Api set:
|
|
38298
|
+
* [Api set: ExcelApi 1.14]
|
|
38101
38299
|
*
|
|
38102
38300
|
* @param columnIndex The zero-based column index, which represents which column filter needs to be cleared.
|
|
38103
38301
|
If the index value is not supported(for example, if the value is a negative number, or if the value is greater than the number of available columns in the range),
|
|
@@ -54302,7 +54500,7 @@ declare namespace Excel {
|
|
|
54302
54500
|
}): FunctionResult<T>;
|
|
54303
54501
|
/**
|
|
54304
54502
|
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
54305
|
-
* Whereas the original FunctionResult<T
|
|
54503
|
+
* Whereas the original `FunctionResult<T>` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Interfaces.FunctionResultData<T>`) that contains shallow copies of any loaded child properties from the original object.
|
|
54306
54504
|
*/
|
|
54307
54505
|
toJSON(): Interfaces.FunctionResultData<T>;
|
|
54308
54506
|
}
|
|
@@ -58063,7 +58261,9 @@ declare namespace Excel {
|
|
|
58063
58261
|
accessDenied = "AccessDenied",
|
|
58064
58262
|
apiNotFound = "ApiNotFound",
|
|
58065
58263
|
conflict = "Conflict",
|
|
58264
|
+
emptyChartSeries = "EmptyChartSeries",
|
|
58066
58265
|
filteredRangeConflict = "FilteredRangeConflict",
|
|
58266
|
+
formulaLengthExceedsLimit = "FormulaLengthExceedsLimit",
|
|
58067
58267
|
generalException = "GeneralException",
|
|
58068
58268
|
inactiveWorkbook = "InactiveWorkbook",
|
|
58069
58269
|
insertDeleteConflict = "InsertDeleteConflict",
|
|
@@ -82553,7 +82753,10 @@ declare namespace Word {
|
|
|
82553
82753
|
*/
|
|
82554
82754
|
readonly lists: Word.ListCollection;
|
|
82555
82755
|
/**
|
|
82556
|
-
*
|
|
82756
|
+
* Gets the collection of paragraph objects in the content control. Read-only.
|
|
82757
|
+
*
|
|
82758
|
+
* **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control are not returned.
|
|
82759
|
+
* From requirement set 1.3, paragraphs in such tables are also returned.
|
|
82557
82760
|
*
|
|
82558
82761
|
* @remarks
|
|
82559
82762
|
* [Api set: WordApi 1.1]
|
|
@@ -86193,6 +86396,9 @@ declare namespace Word {
|
|
|
86193
86396
|
/**
|
|
86194
86397
|
* Gets the parent body of the range. Read-only.
|
|
86195
86398
|
*
|
|
86399
|
+
* **Important**: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this range are not returned.
|
|
86400
|
+
* From requirement set 1.3, paragraphs in such tables are also returned.
|
|
86401
|
+
*
|
|
86196
86402
|
* @remarks
|
|
86197
86403
|
* [Api set: WordApi 1.3]
|
|
86198
86404
|
*/
|
|
@@ -96034,14 +96240,6 @@ declare namespace Word {
|
|
|
96034
96240
|
/**
|
|
96035
96241
|
* Executes a batch script that performs actions on the Word object model, using a new RequestContext. When the promise is resolved, any tracked objects that were automatically allocated during execution will be released.
|
|
96036
96242
|
* @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Word application. Since the Office add-in and the Word application run in two different processes, the RequestContext is required to get access to the Word object model from the add-in.
|
|
96037
|
-
*
|
|
96038
|
-
* @remarks
|
|
96039
|
-
*
|
|
96040
|
-
* In addition to this signature, the method also has the following signatures, which allow you to resume using the request context of previously created objects:
|
|
96041
|
-
*
|
|
96042
|
-
* run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
|
|
96043
|
-
*
|
|
96044
|
-
* run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
|
|
96045
96243
|
*/
|
|
96046
96244
|
function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
|
|
96047
96245
|
}
|
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.267",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -40,6 +40,6 @@
|
|
|
40
40
|
},
|
|
41
41
|
"scripts": {},
|
|
42
42
|
"dependencies": {},
|
|
43
|
-
"typesPublisherContentHash": "
|
|
43
|
+
"typesPublisherContentHash": "b0c3bbab29cdf1d5f7472e9b980a09b896e6fc80880ab136046b53e694430074",
|
|
44
44
|
"typeScriptVersion": "3.7"
|
|
45
45
|
}
|