@types/office-js-preview 1.0.262 → 1.0.266

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.
@@ -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: Fri, 22 Oct 2021 21:31:20 GMT
11
+ * Last updated: Mon, 01 Nov 2021 20:31:23 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -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 preview]
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
  /**
@@ -12676,6 +12674,8 @@ declare namespace Office {
12676
12674
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
12677
12675
  *
12678
12676
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
12677
+ *
12678
+ * @beta
12679
12679
  */
12680
12680
  interface DelayDeliveryTime {
12681
12681
  /**
@@ -12692,6 +12692,8 @@ declare namespace Office {
12692
12692
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12693
12693
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12694
12694
  * `asyncResult`, which is an `Office.AsyncResult` object.
12695
+ *
12696
+ * @beta
12695
12697
  */
12696
12698
  getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date>) => void): void;
12697
12699
  /**
@@ -12706,6 +12708,8 @@ declare namespace Office {
12706
12708
  *
12707
12709
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12708
12710
  * `asyncResult`, which is an `Office.AsyncResult` object.
12711
+ *
12712
+ * @beta
12709
12713
  */
12710
12714
  getAsync(callback?: (asyncResult: Office.AsyncResult<Date>) => void): void;
12711
12715
  /**
@@ -12723,6 +12727,8 @@ declare namespace Office {
12723
12727
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12724
12728
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
12725
12729
  * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
12730
+ *
12731
+ * @beta
12726
12732
  */
12727
12733
  setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12728
12734
  /**
@@ -12738,6 +12744,8 @@ declare namespace Office {
12738
12744
  * @param datetime - The future date and time when the message should be sent.
12739
12745
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
12740
12746
  * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
12747
+ *
12748
+ * @beta
12741
12749
  */
12742
12750
  setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12743
12751
  }
