@types/office-js 1.0.251 → 1.0.254

office-js/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.
 
 ### Additional Details
- * Last updated: Wed, 04 May 2022 00:01:36 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/index.d.ts

@@ -543,16 +543,16 @@ 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
          * **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
          */
         associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
-    }   
+    }
 	/**
      * Message used in the `onVisibilityModeChanged` invocation.
      */
@@ -18296,7 +18296,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.
          *
@@ -19691,6 +19691,32 @@ declare namespace Excel {
          */
         automatic = "Automatic"
     }
+    /**
+     * Represents a command type of `DataConnection`.
+     *
+     * @remarks
+     * [Api set: ExcelApi 1.15]
+     */
+    enum DataSourceType {
+        /**
+         * The data source type is unknown or unsupported.
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        unknown = "Unknown",
+        /**
+         * The data source type is a range in the current workbook.
+         * @remarks
+         * [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"
+    }
     /**
      * Enum representing all accepted conditions by which a date filter can be applied.
                 Used to configure the type of PivotFilter that is applied to the field.
@@ -23996,14 +24022,21 @@ declare namespace Excel {
          */
         getColumnsBefore(count?: number): Excel.Range;
         /**
-         * 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 dependent cells of a specified range in the same worksheet or across multiple worksheets.
+         * 
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        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.
+         * 
          * @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]
@@ -24120,7 +24153,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]
@@ -26990,10 +27023,11 @@ 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.]
+         * [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.
+         * @param alwaysInsert Optional. Specifies whether the new rows will be inserted into the table when new rows are added. If `true`, the new rows will be inserted into the table. If `false`, the new rows will be added below the table. Default is `true`.
          */
         add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, alwaysInsert?: boolean): Excel.TableRow;
         /**
@@ -29162,6 +29196,42 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.7]
          */
         delete(): void;
+        /**
+         * 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 1.15]
+         *
+         * @param dimension The dimension of the axis where the data is from.
+         */
+        getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string>;
+        /**
+         * 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 1.15]
+         *
+         * @param dimension The dimension of the axis where the data is from.
+         */
+        getDimensionDataSourceString(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<string>;
+        /**
+         * Gets the data source type of the chart series.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         *
+         * @param dimension The dimension of the axis where the data is from.
+         */
+        getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
+        /**
+         * Gets the data source type of the chart series.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         *
+         * @param dimension The dimension of the axis where the data is from.
+         */
+        getDimensionDataSourceType(dimension: "Categories" | "Values" | "XValues" | "YValues" | "BubbleSizes"): OfficeExtension.ClientResult<Excel.ChartDataSourceType>;
         /**
          * Gets the values from a single dimension of the chart series. These could be either category values or data values, depending on the dimension specified and how the data is mapped for the chart series.
          *
@@ -33690,6 +33760,15 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.12]
          */
         getFirst(): Excel.PivotTable;
+        /**
+         * Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection.
+                    If the collection is empty, then this method returns 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.15]
+         */
+        getFirstOrNullObject(): Excel.PivotTable;
         /**
          * Gets a PivotTable by name.
          *
@@ -33929,6 +34008,21 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.8]
          */
         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.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        getDataSourceString(): OfficeExtension.ClientResult<string>;
+        /**
+         * Gets the type of the data source for the PivotTable.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        getDataSourceType(): OfficeExtension.ClientResult<Excel.DataSourceType>;
         /**
          * Refreshes the PivotTable.
          *
@@ -40108,6 +40202,15 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.9]
          */
         readonly connectionSiteCount: number;
+        /**
+         * Gets the display name of the shape. A newly created shape has a generated name
+                    that is localized and may not match its `name`. In this scenario, you can use
+                    this API to get the name that is displayed in the UI.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        readonly displayName: string;
         /**
          * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
          *
@@ -42533,6 +42636,38 @@ declare namespace Excel {
          */
         rows = "Rows"
     }
+    /**
+     * Specifies the data source type of the chart series.
+     * 
+     * @remarks
+     * [Api set: ExcelApi 1.15]
+     */
+    enum ChartDataSourceType {
+        /**
+         * The data source type of the chart series is a local range.
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        localRange = "LocalRange",
+        /**
+         * The data source type of the chart series is an external range.
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        externalRange = "ExternalRange",
+        /**
+         * The data source type of the chart series is a list.
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        list = "List",
+        /**
+         * The data source type of the chart series is unknown or unsupported.
+         * @remarks
+         * [Api set: ExcelApi 1.15]
+         */
+        unknown = "Unknown"
+    }
     /**
      * Represents the horizontal alignment for the specified object.
      *
@@ -63170,6 +63305,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.9]
              */
             connectionSiteCount?: number;
+            /**
+             * Gets the display name of the shape. A newly created shape has a generated name
+                        that is localized and may not match its `name`. In this scenario, you can use
+                        this API to get the name that is displayed in the UI.
+             *
+             * @remarks
+             * [Api set: ExcelApi 1.15]
+             */
+            displayName?: string;
             /**
              * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
              *
@@ -73295,6 +73439,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.9]
              */
             connectionSiteCount?: boolean;
+            /**
+             * For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
+                        that is localized and may not match its `name`. In this scenario, you can use
+                        this API to get the name that is displayed in the UI.
+             *
+             * @remarks
+             * [Api set: ExcelApi 1.15]
+             */
+            displayName?: boolean;
             /**
              * For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
              *
@@ -73487,6 +73640,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.9]
              */
             connectionSiteCount?: boolean;
+            /**
+             * Gets the display name of the shape. A newly created shape has a generated name
+                        that is localized and may not match its `name`. In this scenario, you can use
+                        this API to get the name that is displayed in the UI.
+             *
+             * @remarks
+             * [Api set: ExcelApi 1.15]
+             */
+            displayName?: boolean;
             /**
              * Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
              *
@@ -73763,6 +73925,15 @@ declare namespace Excel {
              * [Api set: ExcelApi 1.9]
              */
             connectionSiteCount?: boolean;
+            /**
+             * For EACH ITEM in the collection: Gets the display name of the shape. A newly created shape has a generated name
+                        that is localized and may not match its `name`. In this scenario, you can use
+                        this API to get the name that is displayed in the UI.
+             *
+             * @remarks
+             * [Api set: ExcelApi 1.15]
+             */
+            displayName?: boolean;
             /**
              * For EACH ITEM in the collection: Specifies the geometric shape type of this geometric shape. See `Excel.GeometricShapeType` for details. Returns `null` if the shape type is not "GeometricShape".
              *

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.251",
+    "version": "1.0.254",
     "description": "TypeScript definitions for Office.js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -45,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "ce8af17effe1ba31c7fa40afa18085a4a2b722db7f20d88f36e7d3e9de4968dd",
+    "typesPublisherContentHash": "396dca9293c5b54e74ea62fc185b98686af30c3b95cb56b53ca02602aa49a7bc",
     "typeScriptVersion": "3.9"
 }