@types/office-js-preview 1.0.474 → 1.0.475

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Fri, 24 May 2024 23:36:04 GMT
+ * Last updated: Fri, 31 May 2024 21:07:10 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -21672,6 +21672,65 @@ declare namespace OfficeCore {
 
 
 declare namespace Excel {
+    /**
+     * Represents the type of cell control.
+     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+     */
+    enum CellControlType {
+        /**
+         * Type representing an unknown control.
+         * This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
+         */
+        Unknown = 0,
+        /**
+         * Type representing an empty control.
+         */
+        Empty = 1,
+        /**
+         * Type representing a query that results in a mix of control results.
+         */
+        Mixed = 2,
+        /**
+         * Type representing a checkbox control.
+         */
+        Checkbox = 3
+    }
+    /**
+     * Represents an unknown cell control.
+     * This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
+     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+     */
+    interface UnknownCellControl {
+        type: CellControlType.Unknown;
+    }
+    /**
+     * Represents an empty cell control.
+     * This represents the state where a cell does not have a control.
+     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+     */
+    interface EmptyCellControl {
+        type: CellControlType.Empty;
+    }
+    /**
+     * Represents the result of a query that resulted in multiple cell controls.
+     * If the result has multiple controls, then they can't be represented as a single result.
+     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+     */
+    interface MixedCellControl {
+        type: CellControlType.Mixed;
+    }
+    /**
+    * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    */
+    interface CheckboxCellControl {
+        type: CellControlType.Checkbox;
+    }
+    /**
+    * Represents an interactable control inside of a cell.
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    */
+    type CellControl = UnknownCellControl | EmptyCellControl | MixedCellControl | CheckboxCellControl;
     /**
     * Represents a 2D array of cell values.
     *
@@ -27632,7 +27691,8 @@ declare namespace Excel {
         * Represents the type of this cell value.
         *
         * @remarks
-        * [Api set: ExcelApi 1.16]
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         type: CellValueType.localImage | "LocalImage";
         /**
@@ -27641,14 +27701,16 @@ declare namespace Excel {
         * When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
         *
         * @remarks
-        * [Api set: ExcelApi 1.16]
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         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]
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         basicType?: RangeValueType.error | "Error";
         /**
@@ -29187,6 +29249,35 @@ declare namespace Excel {
     function run<T>(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;
     function postprocessBindingDescriptor(response: any): any;
     function getDataCommonPostprocess(response: any, callArgs: any): any;
+    /**
+     * Provides information about the local image.
+     *
+     * @remarks
+     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+     * @beta
+     */
+    class LocalImage extends OfficeExtension.ClientObject {
+        /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
+        context: RequestContext;
+        /**
+         * Gets the base64-encoded image data stored in the shared image cache with the cache unique identifier (UID).
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param cacheUid Represents the unique identifier (UID) of the image as it appears in the cache. The cache UID can be obtained from JSON representation of the values in the cell.
+         * @returns The base64-encoded image data.
+         */
+        getBase64EncodedImageData(cacheUid: string): OfficeExtension.ClientResult<string>;
+        /**
+        * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
+        * Whereas the original Excel.LocalImage object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.LocalImageData`) that contains shallow copies of any loaded child properties from the original object.
+        */
+        toJSON(): {
+            [key: string]: string;
+        };
+    }
     /**
      * Represents an `AllowEditRange` object found in a worksheet. This object works with worksheet protection properties.
                 When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
@@ -30053,7 +30144,7 @@ declare namespace Excel {
          */
         readonly changedBy: Excel.EmailIdentity;
         /**
-         * Represents the ID of the `comment` or `commentReply` to which the task change is anchored.
+         * Represents the ID of the comment or comment reply to which the task change is anchored.
          *
          * @remarks
          * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -32607,6 +32698,44 @@ declare namespace Excel {
          */
         type: "WorkbookAutoSaveSettingChanged";
     }
+    /**
+     * Represents the type of cell control.
+     *
+     * @remarks
+     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+     * @beta
+     */
+    enum CellControlType {
+        /**
+         * Type representing an unknown control.
+                    This represents a control that was added in a future version of Excel, and the current version of Excel doesn't know how to display this control.
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        unknown = "Unknown",
+        /**
+         * Type representing an empty control.
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        empty = "Empty",
+        /**
+         * Type representing a query that results in a mix of control results.
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        mixed = "Mixed",
+        /**
+         * Type representing a checkbox control.
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        checkbox = "Checkbox"
+    }
     /**
      * Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet.
      *
@@ -34152,6 +34281,14 @@ declare namespace Excel {
          * [Api set: ExcelApiOnline 1.1]
          */
         readonly linkedWorkbooks: Excel.LinkedWorkbookCollection;
+        /**
+         * Returns the `LocalImage` object associated with the workbook.
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        readonly localImage: Excel.LocalImage;
         /**
          * Represents a collection of workbook-scoped named items (named ranges and constants).
          *
@@ -34538,7 +34675,7 @@ declare namespace Excel {
          */
         readonly protected: boolean;
         /**
-         * Protects a workbook. Fails if the workbook has been protected.
+         * Protects the workbook. Fails if the workbook has been protected.
          *
          * @remarks
          * [Api set: ExcelApi 1.7]
@@ -34547,7 +34684,7 @@ declare namespace Excel {
          */
         protect(password?: string): void;
         /**
-         * Unprotects a workbook.
+         * Unprotects the workbook.
          *
          * @remarks
          * [Api set: ExcelApi 1.7]
@@ -34751,7 +34888,7 @@ declare namespace Excel {
          */
         readonly id: string;
         /**
-         * The display name of the worksheet.
+         * The display name of the worksheet. The name must be fewer than 32 characters.
          *
          * @remarks
          * [Api set: ExcelApi 1.1]
@@ -35927,6 +36064,15 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.1]
          */
         readonly columnIndex: number;
+        /**
+         * Accesses the cell control applied to this range.
+                    If the range has multiple cell controls, this returns `EmptyCellControl`.
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        control: CellControl;
         /**
          * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
          *
@@ -36355,6 +36501,7 @@ declare namespace Excel {
         getColumnsBefore(count?: number): Excel.Range;
         /**
          * Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.
+         * Note: This API returns an `ItemNotFound` error if no dependents are found.
          *
          * @remarks
          * [Api set: ExcelApi 1.15]
@@ -36362,6 +36509,7 @@ declare namespace Excel {
         getDependents(): Excel.WorkbookRangeAreas;
         /**
          * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.
+         * Note: This API returns an `ItemNotFound` error if no dependents are found.
          *
          * @remarks
          * [Api set: ExcelApi 1.13]
@@ -36369,6 +36517,7 @@ declare namespace Excel {
         getDirectDependents(): Excel.WorkbookRangeAreas;
         /**
          * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.
+         * Note: This API returns an `ItemNotFound` error if no precedents are found. 
          *
          * @remarks
          * [Api set: ExcelApi 1.12]
@@ -36486,6 +36635,7 @@ declare namespace Excel {
         getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;
         /**
          * Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.
+         * Note: This API returns an `ItemNotFound` error if no precedents are found. 
          *
          * @remarks
          * [Api set: ExcelApi 1.14]
@@ -36780,6 +36930,16 @@ declare namespace Excel {
          * @returns The number of replacements performed.
          */
         replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;
+        /**
+         * Sets all cells in the range to their default state.
+                    Cells with cell controls are set to the default value defined by each control.
+                    Cells without cell controls are set to blank.
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        resetContent(): void;
         /**
          * Selects the specified range in the Excel UI.
          *
@@ -44217,6 +44377,13 @@ declare namespace Excel {
          * @param color HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
          */
         setSolidColor(color: string): void;
+        /**
+        * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
+        * Whereas the original Excel.ChartFill object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartFillData`) that contains shallow copies of any loaded child properties from the original object.
+        */
+        toJSON(): {
+            [key: string]: string;
+        };
     }
     /**
      * Represents the border formatting of a chart element.
@@ -52788,6 +52955,17 @@ declare namespace Excel {
          * @param connectorType Represents the connector type. See `Excel.ConnectorType` for details.
          */
         addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: "Straight" | "Elbow" | "Curve"): Excel.Shape;
