@types/office-js-preview 1.0.302 → 1.0.305

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, 04 May 2022 00:01:37 GMT
+ * Last updated: Fri, 20 May 2022 01:01:40 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js-preview/index.d.ts

@@ -543,9 +543,9 @@ declare namespace Office {
      */
     interface Actions {
         /**
-         * Associates the ID of an action with a function.
+         * Associates the ID or name of an action with a function. 
          * 
-         * @param actionId The ID of an action that is defined in an extended manifest.
+         * @param actionId The ID of an action that is defined in an extended manifest or the name of the function as specified in a **FunctionName** element in the manifest.
          * @param actionFunction The function that is run when the action is invoked. 
          * 
          * @remarks
@@ -19056,7 +19056,7 @@ declare namespace OfficeExtension {
          * This statement will never contain any potentially-sensitive data and may not match the code exactly as written,
          * but will be a close approximation.
          */
-        statements?: string;
+        statement?: string;
         /**
          * The statements that closely precede and follow the statement that caused the error, if available.
          *
@@ -19806,6 +19806,31 @@ declare namespace Excel {
     */
     type CardLayout = EntityCardLayout;
     /**
+    * The compact layout properties for an entity.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    interface EntityCompactLayout {
+        /**
+        * Specifies the name of the icon which is used to open the card.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        icon?: string;
+    }
+    /**
+    * Represents the layout used when there is limited space to represent the entity.
+    *
+    * @remarks
+    * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+    * @beta
+    */
+    type CompactLayout = EntityCompactLayout;
+    /**
     * Represents a reference into `referencedValues`. One scenario for using this reference is to avoid duplicating cell value objects (such as an `EntityCellValue`). Define a cell value object once in `referencedValues`, and then refer to that cell value from many places by using a `ReferenceCellValue` where the duplicated value would have appeared.
     *
     * @remarks
@@ -20695,6 +20720,14 @@ declare namespace Excel {
         * @beta
         */
         card?: CardLayout;
+        /**
+        * Represents the layout used when there is limited space to represent the entity.
+        *
+        * @remarks
+        * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+        * @beta
+        */
+        compact?: CompactLayout;
     }
     /**
     * Represents a card layout best used for an entity.
@@ -24062,15 +24095,13 @@ declare namespace Excel {
      * Represents a command type of `DataConnection`.
      *
      * @remarks
-     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: ExcelApi 1.15]
      */
     enum DataSourceType {
         /**
          * The data source type is unknown or unsupported.
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          */
         unknown = "Unknown",
         /**
@@ -24083,17 +24114,22 @@ declare namespace Excel {
         /**
          * The data source type is a range in the current workbook.
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          */
         localRange = "LocalRange",
         /**
          * The data source type is a table in the current workbook.
          * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        localTable = "LocalTable",
+        /**
+         * Contains command text that the OLE DB provider (such as Power BI) understands.
+         * @remarks
          * [Api set: ExcelApi BETA (PREVIEW ONLY)]
          * @beta
          */
-        localTable = "LocalTable"
+        oledbDefault = "OledbDefault"
     }
     /**
      * Enum representing all accepted conditions by which a date filter can be applied.
@@ -29845,22 +29881,21 @@ declare namespace Excel {
          */
         getColumnsBefore(count?: number): Excel.Range;
         /**
-         * Returns a `WorkbookRangeAreas` object that represents the range containing all the dependents of a cell in the same worksheet or in multiple worksheets.
+         * 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.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          */
         getDependents(): Excel.WorkbookRangeAreas;
         /**
-         * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependents of a cell in the same worksheet or in multiple worksheets.
+         * 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.
          *
          * @remarks
          * [Api set: ExcelApi 1.13]
          */
         getDirectDependents(): Excel.WorkbookRangeAreas;
         /**
-         * Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedents of a cell in the same worksheet or in multiple worksheets.
+         * 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.
          *
          * @remarks
          * [Api set: ExcelApi 1.12]
@@ -29977,7 +30012,7 @@ declare namespace Excel {
          */
         getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;
         /**
-         * Returns a `WorkbookRangeAreas` object that represents the range containing all the precedents of a cell in the same worksheet or in multiple worksheets.
+         * 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.
          *
          * @remarks
          * [Api set: ExcelApi 1.14]
@@ -32973,7 +33008,7 @@ declare namespace Excel {
                      to point at the index for which it was created.
          *
          * @remarks
-         * [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows; ExcelApi BETA (PREVIEW ONLY) for adding `alwaysInsert` parameter.]
+         * [Api set: ExcelApi 1.1 for adding a single row; 1.4 allows adding of multiple rows; 1.15 for adding `alwaysInsert` parameter.]
          *
          * @param index Optional. Specifies the relative position of the new row. If null or -1, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.
          * @param values Optional. A 2D array of unformatted values of the table row.
@@ -35170,8 +35205,7 @@ declare namespace Excel {
          * Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          *
          * @param dimension The dimension of the axis where the data is from.
          */
@@ -35180,8 +35214,7 @@ declare namespace Excel {
          * Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          *
          * @param dimension The dimension of the axis where the data is from.
          */
@@ -35190,8 +35223,7 @@ declare namespace Excel {
          * Gets the data source type of the chart series.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          *
          * @param dimension The dimension of the axis where the data is from.
          */
@@ -35200,8 +35232,7 @@ declare namespace Excel {
          * Gets the data source type of the chart series.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          *
          * @param dimension The dimension of the axis where the data is from.
          */
@@ -37651,22 +37682,6 @@ declare namespace Excel {
     class ChartFill 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;
-        /**
-         * Sets and gets the uniform color fill formatting of a chart element.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
-         */
-        solidColor: string;
-        /**
-         * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
-         * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
-         * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
-         */
-        set(properties: Interfaces.ChartFillUpdateData, options?: OfficeExtension.UpdateOptions): void;
-        /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
-        set(properties: Excel.ChartFill): void;
         /**
          * Clears the fill color of a chart element.
          *
@@ -37683,32 +37698,6 @@ 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;
-        /**
-         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
-         *
-         * @param options Provides options for which properties of the object to load.
-         */
-        load(options?: Excel.Interfaces.ChartFillLoadOptions): Excel.ChartFill;
-        /**
-         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
-         *
-         * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
-         */
-        load(propertyNames?: string | string[]): Excel.ChartFill;
-        /**
-         * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
-         *
-         * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
-         */
-        load(propertyNamesAndPaths?: {
-            select?: string;
-            expand?: string;
-        }): Excel.ChartFill;
-        /**
-        * 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(): Excel.Interfaces.ChartFillData;
     }
     /**
      * Represents the border formatting of a chart element.
@@ -39775,8 +39764,7 @@ declare namespace Excel {
                     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 BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          */
         getFirstOrNullObject(): Excel.PivotTable;
         /**
@@ -40072,16 +40060,14 @@ declare namespace Excel {
                     Otherwise, it returns an empty string.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          */
         getDataSourceString(): OfficeExtension.ClientResult<string>;
         /**
          * Gets the type of the data source for the PivotTable.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          */
         getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;
         /**
@@ -46364,8 +46350,7 @@ declare namespace Excel {
                     this API to get the name that is displayed in the UI.
          *
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         * @beta
+         * [Api set: ExcelApi 1.15]
          */
         readonly displayName: string;
         /**
@@ -49192,31 +49177,34 @@ declare namespace Excel {
         rows = "Rows"
     }
     /**
-     * Specifies whether the series data range is local range, external range, list or unknown.
-     *
+     * Specifies the data source type of the chart series.
+     * 
      * @remarks
-     * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-     * @beta
+     * [Api set: ExcelApi 1.15]
      */
     enum ChartDataSourceType {
         /**
+         * The data source type of the chart series is a local range.
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * [Api set: ExcelApi 1.15]
          */
         localRange = "LocalRange",
         /**
+         * The data source type of the chart series is an external range.
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * [Api set: ExcelApi 1.15]
          */
         externalRange = "ExternalRange",
         /**
+         * The data source type of the chart series is a list.
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * [Api set: ExcelApi 1.15]
          */
         list = "List",
         /**
+         * The data source type of the chart series is unknown or unsupported.
          * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
+         * [Api set: ExcelApi 1.15]
          */
         unknown = "Unknown"
     }
@@ -61977,17 +61965,6 @@ declare namespace Excel {
             */
             font?: Excel.Interfaces.ChartFontUpdateData;
         }
-        /** An interface for updating data on the ChartFill object, for use in `chartFill.set({ ... })`. */
-        interface ChartFillUpdateData {
-            /**
-             * Sets and gets the uniform color fill formatting of a chart element.
-             *
-             * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
-             */
-            solidColor?: string;
-        }
         /** An interface for updating data on the ChartBorder object, for use in `chartBorder.set({ ... })`. */
         interface ChartBorderUpdateData {
             /**
@@ -68215,17 +68192,6 @@ declare namespace Excel {
             */
             font?: Excel.Interfaces.ChartFontData;
         }
-        /** An interface describing the data returned by calling `chartFill.toJSON()`. */
-        interface ChartFillData {
-            /**
-             * Sets and gets the uniform color fill formatting of a chart element.
-             *
-             * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
-             */
-            solidColor?: string;
-        }
         /** An interface describing the data returned by calling `chartBorder.toJSON()`. */
         interface ChartBorderData {
             /**
@@ -70690,8 +70656,7 @@ declare namespace Excel {
                         this API to get the name that is displayed in the UI.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.15]
              */
             displayName?: string;
             /**
@@ -77352,26 +77317,6 @@ declare namespace Excel {
             */
             font?: Excel.Interfaces.ChartFontLoadOptions;
         }
-        /**
-         * Represents the fill formatting for a chart element.
-         *
-         * @remarks
-         * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-         */
-        interface ChartFillLoadOptions {
-            /**
-              Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
-             */
-            $all?: boolean;
-            /**
-             * Sets and gets the uniform color fill formatting of a chart element.
-             *
-             * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
-             */
-            solidColor?: boolean;
-        }
         /**
          * Represents the border formatting of a chart element.
          *
@@ -81798,8 +81743,7 @@ declare namespace Excel {
                         this API to get the name that is displayed in the UI.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.15]
              */
             displayName?: boolean;
             /**
@@ -82000,8 +81944,7 @@ declare namespace Excel {
                         this API to get the name that is displayed in the UI.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.15]
              */
             displayName?: boolean;
             /**
@@ -82286,8 +82229,7 @@ declare namespace Excel {
                         this API to get the name that is displayed in the UI.
              *
              * @remarks
-             * [Api set: ExcelApi BETA (PREVIEW ONLY)]
-             * @beta
+             * [Api set: ExcelApi 1.15]
              */
             displayName?: boolean;
             /**

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.302",
+    "version": "1.0.305",
     "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": "2296999b4ea0b3ad36c3992b4414e9edf12fdc2a53629963b54c0d02dc7cbe34",
+    "typesPublisherContentHash": "2d8fa62dd9f863d04d601a5c6f60341d72f8606a44f710b6376a4dd442771485",
     "typeScriptVersion": "3.9"
 }