@@ -14694,6 +14702,8 @@ declare namespace Office {
14694
14702
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
14695
14703
  *
14696
14704
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
14705
+ *
14706
+ * @beta
14697
14707
  */
14698
14708
  delayDeliveryTime: DelayDeliveryTime;
14699
14709
  /**
@@ -14775,13 +14785,11 @@ declare namespace Office {
14775
14785
  * Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
14776
14786
  *
14777
14787
  * @remarks
14778
- * [Api set: Mailbox preview]
14788
+ * [Api set: Mailbox 1.11]
14779
14789
  *
14780
14790
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
14781
14791
  *
14782
14792
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
14783
- *
14784
- * @beta
14785
14793
  */
14786
14794
  sessionData: SessionData;
14787
14795
  /**
@@ -16817,6 +16825,7 @@ declare namespace Office {
16817
16825
  *
16818
16826
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
16819
16827
  * type `Office.AsyncResult`.
16828
+ *
16820
16829
  * @beta
16821
16830
  */
16822
16831
  getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
@@ -17147,6 +17156,8 @@ declare namespace Office {
17147
17156
  *
17148
17157
  * @remarks
17149
17158
  * [Api set: Mailbox preview]
17159
+ *
17160
+ * @beta
17150
17161
  */
17151
17162
  officeTheme: Office.OfficeTheme;
17152
17163
  /**
@@ -17154,6 +17165,8 @@ declare namespace Office {
17154
17165
  *
17155
17166
  * @remarks
17156
17167
  * [Api set: Mailbox preview]
17168
+ *
17169
+ * @beta
17157
17170
  */
17158
17171
  type: "officeThemeChanged";
17159
17172
  }
@@ -18183,20 +18196,18 @@ declare namespace Office {
18183
18196
  * Provides methods to manage an item's session data.
18184
18197
  *
18185
18198
  * @remarks
18186
- * [Api set: Mailbox preview]
18199
+ * [Api set: Mailbox 1.11]
18187
18200
  *
18188
18201
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
18189
18202
  *
18190
18203
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18191
- *
18192
- * @beta
18193
18204
  */
18194
18205
  interface SessionData {
18195
18206
  /**
18196
18207
  * Clears all session data key-value pairs.
18197
18208
  *
18198
18209
  * @remarks
18199
- * [Api set: Mailbox preview]
18210
+ * [Api set: Mailbox 1.11]
18200
18211
  *
18201
18212
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
18202
18213
  *
@@ -18206,15 +18217,13 @@ declare namespace Office {
18206
18217
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
18207
18218
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18208
18219
  * `asyncResult`, which is an `Office.AsyncResult` object.
18209
- *
18210
- * @beta
18211
18220
  */
18212
18221
  clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18213
18222
  /**
18214
18223
  * Clears all session data key-value pairs.
18215
18224
  *
18216
18225
  * @remarks
18217
- * [Api set: Mailbox preview]
18226
+ * [Api set: Mailbox 1.11]
18218
18227
  *
18219
18228
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
18220
18229
  *
@@ -18222,15 +18231,13 @@ declare namespace Office {
18222
18231
  *
18223
18232
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18224
18233
  * `asyncResult`, which is an `Office.AsyncResult` object.
18225
- *
18226
- * @beta
18227
18234
  */
18228
18235
  clearAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18229
18236
  /**
18230
18237
  * Gets all session data key-value pairs.
18231
18238
  *
18232
18239
  * @remarks
18233
- * [Api set: Mailbox preview]
18240
+ * [Api set: Mailbox 1.11]
18234
18241
  *
18235
18242
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
18236
18243
  *
@@ -18238,15 +18245,13 @@ declare namespace Office {
18238
18245
  *
18239
18246
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18240
18247
  * `asyncResult`, which is an `Office.AsyncResult` object.
18241
- *
18242
- * @beta
18243
18248
  */
18244
18249
  getAllAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
18245
18250
  /**
18246
18251
  * Gets the session data value of the specified key.
18247
18252
  *
18248
18253
  * @remarks
18249
- * [Api set: Mailbox preview]
18254
+ * [Api set: Mailbox 1.11]
18250
18255
  *
18251
18256
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
18252
18257
  *
@@ -18255,15 +18260,13 @@ declare namespace Office {
18255
18260
  * @param name - The session data key.
18256
18261
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
18257
18262
  * type `Office.AsyncResult`.
18258
- *
18259
- * @beta
18260
18263
  */
18261
18264
  getAsync(name: string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
18262
18265
  /**
18263
18266
  * Removes a session data key-value pair.
18264
18267
  *
18265
18268
  * @remarks
18266
- * [Api set: Mailbox preview]
18269
+ * [Api set: Mailbox 1.11]
18267
18270
  *
18268
18271
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
18269
18272
  *
@@ -18274,15 +18277,13 @@ declare namespace Office {
18274
18277
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
18275
18278
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18276
18279
  * `asyncResult`, which is an `Office.AsyncResult` object.
18277
- *
18278
- * @beta
18279
18280
  */
18280
18281
  removeAsync(name: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18281
18282
  /**
18282
18283
  * Removes a session data key-value pair.
18283
18284
  *
18284
18285
  * @remarks
18285
- * [Api set: Mailbox preview]
18286
+ * [Api set: Mailbox 1.11]
18286
18287
  *
18287
18288
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadWriteItem`
18288
18289
  *
@@ -18291,15 +18292,13 @@ declare namespace Office {
18291
18292
  * @param name - The session data key.
18292
18293
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
18293
18294
  * `asyncResult`, which is an `Office.AsyncResult` object.
18294
- *
18295
- * @beta
18296
18295
  */
18297
18296
  removeAsync(name: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18298
18297
  /**
18299
18298
  * Sets a session data key-value pair.
18300
18299
  *
18301
18300
  * @remarks
18302
- * [Api set: Mailbox preview]
18301
+ * [Api set: Mailbox 1.11]
18303
18302
  *
18304
18303
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
18305
18304
  *
@@ -18311,15 +18310,13 @@ declare namespace Office {
18311
18310
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
18312
18311
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
18313
18312
  * type `Office.AsyncResult`.
18314
- *
18315
- * @beta
18316
18313
  */
18317
18314
  setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18318
18315
  /**
18319
18316
  * Sets a session data key-value pair.
18320
18317
  *
18321
18318
  * @remarks
18322
- * [Api set: Mailbox preview]
18319
+ * [Api set: Mailbox 1.11]
18323
18320
  *
18324
18321
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
18325
18322
  *
@@ -18329,8 +18326,6 @@ declare namespace Office {
18329
18326
  * @param value - The session data value as a string.
18330
18327
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
18331
18328
  * type `Office.AsyncResult`.
18332
- *
18333
- * @beta
18334
18329
  */
18335
18330
  setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18336
18331
  }
@@ -19068,6 +19063,47 @@ declare namespace OfficeCore {
19068
19063
 
19069
19064
 
19070
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
+ }
19071
19107
  /**
19072
19108
  * Represents types of #BLOCKED! errors.
19073
19109
  *
@@ -19164,7 +19200,7 @@ declare namespace Excel {
19164
19200
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19165
19201
  * @beta
19166
19202
  */
19167
- primitive?: "#BLOCKED!";
19203
+ basicValue?: "#BLOCKED!";
19168
19204
  /**
19169
19205
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19170
19206
  *
@@ -19172,7 +19208,7 @@ declare namespace Excel {
19172
19208
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19173
19209
  * @beta
19174
19210
  */
19175
- primitiveType?: RangeValueType.error | "Error";
19211
+ basicType?: RangeValueType.error | "Error";
19176
19212
  /**
19177
19213
  * Represents the type of `ErrorCellValue`.
19178
19214
  *
@@ -19213,7 +19249,7 @@ declare namespace Excel {
19213
19249
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19214
19250
  * @beta
19215
19251
  */
19216
- primitive: boolean;
19252
+ basicValue: boolean;
19217
19253
  /**
19218
19254
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19219
19255
  *
@@ -19221,7 +19257,7 @@ declare namespace Excel {
19221
19257
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19222
19258
  * @beta
19223
19259
  */
19224
- primitiveType?: RangeValueType.boolean | "Boolean";
19260
+ basicType?: RangeValueType.boolean | "Boolean";
19225
19261
  }
19226
19262
  /**
19227
19263
  * Represents types of #BUSY! errors.
@@ -19279,7 +19315,7 @@ declare namespace Excel {
19279
19315
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19280
19316
  * @beta
19281
19317
  */
19282
- primitive?: "#BUSY!";
19318
+ basicValue?: "#BUSY!";
19283
19319
  /**
19284
19320
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19285
19321
  *
@@ -19287,7 +19323,7 @@ declare namespace Excel {
19287
19323
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19288
19324
  * @beta
19289
19325
  */
19290
- primitiveType?: RangeValueType.error | "Error";
19326
+ basicType?: RangeValueType.error | "Error";
19291
19327
  /**
19292
19328
  * Represents the type of `ErrorCellValue`.
19293
19329
  *
@@ -19401,7 +19437,7 @@ declare namespace Excel {
19401
19437
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19402
19438
  * @beta
19403
19439
  */
19404
- primitive?: "#CALC!";
19440
+ basicValue?: "#CALC!";
19405
19441
  /**
19406
19442
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19407
19443
  *
@@ -19409,7 +19445,7 @@ declare namespace Excel {
19409
19445
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19410
19446
  * @beta
19411
19447
  */
19412
- primitiveType?: RangeValueType.error | "Error";
19448
+ basicType?: RangeValueType.error | "Error";
19413
19449
  /**
19414
19450
  * Represents the type of `ErrorCellValue`.
19415
19451
  *
@@ -19435,6 +19471,14 @@ declare namespace Excel {
19435
19471
  * @beta
19436
19472
  */
19437
19473
  enum CellValueType {
19474
+ /**
19475
+ * Represents an `ArrayCellValue`.
19476
+ *
19477
+ * @remarks
19478
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19479
+ * @beta
19480
+ */
19481
+ array = "Array",
19438
19482
  /**
19439
19483
  * Represents a `BooleanCellValue`.
19440
19484
  *
@@ -19452,6 +19496,14 @@ declare namespace Excel {
19452
19496
  */
19453
19497
  double = "Double",
19454
19498
  /**
19499
+ * Represents an `EntityCellValue`.
19500
+ *
19501
+ * @remarks
19502
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19503
+ * @beta
19504
+ */
19505
+ entity = "Entity",
19506
+ /**
19455
19507
  * Represents an `EmptyCellValue`.
19456
19508
  *
19457
19509
  * @remarks
@@ -19501,6 +19553,34 @@ declare namespace Excel {
19501
19553
  webImage = "WebImage"
19502
19554
  }
19503
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
+ /**
19504
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.
19505
19585
  *
19506
19586
  * @remarks
@@ -19576,6 +19656,80 @@ declare namespace Excel {
19576
19656
  logoTargetAddress?: string;
19577
19657
  }
19578
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
+ /**
19579
19733
  * Represents types of #CONNECT! errors.
19580
19734
  *
19581
19735
  * @remarks
@@ -19743,7 +19897,7 @@ declare namespace Excel {
19743
19897
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19744
19898
  * @beta
19745
19899
  */
19746
- primitive?: "#CONNECT!";
19900
+ basicValue?: "#CONNECT!";
19747
19901
  /**
19748
19902
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19749
19903
  *
@@ -19751,7 +19905,7 @@ declare namespace Excel {
19751
19905
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19752
19906
  * @beta
19753
19907
  */
19754
- primitiveType?: RangeValueType.error | "Error";
19908
+ basicType?: RangeValueType.error | "Error";
19755
19909
  /**
19756
19910
  * Represents the type of `ErrorCellValue`.
19757
19911
  *
@@ -19792,7 +19946,7 @@ declare namespace Excel {
19792
19946
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19793
19947
  * @beta
19794
19948
  */
19795
- primitive?: "#DIV/0!";
19949
+ basicValue?: "#DIV/0!";
19796
19950
  /**
19797
19951
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19798
19952
  *
@@ -19800,7 +19954,7 @@ declare namespace Excel {
19800
19954
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19801
19955
  * @beta
19802
19956
  */
19803
- primitiveType?: RangeValueType.error | "Error";
19957
+ basicType?: RangeValueType.error | "Error";
19804
19958
  /**
19805
19959
  * Represents the type of `ErrorCellValue`.
19806
19960
  *
@@ -19833,7 +19987,7 @@ declare namespace Excel {
19833
19987
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19834
19988
  * @beta
19835
19989
  */
19836
- primitive: number;
19990
+ basicValue: number;
19837
19991
  /**
19838
19992
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19839
19993
  *
@@ -19841,7 +19995,7 @@ declare namespace Excel {
19841
19995
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19842
19996
  * @beta
19843
19997
  */
19844
- primitiveType?: RangeValueType.double | "Double";
19998
+ basicType?: RangeValueType.double | "Double";
19845
19999
  }
19846
20000
  /**
19847
20001
  * Represents the value of a cell that's empty and has no formulas or data.
@@ -19866,7 +20020,7 @@ declare namespace Excel {
19866
20020
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19867
20021
  * @beta
19868
20022
  */
19869
- primitive?: "";
20023
+ basicValue?: "";
19870
20024
  /**
19871
20025
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19872
20026
  *
@@ -19874,7 +20028,60 @@ declare namespace Excel {
19874
20028
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19875
20029
  * @beta
19876
20030
  */
19877
- primitiveType?: RangeValueType.empty | "Empty";
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!";
20057
+ /**
20058
+ * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20059
+ *
20060
+ * @remarks
20061
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20062
+ * @beta
20063
+ */
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
+ };
19878
20085
  }
19879
20086
  /**
19880
20087
  * Represents the types of the `ErrorCellValue` object.
@@ -19941,13 +20148,13 @@ declare namespace Excel {
19941
20148
  */
19942
20149
  gettingData = "GettingData",
19943
20150
  /**
19944
- * Represents a `NaErrorCellValue`.
20151
+ * Represents a `NotAvailableErrorCellValue`.
19945
20152
  *
19946
20153
  * @remarks
19947
20154
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19948
20155
  * @beta
19949
20156
  */
19950
- na = "Na",
20157
+ notAvailable = "NotAvailable",
19951
20158
  /**
19952
20159
  * Represents a `NameErrorCellValue`.
19953
20160
  *
@@ -19998,6 +20205,14 @@ declare namespace Excel {
19998
20205
  value = "Value"
19999
20206
  }
20000
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
+ /**
20001
20216
  * Represents types of #FIELD! errors.
20002
20217
  *
20003
20218
  * @remarks
@@ -20053,7 +20268,7 @@ declare namespace Excel {
20053
20268
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20054
20269
  * @beta
20055
20270
  */
20056
- primitive?: "#FIELD!";
20271
+ basicValue?: "#FIELD!";
20057
20272
  /**
20058
20273
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20059
20274
  *
@@ -20061,7 +20276,7 @@ declare namespace Excel {
20061
20276
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20062
20277
  * @beta
20063
20278
  */
20064
- primitiveType?: RangeValueType.error | "Error";
20279
+ basicType?: RangeValueType.error | "Error";
20065
20280
  /**
20066
20281
  * Represents the type of `ErrorCellValue`.
20067
20282
  *
@@ -20103,7 +20318,7 @@ declare namespace Excel {
20103
20318
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20104
20319
  * @beta
20105
20320
  */
20106
- primitive: number;
20321
+ basicValue: number;
20107
20322
  /**
20108
20323
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20109
20324
  *
@@ -20111,7 +20326,7 @@ declare namespace Excel {
20111
20326
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20112
20327
  * @beta
20113
20328
  */
20114
- primitiveType?: RangeValueType.double | "Double";
20329
+ basicType?: RangeValueType.double | "Double";
20115
20330
  /**
20116
20331
  * Returns the number format string that is used to display this value.
20117
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}.
@@ -20145,7 +20360,7 @@ declare namespace Excel {
20145
20360
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20146
20361
  * @beta
20147
20362
  */
20148
- primitive?: "#GETTING_DATA";
20363
+ basicValue?: "#GETTING_DATA";
20149
20364
  /**
20150
20365
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20151
20366
  *
@@ -20153,7 +20368,7 @@ declare namespace Excel {
20153
20368
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20154
20369
  * @beta
20155
20370
  */
20156
- primitiveType?: RangeValueType.error | "Error";
20371
+ basicType?: RangeValueType.error | "Error";
20157
20372
  /**
20158
20373
  * Represents the type of `ErrorCellValue`.
20159
20374
  *
@@ -20170,7 +20385,7 @@ declare namespace Excel {
20170
20385
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20171
20386
  * @beta
20172
20387
  */
20173
- interface NaErrorCellValue {
20388
+ interface NotAvailableErrorCellValue {
20174
20389
  /**
20175
20390
  * Represents the type of this cell value.
20176
20391
  *
@@ -20186,7 +20401,7 @@ declare namespace Excel {
20186
20401
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20187
20402
  * @beta
20188
20403
  */
20189
- primitive?: "#N/A!";
20404
+ basicValue?: "#N/A!";
20190
20405
  /**
20191
20406
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20192
20407
  *
@@ -20194,7 +20409,7 @@ declare namespace Excel {
20194
20409
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20195
20410
  * @beta
20196
20411
  */
20197
- primitiveType?: RangeValueType.error | "Error";
20412
+ basicType?: RangeValueType.error | "Error";
20198
20413
  /**
20199
20414
  * Represents the type of `ErrorCellValue`.
20200
20415
  *
@@ -20202,7 +20417,7 @@ declare namespace Excel {
20202
20417
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20203
20418
  * @beta
20204
20419
  */
20205
- errorType?: ErrorCellValueType.na | "Na";
20420
+ errorType?: ErrorCellValueType.notAvailable | "NotAvailable";
20206
20421
  }
20207
20422
  /**
20208
20423
  * Represents the value of a cell containing a #NAME? error.
@@ -20227,7 +20442,7 @@ declare namespace Excel {
20227
20442
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20228
20443
  * @beta
20229
20444
  */
20230
- primitive?: "#NAME?";
20445
+ basicValue?: "#NAME?";
20231
20446
  /**
20232
20447
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20233
20448
  *
@@ -20235,7 +20450,7 @@ declare namespace Excel {
20235
20450
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20236
20451
  * @beta
20237
20452
  */
20238
- primitiveType?: RangeValueType.error | "Error";
20453
+ basicType?: RangeValueType.error | "Error";
20239
20454
  /**
20240
20455
  * Represents the type of `ErrorCellValue`.
20241
20456
  *
@@ -20268,7 +20483,7 @@ declare namespace Excel {
20268
20483
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20269
20484
  * @beta
20270
20485
  */
20271
- primitive?: "#NULL!";
20486
+ basicValue?: "#NULL!";
20272
20487
  /**
20273
20488
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20274
20489
  *
@@ -20276,7 +20491,7 @@ declare namespace Excel {
20276
20491
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20277
20492
  * @beta
20278
20493
  */
20279
- primitiveType?: RangeValueType.error | "Error";
20494
+ basicType?: RangeValueType.error | "Error";
20280
20495
  /**
20281
20496
  * Represents the type of `ErrorCellValue`.
20282
20497
  *
@@ -20309,7 +20524,7 @@ declare namespace Excel {
20309
20524
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20310
20525
  * @beta
20311
20526
  */
20312
- primitive?: "#NUM!";
20527
+ basicValue?: "#NUM!";
20313
20528
  /**
20314
20529
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20315
20530
  *
@@ -20317,7 +20532,7 @@ declare namespace Excel {
20317
20532
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20318
20533
  * @beta
20319
20534
  */
20320
- primitiveType?: RangeValueType.error | "Error";
20535
+ basicType?: RangeValueType.error | "Error";
20321
20536
  /**
20322
20537
  * Represents the type of `ErrorCellValue`.
20323
20538
  *
@@ -20350,7 +20565,7 @@ declare namespace Excel {
20350
20565
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20351
20566
  * @beta
20352
20567
  */
20353
- vlookupColIndexGreaterThanNumCols = "VlookupColIndexGreaterThanNumCols",
20568
+ vlookupColumnIndexGreaterThanNumColumns = "VlookupColumnIndexGreaterThanNumColumns",
20354
20569
  /**
20355
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.
20356
20571
  *
@@ -20374,15 +20589,15 @@ declare namespace Excel {
20374
20589
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20375
20590
  * @beta
20376
20591
  */
20377
- subArrayStartRowOutofBounds = "SubArrayStartRowOutofBounds",
20592
+ subArrayStartRowOutOfBounds = "SubArrayStartRowOutOfBounds",
20378
20593
  /**
20379
- * An error caused by a start_col parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20594
+ * An error caused by a start_column parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20380
20595
  *
20381
20596
  * @remarks
20382
20597
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20383
20598
  * @beta
20384
20599
  */
20385
- subArrayStartColOutofBounds = "SubArrayStartColOutofBounds",
20600
+ subArrayStartColumnOutOfBounds = "SubArrayStartColumnOutOfBounds",
20386
20601
  /**
20387
20602
  * An error caused by an end_row parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20388
20603
  *
@@ -20390,15 +20605,15 @@ declare namespace Excel {
20390
20605
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20391
20606
  * @beta
20392
20607
  */
20393
- subArrayEndRowOutofBounds = "SubArrayEndRowOutofBounds",
20608
+ subArrayEndRowOutOfBounds = "SubArrayEndRowOutOfBounds",
20394
20609
  /**
20395
- * An error caused by an end_col parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20610
+ * An error caused by an end_column parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20396
20611
  *
20397
20612
  * @remarks
20398
20613
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20399
20614
  * @beta
20400
20615
  */
20401
- subArrayEndColOutofBounds = "SubArrayEndColOutofBounds",
20616
+ subArrayEndColumnOutOfBounds = "SubArrayEndColumnOutOfBounds",
20402
20617
  /**
20403
20618
  * An error caused by an end_row parameter of SUBARRAY preceding the start_row parameter. Displays as error type #REF! in Excel.
20404
20619
  *
@@ -20408,13 +20623,13 @@ declare namespace Excel {
20408
20623
  */
20409
20624
  subArrayEndRowPrecedesStartRow = "SubArrayEndRowPrecedesStartRow",
20410
20625
  /**
20411
- * An error caseud by an end_col parameter of SUBARRAY preceding the start_col parameter. Displays as error type #REF! in Excel.
20626
+ * An error caused by an end_column parameter of SUBARRAY preceding the start_column parameter. Displays as error type #REF! in Excel.
20412
20627
  *
20413
20628
  * @remarks
20414
20629
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20415
20630
  * @beta
20416
20631
  */
20417
- subArrayEndColPrecedesStartCol = "SubArrayEndColPrecedesStartCol"
20632
+ subArrayEndColumnPrecedesStartColumn = "SubArrayEndColumnPrecedesStartColumn"
20418
20633
  }
20419
20634
  /**
20420
20635
  * Represents the value of a cell containing a #REF! error.
@@ -20439,7 +20654,7 @@ declare namespace Excel {
20439
20654
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20440
20655
  * @beta
20441
20656
  */
20442
- primitive?: "#REF!";
20657
+ basicValue?: "#REF!";
20443
20658
  /**
20444
20659
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20445
20660
  *
@@ -20447,7 +20662,7 @@ declare namespace Excel {
20447
20662
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20448
20663
  * @beta
20449
20664
  */
20450
- primitiveType?: RangeValueType.error | "Error";
20665
+ basicType?: RangeValueType.error | "Error";
20451
20666
  /**
20452
20667
  * Represents the type of `ErrorCellValue`.
20453
20668
  *
@@ -20463,7 +20678,7 @@ declare namespace Excel {
20463
20678
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20464
20679
  * @beta
20465
20680
  */
20466
- errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColIndexGreaterThanNumCols" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutofBounds" | "SubArrayStartColOutofBounds" | "SubArrayEndRowOutofBounds" | "SubArrayEndColOutofBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColPrecedesStartCol";
20681
+ errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColumnIndexGreaterThanNumColumns" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutOfBounds" | "SubArrayStartColumnOutOfBounds" | "SubArrayEndRowOutOfBounds" | "SubArrayEndColumnOutOfBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColumnPrecedesStartColumn";
20467
20682
  }
20468
20683
  /**
20469
20684
  * Represents types of #SPILL! errors.
@@ -20553,7 +20768,7 @@ declare namespace Excel {
20553
20768
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20554
20769
  * @beta
20555
20770
  */
20556
- primitive?: "#SPILL!";
20771
+ basicValue?: "#SPILL!";
20557
20772
  /**
20558
20773
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20559
20774
  *
@@ -20561,7 +20776,7 @@ declare namespace Excel {
20561
20776
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20562
20777
  * @beta
20563
20778
  */
20564
- primitiveType?: RangeValueType.error | "Error";
20779
+ basicType?: RangeValueType.error | "Error";
20565
20780
  /**
20566
20781
  * Represents the type of `ErrorCellValue`.
20567
20782
  *
@@ -20618,7 +20833,7 @@ declare namespace Excel {
20618
20833
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20619
20834
  * @beta
20620
20835
  */
20621
- primitive: string;
20836
+ basicValue: string;
20622
20837
  /**
20623
20838
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20624
20839
  *
@@ -20626,7 +20841,7 @@ declare namespace Excel {
20626
20841
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20627
20842
  * @beta
20628
20843
  */
20629
- primitiveType?: RangeValueType.string | "String";
20844
+ basicType?: RangeValueType.string | "String";
20630
20845
  }