+        /**
+         * Creates a reference for the local image stored in the cell address and displays it as a floating shape over cells.
+         *
+         * @remarks
+         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param address The address of the cell that contains the local image.
+         * @returns The `Shape` object associated with the floating shape.
+         */
+        addLocalImageReference(address: string): Excel.Shape;
         /**
          * Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet. Returns a `Shape` object that represents the new image.
          *
@@ -59218,7 +59396,7 @@ declare namespace Excel {
          * @remarks
          * [Api set: ExcelApi 1.7]
          */
-        workbookNavigationObjectChanged = "WorkbookNavigationObjectChanged",
+        lineageActivityUpdateAvailable = "LineageActivityUpdateAvailable",
         /**
          * WorksheetRowHeightChanged represents the type of event registered when the height of a worksheet row is changed.
          * @remarks
@@ -66145,7 +66323,7 @@ declare namespace Excel {
              */
             enableCalculation?: boolean;
             /**
-             * The display name of the worksheet.
+             * The display name of the worksheet. The name must be fewer than 32 characters.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -66224,6 +66402,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.2]
              */
             columnHidden?: boolean;
+            /**
+             * Accesses the cell control applied to this range.
+                        If the range has multiple cell controls, this returns `EmptyCellControl`.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            control?: CellControl;
             /**
              * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
              *
@@ -71026,7 +71213,7 @@ declare namespace Excel {
              */
             changedBy?: Excel.EmailIdentity;
             /**
-             * Represents the ID of the `Comment` or `CommentReply` to which the task change is anchored.
+             * Represents the ID of the comment or comment reply to which the task change is anchored.
              *
              * @remarks
              * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71627,7 +71814,7 @@ declare namespace Excel {
              */
             id?: string;
             /**
-             * The display name of the worksheet.
+             * The display name of the worksheet. The name must be fewer than 32 characters.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -71816,6 +72003,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.1]
              */
             columnIndex?: number;
