@types/office-js-preview 1.0.380 → 1.0.381

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Thu, 13 Apr 2023 21:02:45 GMT
+ * Last updated: Mon, 17 Apr 2023 19:02:43 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -19968,6 +19968,56 @@ declare namespace Excel {
         referencedValues?: ReferencedValue[];
     }
     /**
+    * The base64 encoding type and data of an image.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    interface Base64EncodedImage {
+        /**
+        * The file type of the encoded image.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        type: Base64EncodingType | "JPG" | "PNG";
+        /**
+        * The base64 string encoding.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        data: string;
+    }
+    /**
+    * The file type represented by the base64 encoding.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    enum Base64EncodingType {
+        /**
+        * The JPG file type.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        JPG = "JPG",
+        /**
+        * The PNG file type.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        PNG = "PNG"
+    }
+    /**
     * Represents a card layout that is best used for an array.
     *
     * @remarks
@@ -24570,6 +24620,13 @@ declare namespace Excel {
         */
         linkedEntity = "LinkedEntity",
         /**
+        * Represents a `LocalImageCellValue`.
+        *
+        * @remarks
+        * [Api set: ExcelApi 1.16]
+        */
+        localImage = "LocalImage",
+        /**
         * Represents a `ReferenceCellValue`.
         *
         * @remarks
@@ -24604,7 +24661,7 @@ declare namespace Excel {
     * @remarks
     * [Api set: ExcelApi 1.16]
     */
-    type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
+    type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | LocalImageCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
     /**
     * 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.
     *
@@ -25425,7 +25482,14 @@ declare namespace Excel {
         * @remarks
         * [Api set: ExcelApi 1.16]
         */
-        dataProviderError = "DataProviderError"
+        dataProviderError = "DataProviderError",
+        /**
+        * 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.
+        *
+        * @remarks
+        * [Api set: 1.16]
+        */
+        richValueRelMissingFilePart = "RichValueRelMissingFilePart"
     }
     /**
     * Represents the value of a cell containing a #FIELD! error.
@@ -25470,7 +25534,7 @@ declare namespace Excel {
         * @remarks
         * [Api set: ExcelApi 1.16]
         */