20631
20846
  /**
20632
20847
  * Represents types of #VALUE! errors.
@@ -20645,13 +20860,13 @@ declare namespace Excel {
20645
20860
  */
20646
20861
  unknown = "Unknown",
20647
20862
  /**
20648
- * An error caused by a col_index_num parameter of VLOOKUP of less than 1. Displays as error type #VALUE! in Excel.
20863
+ * An error caused by a column_index_num parameter of VLOOKUP of less than 1. Displays as error type #VALUE! in Excel.
20649
20864
  *
20650
20865
  * @remarks
20651
20866
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20652
20867
  * @beta
20653
20868
  */
20654
- vlookupColIndexLessThanOne = "VlookupColIndexLessThanOne",
20869
+ vlookupColumnIndexLessThanOne = "VlookupColumnIndexLessThanOne",
20655
20870
  /**
20656
20871
  * An error caused by VLOOKUP not finding its lookup_value parameter. Displays as error type #VALUE! in Excel.
20657
20872
  *
@@ -20715,7 +20930,7 @@ declare namespace Excel {
20715
20930
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20716
20931
  * @beta
20717
20932
  */
20718
- subArrayStartColMissingEndColNot = "SubArrayStartColMissingEndColNot",
20933
+ subArrayStartColumnMissingEndColumnNot = "SubArrayStartColumnMissingEndColumnNot",
20719
20934
  /**
20720
20935
  * An error caused by a `WebImageValue` with an invalid URL. Displays as error type #VALUE! in Excel.
20721
20936
  *
@@ -20820,7 +21035,7 @@ declare namespace Excel {
20820
21035
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20821
21036
  * @beta
20822
21037
  */
