@types/office-js-preview 1.0.260 → 1.0.264

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: Tue, 19 Oct 2021 21:31:29 GMT
11
+ * Last updated: Fri, 29 Oct 2021 22:31:30 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -12676,6 +12676,8 @@ declare namespace Office {
12676
12676
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
12677
12677
  *
12678
12678
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
12679
+ *
12680
+ * @beta
12679
12681
  */
12680
12682
  interface DelayDeliveryTime {
12681
12683
  /**
@@ -12692,6 +12694,8 @@ declare namespace Office {
12692
12694
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12693
12695
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12694
12696
  * `asyncResult`, which is an `Office.AsyncResult` object.
12697
+ *
12698
+ * @beta
12695
12699
  */
12696
12700
  getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Date>) => void): void;
12697
12701
  /**
@@ -12706,6 +12710,8 @@ declare namespace Office {
12706
12710
  *
12707
12711
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter,
12708
12712
  * `asyncResult`, which is an `Office.AsyncResult` object.
12713
+ *
12714
+ * @beta
12709
12715
  */
12710
12716
  getAsync(callback?: (asyncResult: Office.AsyncResult<Date>) => void): void;
12711
12717
  /**
@@ -12723,6 +12729,8 @@ declare namespace Office {
12723
12729
  * `asyncContext`: Developers can provide any object they wish to access in the callback method.
12724
12730
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
12725
12731
  * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
12732
+ *
12733
+ * @beta
12726
12734
  */
12727
12735
  setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12728
12736
  /**
@@ -12738,6 +12746,8 @@ declare namespace Office {
12738
12746
  * @param datetime - The future date and time when the message should be sent.
12739
12747
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
12740
12748
  * of type Office.AsyncResult. Any errors encountered will be provided in the `asyncResult.error` property.
12749
+ *
12750
+ * @beta
12741
12751
  */
12742
12752
  setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
12743
12753
  }
