@types/office-js-preview 1.0.554 → 1.0.555

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: Wed, 05 Feb 2025 23:02:38 GMT
+ * Last updated: Fri, 07 Feb 2025 19:32:28 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -24276,8 +24276,9 @@ declare namespace Excel {
     /**
      * 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)]
-     * @beta
+     * 
+     * @remarks
+     * [Api set: ExcelApi 1.18]  
      */
     interface UnknownCellControl {
         type: CellControlType.unknown;
@@ -24285,8 +24286,9 @@ declare namespace Excel {
     /**
      * Represents an empty cell control.
      * This represents the state where a cell does not have a control.
-     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-     * @beta
+     * 
+     * @remarks
+     * [Api set: ExcelApi 1.18]  
      */
     interface EmptyCellControl {
         type: CellControlType.empty;
@@ -24294,25 +24296,28 @@ declare namespace Excel {
     /**
      * 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)]
-     * @beta
+     * 
+     * @remarks
+     * [Api set: ExcelApi 1.18]  
      */
     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)]
-    * @beta
-    */
+     * Represents a checkbox. This is a cell control that allows a user to toggle the boolean value in a cell.
+     * 
+     * @remarks
+     * [Api set: ExcelApi 1.18]  
+     */
     interface CheckboxCellControl {
         type: CellControlType.checkbox;
     }
     /**
-    * Represents an interactable control inside of a cell.
-    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-    * @beta
-    */
+     * Represents an interactable control inside of a cell.
+     * 
+     * @remarks
+     * [Api set: ExcelApi 1.18]  
+     */
     type CellControl = UnknownCellControl | EmptyCellControl | MixedCellControl | CheckboxCellControl;
     /**
      * Represents a 2D array of cell values.
@@ -32399,7 +32404,7 @@ declare namespace Excel {
         /**
         * Specifies whether to load on the `textRuns` property.
         *
-        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * [Api set: ExcelApi 1.18]  
         */
         textRuns?: boolean;
     }
@@ -32602,7 +32607,7 @@ declare namespace Excel {
         /**
         * Represents the `textRuns` property.
         *
-        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * [Api set: ExcelApi 1.18]  
         */
         textRuns?: RangeTextRun[];
     }
@@ -36509,39 +36514,41 @@ declare namespace Excel {
      * Represents the type of cell control.
      *
      * @remarks
-     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: ExcelApi 1.18]
      */
     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
+         * [Api set: ExcelApi 1.18]
          */
         unknown = "Unknown",
         /**
          * Type representing an empty control.
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         empty = "Empty",
         /**
          * Type representing a query that results in a mix of control results.
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         mixed = "Mixed",
         /**
          * Type representing a checkbox control.
          * @remarks
+         * [Api set: ExcelApi 1.18]
+         */
+        checkbox = "Checkbox",
+        /**
+         * Type representing a dropdown control.
+         * @remarks
          * [Api set: ExcelApi BETA (PREVIEW ONLY)]
          * @beta
          */
-        checkbox = "Checkbox"
+        dropdown = "Dropdown"
     }
     /**
      * Represents the direction that existing or remaining cells in a worksheet will shift when cells are inserted into or deleted from a worksheet.
@@ -38107,8 +38114,7 @@ declare namespace Excel {
          * Returns a collection of all the notes objects in the workbook.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         readonly notes: Excel.NoteCollection;
         /**
@@ -38634,8 +38640,7 @@ declare namespace Excel {
          * Returns a collection of all the notes objects in the worksheet.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         readonly notes: Excel.NoteCollection;
         /**
@@ -39892,8 +39897,7 @@ declare namespace Excel {
                     If the range has multiple cell controls, this returns `EmptyCellControl`.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         control: CellControl;
         /**
@@ -40158,8 +40162,7 @@ declare namespace Excel {
                     Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the range.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         clearOrResetContents(): void;
         /**
@@ -41087,8 +41090,7 @@ declare namespace Excel {
                     Otherwise, this sets the cells with controls to their default value and clears the values of the other cells in the ranges.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         clearOrResetContents(): void;
         /**
@@ -41253,8 +41255,7 @@ declare namespace Excel {
          * Selects the specified range areas in the Excel UI.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         select(): void;
         /**
@@ -41620,12 +41621,25 @@ declare namespace Excel {
         weight?: boolean;
     }
     /**
+     * Represents a sequence of one or more characters that share the same font attributes in a cell. Can be used as the `textRuns` properties of `getCellProperties` or the `textRuns` input parameter of `setCellProperties`.
+     * 
      * @remarks
-     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: ExcelApi 1.18]
      */
     interface RangeTextRun {
+        /**
+         * The font attributes (such as font name, font size, and color) applied to this text run.
+         * 
+         * @remarks
+         * [Api set: ExcelApi 1.18]
+         */
         font?: Excel.CellPropertiesFont;
+        /**
+         * The text of this text run.
+         * 
+         * @remarks
+         * [Api set: ExcelApi 1.18]
+         */        
         text: string;
     }
     /**
@@ -61268,8 +61282,7 @@ declare namespace Excel {
                     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
+         * [Api set: ExcelApi 1.18]
          */
         resetContents = "ResetContents"
     }