20823
- primitive?: "#VALUE!";
21038
+ basicValue?: "#VALUE!";
20824
21039
  /**
20825
21040
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20826
21041
  *
@@ -20828,7 +21043,7 @@ declare namespace Excel {
20828
21043
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20829
21044
  * @beta
20830
21045
  */
20831
- primitiveType?: RangeValueType.error | "Error";
21046
+ basicType?: RangeValueType.error | "Error";
20832
21047
  /**
20833
21048
  * Represents the type of `ErrorCellValue`.
20834
21049
  *
@@ -20844,7 +21059,7 @@ declare namespace Excel {
20844
21059
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20845
21060
  * @beta
20846
21061
  */
20847
- errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColMissingEndColNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount";
21062
+ errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount";
20848
21063
  }
20849
21064
  /**
20850
21065
  * Represents the value of a cell containing a type of value which cannot be serialized.
@@ -20870,7 +21085,7 @@ declare namespace Excel {
20870
21085
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20871
21086
  * @beta
20872
21087
  */
20873
- primitive: boolean | number | string;
21088
+ basicValue: boolean | number | string;
20874
21089
  /**
20875
21090
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20876
21091
  *
@@ -20878,7 +21093,7 @@ declare namespace Excel {
20878
21093
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20879
21094
  * @beta
20880
21095
  */