@@ -14694,6 +14704,8 @@ declare namespace Office {
14694
14704
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: `ReadItem`
14695
14705
  *
14696
14706
  * **{@link https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
14707
+ *
14708
+ * @beta
14697
14709
  */
14698
14710
  delayDeliveryTime: DelayDeliveryTime;
14699
14711
  /**
@@ -16817,6 +16829,7 @@ declare namespace Office {
16817
16829
  *
16818
16830
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter of
16819
16831
  * type `Office.AsyncResult`.
16832
+ *
16820
16833
  * @beta
16821
16834
  */
16822
16835
  getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
@@ -17147,6 +17160,8 @@ declare namespace Office {
17147
17160
  *
17148
17161
  * @remarks
17149
17162
  * [Api set: Mailbox preview]
17163
+ *
17164
+ * @beta
17150
17165
  */
17151
17166
  officeTheme: Office.OfficeTheme;
17152
17167
  /**
@@ -17154,6 +17169,8 @@ declare namespace Office {
17154
17169
  *
17155
17170
  * @remarks
17156
17171
  * [Api set: Mailbox preview]
17172
+ *
17173
+ * @beta
17157
17174
  */
17158
17175
  type: "officeThemeChanged";
17159
17176
  }
@@ -17326,6 +17343,11 @@ declare namespace Office {
17326
17343
  *
17327
17344
  * - Other: No limit
17328
17345
  *
17346
+ * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
17347
+ * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
17348
+ * associated `EmailAddressDetails` object. For more details, refer to the
17349
+ * {@link https://github.com/OfficeDev/office-js-docs-pr/issues/2962 | related GitHub issue}.
17350
+ *
17329
17351
  * @remarks
17330
17352
  * [Api set: Mailbox 1.1]
17331
17353
  *
@@ -17349,6 +17371,11 @@ declare namespace Office {
17349
17371
  *
17350
17372
  * - Other: No limit
17351
17373
  *
17374
+ * **Important**: In Outlook on the web, if a user created a new message by activating a contact's email address link from their contact or
17375
+ * profile card, your add-in's `getAsync` call currently won't return a value in the `displayName` property of the
17376
+ * associated `EmailAddressDetails` object. For more details, refer to the
17377
+ * {@link https://github.com/OfficeDev/office-js-docs-pr/issues/2962 | related GitHub issue}.
17378
+ *
17352
17379
  * @remarks
17353
17380
  * [Api set: Mailbox 1.1]
17354
17381
  *
@@ -19058,6 +19085,47 @@ declare namespace OfficeCore {
19058
19085
 
19059
19086
 
19060
19087
  declare namespace Excel {
19088
+ /**
19089
+ * Represents a 2D array of cell values.
19090
+ *
19091
+ * @remarks
19092
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19093
+ * @beta
19094
+ */
19095
+ interface ArrayCellValue {
19096
+ /**
19097
+ * Represents the type of this cell value.
19098
+ *
19099
+ * @remarks
19100
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19101
+ * @beta
19102
+ */
19103
+ type: CellValueType.array | "Array";
19104
+ /**
19105
+ * Represents the value that would be returned by `Range.values` for a cell with this value.
19106
+ *
19107
+ * @remarks
19108
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19109
+ * @beta
19110
+ */
19111
+ basicValue?: "#VALUE!";
19112
+ /**
19113
+ * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19114
+ *
19115
+ * @remarks
19116
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19117
+ * @beta
19118
+ */
19119
+ basicType?: RangeValueType.error | "Error";
19120
+ /**
19121
+ * Represents the elements of the array. May not directly contain an `ArrayCellValue`.
19122
+ *
19123
+ * @remarks
19124
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19125
+ * @beta
19126
+ */
19127
+ elements: CellValue[][];
19128
+ }
19061
19129
  /**
19062
19130
  * Represents types of #BLOCKED! errors.
19063
19131
  *
@@ -19154,7 +19222,7 @@ declare namespace Excel {
19154
19222
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19155
19223
  * @beta
19156
19224
  */
19157
- primitive?: "#BLOCKED!";
19225
+ basicValue?: "#BLOCKED!";
19158
19226
  /**
19159
19227
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19160
19228
  *
@@ -19162,7 +19230,7 @@ declare namespace Excel {
19162
19230
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19163
19231
  * @beta
19164
19232
  */
19165
- primitiveType?: RangeValueType.error | "Error";
19233
+ basicType?: RangeValueType.error | "Error";
19166
19234
  /**
19167
19235
  * Represents the type of `ErrorCellValue`.
19168
19236
  *
@@ -19203,7 +19271,7 @@ declare namespace Excel {
19203
19271
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19204
19272
  * @beta
19205
19273
  */
19206
- primitive: boolean;
19274
+ basicValue: boolean;
19207
19275
  /**
19208
19276
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19209
19277
  *
@@ -19211,7 +19279,7 @@ declare namespace Excel {
19211
19279
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19212
19280
  * @beta
19213
19281
  */
19214
- primitiveType?: RangeValueType.boolean | "Boolean";
19282
+ basicType?: RangeValueType.boolean | "Boolean";
19215
19283
  }
19216
19284
  /**
19217
19285
  * Represents types of #BUSY! errors.
@@ -19269,7 +19337,7 @@ declare namespace Excel {
19269
19337
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19270
19338
  * @beta
19271
19339
  */
19272
- primitive?: "#BUSY!";
19340
+ basicValue?: "#BUSY!";
19273
19341
  /**
19274
19342
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19275
19343
  *
@@ -19277,7 +19345,7 @@ declare namespace Excel {
19277
19345
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19278
19346
  * @beta
19279
19347
  */
19280
- primitiveType?: RangeValueType.error | "Error";
19348
+ basicType?: RangeValueType.error | "Error";
19281
19349
  /**
19282
19350
  * Represents the type of `ErrorCellValue`.
19283
19351
  *
@@ -19391,7 +19459,7 @@ declare namespace Excel {
19391
19459
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19392
19460
  * @beta
19393
19461
  */
19394
- primitive?: "#CALC!";
19462
+ basicValue?: "#CALC!";
19395
19463
  /**
19396
19464
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19397
19465
  *
@@ -19399,7 +19467,7 @@ declare namespace Excel {
19399
19467
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19400
19468
  * @beta
19401
19469
  */
19402
- primitiveType?: RangeValueType.error | "Error";
19470
+ basicType?: RangeValueType.error | "Error";
19403
19471
  /**
19404
19472
  * Represents the type of `ErrorCellValue`.
19405
19473
  *
@@ -19425,6 +19493,14 @@ declare namespace Excel {
19425
19493
  * @beta
19426
19494
  */
19427
19495
  enum CellValueType {
19496
+ /**
19497
+ * Represents an `ArrayCellValue`.
19498
+ *
19499
+ * @remarks
19500
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19501
+ * @beta
19502
+ */
19503
+ array = "Array",
19428
19504
  /**
19429
19505
  * Represents a `BooleanCellValue`.
19430
19506
  *
@@ -19442,6 +19518,14 @@ declare namespace Excel {
19442
19518
  */
19443
19519
  double = "Double",
19444
19520
  /**
19521
+ * Represents an `EntityCellValue`.
19522
+ *
19523
+ * @remarks
19524
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19525
+ * @beta
19526
+ */
19527
+ entity = "Entity",
19528
+ /**
19445
19529
  * Represents an `EmptyCellValue`.
19446
19530
  *
19447
19531
  * @remarks
@@ -19491,6 +19575,34 @@ declare namespace Excel {
19491
19575
  webImage = "WebImage"
19492
19576
  }
19493
19577
  /**
19578
+ * Represents the value in a cell.
19579
+ *
19580
+ * @remarks
19581
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19582
+ * @beta
19583
+ */
19584
+ type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & {
19585
+ /**
19586
+ * Represents whether this `CellValue` will be used to overwrite a cell.
19587
+ * When false, APIs which would use this `CellValue` to overwrite a cell will instead ignore this value without throwing an error.
19588
+ * The default value is true.
19589
+ *
19590
+ * @remarks
19591
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19592
+ * @beta
19593
+ */
19594
+ writable?: boolean;
19595
+ /**
19596
+ * Represents an explanation about why `CellValue.writable` is specified as false.
19597
+ * Note: This string is only available if `writable` is specified as false.
19598
+ *
19599
+ * @remarks
19600
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19601
+ * @beta
19602
+ */
19603
+ writableNote?: string;
19604
+ };
19605
+ /**
19494
19606
  * 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.
19495
19607
  *
19496
19608
  * @remarks
@@ -19566,6 +19678,80 @@ declare namespace Excel {
19566
19678
  logoTargetAddress?: string;
19567
19679
  }
19568
19680
  /**
19681
+ * Metadata about a property in `EntityCellValue.properties`.
19682
+ *
19683
+ * @remarks
19684
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19685
+ * @beta
19686
+ */
19687
+ interface CellValuePropertyMetadata {
19688
+ /**
19689
+ * Represents which features this property is excluded from.
19690
+ *
19691
+ * @remarks
19692
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19693
+ * @beta
19694
+ */
19695
+ excludeFrom?: CellValuePropertyMetadataExclusions;
19696
+ /**
19697
+ * Represents the sublabel for this property shown in card view.
19698
+ *
19699
+ * @remarks
19700
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19701
+ * @beta
19702
+ */
19703
+ sublabel?: string;
19704
+ /**
19705
+ * Represents attribution information to describe the source and license requirements for using this property.
19706
+ *
19707
+ * @remarks
19708
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19709
+ * @beta
19710
+ */
19711
+ attribution?: CellValueAttributionAttributes[];
19712
+ }
19713
+ /**
19714
+ * Represents the exclusion of a property in `EntityCellValue.properties` from features of Excel.
19715
+ *
19716
+ * @remarks
19717
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19718
+ * @beta
19719
+ */
19720
+ interface CellValuePropertyMetadataExclusions {
19721
+ /**
19722
+ * 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.
19723
+ *
19724
+ * @remarks
19725
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19726
+ * @beta
19727
+ */
19728
+ cardView?: boolean;
19729
+ /**
19730
+ * 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.
19731
+ *
19732
+ * @remarks
19733
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19734
+ * @beta
19735
+ */
19736
+ autoComplete?: boolean;
19737
+ /**
19738
+ * 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.
19739
+ *
19740
+ * @remarks
19741
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19742
+ * @beta
19743
+ */
19744
+ calcCompare?: boolean;
19745
+ /**
19746
+ * 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.
19747
+ *
19748
+ * @remarks
19749
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19750
+ * @beta
19751
+ */
19752
+ dotNotation?: boolean;
19753
+ }
19754
+ /**
19569
19755
  * Represents types of #CONNECT! errors.
19570
19756
  *
19571
19757
  * @remarks
@@ -19733,7 +19919,7 @@ declare namespace Excel {
19733
19919
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19734
19920
  * @beta
19735
19921
  */
19736
- primitive?: "#CONNECT!";
19922
+ basicValue?: "#CONNECT!";
19737
19923
  /**
19738
19924
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19739
19925
  *
@@ -19741,7 +19927,7 @@ declare namespace Excel {
19741
19927
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19742
19928
  * @beta
19743
19929
  */
19744
- primitiveType?: RangeValueType.error | "Error";
19930
+ basicType?: RangeValueType.error | "Error";
19745
19931
  /**
19746
19932
  * Represents the type of `ErrorCellValue`.
19747
19933
  *
@@ -19782,7 +19968,7 @@ declare namespace Excel {
19782
19968
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19783
19969
  * @beta
19784
19970
  */
19785
- primitive?: "#DIV/0!";
19971
+ basicValue?: "#DIV/0!";
19786
19972
  /**
19787
19973
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19788
19974
  *
@@ -19790,7 +19976,7 @@ declare namespace Excel {
19790
19976
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19791
19977
  * @beta
19792
19978
  */
19793
- primitiveType?: RangeValueType.error | "Error";
19979
+ basicType?: RangeValueType.error | "Error";
19794
19980
  /**
19795
19981
  * Represents the type of `ErrorCellValue`.
19796
19982
  *
@@ -19823,7 +20009,7 @@ declare namespace Excel {
19823
20009
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19824
20010
  * @beta
19825
20011
  */
19826
- primitive: number;
20012
+ basicValue: number;
19827
20013
  /**
19828
20014
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19829
20015
  *
@@ -19831,7 +20017,7 @@ declare namespace Excel {
19831
20017
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19832
20018
  * @beta
19833
20019
  */
19834
- primitiveType?: RangeValueType.double | "Double";
20020
+ basicType?: RangeValueType.double | "Double";
19835
20021
  }
19836
20022
  /**
19837
20023
  * Represents the value of a cell that's empty and has no formulas or data.
@@ -19856,7 +20042,40 @@ declare namespace Excel {
19856
20042
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19857
20043
  * @beta
19858
20044
  */
19859
- primitive?: "";
20045
+ basicValue?: "";
20046
+ /**
20047
+ * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20048
+ *
20049
+ * @remarks
20050
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20051
+ * @beta
20052
+ */
20053
+ basicType?: RangeValueType.empty | "Empty";
20054
+ }
20055
+ /**
20056
+ * Represents an schemaless set of properties.
20057
+ *
20058
+ * @remarks
20059
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20060
+ * @beta
20061
+ */
20062
+ interface EntityCellValue {
20063
+ /**
20064
+ * Represents the type of this cell value.
20065
+ *
20066
+ * @remarks
20067
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20068
+ * @beta
20069
+ */
20070
+ type: CellValueType.entity | "Entity";
20071
+ /**
20072
+ * Represents the value that would be returned by `Range.values` for a cell with this value.
20073
+ *
20074
+ * @remarks
20075
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20076
+ * @beta
20077
+ */
20078
+ basicValue?: "#VALUE!";
19860
20079
  /**
19861
20080
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
19862
20081
  *
@@ -19864,7 +20083,27 @@ declare namespace Excel {
19864
20083
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19865
20084
  * @beta
19866
20085
  */
19867
- primitiveType?: RangeValueType.empty | "Empty";
20086
+ basicType?: RangeValueType.error | "Error";
20087
+ /**
20088
+ * Represents the text shown when a cell with this value is rendered.
20089
+ *
20090
+ * @remarks
20091
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20092
+ * @beta
20093
+ */
20094
+ text?: string;
20095
+ /**
20096
+ * Represents the properties of this entity and their metadata.
20097
+ *
20098
+ * @remarks
20099
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20100
+ * @beta
20101
+ */
20102
+ properties?: {
20103
+ [key: string]: CellValue & {
20104
+ propertyMetadata?: CellValuePropertyMetadata;
20105
+ };
20106
+ };
19868
20107
  }
19869
20108
  /**
19870
20109
  * Represents the types of the `ErrorCellValue` object.
@@ -19931,13 +20170,13 @@ declare namespace Excel {
19931
20170
  */
19932
20171
  gettingData = "GettingData",
19933
20172
  /**
19934
- * Represents a `NaErrorCellValue`.
20173
+ * Represents a `NotAvailableErrorCellValue`.
19935
20174
  *
19936
20175
  * @remarks
19937
20176
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19938
20177
  * @beta
19939
20178
  */
19940
- na = "Na",
20179
+ notAvailable = "NotAvailable",
19941
20180
  /**
19942
20181
  * Represents a `NameErrorCellValue`.
19943
20182
  *
@@ -19988,6 +20227,14 @@ declare namespace Excel {
19988
20227
  value = "Value"
19989
20228
  }
19990
20229
  /**
20230
+ * Represents a cell value which contains an error.
20231
+ *
20232
+ * @remarks
20233
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20234
+ * @beta
20235
+ */
20236
+ type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
20237
+ /**
19991
20238
  * Represents types of #FIELD! errors.
19992
20239
  *
19993
20240
  * @remarks
@@ -20043,7 +20290,7 @@ declare namespace Excel {
20043
20290
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20044
20291
  * @beta
20045
20292
  */
20046
- primitive?: "#FIELD!";
20293
+ basicValue?: "#FIELD!";
20047
20294
  /**
20048
20295
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20049
20296
  *
@@ -20051,7 +20298,7 @@ declare namespace Excel {
20051
20298
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20052
20299
  * @beta
20053
20300
  */
20054
- primitiveType?: RangeValueType.error | "Error";
20301
+ basicType?: RangeValueType.error | "Error";
20055
20302
  /**
20056
20303
  * Represents the type of `ErrorCellValue`.
20057
20304
  *
@@ -20093,7 +20340,7 @@ declare namespace Excel {
20093
20340
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20094
20341
  * @beta
20095
20342
  */
20096
- primitive: number;
20343
+ basicValue: number;
20097
20344
  /**
20098
20345
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20099
20346
  *
@@ -20101,7 +20348,7 @@ declare namespace Excel {
20101
20348
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20102
20349
  * @beta
20103
20350
  */
20104
- primitiveType?: RangeValueType.double | "Double";
20351
+ basicType?: RangeValueType.double | "Double";
20105
20352
  /**
20106
20353
  * Returns the number format string that is used to display this value.
20107
20354
  * 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}.
@@ -20135,7 +20382,7 @@ declare namespace Excel {
20135
20382
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20136
20383
  * @beta
20137
20384
  */
20138
- primitive?: "#GETTING_DATA";
20385
+ basicValue?: "#GETTING_DATA";
20139
20386
  /**
20140
20387
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20141
20388
  *
@@ -20143,7 +20390,7 @@ declare namespace Excel {
20143
20390
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20144
20391
  * @beta
20145
20392
  */
20146
- primitiveType?: RangeValueType.error | "Error";
20393
+ basicType?: RangeValueType.error | "Error";
20147
20394
  /**
20148
20395
  * Represents the type of `ErrorCellValue`.
20149
20396
  *
@@ -20160,7 +20407,7 @@ declare namespace Excel {
20160
20407
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20161
20408
  * @beta
20162
20409
  */
20163
- interface NaErrorCellValue {
20410
+ interface NotAvailableErrorCellValue {
20164
20411
  /**
20165
20412
  * Represents the type of this cell value.
20166
20413
  *
@@ -20176,7 +20423,7 @@ declare namespace Excel {
20176
20423
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20177
20424
  * @beta
20178
20425
  */
20179
- primitive?: "#N/A!";
20426
+ basicValue?: "#N/A!";
20180
20427
  /**
20181
20428
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20182
20429
  *
@@ -20184,7 +20431,7 @@ declare namespace Excel {
20184
20431
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20185
20432
  * @beta
20186
20433
  */
20187
- primitiveType?: RangeValueType.error | "Error";
20434
+ basicType?: RangeValueType.error | "Error";
20188
20435
  /**
20189
20436
  * Represents the type of `ErrorCellValue`.
20190
20437
  *
@@ -20192,7 +20439,7 @@ declare namespace Excel {
20192
20439
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20193
20440
  * @beta
20194
20441
  */
20195
- errorType?: ErrorCellValueType.na | "Na";
20442
+ errorType?: ErrorCellValueType.notAvailable | "NotAvailable";
20196
20443
  }
20197
20444
  /**
20198
20445
  * Represents the value of a cell containing a #NAME? error.
@@ -20217,7 +20464,7 @@ declare namespace Excel {
20217
20464
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20218
20465
  * @beta
20219
20466
  */
20220
- primitive?: "#NAME?";
20467
+ basicValue?: "#NAME?";
20221
20468
  /**
20222
20469
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20223
20470
  *
@@ -20225,7 +20472,7 @@ declare namespace Excel {
20225
20472
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20226
20473
  * @beta
20227
20474
  */
20228
- primitiveType?: RangeValueType.error | "Error";
20475
+ basicType?: RangeValueType.error | "Error";
20229
20476
  /**
20230
20477
  * Represents the type of `ErrorCellValue`.
20231
20478
  *
@@ -20258,7 +20505,7 @@ declare namespace Excel {
20258
20505
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20259
20506
  * @beta
20260
20507
  */
20261
- primitive?: "#NULL!";
20508
+ basicValue?: "#NULL!";
20262
20509
  /**
20263
20510
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20264
20511
  *
@@ -20266,7 +20513,7 @@ declare namespace Excel {
20266
20513
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20267
20514
  * @beta
20268
20515
  */
20269
- primitiveType?: RangeValueType.error | "Error";
20516
+ basicType?: RangeValueType.error | "Error";
20270
20517
  /**
20271
20518
  * Represents the type of `ErrorCellValue`.
20272
20519
  *
@@ -20299,7 +20546,7 @@ declare namespace Excel {
20299
20546
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20300
20547
  * @beta
20301
20548
  */
20302
- primitive?: "#NUM!";
20549
+ basicValue?: "#NUM!";
20303
20550
  /**
20304
20551
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20305
20552
  *
@@ -20307,7 +20554,7 @@ declare namespace Excel {
20307
20554
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20308
20555
  * @beta
20309
20556
  */
20310
- primitiveType?: RangeValueType.error | "Error";
20557
+ basicType?: RangeValueType.error | "Error";
20311
20558
  /**
20312
20559
  * Represents the type of `ErrorCellValue`.
20313
20560
  *
@@ -20340,7 +20587,7 @@ declare namespace Excel {
20340
20587
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20341
20588
  * @beta
20342
20589
  */
20343
- vlookupColIndexGreaterThanNumCols = "VlookupColIndexGreaterThanNumCols",
20590
+ vlookupColumnIndexGreaterThanNumColumns = "VlookupColumnIndexGreaterThanNumColumns",
20344
20591
  /**
20345
20592
  * 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.
20346
20593
  *
@@ -20364,15 +20611,15 @@ declare namespace Excel {
20364
20611
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20365
20612
  * @beta
20366
20613
  */
20367
- subArrayStartRowOutofBounds = "SubArrayStartRowOutofBounds",
20614
+ subArrayStartRowOutOfBounds = "SubArrayStartRowOutOfBounds",
20368
20615
  /**
20369
- * An error caused by a start_col parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20616
+ * An error caused by a start_column parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20370
20617
  *
20371
20618
  * @remarks
20372
20619
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20373
20620
  * @beta
20374
20621
  */
20375
- subArrayStartColOutofBounds = "SubArrayStartColOutofBounds",
20622
+ subArrayStartColumnOutOfBounds = "SubArrayStartColumnOutOfBounds",
20376
20623
  /**
20377
20624
  * An error caused by an end_row parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20378
20625
  *
@@ -20380,15 +20627,15 @@ declare namespace Excel {
20380
20627
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20381
20628
  * @beta
20382
20629
  */
20383
- subArrayEndRowOutofBounds = "SubArrayEndRowOutofBounds",
20630
+ subArrayEndRowOutOfBounds = "SubArrayEndRowOutOfBounds",
20384
20631
  /**
20385
- * An error caused by an end_col parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20632
+ * An error caused by an end_column parameter of SUBARRAY being out of bounds. Displays as error type #REF! in Excel.
20386
20633
  *
20387
20634
  * @remarks
20388
20635
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20389
20636
  * @beta
20390
20637
  */
20391
- subArrayEndColOutofBounds = "SubArrayEndColOutofBounds",
20638
+ subArrayEndColumnOutOfBounds = "SubArrayEndColumnOutOfBounds",
20392
20639
  /**
20393
20640
  * An error caused by an end_row parameter of SUBARRAY preceding the start_row parameter. Displays as error type #REF! in Excel.
20394
20641
  *
@@ -20398,13 +20645,13 @@ declare namespace Excel {
20398
20645
  */
20399
20646
  subArrayEndRowPrecedesStartRow = "SubArrayEndRowPrecedesStartRow",
20400
20647
  /**
20401
- * An error caseud by an end_col parameter of SUBARRAY preceding the start_col parameter. Displays as error type #REF! in Excel.
20648
+ * An error caused by an end_column parameter of SUBARRAY preceding the start_column parameter. Displays as error type #REF! in Excel.
20402
20649
  *
20403
20650
  * @remarks
20404
20651
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20405
20652
  * @beta
20406
20653
  */
20407
- subArrayEndColPrecedesStartCol = "SubArrayEndColPrecedesStartCol"
20654
+ subArrayEndColumnPrecedesStartColumn = "SubArrayEndColumnPrecedesStartColumn"
20408
20655
  }
20409
20656
  /**
20410
20657
  * Represents the value of a cell containing a #REF! error.
@@ -20429,7 +20676,7 @@ declare namespace Excel {
20429
20676
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20430
20677
  * @beta
20431
20678
  */
20432
- primitive?: "#REF!";
20679
+ basicValue?: "#REF!";
20433
20680
  /**
20434
20681
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20435
20682
  *
@@ -20437,7 +20684,7 @@ declare namespace Excel {
20437
20684
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20438
20685
  * @beta
20439
20686
  */
20440
- primitiveType?: RangeValueType.error | "Error";
20687
+ basicType?: RangeValueType.error | "Error";
20441
20688
  /**
20442
20689
  * Represents the type of `ErrorCellValue`.
20443
20690
  *
@@ -20453,7 +20700,7 @@ declare namespace Excel {
20453
20700
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20454
20701
  * @beta
20455
20702
  */
20456
- errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColIndexGreaterThanNumCols" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutofBounds" | "SubArrayStartColOutofBounds" | "SubArrayEndRowOutofBounds" | "SubArrayEndColOutofBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColPrecedesStartCol";
20703
+ errorSubType?: RefErrorCellValueSubType | "Unknown" | "VlookupColumnIndexGreaterThanNumColumns" | "HlookupRowIndexGreaterThanNumRows" | "ExternalLinksRefNotExist" | "SubArrayStartRowOutOfBounds" | "SubArrayStartColumnOutOfBounds" | "SubArrayEndRowOutOfBounds" | "SubArrayEndColumnOutOfBounds" | "SubArrayEndRowPrecedesStartRow" | "SubArrayEndColumnPrecedesStartColumn";
20457
20704
  }
20458
20705
  /**
20459
20706
  * Represents types of #SPILL! errors.
@@ -20543,7 +20790,7 @@ declare namespace Excel {
20543
20790
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20544
20791
  * @beta
20545
20792
  */
20546
- primitive?: "#SPILL!";
20793
+ basicValue?: "#SPILL!";
20547
20794
  /**
20548
20795
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20549
20796
  *
@@ -20551,7 +20798,7 @@ declare namespace Excel {
20551
20798
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20552
20799
  * @beta
20553
20800
  */
20554
- primitiveType?: RangeValueType.error | "Error";
20801
+ basicType?: RangeValueType.error | "Error";
20555
20802
  /**
20556
20803
  * Represents the type of `ErrorCellValue`.
20557
20804
  *
@@ -20608,7 +20855,7 @@ declare namespace Excel {
20608
20855
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20609
20856
  * @beta
20610
20857
  */
20611
- primitive: string;
20858
+ basicValue: string;
20612
20859
  /**
20613
20860
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20614
20861
  *
@@ -20616,7 +20863,7 @@ declare namespace Excel {
20616
20863
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20617
20864
  * @beta
20618
20865
  */
20619
- primitiveType?: RangeValueType.string | "String";
20866
+ basicType?: RangeValueType.string | "String";
20620
20867
  }
20621
20868
  /**
20622
20869
  * Represents types of #VALUE! errors.
@@ -20635,13 +20882,13 @@ declare namespace Excel {
20635
20882
  */
20636
20883
  unknown = "Unknown",
20637
20884
  /**
20638
- * An error caused by a col_index_num parameter of VLOOKUP of less than 1. Displays as error type #VALUE! in Excel.
20885
+ * An error caused by a column_index_num parameter of VLOOKUP of less than 1. Displays as error type #VALUE! in Excel.
20639
20886
  *
20640
20887
  * @remarks
20641
20888
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20642
20889
  * @beta
20643
20890
  */
20644
- vlookupColIndexLessThanOne = "VlookupColIndexLessThanOne",
20891
+ vlookupColumnIndexLessThanOne = "VlookupColumnIndexLessThanOne",
20645
20892
  /**
20646
20893
  * An error caused by VLOOKUP not finding its lookup_value parameter. Displays as error type #VALUE! in Excel.
20647
20894
  *
@@ -20705,7 +20952,7 @@ declare namespace Excel {
20705
20952
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20706
20953
  * @beta
20707
20954
  */
20708
- subArrayStartColMissingEndColNot = "SubArrayStartColMissingEndColNot",
20955
+ subArrayStartColumnMissingEndColumnNot = "SubArrayStartColumnMissingEndColumnNot",
20709
20956
  /**
20710
20957
  * An error caused by a `WebImageValue` with an invalid URL. Displays as error type #VALUE! in Excel.
20711
20958
  *
@@ -20810,7 +21057,7 @@ declare namespace Excel {
20810
21057
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20811
21058
  * @beta
20812
21059
  */
20813
- primitive?: "#VALUE!";
21060
+ basicValue?: "#VALUE!";
20814
21061
  /**
20815
21062
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20816
21063
  *
@@ -20818,7 +21065,7 @@ declare namespace Excel {
20818
21065
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20819
21066
  * @beta
20820
21067
  */
20821
- primitiveType?: RangeValueType.error | "Error";
21068
+ basicType?: RangeValueType.error | "Error";
20822
21069
  /**
20823
21070
  * Represents the type of `ErrorCellValue`.
20824
21071
  *
@@ -20834,7 +21081,7 @@ declare namespace Excel {
20834
21081
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20835
21082
  * @beta
20836
21083
  */
20837
- errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColMissingEndColNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount";
21084
+ errorSubType?: ValueErrorCellValueSubType | "Unknown" | "VlookupColumnIndexLessThanOne" | "VlookupResultNotFound" | "HlookupRowIndexLessThanOne" | "HlookupResultNotFound" | "CoerceStringToNumberInvalid" | "CoerceStringToBoolInvalid" | "CoerceStringToInvalidType" | "SubArrayStartRowMissingEndRowNot" | "SubArrayStartColumnMissingEndColumnNot" | "InvalidImageUrl" | "StockHistoryNonTradingDays" | "StockHistoryNotAStock" | "StockHistoryInvalidDate" | "StockHistoryEndBeforeStart" | "StockHistoryStartInFuture" | "StockHistoryInvalidEnum" | "StockHistoryOnlyDateRequested" | "StockHistoryNotFound" | "LambdaWrongParamCount";
20838
21085
  }
20839
21086
  /**
20840
21087
  * Represents the value of a cell containing a type of value which cannot be serialized.
@@ -20860,7 +21107,7 @@ declare namespace Excel {
20860
21107
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20861
21108
  * @beta
20862
21109
  */
20863
- primitive: boolean | number | string;
21110
+ basicValue: boolean | number | string;
20864
21111
  /**
20865
21112
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20866
21113
  *
@@ -20868,7 +21115,7 @@ declare namespace Excel {
20868
21115
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20869
21116
  * @beta
20870
21117
  */
20871
- primitiveType: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String";
21118
+ basicType: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String";
20872
21119
  }
20873
21120
  /**
20874
21121
  * Represents the value of a cell containing an image downloaded from the internet.
@@ -20893,7 +21140,7 @@ declare namespace Excel {
20893
21140
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20894
21141
  * @beta
20895
21142
  */
20896
- primitive?: "#VALUE!";
21143
+ basicValue?: "#VALUE!";
20897
21144
  /**
20898
21145
  * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
20899
21146
  *
@@ -20901,7 +21148,7 @@ declare namespace Excel {
20901
21148
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20902
21149
  * @beta
20903
21150
  */
20904
- primitiveType?: RangeValueType.error | "Error";
21151
+ basicType?: RangeValueType.error | "Error";
20905
21152
  /**
20906
21153
  * Represents the URL from which the image will be downloaded.
20907
21154
  * This image must be hosted on a server that supports HTTPS.
@@ -38070,7 +38317,7 @@ declare namespace Excel {
38070
38317
  * Clears the column filter criteria of the AutoFilter.
38071
38318
  *
38072
38319
  * @remarks
38073
- * [Api set: ExcelApiOnline 1.1]
38320
+ * [Api set: ExcelApi 1.14]
38074
38321
  *
38075
38322
  * @param columnIndex The zero-based column index, which represents which column filter needs to be cleared.
38076
38323
  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),
@@ -58036,7 +58283,9 @@ declare namespace Excel {
58036
58283
  accessDenied = "AccessDenied",
58037
58284
  apiNotFound = "ApiNotFound",
58038
58285
  conflict = "Conflict",
58286
+ emptyChartSeries = "EmptyChartSeries",
58039
58287
  filteredRangeConflict = "FilteredRangeConflict",
58288
+ formulaLengthExceedsLimit = "FormulaLengthExceedsLimit",
58040
58289
  generalException = "GeneralException",
58041
58290
  inactiveWorkbook = "InactiveWorkbook",
58042
58291
  insertDeleteConflict = "InsertDeleteConflict",
@@ -81705,6 +81954,9 @@ declare namespace Word {
81705
81954
  /**
81706
81955
  * Gets the collection of paragraph objects in the body. Read-only.
81707
81956
  *
81957
+ * **Important**: Paragraphs in tables are not returned for requirement sets 1.1 and 1.2.
81958
+ * From requirement set 1.3, paragraphs in tables are also returned.
81959
+ *
81708
81960
  * @remarks
81709
81961
  * [Api set: WordApi 1.1]
81710
81962
  */
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.260",
3
+ "version": "1.0.264",
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": "2e27861e880de34da1e8c51c8d4b035e9fb2392da322d4412a68bdce29b4818b",
43
+ "typesPublisherContentHash": "db69000376b59e920743659ca9b2e877648b18f9f5075cd78a9de34b48a200f0",
44
44
  "typeScriptVersion": "3.7"
45
45
  }