@types/office-js-preview 1.0.278 → 1.0.279

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: Wed, 05 Jan 2022 00:01:28 GMT
+ * Last updated: Thu, 13 Jan 2022 20:01:40 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -19741,7 +19741,9 @@ declare namespace Excel {
         /**
         * Represents a `LinkedEntityCellValue`.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         linkedEntity = "LinkedEntity",
         /**
@@ -19856,6 +19858,56 @@ declare namespace Excel {
         licenseText?: string;
     }
     /**
+    * Represents the value of a cell containing a #BUSY! error.
+    * This type of error is used as a placeholder while the value of a cell is downloaded.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    interface PlaceholderErrorCellValue {
+        /**
+        * Represents the type of this cell value.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        type: CellValueType.error | "Error";
+        /**
+        * Represents the value that would be returned by `Range.values` for a cell with this value.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        basicValue?: "#BUSY!";
+        /**
+        * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        basicType?: RangeValueType.error | "Error";
+        /**
+        * Represents the type of `ErrorCellValue`.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        errorType?: ErrorCellValueType.placeholder | "Placeholder";
+        /**
+        * `PlaceholderErrorCellValue` is used during processing, while data is downloaded. The `target` property represents the data that is downloading, the data for which the `PlaceholderErrorCellValue` object is a placeholder.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        target: LinkedEntityCellValue | WebImageCellValue;
+    }
+    /**
     * The provider attributes object represents the set of details used in card view to provide specified branding information for a `CellValue` type that supports provider attributes.
     *
     * @remarks
@@ -20446,6 +20498,14 @@ declare namespace Excel {
         */
         num = "Num",
         /**
+        * Represents a `PlaceholderErrorCellValue`.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        placeholder = "Placeholder",
+        /**
         * Represents a `RefErrorCellValue`.
         *
         * @remarks
@@ -20477,7 +20537,7 @@ declare namespace Excel {
     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
     * @beta
     */
-    type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
+    type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | PlaceholderErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
     /**
     * Represents types of #FIELD! errors.
     *
@@ -20647,74 +20707,98 @@ declare namespace Excel {
     /**
     * The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value.
     *
+    * @remarks
     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
     */
-     interface LinkedEntityId {
+    interface LinkedEntityId {
         /**
         * Represents which service was used to create the `CellValue`.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         serviceId: number;
         /**
         * Represents a domain specific to a service used to create the `CellValue`.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         domainId?: string;
         /**
         * Represents an identifier specific to a service used to create the `CellValue`.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         entityId: string;
         /**
         * Represents which language culture was used to create this `CellValue`.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         culture: string;
     }
     /**
     * Represents a value whose properties derive from a service.
     *
+    * @remarks
     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
     */
     interface LinkedEntityCellValue {
         /**
         * Represents the type of this cell value.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         type: CellValueType.linkedEntity | "LinkedEntity";
         /**
         * Represents the value that would be returned by `Range.values` for a cell with this value.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         basicValue?: "#VALUE!";
         /**
         * Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         basicType?: RangeValueType.error | "Error";
         /**
         * Represents the service source that provided the information in this value.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         id: LinkedEntityId;
         /**
         * Represents the text shown when a cell with this value is rendered.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         text?: string;
         /**
         * Represents the properties of this entity and their metadata.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         properties?: {
             [key: string]: CellValue & {
@@ -20725,7 +20809,9 @@ declare namespace Excel {
         * Represents information that describes the service which provided the image.
         * This information can be used for branding in entity cards.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         provider?: CellValueProviderAttributes;
     }
@@ -20984,13 +21070,17 @@ declare namespace Excel {
         /**
         * An error caused by structured references from the linked workbook. Displays as error type #REF! in Excel.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         externalLinksStructuredRef = "ExternalLinksStructuredRef",
         /**
         * An error caused by dynamic array references from the linked workbook. Displays as error type #REF! in Excel.
         *
+        * @remarks
         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
         */
         externalLinksArrayRef = "ExternalLinksArrayRef"
     }
@@ -22244,7 +22334,8 @@ declare namespace Excel {
     function postprocessBindingDescriptor(response: any): any;
     function getDataCommonPostprocess(response: any, callArgs: any): any;
     /**
-     * Represents an `AllowEditRange` object found in a worksheet.
+     * 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.
      *
      * @remarks
      * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -22354,7 +22445,8 @@ declare namespace Excel {
         toJSON(): Excel.Interfaces.AllowEditRangeData;
     }
     /**
-     * Represents the set of `AllowEditRange` objects found in a worksheet.
+     * Represents the set of `AllowEditRange` objects found in a worksheet. `AllowEditRange` objects work 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.
      *
      * @remarks
      * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -27537,7 +27629,7 @@ declare namespace Excel {
          *
          * @param linkedEntityCellValueId An identifier that specifies an individual `LinkedEntityCellValue`.
          */
-         getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;
+        getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;
         /**
          * Gets the currently selected single range from the workbook. If there are multiple ranges selected, this method will throw an error.
          *
@@ -28083,7 +28175,7 @@ declare namespace Excel {
          * @remarks
          * [Api set: ExcelApi 1.9]
          *
-         * @param address Optional. A string containing the comma-separated addresses or names of the individual ranges. For example, "A1:B2, A5:B5". If not specified, an RangeArea object for the entire worksheet is returned.
+         * @param address Optional. A string containing the comma-separated or semicolon-separated addresses or names of the individual ranges. For example, "A1:B2, A5:B5" or "A1:B2; A5:B5". If not specified, a `RangeAreas` object for the entire worksheet is returned.
          */
         getRanges(address?: string): Excel.RangeAreas;
         /**
@@ -28512,7 +28604,7 @@ declare namespace Excel {
          */
         readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;
         /**
-         * Occurs when a worksheet is moved by a user within a workbook.
+         * 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]
@@ -28592,7 +28684,7 @@ declare namespace Excel {
         toJSON(): Excel.Interfaces.WorksheetCollectionData;
     }
     /**
-     * Represents the protection of a sheet object.
+     * Represents the protection of a worksheet object.
      *
      * @remarks
      * [Api set: ExcelApi 1.2]
@@ -28601,7 +28693,8 @@ declare namespace Excel {
         /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
         context: RequestContext;
         /**
-         * Specifies the `AllowEditRangeCollection` found in this worksheet.
+         * Specifies the `AllowEditRangeCollection` object found in this worksheet. This is a collection of `AllowEditRange` objects, which work 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.
          *
          * @remarks
          * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -29236,11 +29329,11 @@ declare namespace Excel {
         /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
         set(properties: Excel.Range): void;
         /**
-         * Fills range from the current range to the destination range using the specified AutoFill logic.
-                     The destination range can be `null`, or can extend the source either horizontally or vertically.
-                     Discontiguous ranges are not supported.
+         * Fills a range from the current range to the destination range using the specified AutoFill logic.
+                    The destination range can be `null` or can extend the source range either horizontally or vertically.
+                    Discontiguous ranges are not supported.
                     
-                     For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
+                    For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
          *
          * @remarks
          * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
@@ -29250,11 +29343,11 @@ declare namespace Excel {
          */
         autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;
         /**
-         * Fills range from the current range to the destination range using the specified AutoFill logic.
-                     The destination range can be `null`, or can extend the source either horizontally or vertically.
-                     Discontiguous ranges are not supported.
+         * Fills a range from the current range to the destination range using the specified AutoFill logic.
+                    The destination range can be `null` or can extend the source range either horizontally or vertically.
+                    Discontiguous ranges are not supported.
                     
-                     For more information, read {@link https://support.office.com/article/video-use-autofill-and-flash-fill-2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
+                    For more information, see {@link https://support.microsoft.com/office/2e79a709-c814-4b27-8bc2-c4dc84d49464 | Use AutoFill and Flash Fill}.
          *
          * @remarks
          * [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
@@ -29563,7 +29656,8 @@ declare namespace Excel {
          */
         getLastRow(): Excel.Range;
         /**
-         * Returns a RangeAreas object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, the API will fail to return the result. If the RangeAreas does not exist, will return a null object.
+         * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
+                    For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
          *
          * @remarks
          * [Api set: ExcelApi 1.13]
@@ -32104,7 +32198,7 @@ declare namespace Excel {
         /**
          * Name of the table.
                     
-                     The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
+                     The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
          *
          * @remarks
          * [Api set: ExcelApi 1.1]
@@ -38753,7 +38847,7 @@ declare namespace Excel {
          */
         getRangeOrNullObject(): Excel.Range;
         /**
-         * Applies the specified Autofilter object currently on the range.
+         * Applies the specified AutoFilter object currently on the range.
          *
          * @remarks
          * [Api set: ExcelApi 1.9]
@@ -39550,7 +39644,8 @@ declare namespace Excel {
          */
         delete(): void;
         /**
-         * Returns the string representation of the data source for the PivotTable. This method currently supports string representations for table and range objects. Otherwise, it returns an empty string.
+         * Returns the string representation of the data source for the PivotTable. This method currently supports string representations for table and range objects.
+                    Otherwise, it returns an empty string.
          *
          * @remarks
          * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -45705,7 +45800,7 @@ declare namespace Excel {
          * @remarks
          * [Api set: ExcelApi 1.9]
          *
-         * @param key Name or ID of the shape to be retrieved.
+         * @param key The name or ID of the shape to be retrieved.
          */
         getItem(key: string): Excel.Shape;
         /**
@@ -59386,7 +59481,7 @@ declare namespace Excel {
             /**
              * Name of the table.
                         
-                         The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
+                         The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -64595,7 +64690,8 @@ declare namespace Excel {
         /** An interface describing the data returned by calling `worksheetProtection.toJSON()`. */
         interface WorksheetProtectionData {
             /**
-            * Specifies the `AllowEditRangeCollection` found in this worksheet.
+            * Specifies the `AllowEditRangeCollection` object found in this worksheet. This is a collection of `AllowEditRange` objects, which work 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.
             *
             * @remarks
             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -65316,7 +65412,7 @@ declare namespace Excel {
             /**
              * Name of the table.
                         
-                         The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
+                         The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -70698,7 +70794,8 @@ declare namespace Excel {
             value?: T;
         }
         /**
-         * Represents an `AllowEditRange` object found in a worksheet.
+         * 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.
          *
          * @remarks
          * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -70740,7 +70837,8 @@ declare namespace Excel {
             title?: boolean;
         }
         /**
-         * Represents the set of `AllowEditRange` objects found in a worksheet.
+         * Represents the set of `AllowEditRange` objects found in a worksheet. `AllowEditRange` objects work 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.
          *
          * @remarks
          * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71949,7 +72047,7 @@ declare namespace Excel {
             visibility?: boolean;
         }
         /**
-         * Represents the protection of a sheet object.
+         * Represents the protection of a worksheet object.
          *
          * @remarks
          * [Api set: ExcelApi 1.2]
@@ -72968,7 +73066,7 @@ declare namespace Excel {
             /**
              * For EACH ITEM in the collection: Name of the table.
                         
-                         The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
+                         The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -73102,7 +73200,7 @@ declare namespace Excel {
             /**
              * For EACH ITEM in the collection: Name of the table.
                         
-                         The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
+                         The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]
@@ -73237,7 +73335,7 @@ declare namespace Excel {
             /**
              * Name of the table.
                         
-                         The set name of the table must follow the guidelines specified in the {@link https://support.office.com/article/Rename-an-Excel-table-FBF49A4F-82A3-43EB-8BA2-44D21233B114 | Rename an Excel table} article.
+                         The set name of the table must follow the guidelines specified in the {@link https://support.microsoft.com/office/fbf49a4f-82a3-43eb-8ba2-44d21233b114 | Rename an Excel table} article.
              *
              * @remarks
              * [Api set: ExcelApi 1.1]

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.278",
+    "version": "1.0.279",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -40,6 +40,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "bbc6bf88e692ef66e97b7052adf73c5707f7a85e97f59778177f0e1a67996da2",
+    "typesPublisherContentHash": "e9165fb259e6225283b2207ca446452331492201f9bef211e017c6faa6f3354d",
     "typeScriptVersion": "3.8"
 }