@types/office-js 1.0.316 → 1.0.318

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: Tue, 28 Feb 2023 21:32:42 GMT
+ * Last updated: Thu, 09 Mar 2023 21:32:38 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -24169,7 +24169,7 @@ declare namespace Excel {
         compact?: CompactLayout;
     }
     /**
-    * Represents a card layout best used for an entity.
+    * Represents a card layout that is best used for an array.
     *
     * @remarks
     * [Api set: ExcelApi 1.16]
@@ -26267,12 +26267,12 @@ declare namespace Excel {
     /**
      * Notifies when a worksheet is moved within a workbook.
                 
-                If a worksheet is moved from one position within the workbook to another
-                via the Excel UI, then this API will trigger an event. Note that if
-                the position of a worksheet changes as a result of moving a different worksheet,
-                then this event won't trigger for both position changes. This event only triggers
-                for the primary worksheet move, and not any worksheet position changes that occur
-                as a result of that primary move.
+                 If a worksheet is moved from one position within the workbook to another
+                 via the Excel UI, then this API will trigger an event. Note that if
+                 the position of a worksheet changes as a result of moving a different worksheet,
+                 then this event won't trigger for both position changes. This event only triggers
+                 for the primary worksheet move, and not any worksheet position changes that occur
+                 as a result of that primary move.
      *
      * @remarks
      * [Api set: ExcelApiOnline 1.1]
@@ -26809,8 +26809,8 @@ declare namespace Excel {
         /**
          * Equals comparator criterion.
                     
-                    Required Criteria: {`comparator`}.
-                    Optional Criteria: {`wholeDays`, `exclusive`}.
+                     Required Criteria: {`comparator`}.
+                     Optional Criteria: {`wholeDays`, `exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -26818,8 +26818,8 @@ declare namespace Excel {
         /**
          * Date is before comparator date.
                     
-                    Required Criteria: {`comparator`}.
-                    Optional Criteria: {`wholeDays`}.
+                     Required Criteria: {`comparator`}.
+                     Optional Criteria: {`wholeDays`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -26827,8 +26827,8 @@ declare namespace Excel {
         /**
          * Date is before or equal to comparator date.
                     
-                    Required Criteria: {`comparator`}.
-                    Optional Criteria: {`wholeDays`}.
+                     Required Criteria: {`comparator`}.
+                     Optional Criteria: {`wholeDays`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -26836,8 +26836,8 @@ declare namespace Excel {
         /**
          * Date is after comparator date.
                     
-                    Required Criteria: {`comparator`}.
-                    Optional Criteria: {`wholeDays`}.
+                     Required Criteria: {`comparator`}.
+                     Optional Criteria: {`wholeDays`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -26845,8 +26845,8 @@ declare namespace Excel {
         /**
          * Date is after or equal to comparator date.
                     
-                    Required Criteria: {`comparator`}.
-                    Optional Criteria: {`wholeDays`}.
+                     Required Criteria: {`comparator`}.
+                     Optional Criteria: {`wholeDays`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -26854,8 +26854,8 @@ declare namespace Excel {
         /**
          * Between `lowerBound` and `upperBound` dates.
                     
-                    Required Criteria: {`lowerBound`, `upperBound`}.
-                    Optional Criteria: {`wholeDays`, `exclusive`}.
+                     Required Criteria: {`lowerBound`, `upperBound`}.
+                     Optional Criteria: {`wholeDays`, `exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27071,8 +27071,8 @@ declare namespace Excel {
         /**
          * Equals comparator criterion.
                     
-                    Required Criteria: {`comparator`}.
-                    Optional Criteria: {`exclusive`}.
+                     Required Criteria: {`comparator`}.
+                     Optional Criteria: {`exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27080,8 +27080,8 @@ declare namespace Excel {
         /**
          * Label begins with substring criterion.
                     
-                    Required Criteria: {`substring`}.
-                    Optional Criteria: {`exclusive`}.
+                     Required Criteria: {`substring`}.
+                     Optional Criteria: {`exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27089,8 +27089,8 @@ declare namespace Excel {
         /**
          * Label ends with substring criterion.
                     
-                    Required Criteria: {`substring`}.
-                    Optional Criteria: {`exclusive`}.
+                     Required Criteria: {`substring`}.
+                     Optional Criteria: {`exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27098,8 +27098,8 @@ declare namespace Excel {
         /**
          * Label contains substring criterion.
                     
-                    Required Criteria: {`substring`}.
-                    Optional Criteria: {`exclusive`}.
+                     Required Criteria: {`substring`}.
+                     Optional Criteria: {`exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27107,7 +27107,7 @@ declare namespace Excel {
         /**
          * Greater than comparator criterion.
                     
-                    Required Criteria: {`comparator`}.
+                     Required Criteria: {`comparator`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27115,7 +27115,7 @@ declare namespace Excel {
         /**
          * Greater than or equal to comparator criterion.
                     
-                    Required Criteria: {`comparator`}.
+                     Required Criteria: {`comparator`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27123,7 +27123,7 @@ declare namespace Excel {
         /**
          * Less than comparator criterion.
                     
-                    Required Criteria: {`comparator`}.
+                     Required Criteria: {`comparator`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27131,7 +27131,7 @@ declare namespace Excel {
         /**
          * Less than or equal to comparator criterion.
                     
-                    Required Criteria: {`comparator`}.
+                     Required Criteria: {`comparator`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27139,8 +27139,8 @@ declare namespace Excel {
         /**
          * Between `lowerBound` and `upperBound` criteria.
                     
-                    Required Criteria: {`lowerBound`, `upperBound`}.
-                    Optional Criteria: {`exclusive`}.
+                     Required Criteria: {`lowerBound`, `upperBound`}.
+                     Optional Criteria: {`exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27453,8 +27453,8 @@ declare namespace Excel {
         /**
          * Equals comparator criterion.
                     
-                    Required Criteria: {`value`, `comparator`}.
-                    Optional Criteria: {`exclusive`}.
+                     Required Criteria: {`value`, `comparator`}.
+                     Optional Criteria: {`exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27462,7 +27462,7 @@ declare namespace Excel {
         /**
          * Greater than comparator criterion.
                     
-                    Required Criteria: {`value`, `comparator`}.
+                     Required Criteria: {`value`, `comparator`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27470,7 +27470,7 @@ declare namespace Excel {
         /**
          * Greater than or equal to comparator criterion.
                     
-                    Required Criteria: {`value`, `comparator`}.
+                     Required Criteria: {`value`, `comparator`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27478,7 +27478,7 @@ declare namespace Excel {
         /**
          * Less than comparator criterion.
                     
-                    Required Criteria: {`value`, `comparator`}.
+                     Required Criteria: {`value`, `comparator`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27486,7 +27486,7 @@ declare namespace Excel {
         /**
          * Less than or equal to comparator criterion.
                     
-                    Required Criteria: {`value`, `comparator`}.
+                     Required Criteria: {`value`, `comparator`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27494,8 +27494,8 @@ declare namespace Excel {
         /**
          * Between `lowerBound` and `upperBound` criteria.
                     
-                    Required Criteria: {`value`, `lowerBound`, `upperBound`}.
-                    Optional Criteria: {`exclusive`}.
+                     Required Criteria: {`value`, `lowerBound`, `upperBound`}.
+                     Optional Criteria: {`exclusive`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27503,7 +27503,7 @@ declare namespace Excel {
         /**
          * In top N (`threshold`) [items, percent, sum] of value category.
                     
-                    Required Criteria: {`value`, `threshold`, `selectionType`}.
+                     Required Criteria: {`value`, `threshold`, `selectionType`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -27511,7 +27511,7 @@ declare namespace Excel {
         /**
          * In bottom N (`threshold`) [items, percent, sum] of value category.
                     
-                    Required Criteria: {`value`, `threshold`, `selectionType`}.
+                     Required Criteria: {`value`, `threshold`, `selectionType`}.
          * @remarks
          * [Api set: ExcelApi 1.12]
          */
