@types/office-js-preview 1.0.268 → 1.0.272

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.
@@ -607,12 +607,12 @@ declare namespace Office {
607
607
  */
608
608
  hide(): Promise<void>;
609
609
  /**
610
- * Adds a listener for the `onVisibilityModeChanged` event.
611
- * @param listener - The listener function that is called when the event is emitted. This function takes in a message for the receiving component.
612
- * @returns A promise that resolves to a function when the listener is added. Calling it removes the listener.
610
+ * Adds a handler for the `onVisibilityModeChanged` event.
611
+ * @param handler - The handler function that is called when the event is emitted. This function takes in a message for the receiving component.
612
+ * @returns A promise that resolves to a function when the handler is added. Calling it removes the handler.
613
613
  */
614
614
  onVisibilityModeChanged(
615
- listener: (message: VisibilityModeChangedMessage) => void,
615
+ handler: (message: VisibilityModeChangedMessage) => void,
616
616
  ): Promise<() => Promise<void>>;
617
617
 
618
618
  /**
@@ -657,7 +657,7 @@ declare namespace Office {
657
657
  * This event handler will be triggered if one of the following conditions is met:
658
658
  * 1. When the notification dialog is open, the end user clicks the **Don't close** button within the dialog, clicks the Close button in the upper right corner of the dialog, or presses the Esc key.
659
659
  * 2. When the add-in calls the `enable` method on the `BeforeDocumentCloseNotification` object.
660
- * @param listener The event handler that is called when the dialog is cancelled.
660
+ * @param handler The event handler that is called when the dialog is cancelled.
661
661
  * @returns A promise that resolves when the event handler is added.
662
662
  *
663
663
  * @remarks
@@ -665,7 +665,7 @@ declare namespace Office {
665
665
  * @beta
666
666
  */
667
667
  onCloseActionCancelled(
668
- listener: () => void
668
+ handler: () => void
669
669
  ): Promise<() => Promise<void>>;
670
670
  }
671
671
  /**
@@ -1078,10 +1078,24 @@ declare namespace Office {
1078
1078
  *
1079
1079
  * @param eventType Specifies the type of event to add. This must be `Office.EventType.DialogParentMessageReceived`.
1080
1080
  * @param handler The event handler function to add, whose only parameter is of type {@link Office.DialogParentMessageReceivedEventArgs}.
1081
- * @param options Optional. Provides an option for preserving context data of any type, unchanged, for use in a callback.
1081
+ * @param options Provides an option for preserving context data of any type, unchanged, for use in a callback.
1082
1082
  * @param callback Optional. A function that is invoked when the handler registration returns, whose only parameter is of type {@link Office.AsyncResult}.
1083
1083
  */
1084
- addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
1084
+ addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, options: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;
1085
+ /**
1086
+ * Adds an event handler to the object using the specified event type.
1087
+ *
1088
+ * @remarks
1089
+ *
1090
+ * **Requirement set**: {@link https://docs.microsoft.com/office/dev/add-ins/reference/requirement-sets/dialog-api-requirement-sets | DialogApi 1.2}
1091
+ *
1092
+ * You can add multiple event handlers for the specified event type as long as the name of each event handler function is unique.
1093
+ *
1094
+ * @param eventType Specifies the type of event to add. This must be `Office.EventType.DialogParentMessageReceived`.
1095
+ * @param handler The event handler function to add, whose only parameter is of type {@link Office.DialogParentMessageReceivedEventArgs}.
1096
+ * @param callback Optional. A function that is invoked when the handler registration returns, whose only parameter is of type {@link Office.AsyncResult}.
1097
+ */
1098
+ addHandlerAsync(eventType: Office.EventType, handler: (result: DialogParentMessageReceivedEventArgs) => void, callback?: (result: AsyncResult<void>) => void): void;
1085
1099
  /**
1086
1100
  * Displays a dialog to show or collect information from the user or to facilitate Web navigation.
1087
1101
  *
@@ -9712,6 +9726,8 @@ declare namespace Office {
9712
9726
  /**
9713
9727
  * Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
9714
9728
  *
9729
+ * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
9730
+ *
9715
9731
  * @remarks
9716
9732
  * [Api set: Mailbox 1.11]
9717
9733
  *
@@ -14810,6 +14826,8 @@ declare namespace Office {
14810
14826
  /**
14811
14827
  * Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
14812
14828
  *
14829
+ * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
14830
+ *
14813
14831
  * @remarks
14814
14832
  * [Api set: Mailbox 1.11]
14815
14833
  *
@@ -18225,7 +18243,9 @@ declare namespace Office {
18225
18243
  setStartTime(time: string): void;
18226
18244
  }
18227
18245
  /**
18228
- * Provides methods to manage an item's session data.
18246
+ * Provides methods to manage an item's session data.
18247
+ *
18248
+ * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
18229
18249
  *
18230
18250
  * @remarks
18231
18251
  * [Api set: Mailbox 1.11]
@@ -18329,6 +18349,8 @@ declare namespace Office {
18329
18349
  /**
18330
18350
  * Sets a session data key-value pair.
18331
18351
  *
18352
+ * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
18353
+ *
18332
18354
  * @remarks
18333
18355
  * [Api set: Mailbox 1.11]
18334
18356
  *
@@ -18347,6 +18369,8 @@ declare namespace Office {
18347
18369
  /**
18348
18370
  * Sets a session data key-value pair.
18349
18371
  *
18372
+ * **Important**: The entire SessionData object is limited to 50,000 characters per add-in.
18373
+ *
18350
18374
  * @remarks
18351
18375
  * [Api set: Mailbox 1.11]
18352
18376
  *
@@ -19496,6 +19520,157 @@ declare namespace Excel {
19496
19520
  errorSubType?: CalcErrorCellValueSubType | "Unknown" | "ArrayOfArrays" | "ArrayOfRanges" | "EmptyArray" | "UnsupportedLifting" | "DataTableReferencedPendingFormula" | "TooManyCells" | "LambdaInCell";
19497
19521
  }
19498
19522
  /**
19523
+ * Represents a reference to a property used by the card layout.
19524
+ *
19525
+ * @remarks
19526
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19527
+ * @beta
19528
+ */
19529
+ interface CardLayoutPropertyReference {
19530
+ /**
19531
+ * The name of the property referenced by the card layout.
19532
+ *
19533
+ * @remarks
19534
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19535
+ * @beta
19536
+ */
19537
+ property: string;
19538
+ }
19539
+ /**
19540
+ * Properties of a card layout relevant to most card layouts.
19541
+ *
19542
+ * @remarks
19543
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19544
+ * @beta
19545
+ */
19546
+ interface CardLayoutSectionStandardProperties {
19547
+ /**
19548
+ * Represents the title of this section of the card.
19549
+ *
19550
+ * @remarks
19551
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19552
+ * @beta
19553
+ */
19554
+ title?: string;
19555
+ /**
19556
+ * Represents whether this section of the card is collapsible.
19557
+ * If the card section has a title, the default value is `true`.
19558
+ * If the card section doesn't have a title, the default value is `false`.
19559
+ *
19560
+ * @remarks
19561
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19562
+ * @beta
19563
+ */
19564
+ collapsible?: boolean;
19565
+ /**
19566
+ * Represents whether this section of the card is initially collapsed.
19567
+ *
19568
+ * @remarks
19569
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19570
+ * @beta
19571
+ */
19572
+ collapsed?: boolean;
19573
+ /**
19574
+ * Represents the names of the properties in this section.
19575
+ *
19576
+ * @remarks
19577
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19578
+ * @beta
19579
+ */
19580
+ properties: string[];
19581
+ }
19582
+ /**
19583
+ * Represents a section of a card that is arranged as a list in card view.
19584
+ *
19585
+ * @remarks
19586
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19587
+ * @beta
19588
+ */
19589
+ interface CardLayoutListSection extends CardLayoutSectionStandardProperties {
19590
+ /**
19591
+ * Represents the type of layout for this section.
19592
+ *
19593
+ * @remarks
19594
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19595
+ * @beta
19596
+ */
19597
+ layout: "List";
19598
+ }
19599
+ /**
19600
+ * Represents a section of a card that is arranged as a table in card view.
19601
+ *
19602
+ * @remarks
19603
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19604
+ * @beta
19605
+ */
19606
+ interface CardLayoutTableSection extends CardLayoutSectionStandardProperties {
19607
+ /**
19608
+ * Represents the type of layout for this section.
19609
+ *
19610
+ * @remarks
19611
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19612
+ * @beta
19613
+ */
19614
+ layout: "Table";
19615
+ }
19616
+ /**
19617
+ * Represents the layout of a section of a card in card view.
19618
+ *
19619
+ * @remarks
19620
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19621
+ * @beta
19622
+ */
19623
+ type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection;
19624
+ /**
19625
+ * Properties of a card layout relevant to most card layouts.
19626
+ *
19627
+ * @remarks
19628
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19629
+ * @beta
19630
+ */
19631
+ interface CardLayoutStandardProperties {
19632
+ /**
19633
+ * Specifies a property which will be used as the main image of the card.
19634
+ *
19635
+ * @remarks
19636
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19637
+ * @beta
19638
+ */
19639
+ mainImage?: CardLayoutPropertyReference;
19640
+ /**
19641
+ * Represents the title of the card or the specification of which property contains the title of the card.
19642
+ *
19643
+ * @remarks
19644
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19645
+ * @beta
19646
+ */
19647
+ title?: string | CardLayoutPropertyReference;
19648
+ /**
19649
+ * Represents a specification of which property contains the subtitle of the card.
19650
+ *
19651
+ * @remarks
19652
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19653
+ * @beta
19654
+ */
19655
+ subTitle?: CardLayoutPropertyReference;
19656
+ /**
19657
+ * Represents the sections of the card.
19658
+ *
19659
+ * @remarks
19660
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19661
+ * @beta
19662
+ */
19663
+ sections?: CardLayoutSection[];
19664
+ }
19665
+ /**
19666
+ * Represents the layout of a card in card view.
19667
+ *
19668
+ * @remarks
19669
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19670
+ * @beta
19671
+ */
19672
+ type CardLayout = EntityCardLayout;
19673
+ /**
19499
19674
  * Represents the types of the `CellValue` object.
19500
19675
  *
19501
19676
  * @remarks
@@ -19591,7 +19766,7 @@ declare namespace Excel {
19591
19766
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19592
19767
  * @beta
19593
19768
  */