+            /**
+             * Accesses the cell control applied to this range.
+                        If the range has multiple cell controls, this returns `EmptyCellControl`.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            control?: CellControl;
             /**
              * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
              *
@@ -78130,7 +78326,7 @@ declare namespace Excel {
              */
             changedBy?: boolean;
             /**
-             * Represents the ID of the `comment` or `commentReply` to which the task change is anchored.
+             * Represents the ID of the comment or comment reply to which the task change is anchored.
              *
              * @remarks
              * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -78243,7 +78439,7 @@ declare namespace Excel {
              */
             changedBy?: boolean;
             /**
-             * For EACH ITEM in the collection: Represents the ID of the `comment` or `commentReply` to which the task change is anchored.
+             * For EACH ITEM in the collection: Represents the ID of the comment or comment reply to which the task change is anchored.
              *
              * @remarks
              * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -78882,7 +79078,7 @@ declare namespace Excel {
              */
             id?: boolean;
             /**
-             * The display name of the worksheet.
+             * The display name of the worksheet. The name must be fewer than 32 characters.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -79010,7 +79206,7 @@ declare namespace Excel {
              */
             id?: boolean;
             /**
-             * For EACH ITEM in the collection: The display name of the worksheet.
+             * For EACH ITEM in the collection: The display name of the worksheet. The name must be fewer than 32 characters.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -79206,6 +79402,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.1]
              */
             columnIndex?: boolean;
+            /**
+             * Accesses the cell control applied to this range.
+                        If the range has multiple cell controls, this returns `EmptyCellControl`.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            control?: boolean;
             /**
              * Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
              *
@@ -87521,6 +87726,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.1]
              */
             columnIndex?: boolean;
+            /**
+             * For EACH ITEM in the collection: Accesses the cell control applied to this range.
+                        If the range has multiple cell controls, this returns `EmptyCellControl`.
+             *
+             * @remarks
+             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            control?: boolean;
             /**
              * For EACH ITEM in the collection: Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
              *

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.474",
+    "version": "1.0.475",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -45,7 +45,7 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "207a31d6442f7bde128055760e127aa9ee6b52918cb1c8b65b88835c47b425ce",
+    "typesPublisherContentHash": "a51479e683c9cbb0179ba6026a0cd9e3649da1c1a42f6dc37a75b72d2375f370",
     "typeScriptVersion": "4.7",
     "nonNpm": true
 }