20881
- primitiveType: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String";
21096
+ basicType: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String";
20882
21097
  }
20883
21098
  /**
20884
21099
  * Represents the value of a cell containing an image downloaded from the internet.
@@ -20903,7 +21118,7 @@ declare namespace Excel {
20903
21118
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20904
21119
  * @beta
20905
21120
  */
20906
- primitive?: "#VALUE!";
21121
+ basicValue?: "#VALUE!";
20907
21122
  /**
20908
21123
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20909
21124
  *
@@ -20911,7 +21126,7 @@ declare namespace Excel {
20911
21126
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20912
21127
  * @beta
20913
21128
  */
20914
- primitiveType?: RangeValueType.error | "Error";
21129
+ basicType?: RangeValueType.error | "Error";
20915
21130
  /**
20916
21131
  * Represents the URL from which the image will be downloaded.
20917
21132
  * This image must be hosted on a server that supports HTTPS.
@@ -38080,7 +38295,7 @@ declare namespace Excel {
38080
38295
  * Clears the column filter criteria of the AutoFilter.
38081
38296
  *
38082
38297
  * @remarks
38083
- * [Api set: ExcelApiOnline 1.1]
38298
+ * [Api set: ExcelApi 1.14]
38084
38299
  *
38085
38300
  * @param columnIndex The zero-based column index, which represents which column filter needs to be cleared.
38086
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),
@@ -54285,7 +54500,7 @@ declare namespace Excel {
54285
54500
  }): FunctionResult<T>;
54286
54501
  /**
54287
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.)
54288
- * 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.
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.
54289
54504
  */