@@ -66128,8 +66141,7 @@ declare namespace Excel {
      * Represents a collection of note objects that are part of the workbook.
      *
      * @remarks
-     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: ExcelApi 1.18]
      */
     class NoteCollection extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -66140,8 +66152,7 @@ declare namespace Excel {
          * Adds a new note with the given content on the given cell.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          *
          * @param cellAddress The cell to which the note is added. This can be a `Range` object or a string such as "A1". If the string is invalid, or the range is not a single cell, an `InvalidCellAddress` error is thrown.
          * @param content The text of the note.
@@ -66151,20 +66162,38 @@ declare namespace Excel {
          * Gets the number of notes in the collection.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         getCount(): OfficeExtension.ClientResult<number>;
         /**
-         * Gets a note object by its index in the collection.
+         * Gets a note by its cell address.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
+         *
+         * @param key The cell address of the note.
+         * @returns The note with the given cell address. If there is no note with the given cell address, then the `ItemNotFound` error is thrown.
+         */
+        getItem(key: string): Excel.Note;
+        /**
+         * Gets a note from the collection based on its position.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.18]
          *
          * @param index The index value of the note to be retrieved. Zero-indexed.
          */
         getItemAt(index: number): Excel.Note;
+        /**
+         * Gets a note by its cell address. If the note object does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties  | *OrNullObject methods and properties}.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.18]
+         *
+         * @param key The cell address of the note.
+         * @returns The note with the given cell address or null object.
+         */
+        getItemOrNullObject(key: string): Excel.Note;
         /**
          * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
          *
@@ -66193,8 +66222,7 @@ declare namespace Excel {
      * Represents a note in the workbook or worksheet.
      *
      * @remarks
-     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: ExcelApi 1.18]
      */
     class Note extends OfficeExtension.ClientObject {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -66203,40 +66231,35 @@ declare namespace Excel {
          * Gets the author of the note.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         readonly authorName: string;
         /**
-         * Gets or sets the text of the note. The string must be fewer than 256 characters.
+         * Gets or sets the text of the note.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         content: string;
         /**
          * Specifies the height of the note.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         height: number;
         /**
          * Specifies the visibility of the note. A value of `true` means the note is shown.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         visible: boolean;
         /**
          * Specifies the width of the note.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         width: number;
         /**
@@ -66251,16 +66274,14 @@ declare namespace Excel {
          * Deletes the note.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         delete(): void;
         /**
          * Gets the cell where this note is located.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         getLocation(): Excel.Range;
         /**
@@ -70448,8 +70469,7 @@ declare namespace Excel {
                         If the range has multiple cell controls, this returns `EmptyCellControl`.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             control?: CellControl;
             /**
@@ -75144,35 +75164,31 @@ declare namespace Excel {
         /** An interface for updating data on the `Note` object, for use in `note.set({ ... })`. */
         interface NoteUpdateData {
             /**
-             * Gets or sets the text of the note. The string must be fewer than 256 characters.
+             * Gets or sets the text of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             content?: string;
             /**
              * Specifies the height of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             height?: number;
             /**
              * Specifies the visibility of the note. A value of `true` means the note is shown.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             visible?: boolean;
             /**
              * Specifies the width of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             width?: number;
         }
@@ -75607,8 +75623,7 @@ declare namespace Excel {
             * Returns a collection of all the notes objects in the workbook.
             *
             * @remarks
-            * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-            * @beta
+            * [Api set: ExcelApi 1.18]
             */
             notes?: Excel.Interfaces.NoteData[];
             /**
@@ -75841,8 +75856,7 @@ declare namespace Excel {
             * Returns a collection of all the notes objects in the worksheet.
             *
             * @remarks
-            * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-            * @beta
+            * [Api set: ExcelApi 1.18]
             */
             notes?: Excel.Interfaces.NoteData[];
             /**
@@ -76104,8 +76118,7 @@ declare namespace Excel {
                         If the range has multiple cell controls, this returns `EmptyCellControl`.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             control?: CellControl;
             /**
@@ -82164,40 +82177,35 @@ declare namespace Excel {
              * Gets the author of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             authorName?: string;
             /**
-             * Gets or sets the text of the note. The string must be fewer than 256 characters.
+             * Gets or sets the text of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             content?: string;
             /**
              * Specifies the height of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             height?: number;
             /**
              * Specifies the visibility of the note. A value of `true` means the note is shown.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             visible?: boolean;
             /**
              * Specifies the width of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             width?: number;
         }
@@ -83558,8 +83566,7 @@ declare namespace Excel {
                         If the range has multiple cell controls, this returns `EmptyCellControl`.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             control?: boolean;
             /**
@@ -91890,8 +91897,7 @@ declare namespace Excel {
                         If the range has multiple cell controls, this returns `EmptyCellControl`.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             control?: boolean;
             /**
@@ -94035,8 +94041,7 @@ declare namespace Excel {
          * Represents a collection of note objects that are part of the workbook.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         interface NoteCollectionLoadOptions {
             /**
@@ -94047,40 +94052,35 @@ declare namespace Excel {
              * For EACH ITEM in the collection: Gets the author of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             authorName?: boolean;
             /**
-             * For EACH ITEM in the collection: Gets or sets the text of the note. The string must be fewer than 256 characters.
+             * For EACH ITEM in the collection: Gets or sets the text of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             content?: boolean;
             /**
              * For EACH ITEM in the collection: Specifies the height of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             height?: boolean;
             /**
              * For EACH ITEM in the collection: Specifies the visibility of the note. A value of `true` means the note is shown.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             visible?: boolean;
             /**
              * For EACH ITEM in the collection: Specifies the width of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             width?: boolean;
         }
@@ -94088,8 +94088,7 @@ declare namespace Excel {
          * Represents a note in the workbook or worksheet.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.18]
          */
         interface NoteLoadOptions {
             /**
@@ -94100,40 +94099,35 @@ declare namespace Excel {
              * Gets the author of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             authorName?: boolean;
             /**
-             * Gets or sets the text of the note. The string must be fewer than 256 characters.
+             * Gets or sets the text of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             content?: boolean;
             /**
              * Specifies the height of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             height?: boolean;
             /**
              * Specifies the visibility of the note. A value of `true` means the note is shown.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             visible?: boolean;
             /**
              * Specifies the width of the note.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.18]
              */
             width?: boolean;
         }

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.554",
+    "version": "1.0.555",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -46,7 +46,7 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "8e374d2438112f99d6d8f4e84a978d51d22c77093b103c3289efdff1bb1aaf2e",
+    "typesPublisherContentHash": "f812a3a4625066ccd93204cb30dcbd4c8a8e243f2408fb30a479e9173b8af266",
     "typeScriptVersion": "5.0",
     "nonNpm": true
 }