@types/office-js 1.0.319 → 1.0.321

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, 11 Apr 2023 23:03:25 GMT
+ * Last updated: Thu, 20 Apr 2023 20:32:48 GMT
  * Dependencies: none
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
 

office-js/index.d.ts

@@ -10113,15 +10113,12 @@ declare namespace Office {
          */
         addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
-         * Closes the current item that is being composed
+         * Closes the current item that is being composed.
          *
-         * The behaviors of the `close` method depends on the current state of the item being composed.
+         * The behavior of the `close` method depends on the current state of the item being composed.
          * If the item has unsaved changes, the client prompts the user to save, discard, or close the action.
          *
-         * In the Outlook desktop client, if the message is an inline reply, the `close` method has no effect.
-         *
-         * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
-         * discard, or cancel even if no changes have occurred since the item was last saved.
+         * In the Outlook desktop client, the `close` method has no effect on a reply in the Reading Pane.
          *
          * @remarks
          * [Api set: Mailbox 1.3]
@@ -10129,6 +10126,9 @@ declare namespace Office {
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
+         * 
+         * **Important**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
+         * discard, or cancel even if no changes have occurred since the item was last saved.
          */
         close(): void;
         /**
@@ -15158,15 +15158,12 @@ declare namespace Office {
          */
         addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
         /**
-         * Closes the current item that is being composed
+         * Closes the current item that is being composed.
          *
-         * The behaviors of the close method depends on the current state of the item being composed.
+         * The behavior of the `close` method depends on the current state of the item being composed.
          * If the item has unsaved changes, the client prompts the user to save, discard, or close the action.
          *
-         * In the Outlook desktop client, if the message is an inline reply, the close method has no effect.
-         *
-         * **Note**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
-         * discard, or cancel even if no changes have occurred since the item was last saved.
+         * In the Outlook desktop client, the `close` method has no effect on a reply in the Reading Pane.
          *
          * @remarks
          * [Api set: Mailbox 1.3]
@@ -15174,6 +15171,9 @@ declare namespace Office {
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
          *
          * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
+         *
+         * **Important**: In Outlook on the web, if the item is an appointment and it has previously been saved using `saveAsync`, the user is prompted to save,
+         * discard, or cancel even if no changes have occurred since the item was last saved.
          */
         close(): void;
         /**
@@ -23542,6 +23542,13 @@ declare namespace Excel {
         */
         linkedEntity = "LinkedEntity",
         /**
+        * Represents a `LocalImageCellValue`.
+        *
+        * @remarks
+        * [Api set: ExcelApi 1.16]
+        */
+        localImage = "LocalImage",
+        /**
         * Represents a `ReferenceCellValue`.
         *
         * @remarks
@@ -24397,7 +24404,14 @@ declare namespace Excel {
         * @remarks
         * [Api set: ExcelApi 1.16]
         */
-        dataProviderError = "DataProviderError"
+        dataProviderError = "DataProviderError",
+        /**
+        * An error caused by a missing file. In this case, the RichValueRel.xml file is missing from the metro package. Displays as error type #FIELD! in Excel.
+        *
+        * @remarks
+        * [Api set: 1.16]
+        */
+        richValueRelMissingFilePart = "RichValueRelMissingFilePart"
     }
     /**
     * Represents the value of a cell containing a #FIELD! error.
@@ -24442,7 +24456,7 @@ declare namespace Excel {
         * @remarks
         * [Api set: ExcelApi 1.16]
         */
-        errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError";
+        errorSubType?: FieldErrorCellValueSubType | "Unknown" | "WebImageMissingFilePart" | "DataProviderError" | "RichValueRelMissingFilePart";
         /**
         * Represents the field which was not found by FIELDVALUE.
         *
@@ -26275,42 +26289,42 @@ declare namespace Excel {
                  as a result of that primary move.
      *
      * @remarks
-     * [Api set: ExcelApiOnline 1.1]
+     * [Api set: ExcelApi 1.17]
      */
     interface WorksheetMovedEventArgs {
         /**
          * Gets the new position of the worksheet, after the move.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         positionAfter: number;
         /**
          * Gets the previous position of the worksheet, prior to the move.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         positionBefore: number;
         /**
          * The source of the event. It can be local or remote (through co-authoring).
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         source: Excel.EventSource | "Local" | "Remote";
         /**
          * Gets the type of the event.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         type: string;
         /**
          * Gets the ID of the worksheet that was moved.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         worksheetId: string;
     }
@@ -26318,42 +26332,42 @@ declare namespace Excel {
      * Provides information about the worksheet whose name has changed.
      *
      * @remarks
-     * [Api set: ExcelApiOnline 1.1]
+     * [Api set: ExcelApi 1.17]
      */
     interface WorksheetNameChangedEventArgs {
         /**
          * Gets the new name of the worksheet, after the name change.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         nameAfter: string;
         /**
          * Gets the previous name of the worksheet, before the name changed.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         nameBefore: string;
         /**
          * The source of the event. It can be local or remote (through co-authoring).
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         source: Excel.EventSource | "Local" | "Remote";
         /**
          * Gets the type of the event.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         type: string;
         /**
          * Gets the ID of the worksheet with the new name.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         worksheetId: string;
     }
@@ -26361,42 +26375,42 @@ declare namespace Excel {
      * Provides information about the worksheet whose visibility has changed.
      *
      * @remarks
-     * [Api set: ExcelApiOnline 1.1]
+     * [Api set: ExcelApi 1.17]
      */
     interface WorksheetVisibilityChangedEventArgs {
         /**
          * The source of the event. It can be local or remote (through co-authoring).
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         source: Excel.EventSource | "Local" | "Remote";
         /**
          * Gets the type of the event.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         type: string;
         /**
          * Gets the new visibility setting of the worksheet, after the visibility change.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         visibilityAfter: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
         /**
          * Gets the previous visibility setting of the worksheet, before the visibility change.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         visibilityBefore: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
         /**
          * Gets the ID of the worksheet whose visibility has changed.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          */
         worksheetId: string;
     }
@@ -30054,7 +30068,7 @@ declare namespace Excel {
          * Occurs when the worksheet name is changed.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -30112,7 +30126,7 @@ declare namespace Excel {
          * Occurs when the worksheet visibility is changed.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -30299,7 +30313,7 @@ declare namespace Excel {
          * 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]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -30308,7 +30322,7 @@ declare namespace Excel {
          * Occurs when the worksheet name is changed in the worksheet collection.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -30364,7 +30378,7 @@ declare namespace Excel {
          * Occurs when the worksheet visibility is changed in the worksheet collection.
          *
          * @remarks
-         * [Api set: ExcelApiOnline 1.1]
+         * [Api set: ExcelApi 1.17]
          *
          * @eventproperty
          */
@@ -40727,6 +40741,13 @@ declare namespace Excel {
     class NumberFormatInfo 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;
+        /**
+         * Gets the currency symbol for currency values. This is based on current system settings.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         */
+        readonly currencySymbol: string;
         /**
          * Gets the string used as the decimal separator for numeric values. This is based on current system settings.
          *
@@ -43677,6 +43698,72 @@ declare namespace Excel {
         set(properties: Interfaces.ConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;
         /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
         set(properties: Excel.ConditionalFormat): void;
+        /**
+         * Change the conditional format rule type to cell value.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         *
+         * @param properties The properties to set for the cell value conditional format rule.
+         */
+        changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;
+        /**
+         * Change the conditional format rule type to color scale.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         */
+        changeRuleToColorScale(): void;
+        /**
+         * Change the conditional format rule type to text comparison.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         *
+         * @param properties The properties to set for the text comparison conditional format rule.
+         */
+        changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;
+        /**
+         * Change the conditional format rule type to custom.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         *
+         * @param formula The formula to set for the custom conditional format rule.
+         */
+        changeRuleToCustom(formula: string): void;
+        /**
+         * Change the conditional format rule type to data bar.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         */
+        changeRuleToDataBar(): void;
+        /**
+         * Change the conditional format rule type to icon set.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         */
+        changeRuleToIconSet(): void;
+        /**
+         * Change the conditional format rule type to preset criteria.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         *
+         * @param properties The properties to set for the preset criteria conditional format rule.
+         */
+        changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;
+        /**
+         * Change the conditional format rule type to top/bottom.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         *
+         * @param properties The properties to set for the top/bottom conditional format rule.
+         */
+        changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;
         /**
          * Deletes this conditional format.
          *
@@ -43706,6 +43793,15 @@ declare namespace Excel {
          * [Api set: ExcelApi 1.9]
          */
         getRanges(): Excel.RangeAreas;
+        /**
+         * Set the ranges that the conditonal format rule is applied to.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         *
+         * @param ranges Collection of one or more ranges for this rule to be applied to.
+         */
+        setRanges(ranges: Range | RangeAreas | string): void;
         /**
          * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
          *
@@ -44710,6 +44806,13 @@ declare namespace Excel {
         set(properties: Interfaces.ConditionalRangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;
         /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
         set(properties: Excel.ConditionalRangeFormat): void;
+        /**
+         * Remove the format properties from a conditional format rule. This creates a rule with no format settings.
+         *
+         * @remarks
+         * [Api set: ExcelApi 1.17]
+         */
+        clearFormat(): void;
         /**
          * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
          *
@@ -69052,6 +69155,13 @@ declare namespace Excel {
         }
         /** An interface describing the data returned by calling `numberFormatInfo.toJSON()`. */
         interface NumberFormatInfoData {
+            /**
+             * Gets the currency symbol for currency values. This is based on current system settings.
+             *
+             * @remarks
+             * [Api set: ExcelApi 1.17]
+             */
+            currencySymbol?: string;
             /**
              * Gets the string used as the decimal separator for numeric values. This is based on current system settings.
              *
@@ -77764,6 +77874,13 @@ declare namespace Excel {
               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;
+            /**
+             * Gets the currency symbol for currency values. This is based on current system settings.
+             *
+             * @remarks
+             * [Api set: ExcelApi 1.17]
+             */
+            currencySymbol?: boolean;
             /**
              * Gets the string used as the decimal separator for numeric values. This is based on current system settings.
              *

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.319",
+    "version": "1.0.321",
     "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": "de8d306117b73b91cd0c9ad0f900c3221f8db4ab7794f3f6e5a0adb0c7bdd3f6",
+    "typesPublisherContentHash": "987977fd9bbb9fc7bc190dbc3e6cf663be73b41d1e2b6f7a94127729ab900282",
     "typeScriptVersion": "4.3"
 }