54290
54505
  toJSON(): Interfaces.FunctionResultData<T>;
54291
54506
  }
@@ -58046,7 +58261,9 @@ declare namespace Excel {
58046
58261
  accessDenied = "AccessDenied",
58047
58262
  apiNotFound = "ApiNotFound",
58048
58263
  conflict = "Conflict",
58264
+ emptyChartSeries = "EmptyChartSeries",
58049
58265
  filteredRangeConflict = "FilteredRangeConflict",
58266
+ formulaLengthExceedsLimit = "FormulaLengthExceedsLimit",
58050
58267
  generalException = "GeneralException",
58051
58268
  inactiveWorkbook = "InactiveWorkbook",
58052
58269
  insertDeleteConflict = "InsertDeleteConflict",
@@ -82536,7 +82753,10 @@ declare namespace Word {
82536
82753
  */
82537
82754
  readonly lists: Word.ListCollection;
82538
82755
  /**
82539
- * Get the collection of paragraph objects in the content control. Read-only.
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.
82540
82760
  *
82541
82761
  * @remarks
82542
82762
  * [Api set: WordApi 1.1]
@@ -86176,6 +86396,9 @@ declare namespace Word {
86176
86396
  /**
86177
86397
  * Gets the parent body of the range. Read-only.
86178
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
+ *
86179
86402
  * @remarks
86180
86403
  * [Api set: WordApi 1.3]
86181
86404
  */
@@ -96017,14 +96240,6 @@ declare namespace Word {
96017
96240
  /**
96018
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.
96019
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.
96020
- *
96021
- * @remarks
96022
- *
96023
- * 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:
96024
- *
96025
- * run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
96026
- *
96027
- * run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
96028
96243
  */
96029
96244
  function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
96030
96245
  }
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.262",
3
+ "version": "1.0.266",
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": "159bd6cbe1379101cfb3652179a5481c3086b00b5328ec2fb5eb1ee83b301846",
43
+ "typesPublisherContentHash": "f60321769b6b2f67dbb1e217749b0ecdb6df989c6750d58b20198c885e960c05",
44
44
  "typeScriptVersion": "3.7"
45
45
  }