@types/office-js-preview 1.0.379 → 1.0.381

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, 11 Apr 2023 23:03:25 GMT
11
+ * Last updated: Mon, 17 Apr 2023 19:02:43 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -9905,7 +9905,12 @@ declare namespace Office {
9905
9905
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
9906
9906
  *
9907
9907
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
9908
- *
9908
+ *
9909
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
9910
+ *
9911
+ * To learn more about how to manage sensitivity labels in your add-in, see
9912
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
9913
+ *
9909
9914
  * @beta
9910
9915
  */
9911
9916
  sensitivityLabel: SensitivityLabel;
@@ -15230,7 +15235,12 @@ declare namespace Office {
15230
15235
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
15231
15236
  *
15232
15237
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15233
- *
15238
+ *
15239
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
15240
+ *
15241
+ * To learn more about how to manage sensitivity labels in your add-in, see
15242
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
15243
+ *
15234
15244
  * @beta
15235
15245
  */
15236
15246
  sensitivityLabel: SensitivityLabel;
@@ -18551,7 +18561,12 @@ declare namespace Office {
18551
18561
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18552
18562
  *
18553
18563
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18554
- *
18564
+ *
18565
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18566
+ *
18567
+ * To learn more about how to manage sensitivity labels in your add-in, see
18568
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18569
+ *
18555
18570
  * @beta
18556
18571
  */
18557
18572
  interface SensitivityLabel {
@@ -18564,13 +18579,18 @@ declare namespace Office {
18564
18579
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18565
18580
  *
18566
18581
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18567
- *
18582
+ *
18583
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18584
+ *
18585
+ * To learn more about how to manage sensitivity labels in your add-in, see
18586
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18587
+ *
18568
18588
  * @param options - An object literal that contains one or more of the following properties:-
18569
18589
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18570
18590
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18571
18591
  * which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
18572
18592
  * `asyncResult.value` property.
18573
- *
18593
+ *
18574
18594
  * @beta
18575
18595
  */
18576
18596
  getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
@@ -18583,11 +18603,16 @@ declare namespace Office {
18583
18603
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18584
18604
  *
18585
18605
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18586
- *
18606
+ *
18607
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18608
+ *
18609
+ * To learn more about how to manage sensitivity labels in your add-in, see
18610
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18611
+ *
18587
18612
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18588
18613
  * which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
18589
18614
  * `asyncResult.value` property.
18590
- *
18615
+ *
18591
18616
  * @beta
18592
18617
  */
18593
18618
  getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
@@ -18600,8 +18625,13 @@ declare namespace Office {
18600
18625
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18601
18626
  *
18602
18627
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18603
- *
18628
+ *
18629
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18630
+ *
18604
18631
  * **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
18632
+ *
18633
+ * To learn more about how to manage sensitivity labels in your add-in, see
18634
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18605
18635
  *
18606
18636
  * @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
18607
18637
  * unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
@@ -18609,7 +18639,7 @@ declare namespace Office {
18609
18639
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18610
18640
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18611
18641
  * which is an `Office.AsyncResult` object.
18612
- *
18642
+ *
18613
18643
  * @beta
18614
18644
  */
18615
18645
  setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
@@ -18622,8 +18652,13 @@ declare namespace Office {
18622
18652
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18623
18653
  *
18624
18654
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18625
- *
18655
+ *
18656
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18657
+ *
18626
18658
  * **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
18659
+ *
18660
+ * To learn more about how to manage sensitivity labels in your add-in, see
18661
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18627
18662
  *
18628
18663
  * @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
18629
18664
  * unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
@@ -18640,7 +18675,12 @@ declare namespace Office {
18640
18675
  *
18641
18676
  * @remarks
18642
18677
  * [Api set: Mailbox preview]
18643
- *
18678
+ *
18679
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18680
+ *
18681
+ * To learn more about how to manage sensitivity labels in your add-in, see
18682
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18683
+ *
18644
18684
  * @beta
18645
18685
  */
18646
18686
  export interface SensitivityLabelChangedEventArgs {
@@ -18663,6 +18703,11 @@ declare namespace Office {
18663
18703
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18664
18704
  *
18665
18705
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18706
+ *
18707
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18708
+ *
18709
+ * To learn more about how to manage sensitivity labels in your add-in, see
18710
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18666
18711
  *
18667
18712
  * @beta
18668
18713
  */
@@ -18709,7 +18754,12 @@ declare namespace Office {
18709
18754
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18710
18755
  *
18711
18756
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18712
- *
18757
+ *
18758
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18759
+ *
18760
+ * To learn more about how to manage sensitivity labels in your add-in, see
18761
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18762
+ *
18713
18763
  * @beta
18714
18764
  */
18715
18765
  export interface SensitivityLabelsCatalog {
@@ -18722,9 +18772,14 @@ declare namespace Office {
18722
18772
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18723
18773
  *
18724
18774
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18725
- *
18775
+ *
18776
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18777
+ *
18726
18778
  * **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
18727
- *
18779
+ *
18780
+ * To learn more about how to manage sensitivity labels in your add-in, see
18781
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18782
+ *
18728
18783
  * @param options - An object literal that contains one or more of the following properties:-
18729
18784
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18730
18785
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
@@ -18743,8 +18798,13 @@ declare namespace Office {
18743
18798
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18744
18799
  *
18745
18800
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18746
- *
18801
+ *
18802
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18803
+ *
18747
18804
  * **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
18805
+ *
18806
+ * To learn more about how to manage sensitivity labels in your add-in, see
18807
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18748
18808
  *
18749
18809
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18750
18810
  * which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
@@ -18765,7 +18825,12 @@ declare namespace Office {
18765
18825
  *
18766
18826
  * **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
18767
18827
  * {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
18768
- *
18828
+ *
18829
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18830
+ *
18831
+ * To learn more about how to manage sensitivity labels in your add-in, see
18832
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18833
+ *
18769
18834
  * @param options - An object literal that contains one or more of the following properties:-
18770
18835
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18771
18836
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
@@ -18783,10 +18848,15 @@ declare namespace Office {
18783
18848
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18784
18849
  *
18785
18850
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18786
- *
18851
+ *
18787
18852
  * **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
18788
18853
  * {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
18789
- *
18854
+ *
18855
+ * **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
18856
+ *
18857
+ * To learn more about how to manage sensitivity labels in your add-in, see
18858
+ * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
18859
+ *
18790
18860
  * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18791
18861
  * which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
18792
18862
  *
@@ -19898,6 +19968,56 @@ declare namespace Excel {
19898
19968
  referencedValues?: ReferencedValue[];
19899
19969
  }
19900
19970
  /**
19971
+ * The base64 encoding type and data of an image.
19972
+ *
19973
+ * @remarks
19974
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19975
+ * @beta
19976
+ */
19977
+ interface Base64EncodedImage {
19978
+ /**
19979
+ * The file type of the encoded image.
19980
+ *
19981
+ * @remarks
19982
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19983
+ * @beta
19984
+ */
19985
+ type: Base64EncodingType | "JPG" | "PNG";
19986
+ /**
19987
+ * The base64 string encoding.
19988
+ *
19989
+ * @remarks
19990
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19991
+ * @beta
19992
+ */
19993
+ data: string;
19994
+ }
19995
+ /**
19996
+ * The file type represented by the base64 encoding.
19997
+ *
19998
+ * @remarks
19999
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20000
+ * @beta
20001
+ */
20002
+ enum Base64EncodingType {
20003
+ /**
20004
+ * The JPG file type.
20005
+ *
20006
+ * @remarks
20007
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20008
+ * @beta
20009
+ */
20010
+ JPG = "JPG",
20011
+ /**
20012
+ * The PNG file type.
20013
+ *
20014
+ * @remarks
20015
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20016
+ * @beta
20017
+ */
20018
+ PNG = "PNG"
20019
+ }
20020
+ /**
19901
20021
  * Represents a card layout that is best used for an array.
19902
20022
  *
19903
20023
  * @remarks
@@ -24500,6 +24620,13 @@ declare namespace Excel {
24500
24620
  */
24501
24621
  linkedEntity = "LinkedEntity",
24502
24622
  /**
24623
+ * Represents a `LocalImageCellValue`.
24624
+ *
24625
+ * @remarks
24626
+ * [Api set: ExcelApi 1.16]
24627
+ */
24628
+ localImage = "LocalImage",
24629
+ /**
24503
24630
  * Represents a `ReferenceCellValue`.
24504
24631
  *
24505
24632
  * @remarks
@@ -24534,7 +24661,7 @@ declare namespace Excel {
24534
24661
  * @remarks
24535
24662
  * [Api set: ExcelApi 1.16]
24536
24663
  */
24537
- type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
24664
+ type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | LocalImageCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
24538
24665
  /**
24539
24666
  * These extra properties may appear on a `CellValue` and provide information about that `CellValue`, but the extra properties are not part of the value in the cell.
24540
24667
  *
@@ -25355,7 +25482,14 @@ declare namespace Excel {
25355
25482
  * @remarks
25356
25483
  * [Api set: ExcelApi 1.16]
25357
25484
  */
25358
- dataProviderError = "DataProviderError"
25485
+ dataProviderError = "DataProviderError",
25486
+ /**
25487
+ * An error caused by a missing file. In this case, the RichValueRel.xml file is missing from the metro package. Displays as error type #FIELD! in Excel.
25488
+ *
25489
+ * @remarks
25490
+ * [Api set: 1.16]
25491
+ */
25492
+ richValueRelMissingFilePart = "RichValueRelMissingFilePart"
25359
25493
  }
25360
25494
  /**
25361
25495
  * Represents the value of a cell containing a #FIELD! error.
@@ -25400,7 +25534,7 @@ declare namespace Excel {
25400
25534
  * @remarks
25401
25535
  * [Api set: ExcelApi 1.16]
25402
25536
  */
25403
- errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError";
25537
+ errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError" | "RichValueRelMissingFilePart";
25404
25538
  /**
25405
25539
  * Represents the field which was not found by FIELDVALUE.
25406
25540
  *
@@ -25596,6 +25730,88 @@ declare namespace Excel {
25596
25730
  provider?: CellValueProviderAttributes;
25597
25731
  }
25598
25732
  /**
25733
+ * Represents the value of a cell containing a locally stored or generated image.
25734
+ *
25735
+ * @remarks
25736
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
25737
+ * @beta
25738
+ */
25739
+ interface LocalImageCellValue {
25740
+ /**
25741
+ * Represents the type of this cell value.
25742
+ *
25743
+ * @remarks
25744
+ * [Api set: ExcelApi 1.16]
25745
+ */
25746
+ type: CellValueType.localImage | "LocalImage";
25747
+ /**
25748
+ * Represents the value that would be returned by `Range.values` for a cell with this value.
25749
+ * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
25750
+ * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
25751
+ *
25752
+ * @remarks
25753
+ * [Api set: ExcelApi 1.16]
25754
+ */
25755
+ basicValue?: "#VALUE!" | string;
25756
+ /**
25757
+ * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
25758
+ *
25759
+ * @remarks
25760
+ * [Api set: ExcelApi 1.16]
25761
+ */
25762
+ basicType?: RangeValueType.error | "Error";
25763
+ /**
25764
+ * Represents the image itself, either cached or encoded.
25765
+ *
25766
+ * @remarks
25767
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
25768
+ * @beta
25769
+ */
25770
+ image: LocalImageCellValueCacheId | Base64EncodedImage;
25771
+ /**
25772
+ * Represents the alternate text used in accessibility scenarios to describe what the image represents.
25773
+ *
25774
+ * @remarks
25775
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
25776
+ * @beta
25777
+ */
25778
+ altText?: string;
25779
+ /**
25780
+ * Represents attribution information to describe the source and license requirements for this image.
25781
+ *
25782
+ * @remarks
25783
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
25784
+ * @beta
25785
+ */
25786
+ attribution?: CellValueAttributionAttributes[];
25787
+ /**
25788
+ * Represents information that describes the entity or individual who provided the image.
25789
+ * This information is used for branding purposes in image cards.
25790
+ *
25791
+ * @remarks
25792
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
25793
+ * @beta
25794
+ */
25795
+ provider?: CellValueProviderAttributes;
25796
+ }
25797
+ /**
25798
+ * The UID of a previously cached image.
25799
+ *
25800
+ * @remarks
25801
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
25802
+ * @beta
25803
+ */
25804
+ interface LocalImageCellValueCacheId {
25805
+ /**
25806
+ * Represents the image's UID as it appears in the cache.
25807
+ *
25808
+ * @remarks
25809
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
25810
+ * @beta
25811
+ */
25812
+ cacheUid: string;
25813
+ }
25814
+ /**
25599
25815
  * Represents the value of a cell containing a #N/A! error.
25600
25816
  *
25601
25817
  * @remarks
@@ -27233,42 +27449,42 @@ declare namespace Excel {
27233
27449
  as a result of that primary move.
27234
27450
  *
27235
27451
  * @remarks
27236
- * [Api set: ExcelApiOnline 1.1]
27452
+ * [Api set: ExcelApi 1.17]
27237
27453
  */
27238
27454
  interface WorksheetMovedEventArgs {
27239
27455
  /**
27240
27456
  * Gets the new position of the worksheet, after the move.
27241
27457
  *
27242
27458
  * @remarks
27243
- * [Api set: ExcelApiOnline 1.1]
27459
+ * [Api set: ExcelApi 1.17]
27244
27460
  */
27245
27461
  positionAfter: number;
27246
27462
  /**
27247
27463
  * Gets the previous position of the worksheet, prior to the move.
27248
27464
  *
27249
27465
  * @remarks
27250
- * [Api set: ExcelApiOnline 1.1]
27466
+ * [Api set: ExcelApi 1.17]
27251
27467
  */
27252
27468
  positionBefore: number;
27253
27469
  /**
27254
27470
  * The source of the event. It can be local or remote (through co-authoring).
27255
27471
  *
27256
27472
  * @remarks
27257
- * [Api set: ExcelApiOnline 1.1]
27473
+ * [Api set: ExcelApi 1.17]
27258
27474
  */
27259
27475
  source: Excel.EventSource | "Local" | "Remote";
27260
27476
  /**
27261
27477
  * Gets the type of the event.
27262
27478
  *
27263
27479
  * @remarks
27264
- * [Api set: ExcelApiOnline 1.1]
27480
+ * [Api set: ExcelApi 1.17]
27265
27481
  */
27266
27482
  type: string;
27267
27483
  /**
27268
27484
  * Gets the ID of the worksheet that was moved.
27269
27485
  *
27270
27486
  * @remarks
27271
- * [Api set: ExcelApiOnline 1.1]
27487
+ * [Api set: ExcelApi 1.17]
27272
27488
  */
27273
27489
  worksheetId: string;
27274
27490
  }
@@ -27276,42 +27492,42 @@ declare namespace Excel {
27276
27492
  * Provides information about the worksheet whose name has changed.
27277
27493
  *
27278
27494
  * @remarks
27279
- * [Api set: ExcelApiOnline 1.1]
27495
+ * [Api set: ExcelApi 1.17]
27280
27496
  */
27281
27497
  interface WorksheetNameChangedEventArgs {
27282
27498
  /**
27283
27499
  * Gets the new name of the worksheet, after the name change.
27284
27500
  *
27285
27501
  * @remarks
27286
- * [Api set: ExcelApiOnline 1.1]
27502
+ * [Api set: ExcelApi 1.17]
27287
27503
  */
27288
27504
  nameAfter: string;
27289
27505
  /**
27290
27506
  * Gets the previous name of the worksheet, before the name changed.
27291
27507
  *
27292
27508
  * @remarks
27293
- * [Api set: ExcelApiOnline 1.1]
27509
+ * [Api set: ExcelApi 1.17]
27294
27510
  */
27295
27511
  nameBefore: string;
27296
27512
  /**
27297
27513
  * The source of the event. It can be local or remote (through co-authoring).
27298
27514
  *
27299
27515
  * @remarks
27300
- * [Api set: ExcelApiOnline 1.1]
27516
+ * [Api set: ExcelApi 1.17]
27301
27517
  */
27302
27518
  source: Excel.EventSource | "Local" | "Remote";
27303
27519
  /**
27304
27520
  * Gets the type of the event.
27305
27521
  *
27306
27522
  * @remarks
27307
- * [Api set: ExcelApiOnline 1.1]
27523
+ * [Api set: ExcelApi 1.17]
27308
27524
  */
27309
27525
  type: string;
27310
27526
  /**
27311
27527
  * Gets the ID of the worksheet with the new name.
27312
27528
  *
27313
27529
  * @remarks
27314
- * [Api set: ExcelApiOnline 1.1]
27530
+ * [Api set: ExcelApi 1.17]
27315
27531
  */
27316
27532
  worksheetId: string;
27317
27533
  }
@@ -27319,42 +27535,42 @@ declare namespace Excel {
27319
27535
  * Provides information about the worksheet whose visibility has changed.
27320
27536
  *
27321
27537
  * @remarks
27322
- * [Api set: ExcelApiOnline 1.1]
27538
+ * [Api set: ExcelApi 1.17]
27323
27539
  */
27324
27540
  interface WorksheetVisibilityChangedEventArgs {
27325
27541
  /**
27326
27542
  * The source of the event. It can be local or remote (through co-authoring).
27327
27543
  *
27328
27544
  * @remarks
27329
- * [Api set: ExcelApiOnline 1.1]
27545
+ * [Api set: ExcelApi 1.17]
27330
27546
  */
27331
27547
  source: Excel.EventSource | "Local" | "Remote";
27332
27548
  /**
27333
27549
  * Gets the type of the event.
27334
27550
  *
27335
27551
  * @remarks
27336
- * [Api set: ExcelApiOnline 1.1]
27552
+ * [Api set: ExcelApi 1.17]
27337
27553
  */
27338
27554
  type: string;
27339
27555
  /**
27340
27556
  * Gets the new visibility setting of the worksheet, after the visibility change.
27341
27557
  *
27342
27558
  * @remarks
27343
- * [Api set: ExcelApiOnline 1.1]
27559
+ * [Api set: ExcelApi 1.17]
27344
27560
  */
27345
27561
  visibilityAfter: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
27346
27562
  /**
27347
27563
  * Gets the previous visibility setting of the worksheet, before the visibility change.
27348
27564
  *
27349
27565
  * @remarks
27350
- * [Api set: ExcelApiOnline 1.1]
27566
+ * [Api set: ExcelApi 1.17]
27351
27567
  */
27352
27568
  visibilityBefore: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
27353
27569
  /**
27354
27570
  * Gets the ID of the worksheet whose visibility has changed.
27355
27571
  *
27356
27572
  * @remarks
27357
- * [Api set: ExcelApiOnline 1.1]
27573
+ * [Api set: ExcelApi 1.17]
27358
27574
  */
27359
27575
  worksheetId: string;
27360
27576
  }
@@ -31827,6 +32043,15 @@ declare namespace Excel {
31827
32043
  * [Api set: ExcelApi 1.11]
31828
32044
  */
31829
32045
  readonly decimalSeparator: string;
32046
+ /**
32047
+ * Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.
32048
+ The stale formulas are rendered with stale formatting if the option is enabled.
32049
+ *
32050
+ * @remarks
32051
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
32052
+ * @beta
32053
+ */
32054
+ formatStaleValues: boolean;
31830
32055
  /**
31831
32056
  * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on the local Excel settings.
31832
32057
  *
@@ -32994,7 +33219,7 @@ declare namespace Excel {
32994
33219
  * Occurs when the worksheet name is changed.
32995
33220
  *
32996
33221
  * @remarks
32997
- * [Api set: ExcelApiOnline 1.1]
33222
+ * [Api set: ExcelApi 1.17]
32998
33223
  *
32999
33224
  * @eventproperty
33000
33225
  */
@@ -33052,7 +33277,7 @@ declare namespace Excel {
33052
33277
  * Occurs when the worksheet visibility is changed.
33053
33278
  *
33054
33279
  * @remarks
33055
- * [Api set: ExcelApiOnline 1.1]
33280
+ * [Api set: ExcelApi 1.17]
33056
33281
  *
33057
33282
  * @eventproperty
33058
33283
  */
@@ -33281,7 +33506,7 @@ declare namespace Excel {
33281
33506
  * Occurs when a worksheet is moved within a workbook. This event only triggers when a worksheet is directly moved within a workbook. This event doesn't trigger when the position of a worksheet is indirectly changed, such as when a new worksheet is inserted and causes existing worksheets to change positions.
33282
33507
  *
33283
33508
  * @remarks
33284
- * [Api set: ExcelApiOnline 1.1]
33509
+ * [Api set: ExcelApi 1.17]
33285
33510
  *
33286
33511
  * @eventproperty
33287
33512
  */
@@ -33290,7 +33515,7 @@ declare namespace Excel {
33290
33515
  * Occurs when the worksheet name is changed in the worksheet collection.
33291
33516
  *
33292
33517
  * @remarks
33293
- * [Api set: ExcelApiOnline 1.1]
33518
+ * [Api set: ExcelApi 1.17]
33294
33519
  *
33295
33520
  * @eventproperty
33296
33521
  */
@@ -33346,7 +33571,7 @@ declare namespace Excel {
33346
33571
  * Occurs when the worksheet visibility is changed in the worksheet collection.
33347
33572
  *
33348
33573
  * @remarks
33349
- * [Api set: ExcelApiOnline 1.1]
33574
+ * [Api set: ExcelApi 1.17]
33350
33575
  *
33351
33576
  * @eventproperty
33352
33577
  */
@@ -43769,8 +43994,7 @@ declare namespace Excel {
43769
43994
  * Gets the currency symbol for currency values. This is based on current system settings.
43770
43995
  *
43771
43996
  * @remarks
43772
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
43773
- * @beta
43997
+ * [Api set: ExcelApi 1.17]
43774
43998
  */
43775
43999
  readonly currencySymbol: string;
43776
44000
  /**
@@ -46807,8 +47031,7 @@ declare namespace Excel {
46807
47031
  * Change the conditional format rule type to cell value.
46808
47032
  *
46809
47033
  * @remarks
46810
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46811
- * @beta
47034
+ * [Api set: ExcelApi 1.17]
46812
47035
  *
46813
47036
  * @param properties The properties to set for the cell value conditional format rule.
46814
47037
  */
@@ -46817,16 +47040,14 @@ declare namespace Excel {
46817
47040
  * Change the conditional format rule type to color scale.
46818
47041
  *
46819
47042
  * @remarks
46820
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46821
- * @beta
47043
+ * [Api set: ExcelApi 1.17]
46822
47044
  */
46823
47045
  changeRuleToColorScale(): void;
46824
47046
  /**
46825
47047
  * Change the conditional format rule type to text comparison.
46826
47048
  *
46827
47049
  * @remarks
46828
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46829
- * @beta
47050
+ * [Api set: ExcelApi 1.17]
46830
47051
  *
46831
47052
  * @param properties The properties to set for the text comparison conditional format rule.
46832
47053
  */
@@ -46835,8 +47056,7 @@ declare namespace Excel {
46835
47056
  * Change the conditional format rule type to custom.
46836
47057
  *
46837
47058
  * @remarks
46838
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46839
- * @beta
47059
+ * [Api set: ExcelApi 1.17]
46840
47060
  *
46841
47061
  * @param formula The formula to set for the custom conditional format rule.
46842
47062
  */
@@ -46845,24 +47065,21 @@ declare namespace Excel {
46845
47065
  * Change the conditional format rule type to data bar.
46846
47066
  *
46847
47067
  * @remarks
46848
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46849
- * @beta
47068
+ * [Api set: ExcelApi 1.17]
46850
47069
  */
46851
47070
  changeRuleToDataBar(): void;
46852
47071
  /**
46853
47072
  * Change the conditional format rule type to icon set.
46854
47073
  *
46855
47074
  * @remarks
46856
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46857
- * @beta
47075
+ * [Api set: ExcelApi 1.17]
46858
47076
  */
46859
47077
  changeRuleToIconSet(): void;
46860
47078
  /**
46861
47079
  * Change the conditional format rule type to preset criteria.
46862
47080
  *
46863
47081
  * @remarks
46864
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46865
- * @beta
47082
+ * [Api set: ExcelApi 1.17]
46866
47083
  *
46867
47084
  * @param properties The properties to set for the preset criteria conditional format rule.
46868
47085
  */
@@ -46871,8 +47088,7 @@ declare namespace Excel {
46871
47088
  * Change the conditional format rule type to top/bottom.
46872
47089
  *
46873
47090
  * @remarks
46874
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46875
- * @beta
47091
+ * [Api set: ExcelApi 1.17]
46876
47092
  *
46877
47093
  * @param properties The properties to set for the top/bottom conditional format rule.
46878
47094
  */
@@ -46910,8 +47126,7 @@ declare namespace Excel {
46910
47126
  * Set the ranges that the conditonal format rule is applied to.
46911
47127
  *
46912
47128
  * @remarks
46913
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
46914
- * @beta
47129
+ * [Api set: ExcelApi 1.17]
46915
47130
  *
46916
47131
  * @param ranges Collection of one or more ranges for this rule to be applied to.
46917
47132
  */
@@ -47924,8 +48139,7 @@ declare namespace Excel {
47924
48139
  * Remove the format properties from a conditional format rule. This creates a rule with no format settings.
47925
48140
  *
47926
48141
  * @remarks
47927
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
47928
- * @beta
48142
+ * [Api set: ExcelApi 1.17]
47929
48143
  */
47930
48144
  clearFormat(): void;
47931
48145
  /**
@@ -63887,6 +64101,15 @@ declare namespace Excel {
63887
64101
  * [Api set: ExcelApi 1.1 for get, 1.8 for set]
63888
64102
  */
63889
64103
  calculationMode?: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";
64104
+ /**
64105
+ * Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.
64106
+ The stale formulas are rendered with stale formatting if the option is enabled.
64107
+ *
64108
+ * @remarks
64109
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64110
+ * @beta
64111
+ */
64112
+ formatStaleValues?: boolean;
63890
64113
  }
63891
64114
  /** An interface for updating data on the IterativeCalculation object, for use in `iterativeCalculation.set({ ... })`. */
63892
64115
  interface IterativeCalculationUpdateData {
@@ -69090,6 +69313,15 @@ declare namespace Excel {
69090
69313
  * [Api set: ExcelApi 1.11]
69091
69314
  */
69092
69315
  decimalSeparator?: string;
69316
+ /**
69317
+ * Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.
69318
+ The stale formulas are rendered with stale formatting if the option is enabled.
69319
+ *
69320
+ * @remarks
69321
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
69322
+ * @beta
69323
+ */
69324
+ formatStaleValues?: boolean;
69093
69325
  /**
69094
69326
  * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on the local Excel settings.
69095
69327
  *
@@ -73070,8 +73302,7 @@ declare namespace Excel {
73070
73302
  * Gets the currency symbol for currency values. This is based on current system settings.
73071
73303
  *
73072
73304
  * @remarks
73073
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
73074
- * @beta
73305
+ * [Api set: ExcelApi 1.17]
73075
73306
  */
73076
73307
  currencySymbol?: string;
73077
73308
  /**
@@ -76417,6 +76648,15 @@ declare namespace Excel {
76417
76648
  * [Api set: ExcelApi 1.11]
76418
76649
  */
76419
76650
  decimalSeparator?: boolean;
76651
+ /**
76652
+ * Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.
76653
+ The stale formulas are rendered with stale formatting if the option is enabled.
76654
+ *
76655
+ * @remarks
76656
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
76657
+ * @beta
76658
+ */
76659
+ formatStaleValues?: boolean;
76420
76660
  /**
76421
76661
  * Gets the string used to separate groups of digits to the left of the decimal for numeric values. This is based on the local Excel settings.
76422
76662
  *
@@ -82346,8 +82586,7 @@ declare namespace Excel {
82346
82586
  * Gets the currency symbol for currency values. This is based on current system settings.
82347
82587
  *
82348
82588
  * @remarks
82349
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
82350
- * @beta
82589
+ * [Api set: ExcelApi 1.17]
82351
82590
  */
82352
82591
  currencySymbol?: boolean;
82353
82592
  /**
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.379",
3
+ "version": "1.0.381",
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",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "f6cac7ee561007c280c025efc33c2f0947230ed1ea49bc5f69cc6c71913ba505",
48
+ "typesPublisherContentHash": "d9be09e80fb0b76b6836d314e2a69413acaea87d8081c47ec070b9f2a8f15b2b",
49
49
  "typeScriptVersion": "4.3"
50
50
  }