@@ -30098,9 +30098,9 @@ declare namespace Excel {
         /**
          * Occurs when a left-clicked/tapped action happens in the worksheet. This event will not be fired when clicking in the following cases:
 
-                    - The user drags the mouse for multi-selection.
+                     - The user drags the mouse for multi-selection.
 
-                    - The user selects a cell in the mode when cell arguments are selected for formula references.
+                     - The user selects a cell in the mode when cell arguments are selected for formula references.
          *
          * @remarks
          * [Api set: ExcelApi 1.10]
@@ -30438,7 +30438,7 @@ declare namespace Excel {
         /**
          * Specifies if the password can be used to unlock worksheet protection.
                     This method doesn't change the worksheet protection state.
-                    If a password is inputted but no password is required to unlock worksheet protection, this method will return false.
+                    If a password is input but no password is required to unlock worksheet protection, this method will return false.
          *
          * @remarks
          * [Api set: ExcelApiOnline 1.1]
@@ -31032,10 +31032,10 @@ declare namespace Excel {
         set(properties: Excel.Range): void;
         /**
          * 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.
+                     The destination range can be `null` or can extend the source range either horizontally or vertically.
+                     Discontiguous ranges are not supported.
                     
-                    For more information, see {@link https://support.microsoft.com/office/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`]
@@ -31046,10 +31046,10 @@ declare namespace Excel {
         autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;
         /**
          * 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.
+                     The destination range can be `null` or can extend the source range either horizontally or vertically.
+                     Discontiguous ranges are not supported.
                     
-                    For more information, see {@link https://support.microsoft.com/office/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`]
@@ -31101,8 +31101,8 @@ declare namespace Excel {
          */
         convertToLinkedDataType(serviceID: number, languageCulture: string): void;
         /**
-         * Copies cell data or formatting from the source range or `RangeAreas` to the current range.
-                    The destination range can be a different size than the source range or `RangeAreas`. The destination will be expanded automatically if it is smaller than the source.
+         * Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range can be a different size than the source range or `RangeAreas`. The destination is expanded automatically if it's smaller than the source.
+                    Note: Like the copy functionality in the Excel UI, if the destination range is an exact multiple greater than the source range in either rows or columns, then the source content is replicated multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range.
          *
          * @remarks
          * [Api set: ExcelApi 1.9]
@@ -31114,8 +31114,8 @@ declare namespace Excel {
          */
         copyFrom(sourceRange: Range | RangeAreas | string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean): void;
         /**
-         * Copies cell data or formatting from the source range or `RangeAreas` to the current range.
-                    The destination range can be a different size than the source range or `RangeAreas`. The destination will be expanded automatically if it is smaller than the source.
+         * Copies cell data or formatting from the source range or `RangeAreas` to the current range. The destination range can be a different size than the source range or `RangeAreas`. The destination is expanded automatically if it's smaller than the source.
+                    Note: Like the copy functionality in the Excel UI, if the destination range is an exact multiple greater than the source range in either rows or columns, then the source content is replicated multiple times. For example, a 2x2 range copy into a 2x6 range will result in 3 copies of the original 2x2 range.
          *
          * @remarks
          * [Api set: ExcelApi 1.9]
@@ -31262,7 +31262,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.
-         * 
+         *
          * @remarks
          * [Api set: ExcelApi 1.13]
          */
@@ -40537,7 +40537,7 @@ declare namespace Excel {
          */
         date: string;
         /**
-         * How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specifity is set to "month", the filter operation will keep all rows with a date in the month of April 2005.
+         * How specific the date should be used to keep data. For example, if the date is 2005-04-02 and the specificity is set to "month", the filter operation will keep all rows with a date in the month of April 2005.
          *
          * @remarks
          * [Api set: ExcelApi 1.2]
@@ -41428,9 +41428,9 @@ declare namespace Excel {
         /**
          * The alt text description of the PivotTable.
                     
-                    Alt text provides alternative, text-based representations of the information contained in the PivotTable.
-                    This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
-                    A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+                     Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+                     This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+                     A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
          *
          * @remarks
          * [Api set: ExcelApi 1.13]
@@ -41439,9 +41439,9 @@ declare namespace Excel {
         /**
          * The alt text title of the PivotTable.
                     
-                    Alt text provides alternative, text-based representations of the information contained in the PivotTable.
-                    This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
-                    A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+                     Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+                     This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+                     A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
          *
          * @remarks
          * [Api set: ExcelApi 1.13]
@@ -42771,7 +42771,7 @@ declare namespace Excel {
         descending = "Descending"
     }
     /**
-     * Aggregation function for the DataPivotField.
+     * Aggregation function for the `DataPivotHierarchy`.
      *
      * @remarks
      * [Api set: ExcelApi 1.8]
@@ -46656,7 +46656,7 @@ declare namespace Excel {
         toJSON(): Excel.Interfaces.PageBreakCollectionData;
     }
     /**
-     * Represents a collection of all the data connections that are part of the workbook or worksheet.
+     * Represents a collection of all the data connections that are part of the workbook.
      *
      * @remarks
      * [Api set: ExcelApi 1.7]
@@ -63073,9 +63073,9 @@ declare namespace Excel {
             /**
              * The alt text description of the PivotTable.
                         
-                        Alt text provides alternative, text-based representations of the information contained in the PivotTable.
-                        This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
-                        A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+                         Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+                         This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+                         A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
              *
              * @remarks
              * [Api set: ExcelApi 1.13]
@@ -63084,9 +63084,9 @@ declare namespace Excel {
             /**
              * The alt text title of the PivotTable.
                         
-                        Alt text provides alternative, text-based representations of the information contained in the PivotTable.
-                        This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
-                        A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+                         Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+                         This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+                         A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
              *
              * @remarks
              * [Api set: ExcelApi 1.13]
@@ -69223,9 +69223,9 @@ declare namespace Excel {
             /**
              * The alt text description of the PivotTable.
                         
-                        Alt text provides alternative, text-based representations of the information contained in the PivotTable.
-                        This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
-                        A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+                         Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+                         This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+                         A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
              *
              * @remarks
              * [Api set: ExcelApi 1.13]
@@ -69234,9 +69234,9 @@ declare namespace Excel {
             /**
              * The alt text title of the PivotTable.
                         
-                        Alt text provides alternative, text-based representations of the information contained in the PivotTable.
-                        This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
-                        A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+                         Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+                         This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+                         A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
              *
              * @remarks
              * [Api set: ExcelApi 1.13]
@@ -78125,9 +78125,9 @@ declare namespace Excel {
             /**
              * The alt text description of the PivotTable.
                         
-                        Alt text provides alternative, text-based representations of the information contained in the PivotTable.
-                        This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
-                        A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+                         Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+                         This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+                         A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
              *
              * @remarks
              * [Api set: ExcelApi 1.13]
@@ -78136,9 +78136,9 @@ declare namespace Excel {
             /**
              * The alt text title of the PivotTable.
                         
-                        Alt text provides alternative, text-based representations of the information contained in the PivotTable.
-                        This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
-                        A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
+                         Alt text provides alternative, text-based representations of the information contained in the PivotTable.
+                         This information is useful for people with vision or cognitive impairments who may not be able to see or understand the table.
+                         A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
              *
              * @remarks
              * [Api set: ExcelApi 1.13]
@@ -109309,7 +109309,7 @@ declare namespace PowerPoint {
          * @remarks
          * [Api set: PowerPointApi 1.3]
          *
-         * @param key The ID of the tag.
+         * @param key The ID of the tag. The `key` parameter is case-sensitive.
          * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
          */
         getItem(key: string): PowerPoint.Tag;
@@ -109329,7 +109329,7 @@ declare namespace PowerPoint {
          * @remarks
          * [Api set: PowerPointApi 1.3]
          *
-         * @param key The ID of the tag.
+         * @param key The ID of the tag. The `key` parameter is case-sensitive. 
          * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
          */
         getItemOrNullObject(key: string): PowerPoint.Tag;

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.316",
+    "version": "1.0.318",
     "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": "13d21fe2eb5ddeae15c8ee9dfcef62fdc9a9f904327153e0c582813a88bf70be",
+    "typesPublisherContentHash": "8892a7fa745b18d3a2d33c8d0fa2e782a9a3d009c249efef0d01dae9a797c641",
     "typeScriptVersion": "4.2"
 }