-        errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError";
+        errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError" | "RichValueRelMissingFilePart";
         /**
         * Represents the field which was not found by FIELDVALUE.
         *
@@ -25666,6 +25730,88 @@ declare namespace Excel {
         provider?: CellValueProviderAttributes;
     }
     /**
+    * Represents the value of a cell containing a locally stored or generated image.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    interface LocalImageCellValue {
+        /**
+        * Represents the type of this cell value.
+        *
+        * @remarks
+        * [Api set: ExcelApi 1.16]
+        */
+        type: CellValueType.localImage | "LocalImage";
+        /**
+        * Represents the value that would be returned by `Range.values` for a cell with this value.
+        * When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
+        * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
+        *
+        * @remarks
+        * [Api set: ExcelApi 1.16]
+        */
+        basicValue?: "#VALUE!" | string;
+        /**
+        * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
+        *
+        * @remarks
+        * [Api set: ExcelApi 1.16]
+        */
+        basicType?: RangeValueType.error | "Error";
+        /**
+        * Represents the image itself, either cached or encoded.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        image: LocalImageCellValueCacheId | Base64EncodedImage;
+        /**
+        * Represents the alternate text used in accessibility scenarios to describe what the image represents.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        altText?: string;
+        /**
+        * Represents attribution information to describe the source and license requirements for this image.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        attribution?: CellValueAttributionAttributes[];
+        /**
+        * Represents information that describes the entity or individual who provided the image.
+        * This information is used for branding purposes in image cards.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        provider?: CellValueProviderAttributes;
+    }
+    /**
+    * The UID of a previously cached image.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    interface LocalImageCellValueCacheId {
+        /**
+        * Represents the image's UID as it appears in the cache.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        cacheUid: string;
+    }
+    /**
     * Represents the value of a cell containing a #N/A! error.
     *
     * @remarks
@@ -27303,42 +27449,42 @@ declare namespace Excel {
                  as a result of that primary move.
      *
      * @remarks
-     * [Api set: ExcelApiOnline 1.1]
+     * [Api set: ExcelApi 1.17]
      */
     interface WorksheetMovedEventArgs {
         /**
          * Gets the new position of the worksheet, after the move.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         positionAfter: number;
         /**
          * Gets the previous position of the worksheet, prior to the move.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         positionBefore: number;
         /**
          * The source of the event. It can be local or remote (through co-authoring).
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         source: Excel.EventSource | "Local" | "Remote";
         /**
          * Gets the type of the event.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         type: string;
         /**
          * Gets the ID of the worksheet that was moved.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         worksheetId: string;
     }
@@ -27346,42 +27492,42 @@ declare namespace Excel {
      * Provides information about the worksheet whose name has changed.
      *
      * @remarks
-     * [Api set: ExcelApiOnline 1.1]
+     * [Api set: ExcelApi 1.17]
      */
     interface WorksheetNameChangedEventArgs {
         /**
          * Gets the new name of the worksheet, after the name change.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         nameAfter: string;
         /**
          * Gets the previous name of the worksheet, before the name changed.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         nameBefore: string;
         /**
          * The source of the event. It can be local or remote (through co-authoring).
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         source: Excel.EventSource | "Local" | "Remote";
         /**
          * Gets the type of the event.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         type: string;
         /**
          * Gets the ID of the worksheet with the new name.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         worksheetId: string;
     }
@@ -27389,42 +27535,42 @@ declare namespace Excel {
      * Provides information about the worksheet whose visibility has changed.
      *
      * @remarks
-     * [Api set: ExcelApiOnline 1.1]
+     * [Api set: ExcelApi 1.17]
      */
     interface WorksheetVisibilityChangedEventArgs {
         /**
          * The source of the event. It can be local or remote (through co-authoring).
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         source: Excel.EventSource | "Local" | "Remote";
         /**
          * Gets the type of the event.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         type: string;
         /**
          * Gets the new visibility setting of the worksheet, after the visibility change.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         visibilityAfter: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
         /**
          * Gets the previous visibility setting of the worksheet, before the visibility change.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         visibilityBefore: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
         /**
          * Gets the ID of the worksheet whose visibility has changed.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         worksheetId: string;
     }
@@ -31897,6 +32043,15 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.11]
          */
         readonly decimalSeparator: string;
+        /**
+         * Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.
+                    The stale formulas are rendered with stale formatting if the option is enabled.
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        formatStaleValues: boolean;
         /**
          * 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.
          *
@@ -33064,7 +33219,7 @@ declare namespace Excel {
          * Occurs when the worksheet name is changed.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -33122,7 +33277,7 @@ declare namespace Excel {
          * Occurs when the worksheet visibility is changed.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -33351,7 +33506,7 @@ declare namespace Excel {
          * 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.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -33360,7 +33515,7 @@ declare namespace Excel {
          * Occurs when the worksheet name is changed in the worksheet collection.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -33416,7 +33571,7 @@ declare namespace Excel {
          * Occurs when the worksheet visibility is changed in the worksheet collection.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -43839,8 +43994,7 @@ declare namespace Excel {
          * Gets the currency symbol for currency values. This is based on current system settings.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          */
         readonly currencySymbol: string;
         /**
@@ -46877,8 +47031,7 @@ declare namespace Excel {
          * Change the conditional format rule type to cell value.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          *
          * @param properties The properties to set for the cell value conditional format rule.
          */
@@ -46887,16 +47040,14 @@ declare namespace Excel {
          * Change the conditional format rule type to color scale.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          */
         changeRuleToColorScale(): void;
         /**
          * Change the conditional format rule type to text comparison.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          *
          * @param properties The properties to set for the text comparison conditional format rule.
          */
@@ -46905,8 +47056,7 @@ declare namespace Excel {
          * Change the conditional format rule type to custom.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          *
          * @param formula The formula to set for the custom conditional format rule.
          */
@@ -46915,24 +47065,21 @@ declare namespace Excel {
          * Change the conditional format rule type to data bar.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          */
         changeRuleToDataBar(): void;
         /**
          * Change the conditional format rule type to icon set.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          */
         changeRuleToIconSet(): void;
         /**
          * Change the conditional format rule type to preset criteria.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          *
          * @param properties The properties to set for the preset criteria conditional format rule.
          */
@@ -46941,8 +47088,7 @@ declare namespace Excel {
          * Change the conditional format rule type to top/bottom.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          *
          * @param properties The properties to set for the top/bottom conditional format rule.
          */
@@ -46980,8 +47126,7 @@ declare namespace Excel {
          * Set the ranges that the conditonal format rule is applied to.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          *
          * @param ranges Collection of one or more ranges for this rule to be applied to.
          */
@@ -47994,8 +48139,7 @@ declare namespace Excel {
          * Remove the format properties from a conditional format rule. This creates a rule with no format settings.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.17]
          */
         clearFormat(): void;
         /**
@@ -63957,6 +64101,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.1 for get, 1.8 for set]
              */
             calculationMode?: Excel.CalculationMode | "Automatic" | "AutomaticExceptTables" | "Manual";
+            /**
+             * Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.
+                        The stale formulas are rendered with stale formatting if the option is enabled.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            formatStaleValues?: boolean;
         }
         /** An interface for updating data on the IterativeCalculation object, for use in `iterativeCalculation.set({ ... })`. */
         interface IterativeCalculationUpdateData {
@@ -69160,6 +69313,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.11]
              */
             decimalSeparator?: string;
+            /**
+             * Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.
+                        The stale formulas are rendered with stale formatting if the option is enabled.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            formatStaleValues?: boolean;
             /**
              * 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.
              *
@@ -73140,8 +73302,7 @@ declare namespace Excel {
              * Gets the currency symbol for currency values. This is based on current system settings.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.17]
              */
             currencySymbol?: string;
             /**
@@ -76487,6 +76648,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.11]
              */
             decimalSeparator?: boolean;
+            /**
+             * Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.
+                        The stale formulas are rendered with stale formatting if the option is enabled.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            formatStaleValues?: boolean;
             /**
              * 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.
              *
@@ -82416,8 +82586,7 @@ declare namespace Excel {
              * Gets the currency symbol for currency values. This is based on current system settings.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.17]
              */
             currencySymbol?: boolean;
             /**

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.380",
+    "version": "1.0.381",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "256759ce6cef15e36020eb5124f084d7a54c3f18f30c143e4e77839603252776",
+    "typesPublisherContentHash": "d9be09e80fb0b76b6836d314e2a69413acaea87d8081c47ec070b9f2a8f15b2b",
     "typeScriptVersion": "4.3"
 }