19594
- type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue & {
19769
+ type CellValue = ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue | string | number | boolean & {
19595
19770
  /**
19596
19771
  * Represents whether this `CellValue` will be used to overwrite a cell.
19597
19772
  * When false, APIs which would use this `CellValue` to overwrite a cell will instead ignore this value without throwing an error.
@@ -19613,6 +19788,23 @@ declare namespace Excel {
19613
19788
  writableNote?: string;
19614
19789
  };
19615
19790
  /**
19791
+ * Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type.
19792
+ *
19793
+ * @remarks
19794
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19795
+ * @beta
19796
+ */
19797
+ type CellValueAndPropertyMetadata = CellValue & {
19798
+ /**
19799
+ * Represents metadata about the property.
19800
+ *
19801
+ * @remarks
19802
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19803
+ * @beta
19804
+ */
19805
+ propertyMetadata?: CellValuePropertyMetadata;
19806
+ };
19807
+ /**
19616
19808
  * 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.
19617
19809
  *
19618
19810
  * @remarks
@@ -20063,6 +20255,14 @@ declare namespace Excel {
20063
20255
  basicType?: RangeValueType.empty | "Empty";
20064
20256
  }
20065
20257
  /**
20258
+ * Represents the value of a property.
20259
+ *
20260
+ * @remarks
20261
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20262
+ * @beta
20263
+ */
20264
+ type EntityPropertyType = CellValueAndPropertyMetadata | CellValue;
20265
+ /**
20066
20266
  * Represents an schemaless set of properties.
20067
20267
  *
20068
20268
  * @remarks
@@ -20110,10 +20310,34 @@ declare namespace Excel {
20110
20310
  * @beta
20111
20311
  */
20112
20312
  properties?: {
20113
- [key: string]: CellValue & {
20114
- propertyMetadata?: CellValuePropertyMetadata;
20115
- };
20313
+ [key: string]: EntityPropertyType;
20116
20314
  };
20315
+ /**
20316
+ * Represents the layout of this entity in card view.
20317
+ * If the `CardLayout` object does not have a layout property, it is assumed to be "Entity".
20318
+ *
20319
+ * @remarks
20320
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20321
+ * @beta
20322
+ */
20323
+ cardLayout?: CardLayout;
20324
+ }
20325
+ /**
20326
+ * Represents a card layout best used for an entity.
20327
+ *
20328
+ * @remarks
20329
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20330
+ * @beta
20331
+ */
20332
+ interface EntityCardLayout extends CardLayoutStandardProperties {
20333
+ /**
20334
+ * Represent the type of this layout.
20335
+ *
20336
+ * @remarks
20337
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20338
+ * @beta
20339
+ */
20340
+ layout?: "Entity";
20117
20341
  }
20118
20342
  /**
20119
20343
  * Represents the types of the `ErrorCellValue` object.
@@ -22086,7 +22310,7 @@ declare namespace Excel {
22086
22310
  * @beta
22087
22311
  *
22088
22312
  * @param key The title of the `AllowEditRange`.
22089
- * @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
22313
+ * @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
22090
22314
  */
22091
22315
  getItemOrNullObject(key: string): Excel.AllowEditRange;
22092
22316
  /**
@@ -22584,7 +22808,7 @@ declare namespace Excel {
22584
22808
  */
22585
22809
  getItem(key: string): Excel.LinkedWorkbook;
22586
22810
  /**
22587
- * Gets information about a linked workbook by its URL. If the workbook does not exist, then this function will return an object with its `isNullObject` property set to `true`.
22811
+ * Gets information about a linked workbook by its URL. If the workbook does not exist, then this method returns an object with its `isNullObject` property set to `true`.
22588
22812
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
22589
22813
  *
22590
22814
  * @remarks
@@ -23334,7 +23558,7 @@ declare namespace Excel {
23334
23558
  * @beta
23335
23559
  *
23336
23560
  * @param key The ID of the task.
23337
- * @returns The task with the given ID. If there is no task with the given ID, then this function will return an object with its `isNullObject` property set to `true`.
23561
+ * @returns The task with the given ID. If there is no task with the given ID, then this method returns an object with its `isNullObject` property set to `true`.
23338
23562
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
23339
23563
  */
23340
23564
  getItemOrNullObject(key: string): Excel.DocumentTask;
@@ -27167,7 +27391,7 @@ declare namespace Excel {
27167
27391
  */
27168
27392
  getActiveChart(): Excel.Chart;
27169
27393
  /**
27170
- * Gets the currently active chart in the workbook. If there is no active chart, then this function will return an object with its `isNullObject` property set to `true`.
27394
+ * Gets the currently active chart in the workbook. If there is no active chart, then this method returns an object with its `isNullObject` property set to `true`.
27171
27395
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
27172
27396
  *
27173
27397
  * @remarks
@@ -27182,7 +27406,7 @@ declare namespace Excel {
27182
27406
  */
27183
27407
  getActiveSlicer(): Excel.Slicer;
27184
27408
  /**
27185
- * Gets the currently active slicer in the workbook. If there is no active slicer, then this function will return an object with its `isNullObject` property set to `true`.
27409
+ * Gets the currently active slicer in the workbook. If there is no active slicer, then this method returns an object with its `isNullObject` property set to `true`.
27186
27410
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
27187
27411
  *
27188
27412
  * @remarks
@@ -27663,7 +27887,7 @@ declare namespace Excel {
27663
27887
  *
27664
27888
  * @param text The string to find.
27665
27889
  * @param criteria Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive.
27666
- * @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If there are no matches, then this function will return an object with its `isNullObject` property set to `true`.
27890
+ * @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
27667
27891
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
27668
27892
  */
27669
27893
  findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;
@@ -27687,7 +27911,7 @@ declare namespace Excel {
27687
27911
  */
27688
27912
  getNext(visibleOnly?: boolean): Excel.Worksheet;
27689
27913
  /**
27690
- * Gets the worksheet that follows this one. If there are no worksheets following this one, then this method will return an object with its `isNullObject` property set to `true`.
27914
+ * Gets the worksheet that follows this one. If there are no worksheets following this one, then this method returns an object with its `isNullObject` property set to `true`.
27691
27915
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
27692
27916
  *
27693
27917
  * @remarks
@@ -27706,7 +27930,7 @@ declare namespace Excel {
27706
27930
  */
27707
27931
  getPrevious(visibleOnly?: boolean): Excel.Worksheet;
27708
27932
  /**
27709
- * Gets the worksheet that precedes this one. If there are no previous worksheets, then this method will return an object with its `isNullObject` property set to `true`.
27933
+ * Gets the worksheet that precedes this one. If there are no previous worksheets, then this method returns an object with its `isNullObject` property set to `true`.
27710
27934
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
27711
27935
  *
27712
27936
  * @remarks
@@ -27755,7 +27979,7 @@ declare namespace Excel {
27755
27979
  */
27756
27980
  getUsedRange(valuesOnly?: boolean): Excel.Range;
27757
27981
  /**
27758
- * The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, then this function will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
27982
+ * The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
27759
27983
  *
27760
27984
  * @remarks
27761
27985
  * [Api set: ExcelApi 1.4]
@@ -28043,7 +28267,7 @@ declare namespace Excel {
28043
28267
  */
28044
28268
  getItem(key: string): Excel.Worksheet;
28045
28269
  /**
28046
- * Gets a worksheet object using its name or ID. If the worksheet does not exist, then this function will return an object with its `isNullObject` property set to `true`.
28270
+ * Gets a worksheet object using its name or ID. If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
28047
28271
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
28048
28272
  *
28049
28273
  * @remarks
@@ -28562,7 +28786,7 @@ declare namespace Excel {
28562
28786
  /**
28563
28787
  * Gets a range that describes the frozen cells in the active worksheet view.
28564
28788
  The frozen range corresponds to cells that are frozen in the top- and left-most pane.
28565
- If there is no frozen pane, then this function will return an object with its `isNullObject` property set to `true`.
28789
+ If there is no frozen pane, then this method returns an object with its `isNullObject` property set to `true`.
28566
28790
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
28567
28791
  *
28568
28792
  * @remarks
@@ -28870,6 +29094,15 @@ declare namespace Excel {
28870
29094
  * [Api set: ExcelApi 1.1]
28871
29095
  */
28872
29096
  values: any[][];
29097
+ /**
29098
+ * A JSON representation of the values in the cells in this range.
29099
+ Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
29100
+ *
29101
+ * @remarks
29102
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29103
+ * @beta
29104
+ */
29105
+ valuesAsJson: CellValue[][];
28873
29106
  /**
28874
29107
  * Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
28875
29108
  *
@@ -29014,7 +29247,7 @@ declare namespace Excel {
29014
29247
  /**
29015
29248
  * Finds the given string based on the criteria specified.
29016
29249
  If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell.
29017
- If there are no matches, then this function will return an object with its `isNullObject` property set to `true`.
29250
+ If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
29018
29251
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29019
29252
  *
29020
29253
  * @remarks
@@ -29182,7 +29415,7 @@ declare namespace Excel {
29182
29415
  */
29183
29416
  getIntersection(anotherRange: Range | string): Excel.Range;
29184
29417
  /**
29185
- * Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, then this function will return an object with its `isNullObject` property set to `true`.
29418
+ * Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
29186
29419
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29187
29420
  *
29188
29421
  * @remarks
@@ -29337,7 +29570,7 @@ declare namespace Excel {
29337
29570
  getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
29338
29571
  /**
29339
29572
  * Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
29340
- If no special cells are found, then this function will return an object with its `isNullObject` property set to `true`.
29573
+ If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
29341
29574
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29342
29575
  *
29343
29576
  * @remarks
@@ -29349,7 +29582,7 @@ declare namespace Excel {
29349
29582
  getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
29350
29583
  /**
29351
29584
  * Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
29352
- If no special cells are found, then this function will return an object with its `isNullObject` property set to `true`.
29585
+ If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
29353
29586
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29354
29587
  *
29355
29588
  * @remarks
@@ -29368,7 +29601,7 @@ declare namespace Excel {
29368
29601
  getSpillParent(): Excel.Range;
29369
29602
  /**
29370
29603
  * Gets the range object containing the anchor cell for the cell getting spilled into.
29371
- If it's not a spilled cell, or more than one cell is given, then this function will return an object with its `isNullObject` property set to `true`.
29604
+ If it's not a spilled cell, or more than one cell is given, then this method returns an object with its `isNullObject` property set to `true`.
29372
29605
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29373
29606
  *
29374
29607
  * @remarks
@@ -29384,7 +29617,7 @@ declare namespace Excel {
29384
29617
  getSpillingToRange(): Excel.Range;
29385
29618
  /**
29386
29619
  * Gets the range object containing the spill range when called on an anchor cell.
29387
- If the range isn't an anchor cell or the spill range can't be found, then this function will return an object with its `isNullObject` property set to `true`.
29620
+ If the range isn't an anchor cell or the spill range can't be found, then this method returns an object with its `isNullObject` property set to `true`.
29388
29621
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29389
29622
  *
29390
29623
  * @remarks
@@ -29417,7 +29650,7 @@ declare namespace Excel {
29417
29650
  */
29418
29651
  getUsedRange(valuesOnly?: boolean): Excel.Range;
29419
29652
  /**
29420
- * Returns the used range of the given range object. If there are no used cells within the range, then this function will return an object with its `isNullObject` property set to `true`.
29653
+ * Returns the used range of the given range object. If there are no used cells within the range, then this method returns an object with its `isNullObject` property set to `true`.
29421
29654
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29422
29655
  *
29423
29656
  * @remarks
@@ -29908,7 +30141,7 @@ declare namespace Excel {
29908
30141
  */
29909
30142
  getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;
29910
30143
  /**
29911
- * Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, then this function will return an object with its `isNullObject` property set to `true`.
30144
+ * Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
29912
30145
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29913
30146
  *
29914
30147
  * @remarks
@@ -29948,7 +30181,7 @@ declare namespace Excel {
29948
30181
  */
29949
30182
  getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
29950
30183
  /**
29951
- * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this function will return an object with its `isNullObject` property set to `true`.
30184
+ * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
29952
30185
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29953
30186
  *
29954
30187
  * @remarks
@@ -29959,7 +30192,7 @@ declare namespace Excel {
29959
30192
  */
29960
30193
  getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
29961
30194
  /**
29962
- * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this function will return an object with its `isNullObject` property set to `true`.
30195
+ * Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
29963
30196
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29964
30197
  *
29965
30198
  * @remarks
@@ -29990,7 +30223,7 @@ declare namespace Excel {
29990
30223
  getUsedRangeAreas(valuesOnly?: boolean): Excel.RangeAreas;
29991
30224
  /**
29992
30225
  * Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.
29993
- If there are no used cells within the `RangeAreas`, then this function will return an object with its `isNullObject` property set to `true`.
30226
+ If there are no used cells within the `RangeAreas`, then this method returns an object with its `isNullObject` property set to `true`.
29994
30227
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
29995
30228
  *
29996
30229
  * @remarks
@@ -30081,7 +30314,7 @@ declare namespace Excel {
30081
30314
  */
30082
30315
  getRangeAreasBySheet(key: string): Excel.RangeAreas;
30083
30316
  /**
30084
- * Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist, then this function will return an object with its `isNullObject` property set to `true`.
30317
+ * Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
30085
30318
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
30086
30319
  *
30087
30320
  * @remarks
@@ -30697,6 +30930,15 @@ declare namespace Excel {
30697
30930
  * [Api set: ExcelApi 1.3]
30698
30931
  */
30699
30932
  values: any[][];
30933
+ /**
30934
+ * A JSON representation of the values in the cells in this range.
30935
+ Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
30936
+ *
30937
+ * @remarks
30938
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
30939
+ * @beta
30940
+ */
30941
+ valuesAsJson: CellValue[][];
30700
30942
  /**
30701
30943
  * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
30702
30944
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
@@ -30828,7 +31070,7 @@ declare namespace Excel {
30828
31070
  */
30829
31071
  getItem(key: string): Excel.Setting;
30830
31072
  /**
30831
- * Gets a setting entry via the key. If the setting does not exist, then this function will return an object with its `isNullObject` property set to `true`.
31073
+ * Gets a setting entry via the key. If the setting does not exist, then this method returns an object with its `isNullObject` property set to `true`.
30832
31074
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
30833
31075
  *
30834
31076
  * @remarks
@@ -30987,7 +31229,7 @@ declare namespace Excel {
30987
31229
  */
30988
31230
  getItem(name: string): Excel.NamedItem;
30989
31231
  /**
30990
- * Gets a `NamedItem` object using its name. If the object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
31232
+ * Gets a `NamedItem` object using its name. If the object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
30991
31233
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
30992
31234
  *
30993
31235
  * @remarks
@@ -31044,7 +31286,7 @@ declare namespace Excel {
31044
31286
  */
31045
31287
  readonly worksheet: Excel.Worksheet;
31046
31288
  /**
31047
- * Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this function will return an object with its `isNullObject` property set to `true`.
31289
+ * Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
31048
31290
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
31049
31291
  *
31050
31292
  * @remarks
@@ -31093,6 +31335,15 @@ declare namespace Excel {
31093
31335
  * [Api set: ExcelApi 1.1]
31094
31336
  */
31095
31337
  readonly value: any;
31338
+ /**
31339
+ * A JSON representation of the values in this named item.
31340
+ Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell.
31341
+ *
31342
+ * @remarks
31343
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
31344
+ * @beta
31345
+ */
31346
+ readonly valueAsJson: CellValue;
31096
31347
  /**
31097
31348
  * Specifies if the object is visible.
31098
31349
  *
@@ -31123,7 +31374,7 @@ declare namespace Excel {
31123
31374
  */
31124
31375
  getRange(): Excel.Range;
31125
31376
  /**
31126
- * Returns the range object that is associated with the name. If the named item's type is not a range, then this function will return an object with its `isNullObject` property set to `true`.
31377
+ * Returns the range object that is associated with the name. If the named item's type is not a range, then this method returns an object with its `isNullObject` property set to `true`.
31127
31378
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
31128
31379
  *
31129
31380
  * @remarks
@@ -31180,6 +31431,15 @@ declare namespace Excel {
31180
31431
  * [Api set: ExcelApi 1.7]
31181
31432
  */
31182
31433
  readonly values: any[][];
31434
+ /**
31435
+ * A JSON representation of the values in the cells in this range.
31436
+ Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell.
31437
+ *
31438
+ * @remarks
31439
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
31440
+ * @beta
31441
+ */
31442
+ readonly valuesAsJson: CellValue[][];
31183
31443
  /**
31184
31444
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
31185
31445
  *
@@ -31417,7 +31677,7 @@ declare namespace Excel {
31417
31677
  */
31418
31678
  getItemAt(index: number): Excel.Binding;
31419
31679
  /**
31420
- * Gets a binding object by ID. If the binding object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
31680
+ * Gets a binding object by ID. If the binding object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
31421
31681
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
31422
31682
  *
31423
31683
  * @remarks
@@ -31504,7 +31764,7 @@ declare namespace Excel {
31504
31764
  */
31505
31765
  getItemAt(index: number): Excel.Table;
31506
31766
  /**
31507
- * Gets a table by name or ID. If the table doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
31767
+ * Gets a table by name or ID. If the table doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
31508
31768
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
31509
31769
  *
31510
31770
  * @remarks
@@ -31610,7 +31870,7 @@ declare namespace Excel {
31610
31870
  getItem(key: string): Excel.Table;
31611
31871
  /**
31612
31872
  * Gets a table by name or ID.
31613
- If the table object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
31873
+ If the table object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
31614
31874
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
31615
31875
  *
31616
31876
  * @remarks
@@ -31976,7 +32236,7 @@ declare namespace Excel {
31976
32236
  */
31977
32237
  getItemAt(index: number): Excel.TableColumn;
31978
32238
  /**
31979
- * Gets a column object by name or ID. If the column doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
32239
+ * Gets a column object by name or ID. If the column doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
31980
32240
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
31981
32241
  *
31982
32242
  * @remarks
@@ -32054,6 +32314,15 @@ declare namespace Excel {
32054
32314
  * [Api set: ExcelApi 1.1]
32055
32315
  */
32056
32316
  values: any[][];
32317
+ /**
32318
+ * A JSON representation of the values in the cells in this table column.
32319
+ Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
32320
+ *
32321
+ * @remarks
32322
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
32323
+ * @beta
32324
+ */
32325
+ valuesAsJson: CellValue[][];
32057
32326
  /**
32058
32327
  * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
32059
32328
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
@@ -32258,6 +32527,15 @@ declare namespace Excel {
32258
32527
  * [Api set: ExcelApi 1.1]
32259
32528
  */
32260
32529
  values: any[][];
32530
+ /**
32531
+ * A JSON representation of the values in the cells in this table row.
32532
+ Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
32533
+ *
32534
+ * @remarks
32535
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
32536
+ * @beta
32537
+ */
32538
+ valuesAsJson: CellValue[][];
32261
32539
  /**
32262
32540
  * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
32263
32541
  * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
@@ -33376,7 +33654,7 @@ declare namespace Excel {
33376
33654
  */
33377
33655
  getItemAt(index: number): Excel.Chart;
33378
33656
  /**
33379
- * Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. If the chart doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
33657
+ * Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. If the chart doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
33380
33658
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
33381
33659
  *
33382
33660
  * @remarks
@@ -33655,7 +33933,7 @@ declare namespace Excel {
33655
33933
  */
33656
33934
  getDataTable(): Excel.ChartDataTable;
33657
33935
  /**
33658
- * Gets the data table on the chart. If the chart doesn't allow a data table, then this function returns an object with its `isNullObject` property set to `true`.
33936
+ * Gets the data table on the chart. If the chart doesn't allow a data table, then this method returns an object with its `isNullObject` property set to `true`.
33659
33937
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
33660
33938
  *
33661
33939
  * @remarks
@@ -38629,7 +38907,7 @@ declare namespace Excel {
38629
38907
  getItem(id: string): Excel.CustomXmlPart;
38630
38908
  /**
38631
38909
  * Gets a custom XML part based on its ID.
38632
- If the `CustomXmlPart` does not exist, then this function returns an object with its `isNullObject` property set to `true`.
38910
+ If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
38633
38911
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38634
38912
  *
38635
38913
  * @remarks
@@ -38725,7 +39003,7 @@ declare namespace Excel {
38725
39003
  getItem(id: string): Excel.CustomXmlPart;
38726
39004
  /**
38727
39005
  * Gets a custom XML part based on its ID.
38728
- If the `CustomXmlPart` does not exist, then this function returns an object with its `isNullObject` property set to `true`.
39006
+ If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
38729
39007
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38730
39008
  *
38731
39009
  * @remarks
@@ -38858,7 +39136,7 @@ declare namespace Excel {
38858
39136
  getFirst(): Excel.PivotTable;
38859
39137
  /**
38860
39138
  * Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection.
38861
- If the collection is empty, then this function returns an object with its `isNullObject` property set to `true`.
39139
+ If the collection is empty, then this method returns an object with its `isNullObject` property set to `true`.
38862
39140
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38863
39141
  *
38864
39142
  * @remarks
@@ -38876,7 +39154,7 @@ declare namespace Excel {
38876
39154
  */
38877
39155
  getItem(key: string): Excel.PivotTable;
38878
39156
  /**
38879
- * Gets a PivotTable by name. If the PivotTable does not exist, then this function returns an object with its `isNullObject` property set to `true`.
39157
+ * Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
38880
39158
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38881
39159
  *
38882
39160
  * @remarks
@@ -38949,7 +39227,7 @@ declare namespace Excel {
38949
39227
  */
38950
39228
  getItem(name: string): Excel.PivotTable;
38951
39229
  /**
38952
- * Gets a PivotTable by name. If the PivotTable does not exist, then this function returns an object with its `isNullObject` property set to `true`.
39230
+ * Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
38953
39231
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
38954
39232
  *
38955
39233
  * @remarks
@@ -39508,7 +39786,7 @@ declare namespace Excel {
39508
39786
  */
39509
39787
  getItem(name: string): Excel.PivotHierarchy;
39510
39788
  /**
39511
- * Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this function will return an object with its `isNullObject` property set to `true`.
39789
+ * Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39512
39790
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39513
39791
  *
39514
39792
  * @remarks
@@ -39642,7 +39920,7 @@ declare namespace Excel {
39642
39920
  */
39643
39921
  getItem(name: string): Excel.RowColumnPivotHierarchy;
39644
39922
  /**
39645
- * Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this function will return an object with its `isNullObject` property set to `true`.
39923
+ * Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39646
39924
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39647
39925
  *
39648
39926
  * @remarks
@@ -39797,7 +40075,7 @@ declare namespace Excel {
39797
40075
  */
39798
40076
  getItem(name: string): Excel.FilterPivotHierarchy;
39799
40077
  /**
39800
- * Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this function will return an object with its `isNullObject` property set to `true`.
40078
+ * Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39801
40079
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39802
40080
  *
39803
40081
  * @remarks
@@ -39958,7 +40236,7 @@ declare namespace Excel {
39958
40236
  */
39959
40237
  getItem(name: string): Excel.DataPivotHierarchy;
39960
40238
  /**
39961
- * Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this function will return an object with its `isNullObject` property set to `true`.
40239
+ * Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
39962
40240
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
39963
40241
  *
39964
40242
  * @remarks
@@ -40153,7 +40431,7 @@ declare namespace Excel {
40153
40431
  */
40154
40432
  getItem(name: string): Excel.PivotField;
40155
40433
  /**
40156
- * Gets a PivotField by name. If the PivotField does not exist, then this function will return an object with its `isNullObject` property set to `true`.
40434
+ * Gets a PivotField by name. If the PivotField does not exist, then this method returns an object with its `isNullObject` property set to `true`.
40157
40435
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
40158
40436
  *
40159
40437
  * @remarks
@@ -40395,7 +40673,7 @@ declare namespace Excel {
40395
40673
  */
40396
40674
  getItem(name: string): Excel.PivotItem;
40397
40675
  /**
40398
- * Gets a PivotItem by name. If the PivotItem does not exist, then this function will return an object with its `isNullObject` property set to `true`.
40676
+ * Gets a PivotItem by name. If the PivotItem does not exist, then this method returns an object with its `isNullObject` property set to `true`.
40399
40677
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
40400
40678
  *
40401
40679
  * @remarks
@@ -40921,7 +41199,7 @@ declare namespace Excel {
40921
41199
  */
40922
41200
  getItem(key: string): Excel.WorksheetCustomProperty;
40923
41201
  /**
40924
- * Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
41202
+ * Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
40925
41203
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
40926
41204
  *
40927
41205
  * @remarks
@@ -40964,7 +41242,7 @@ declare namespace Excel {
40964
41242
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
40965
41243
  context: RequestContext;
40966
41244
  /**
40967
- * Gets the collection of custom properties of the workbook. Read only.
41245
+ * Gets the collection of custom properties of the workbook.
40968
41246
  *
40969
41247
  * @remarks
40970
41248
  * [Api set: ExcelApi 1.7]
@@ -40999,7 +41277,7 @@ declare namespace Excel {
40999
41277
  */
41000
41278
  company: string;
41001
41279
  /**
41002
- * Gets the creation date of the workbook. Read only.
41280
+ * Gets the creation date of the workbook.
41003
41281
  *
41004
41282
  * @remarks
41005
41283
  * [Api set: ExcelApi 1.7]
@@ -41013,7 +41291,7 @@ declare namespace Excel {
41013
41291
  */
41014
41292
  keywords: string;
41015
41293
  /**
41016
- * Gets the last author of the workbook. Read only.
41294
+ * Gets the last author of the workbook.
41017
41295
  *
41018
41296
  * @remarks
41019
41297
  * [Api set: ExcelApi 1.7]
@@ -41027,7 +41305,7 @@ declare namespace Excel {
41027
41305
  */
41028
41306
  manager: string;
41029
41307
  /**
41030
- * Gets the revision number of the workbook. Read only.
41308
+ * Gets the revision number of the workbook.
41031
41309
  *
41032
41310
  * @remarks
41033
41311
  * [Api set: ExcelApi 1.7]
@@ -41199,7 +41477,7 @@ declare namespace Excel {
41199
41477
  */
41200
41478
  getItem(key: string): Excel.CustomProperty;
41201
41479
  /**
41202
- * Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
41480
+ * Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
41203
41481
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
41204
41482
  *
41205
41483
  * @remarks
@@ -41296,7 +41574,7 @@ declare namespace Excel {
41296
41574
  getItemAt(index: number): Excel.ConditionalFormat;
41297
41575
  /**
41298
41576
  * Returns a conditional format identified by its ID.
41299
- If the conditional format object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
41577
+ If the conditional format object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
41300
41578
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
41301
41579
  *
41302
41580
  * @remarks
@@ -41511,7 +41789,7 @@ declare namespace Excel {
41511
41789
  */
41512
41790
  getRange(): Excel.Range;
41513
41791
  /**
41514
- * Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this function will return an object with its `isNullObject` property set to `true`.
41792
+ * Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this method returns an object with its `isNullObject` property set to `true`.
41515
41793
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
41516
41794
  *
41517
41795
  * @remarks
@@ -43120,7 +43398,7 @@ declare namespace Excel {
43120
43398
  getItemAt(index: number): Excel.Style;
43121
43399
  /**
43122
43400
  * Gets a style by name.
43123
- If the style object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
43401
+ If the style object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
43124
43402
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
43125
43403
  *
43126
43404
  * @remarks
@@ -43201,7 +43479,7 @@ declare namespace Excel {
43201
43479
  */
43202
43480
  getItem(name: string): Excel.TableStyle;
43203
43481
  /**
43204
- * Gets a `TableStyle` by name. If the table style does not exist, then this function will return an object with its `isNullObject` property set to `true`.
43482
+ * Gets a `TableStyle` by name. If the table style does not exist, then this method returns an object with its `isNullObject` property set to `true`.
43205
43483
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
43206
43484
  *
43207
43485
  * @remarks
@@ -43365,7 +43643,7 @@ declare namespace Excel {
43365
43643
  */
43366
43644
  getItem(name: string): Excel.PivotTableStyle;
43367
43645
  /**
43368
- * Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this function will return an object with its `isNullObject` property set to `true`.
43646
+ * Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
43369
43647
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
43370
43648
  *
43371
43649
  * @remarks
@@ -43529,7 +43807,7 @@ declare namespace Excel {
43529
43807
  */
43530
43808
  getItem(name: string): Excel.SlicerStyle;
43531
43809
  /**
43532
- * Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
43810
+ * Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
43533
43811
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
43534
43812
  *
43535
43813
  * @remarks
@@ -43693,7 +43971,7 @@ declare namespace Excel {
43693
43971
  */
43694
43972
  getItem(name: string): Excel.TimelineStyle;
43695
43973
  /**
43696
- * Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
43974
+ * Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
43697
43975
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
43698
43976
  *
43699
43977
  * @remarks
@@ -43975,7 +44253,7 @@ declare namespace Excel {
43975
44253
  */
43976
44254
  getPrintArea(): Excel.RangeAreas;
43977
44255
  /**
43978
- * Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. If there is no print area, then this function will return an object with its `isNullObject` property set to `true`.
44256
+ * Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. If there is no print area, then this method returns an object with its `isNullObject` property set to `true`.
43979
44257
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
43980
44258
  *
43981
44259
  * @remarks
@@ -43990,7 +44268,7 @@ declare namespace Excel {
43990
44268
  */
43991
44269
  getPrintTitleColumns(): Excel.Range;
43992
44270
  /**
43993
- * Gets the range object representing the title columns. If not set, then this function will return an object with its `isNullObject` property set to `true`.
44271
+ * Gets the range object representing the title columns. If not set, then this method returns an object with its `isNullObject` property set to `true`.
43994
44272
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
43995
44273
  *
43996
44274
  * @remarks
@@ -44005,7 +44283,7 @@ declare namespace Excel {
44005
44283
  */
44006
44284
  getPrintTitleRows(): Excel.Range;
44007
44285
  /**
44008
- * Gets the range object representing the title rows. If not set, then this function will return an object with its `isNullObject` property set to `true`.
44286
+ * Gets the range object representing the title rows. If not set, then this method returns an object with its `isNullObject` property set to `true`.
44009
44287
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
44010
44288
  *
44011
44289
  * @remarks
@@ -44726,7 +45004,7 @@ declare namespace Excel {
44726
45004
  getItemByReplyId(replyId: string): Excel.Comment;
44727
45005
  /**
44728
45006
  * Gets a comment from the collection based on its ID.
44729
- If the comment object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
45007
+ If the comment object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
44730
45008
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
44731
45009
  *
44732
45010
  * @remarks
@@ -44906,7 +45184,7 @@ declare namespace Excel {
44906
45184
  */
44907
45185
  getTask(): Excel.DocumentTask;
44908
45186
  /**
44909
- * Gets the task associated with this comment. If there is no task for the comment thread, then this function will return an object with its `isNullObject` property set to `true`.
45187
+ * Gets the task associated with this comment. If there is no task for the comment thread, then this method returns an object with its `isNullObject` property set to `true`.
44910
45188
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
44911
45189
  *
44912
45190
  * @remarks
@@ -45008,7 +45286,7 @@ declare namespace Excel {
45008
45286
  getItemAt(index: number): Excel.CommentReply;
45009
45287
  /**
45010
45288
  * Returns a comment reply identified by its ID.
45011
- If the comment reply object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
45289
+ If the comment reply object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
45012
45290
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
45013
45291
  *
45014
45292
  * @remarks
@@ -45161,7 +45439,7 @@ declare namespace Excel {
45161
45439
  */
45162
45440
  getTask(): Excel.DocumentTask;
45163
45441
  /**
45164
- * Gets the task associated with this comment reply's thread. If there is no task for the comment thread, then this function will return an object with its `isNullObject` property set to `true`.
45442
+ * Gets the task associated with this comment reply's thread. If there is no task for the comment thread, then this method returns an object with its `isNullObject` property set to `true`.
45165
45443
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
45166
45444
  *
45167
45445
  * @remarks
@@ -45324,7 +45602,7 @@ declare namespace Excel {
45324
45602
  getItemAt(index: number): Excel.Shape;
45325
45603
  /**
45326
45604
  * Gets a shape using its name or ID.
45327
- If the shape object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
45605
+ If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
45328
45606
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
45329
45607
  *
45330
45608
  * @remarks
@@ -45417,7 +45695,7 @@ declare namespace Excel {
45417
45695
  */
45418
45696
  readonly parentGroup: Excel.Shape;
45419
45697
  /**
45420
- * Returns the text frame object of this shape. Read only.
45698
+ * Returns the text frame object of this shape.
45421
45699
  *
45422
45700
  * @remarks
45423
45701
  * [Api set: ExcelApi 1.9]
@@ -45943,7 +46221,7 @@ declare namespace Excel {
45943
46221
  getItemAt(index: number): Excel.Shape;
45944
46222
  /**
45945
46223
  * Gets a shape using its name or ID.
45946
- If the shape object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
46224
+ If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
45947
46225
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
45948
46226
  *
45949
46227
  * @remarks
@@ -46860,7 +47138,7 @@ declare namespace Excel {
46860
47138
  */
46861
47139
  getItemAt(index: number): Excel.Slicer;
46862
47140
  /**
46863
- * Gets a slicer using its name or ID. If the slicer doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
47141
+ * Gets a slicer using its name or ID. If the slicer doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
46864
47142
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
46865
47143
  *
46866
47144
  * @remarks
@@ -47004,7 +47282,7 @@ declare namespace Excel {
47004
47282
  */
47005
47283
  getItemAt(index: number): Excel.SlicerItem;
47006
47284
  /**
47007
- * Gets a slicer item using its key or name. If the slicer item doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
47285
+ * Gets a slicer item using its key or name. If the slicer item doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
47008
47286
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
47009
47287
  *
47010
47288
  * @remarks
@@ -47206,7 +47484,7 @@ declare namespace Excel {
47206
47484
  */
47207
47485
  getItemAt(index: number): Excel.LinkedDataType;
47208
47486
  /**
47209
- * Gets a linked data type by ID. If the linked data type doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
47487
+ * Gets a linked data type by ID. If the linked data type doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
47210
47488
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
47211
47489
  *
47212
47490
  * @remarks
@@ -54450,7 +54728,7 @@ declare namespace Excel {
54450
54728
  getItemAt(index: number): Excel.NamedSheetView;
54451
54729
  /**
54452
54730
  * Gets a sheet view using its name.
54453
- If the sheet view object does not exist, then this function will return an object with its `isNullObject` property set to `true`.
54731
+ If the sheet view object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
54454
54732
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
54455
54733
  *
54456
54734
  * @remarks
@@ -58310,6 +58588,7 @@ declare namespace Excel {
58310
58588
  nonBlankCellOffSheet = "NonBlankCellOffSheet",
58311
58589
  notImplemented = "NotImplemented",
58312
58590
  openWorkbookLinksBlocked = "OpenWorkbookLinksBlocked",
58591
+ operationCellsExceedLimit = "OperationCellsExceedLimit",
58313
58592
  pivotTableRangeConflict = "PivotTableRangeConflict",
58314
58593
  rangeExceedsLimit = "RangeExceedsLimit",
58315
58594
  refreshWorkbookLinksBlocked = "RefreshWorkbookLinksBlocked",
@@ -58822,6 +59101,15 @@ declare namespace Excel {
58822
59101
  * [Api set: ExcelApi 1.1]
58823
59102
  */
58824
59103
  values?: any[][];
59104
+ /**
59105
+ * A JSON representation of the values in the cells in this range.
59106
+ Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
59107
+ *
59108
+ * @remarks
59109
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59110
+ * @beta
59111
+ */
59112
+ valuesAsJson?: CellValue[][];
58825
59113
  }
58826
59114
  /** An interface for updating data on the RangeAreas object, for use in `rangeAreas.set({ ... })`. */
58827
59115
  interface RangeAreasUpdateData {
@@ -58886,6 +59174,15 @@ declare namespace Excel {
58886
59174
  * [Api set: ExcelApi 1.3]
58887
59175
  */
58888
59176
  values?: any[][];
59177
+ /**
59178
+ * A JSON representation of the values in the cells in this range.
59179
+ Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
59180
+ *
59181
+ * @remarks
59182
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59183
+ * @beta
59184
+ */
59185
+ valuesAsJson?: CellValue[][];
58889
59186
  }
58890
59187
  /** An interface for updating data on the RangeViewCollection object, for use in `rangeViewCollection.set({ ... })`. */
58891
59188
  interface RangeViewCollectionUpdateData {
@@ -59042,6 +59339,15 @@ declare namespace Excel {
59042
59339
  * [Api set: ExcelApi 1.1]
59043
59340
  */
59044
59341
  values?: any[][];
59342
+ /**
59343
+ * A JSON representation of the values in the cells in this table column.
59344
+ Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
59345
+ *
59346
+ * @remarks
59347
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59348
+ * @beta
59349
+ */
59350
+ valuesAsJson?: CellValue[][];
59045
59351
  }
59046
59352
  /** An interface for updating data on the TableRowCollection object, for use in `tableRowCollection.set({ ... })`. */
59047
59353
  interface TableRowCollectionUpdateData {
@@ -59057,6 +59363,15 @@ declare namespace Excel {
59057
59363
  * [Api set: ExcelApi 1.1]
59058
59364
  */
59059
59365
  values?: any[][];
59366
+ /**
59367
+ * A JSON representation of the values in the cells in this table row.
59368
+ Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
59369
+ *
59370
+ * @remarks
59371
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59372
+ * @beta
59373
+ */
59374
+ valuesAsJson?: CellValue[][];
59060
59375
  }
59061
59376
  /** An interface for updating data on the DataValidation object, for use in `dataValidation.set({ ... })`. */
59062
59377
  interface DataValidationUpdateData {
@@ -61792,7 +62107,7 @@ declare namespace Excel {
61792
62107
  */
61793
62108
  manager?: string;
61794
62109
  /**
61795
- * Gets the revision number of the workbook. Read only.
62110
+ * Gets the revision number of the workbook.
61796
62111
  *
61797
62112
  * @remarks
61798
62113
  * [Api set: ExcelApi 1.7]
@@ -64444,6 +64759,15 @@ declare namespace Excel {
64444
64759
  * [Api set: ExcelApi 1.1]
64445
64760
  */
64446
64761
  values?: any[][];
64762
+ /**
64763
+ * A JSON representation of the values in the cells in this range.
64764
+ Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
64765
+ *
64766
+ * @remarks
64767
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64768
+ * @beta
64769
+ */
64770
+ valuesAsJson?: CellValue[][];
64447
64771
  /**
64448
64772
  * Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
64449
64773
  *
@@ -64644,6 +64968,15 @@ declare namespace Excel {
64644
64968
  * [Api set: ExcelApi 1.3]
64645
64969
  */
64646
64970
  values?: any[][];
64971
+ /**
64972
+ * A JSON representation of the values in the cells in this range.
64973
+ Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
64974
+ *
64975
+ * @remarks
64976
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64977
+ * @beta
64978
+ */
64979
+ valuesAsJson?: CellValue[][];
64647
64980
  }
64648
64981
  /** An interface describing the data returned by calling `rangeViewCollection.toJSON()`. */
64649
64982
  interface RangeViewCollectionData {
@@ -64725,6 +65058,15 @@ declare namespace Excel {
64725
65058
  * [Api set: ExcelApi 1.1]
64726
65059
  */
64727
65060
  value?: any;
65061
+ /**
65062
+ * A JSON representation of the values in this named item.
65063
+ Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell.
65064
+ *
65065
+ * @remarks
65066
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65067
+ * @beta
65068
+ */
65069
+ valueAsJson?: CellValue;
64728
65070
  /**
64729
65071
  * Specifies if the object is visible.
64730
65072
  *
@@ -64749,6 +65091,15 @@ declare namespace Excel {
64749
65091
  * [Api set: ExcelApi 1.7]
64750
65092
  */
64751
65093
  values?: any[][];
65094
+ /**
65095
+ * A JSON representation of the values in the cells in this range.
65096
+ Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell.
65097
+ *
65098
+ * @remarks
65099
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65100
+ * @beta
65101
+ */
65102
+ valuesAsJson?: CellValue[][];
64752
65103
  }
64753
65104
  /** An interface describing the data returned by calling `binding.toJSON()`. */
64754
65105
  interface BindingData {
@@ -64939,6 +65290,15 @@ declare namespace Excel {
64939
65290
  * [Api set: ExcelApi 1.1]
64940
65291
  */
64941
65292
  values?: any[][];
65293
+ /**
65294
+ * A JSON representation of the values in the cells in this table column.
65295
+ Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
65296
+ *
65297
+ * @remarks
65298
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65299
+ * @beta
65300
+ */
65301
+ valuesAsJson?: CellValue[][];
64942
65302
  }
64943
65303
  /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */
64944
65304
  interface TableRowCollectionData {
@@ -64961,6 +65321,15 @@ declare namespace Excel {
64961
65321
  * [Api set: ExcelApi 1.1]
64962
65322
  */
64963
65323
  values?: any[][];
65324
+ /**
65325
+ * A JSON representation of the values in the cells in this table row.
65326
+ Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
65327
+ *
65328
+ * @remarks
65329
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65330
+ * @beta
65331
+ */
65332
+ valuesAsJson?: CellValue[][];
64964
65333
  }
64965
65334
  /** An interface describing the data returned by calling `dataValidation.toJSON()`. */
64966
65335
  interface DataValidationData {
@@ -68134,7 +68503,7 @@ declare namespace Excel {
68134
68503
  /** An interface describing the data returned by calling `documentProperties.toJSON()`. */
68135
68504
  interface DocumentPropertiesData {
68136
68505
  /**
68137
- * Gets the collection of custom properties of the workbook. Read only.
68506
+ * Gets the collection of custom properties of the workbook.
68138
68507
  *
68139
68508
  * @remarks
68140
68509
  * [Api set: ExcelApi 1.7]
@@ -68169,7 +68538,7 @@ declare namespace Excel {
68169
68538
  */
68170
68539
  company?: string;
68171
68540
  /**
68172
- * Gets the creation date of the workbook. Read only.
68541
+ * Gets the creation date of the workbook.
68173
68542
  *
68174
68543
  * @remarks
68175
68544
  * [Api set: ExcelApi 1.7]
@@ -68183,7 +68552,7 @@ declare namespace Excel {
68183
68552
  */
68184
68553
  keywords?: string;
68185
68554
  /**
68186
- * Gets the last author of the workbook. Read only.
68555
+ * Gets the last author of the workbook.
68187
68556
  *
68188
68557
  * @remarks
68189
68558
  * [Api set: ExcelApi 1.7]
@@ -68197,7 +68566,7 @@ declare namespace Excel {
68197
68566
  */
68198
68567
  manager?: string;
68199
68568
  /**
68200
- * Gets the revision number of the workbook. Read only.
68569
+ * Gets the revision number of the workbook.
68201
68570
  *
68202
68571
  * @remarks
68203
68572
  * [Api set: ExcelApi 1.7]
@@ -71757,6 +72126,15 @@ declare namespace Excel {
71757
72126
  * [Api set: ExcelApi 1.1]
71758
72127
  */
71759
72128
  values?: boolean;
72129
+ /**
72130
+ * A JSON representation of the values in the cells in this range.
72131
+ Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
72132
+ *
72133
+ * @remarks
72134
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72135
+ * @beta
72136
+ */
72137
+ valuesAsJson?: boolean;
71760
72138
  /**
71761
72139
  * Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
71762
72140
  *
@@ -71957,6 +72335,15 @@ declare namespace Excel {
71957
72335
  * [Api set: ExcelApi 1.3]
71958
72336
  */
71959
72337
  values?: boolean;
72338
+ /**
72339
+ * A JSON representation of the values in the cells in this range.
72340
+ Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
72341
+ *
72342
+ * @remarks
72343
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72344
+ * @beta
72345
+ */
72346
+ valuesAsJson?: boolean;
71960
72347
  }
71961
72348
  /**
71962
72349
  * Represents a collection of `RangeView` objects.
@@ -72046,6 +72433,15 @@ declare namespace Excel {
72046
72433
  * [Api set: ExcelApi 1.3]
72047
72434
  */
72048
72435
  values?: boolean;
72436
+ /**
72437
+ * For EACH ITEM in the collection: A JSON representation of the values in the cells in this range.
72438
+ Unlike `RangeView.values`, `RangeView.valuesAsJson` supports all data types which can be in a cell.
72439
+ *
72440
+ * @remarks
72441
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72442
+ * @beta
72443
+ */
72444
+ valuesAsJson?: boolean;
72049
72445
  }
72050
72446
  /**
72051
72447
  * Represents a collection of key-value pair setting objects that are part of the workbook. The scope is limited to per file and add-in (task-pane or content) combination.
@@ -72125,7 +72521,7 @@ declare namespace Excel {
72125
72521
  */
72126
72522
  worksheet?: Excel.Interfaces.WorksheetLoadOptions;
72127
72523
  /**
72128
- * For EACH ITEM in the collection: Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this function will return an object with its `isNullObject` property set to `true`.
72524
+ * For EACH ITEM in the collection: Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
72129
72525
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
72130
72526
  *
72131
72527
  * @remarks
@@ -72174,6 +72570,15 @@ declare namespace Excel {
72174
72570
  * [Api set: ExcelApi 1.1]
72175
72571
  */
72176
72572
  value?: boolean;
72573
+ /**
72574
+ * For EACH ITEM in the collection: A JSON representation of the values in this named item.
72575
+ Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell.
72576
+ *
72577
+ * @remarks
72578
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72579
+ * @beta
72580
+ */
72581
+ valueAsJson?: boolean;
72177
72582
  /**
72178
72583
  * For EACH ITEM in the collection: Specifies if the object is visible.
72179
72584
  *
@@ -72208,7 +72613,7 @@ declare namespace Excel {
72208
72613
  */
72209
72614
  worksheet?: Excel.Interfaces.WorksheetLoadOptions;
72210
72615
  /**
72211
- * Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this function will return an object with its `isNullObject` property set to `true`.
72616
+ * Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
72212
72617
  For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
72213
72618
  *
72214
72619
  * @remarks
@@ -72257,6 +72662,15 @@ declare namespace Excel {
72257
72662
  * [Api set: ExcelApi 1.1]
72258
72663
  */
72259
72664
  value?: boolean;
72665
+ /**
72666
+ * A JSON representation of the values in this named item.
72667
+ Unlike `NamedItem.value`, `NamedItem.valueAsJson` supports all data types which can be in a cell.
72668
+ *
72669
+ * @remarks
72670
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72671
+ * @beta
72672
+ */
72673
+ valueAsJson?: boolean;
72260
72674
  /**
72261
72675
  * Specifies if the object is visible.
72262
72676
  *
@@ -72290,6 +72704,15 @@ declare namespace Excel {
72290
72704
  * [Api set: ExcelApi 1.7]
72291
72705
  */
72292
72706
  values?: boolean;
72707
+ /**
72708
+ * A JSON representation of the values in the cells in this range.
72709
+ Unlike `NamedItemArrayValues.values`, `NamedItemArrayValues.valuesAsJson` supports all data types which can be in a cell.
72710
+ *
72711
+ * @remarks
72712
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72713
+ * @beta
72714
+ */
72715
+ valuesAsJson?: boolean;
72293
72716
  }
72294
72717
  /**
72295
72718
  * Represents an Office.js binding that is defined in the workbook.
@@ -72793,6 +73216,15 @@ declare namespace Excel {
72793
73216
  * [Api set: ExcelApi 1.1]
72794
73217
  */
72795
73218
  values?: boolean;
73219
+ /**
73220
+ * For EACH ITEM in the collection: A JSON representation of the values in the cells in this table column.
73221
+ Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
73222
+ *
73223
+ * @remarks
73224
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
73225
+ * @beta
73226
+ */
73227
+ valuesAsJson?: boolean;
72796
73228
  }
72797
73229
  /**
72798
73230
  * Represents a column in a table.
@@ -72841,6 +73273,15 @@ declare namespace Excel {
72841
73273
  * [Api set: ExcelApi 1.1]
72842
73274
  */
72843
73275
  values?: boolean;
73276
+ /**
73277
+ * A JSON representation of the values in the cells in this table column.
73278
+ Unlike `TableColumn.values`, `TableColumn.valuesAsJson` supports all data types which can be in a cell.
73279
+ *
73280
+ * @remarks
73281
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
73282
+ * @beta
73283
+ */
73284
+ valuesAsJson?: boolean;
72844
73285
  }
72845
73286
  /**
72846
73287
  * Represents a collection of all the rows that are part of the table.
@@ -72873,6 +73314,15 @@ declare namespace Excel {
72873
73314
  * [Api set: ExcelApi 1.1]
72874
73315
  */
72875
73316
  values?: boolean;
73317
+ /**
73318
+ * For EACH ITEM in the collection: A JSON representation of the values in the cells in this table row.
73319
+ Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
73320
+ *
73321
+ * @remarks
73322
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
73323
+ * @beta
73324
+ */
73325
+ valuesAsJson?: boolean;
72876
73326
  }
72877
73327
  /**
72878
73328
  * Represents a row in a table.
@@ -72905,6 +73355,15 @@ declare namespace Excel {
72905
73355
  * [Api set: ExcelApi 1.1]
72906
73356
  */
72907
73357
  values?: boolean;
73358
+ /**
73359
+ * A JSON representation of the values in the cells in this table row.
73360
+ Unlike `TableRow.values`, `TableRow.valuesAsJson` supports all data types which can be in a cell.
73361
+ *
73362
+ * @remarks
73363
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
73364
+ * @beta
73365
+ */
73366
+ valuesAsJson?: boolean;
72908
73367
  }
72909
73368
  /**
72910
73369
  * Represents the data validation applied to the current range.
@@ -77779,7 +78238,7 @@ declare namespace Excel {
77779
78238
  */
77780
78239
  company?: boolean;
77781
78240
  /**
77782
- * Gets the creation date of the workbook. Read only.
78241
+ * Gets the creation date of the workbook.
77783
78242
  *
77784
78243
  * @remarks
77785
78244
  * [Api set: ExcelApi 1.7]
@@ -77793,7 +78252,7 @@ declare namespace Excel {
77793
78252
  */
77794
78253
  keywords?: boolean;
77795
78254
  /**
77796
- * Gets the last author of the workbook. Read only.
78255
+ * Gets the last author of the workbook.
77797
78256
  *
77798
78257
  * @remarks
77799
78258
  * [Api set: ExcelApi 1.7]
@@ -77807,7 +78266,7 @@ declare namespace Excel {
77807
78266
  */
77808
78267
  manager?: boolean;
77809
78268
  /**
77810
- * Gets the revision number of the workbook. Read only.
78269
+ * Gets the revision number of the workbook.
77811
78270
  *
77812
78271
  * @remarks
77813
78272
  * [Api set: ExcelApi 1.7]
@@ -79878,6 +80337,15 @@ declare namespace Excel {
79878
80337
  * [Api set: ExcelApi 1.1]
79879
80338
  */
79880
80339
  values?: boolean;
80340
+ /**
80341
+ * For EACH ITEM in the collection: A JSON representation of the values in the cells in this range.
80342
+ Unlike `Range.values`, `Range.valuesAsJson` supports all data types which can be in a cell.
80343
+ *
80344
+ * @remarks
80345
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
80346
+ * @beta
80347
+ */
80348
+ valuesAsJson?: boolean;
79881
80349
  /**
79882
80350
  * For EACH ITEM in the collection: Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
79883
80351
  *
@@ -80331,7 +80799,7 @@ declare namespace Excel {
80331
80799
  */
80332
80800
  parentGroup?: Excel.Interfaces.ShapeLoadOptions;
80333
80801
  /**
80334
- * For EACH ITEM in the collection: Returns the text frame object of this shape. Read only.
80802
+ * For EACH ITEM in the collection: Returns the text frame object of this shape.
80335
80803
  *
80336
80804
  * @remarks
80337
80805
  * [Api set: ExcelApi 1.9]
@@ -80533,7 +81001,7 @@ declare namespace Excel {
80533
81001
  */
80534
81002
  parentGroup?: Excel.Interfaces.ShapeLoadOptions;
80535
81003
  /**
80536
- * Returns the text frame object of this shape. Read only.
81004
+ * Returns the text frame object of this shape.
80537
81005
  *
80538
81006
  * @remarks
80539
81007
  * [Api set: ExcelApi 1.9]
@@ -80819,7 +81287,7 @@ declare namespace Excel {
80819
81287
  */
80820
81288
  parentGroup?: Excel.Interfaces.ShapeLoadOptions;
80821
81289
  /**
80822
- * For EACH ITEM in the collection: Returns the text frame object of this shape. Read only.
81290
+ * For EACH ITEM in the collection: Returns the text frame object of this shape.
80823
81291
  *
80824
81292
  * @remarks
80825
81293
  * [Api set: ExcelApi 1.9]