@types/office-js 1.0.473 → 1.0.474

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: Mon, 03 Mar 2025 17:34:12 GMT
+ * Last updated: Mon, 03 Mar 2025 21:02:17 GMT
  * Dependencies: none
 
 # Credits

office-js/index.d.ts

@@ -96415,7 +96415,7 @@ declare namespace Word {
         toJSON(): Word.Interfaces.TrackedChangeCollectionData;
     }
     /**
-     * Represents a shape in the header, footer or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
+     * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
      *
      * @remarks
      * [Api set: WordApiDesktop 1.2]
@@ -96571,7 +96571,7 @@ declare namespace Word {
          */
         relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
         /**
-         * The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}.
+         * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
          *
          * @remarks
          * [Api set: WordApiDesktop 1.2]
@@ -96592,7 +96592,7 @@ declare namespace Word {
          */
         rotation: number;
         /**
-         * The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
+         * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
          *
          * @remarks
          * [Api set: WordApiDesktop 1.2]
@@ -96829,9 +96829,9 @@ declare namespace Word {
          */
         untrack(): Word.ShapeGroup;
         /**
-        * 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's passed to it.)
-        * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
-        */
+         * 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's passed to it.)
+         * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
+         */
         toJSON(): Word.Interfaces.ShapeGroupData;
     }
     /**
@@ -96908,7 +96908,7 @@ declare namespace Word {
         toJSON(): Word.Interfaces.CanvasData;
     }
     /**
-     * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
+     * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
      *
      * @remarks
      * [Api set: WordApiDesktop 1.2]
@@ -104336,7 +104336,7 @@ declare namespace Word {
              */
             relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
             /**
-             * The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}.
+             * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -104357,7 +104357,7 @@ declare namespace Word {
              */
             rotation?: number;
             /**
-             * The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
+             * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -104395,11 +104395,11 @@ declare namespace Word {
         /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */
         interface ShapeGroupUpdateData {
             /**
-            * Gets the Shape object associated with the group.
-            *
-            * @remarks
-            * [Api set: WordApiDesktop 1.2]
-            */
+             * Gets the Shape object associated with the group.
+             *
+             * @remarks
+             * [Api set: WordApiDesktop 1.2]
+             */
             shape?: Word.Interfaces.ShapeUpdateData;
         }
         /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */
@@ -105888,7 +105888,7 @@ declare namespace Word {
              */
             listItemOrNullObject?: Word.Interfaces.ListItemData;
             /**
-             * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
+             * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -107006,7 +107006,7 @@ declare namespace Word {
              */
             relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
             /**
-             * The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}.
+             * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -107027,7 +107027,7 @@ declare namespace Word {
              */
             rotation?: number;
             /**
-             * The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
+             * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -107072,18 +107072,18 @@ declare namespace Word {
         /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
         interface ShapeGroupData {
             /**
-            * Gets the Shape object associated with the group.
-            *
-            * @remarks
-            * [Api set: WordApiDesktop 1.2]
-            */
+             * Gets the Shape object associated with the group.
+             *
+             * @remarks
+             * [Api set: WordApiDesktop 1.2]
+             */
             shape?: Word.Interfaces.ShapeData;
             /**
-            * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported.
-            *
-            * @remarks
-            * [Api set: WordApiDesktop 1.2]
-            */
+             * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported.
+             *
+             * @remarks
+             * [Api set: WordApiDesktop 1.2]
+             */
             shapes?: Word.Interfaces.ShapeData[];
             /**
              * Gets an integer that represents the shape group identifier.
@@ -107096,18 +107096,18 @@ declare namespace Word {
         /** An interface describing the data returned by calling `canvas.toJSON()`. */
         interface CanvasData {
             /**
-            * Gets the Shape object associated with the canvas.
-            *
-            * @remarks
-            * [Api set: WordApiDesktop 1.2]
-            */
+             * Gets the Shape object associated with the canvas.
+             *
+             * @remarks
+             * [Api set: WordApiDesktop 1.2]
+             */
             shape?: Word.Interfaces.ShapeData;
             /**
-            * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.
-            *
-            * @remarks
-            * [Api set: WordApiDesktop 1.2]
-            */
+             * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.
+             *
+             * @remarks
+             * [Api set: WordApiDesktop 1.2]
+             */
             shapes?: Word.Interfaces.ShapeData[];
             /**
              * Gets an integer that represents the canvas identifier.
@@ -111692,7 +111692,7 @@ declare namespace Word {
             type?: boolean;
         }
         /**
-         * Represents a shape in the header, footer or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
+         * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
          *
          * @remarks
          * [Api set: WordApiDesktop 1.2]
@@ -111759,11 +111759,11 @@ declare namespace Word {
              */
             textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
             /**
-              * Specifies whether a given shape can overlap other shapes.
-              *
-              * @remarks
-              * [Api set: WordApiDesktop 1.2]
-              */
+             * Specifies whether a given shape can overlap other shapes.
+             *
+             * @remarks
+             * [Api set: WordApiDesktop 1.2]
+             */
             allowOverlap?: boolean;
             /**
              * Specifies a string that represents the alternative text associated with the shape.
@@ -111850,7 +111850,7 @@ declare namespace Word {
              */
             relativeHorizontalSize?: boolean;
             /**
-             * The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}.
+             * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -111871,7 +111871,7 @@ declare namespace Word {
              */
             rotation?: boolean;
             /**
-             * The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
+             * The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -112124,7 +112124,7 @@ declare namespace Word {
              */
             relativeHorizontalSize?: boolean;
             /**
-             * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, See {@link Word.RelativeVerticalPosition}.
+             * For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -112145,7 +112145,7 @@ declare namespace Word {
              */
             rotation?: boolean;
             /**
-             * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, See {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
+             * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
              *
              * @remarks
              * [Api set: WordApiDesktop 1.2]
@@ -124775,7 +124775,13 @@ declare namespace PowerPoint {
         /** 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 bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
+         * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+         *
+         * - `true`: All the text is bold.
+         *
+         * - `false`: None of the text is bold.
+         *
+         * - `null`: Returned if some, but not all, of the text is bold.
          *
          * @remarks
          * [Api set: PowerPointApi 1.4]
@@ -124789,7 +124795,13 @@ declare namespace PowerPoint {
          */
         color: string | null;
         /**
-         * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
+         * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+         *
+         * - `true`: All the text is italicized.
+         *
+         * - `false`: None of the text is italicized.
+         *
+         * - `null`: Returned if some, but not all, of the text is italicized.
          *
          * @remarks
          * [Api set: PowerPointApi 1.4]
@@ -126816,7 +126828,13 @@ declare namespace PowerPoint {
         /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
         interface ShapeFontUpdateData {
             /**
-             * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
+             * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+             *
+             * - `true`: All the text is bold.
+             *
+             * - `false`: None of the text is bold.
+             *
+             * - `null`: Returned if some, but not all, of the text is bold.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
@@ -126830,7 +126848,13 @@ declare namespace PowerPoint {
              */
             color?: string | null;
             /**
-             * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
+             * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+             *
+             * - `true`: All the text is italicized.
+             *
+             * - `false`: None of the text is italicized.
+             *
+             * - `null`: Returned if some, but not all, of the text is italicized.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
@@ -127242,7 +127266,13 @@ declare namespace PowerPoint {
         /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
         interface ShapeFontData {
             /**
-             * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
+             * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+             *
+             * - `true`: All the text is bold.
+             *
+             * - `false`: None of the text is bold.
+             *
+             * - `null`: Returned if some, but not all, of the text is bold.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
@@ -127256,7 +127286,13 @@ declare namespace PowerPoint {
              */
             color?: string | null;
             /**
-             * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
+             * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+             *
+             * - `true`: All the text is italicized.
+             *
+             * - `false`: None of the text is italicized.
+             *
+             * - `null`: Returned if some, but not all, of the text is italicized.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
@@ -127886,7 +127922,13 @@ declare namespace PowerPoint {
              */
             $all?: boolean;
             /**
-             * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
+             * Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
+             *
+             * - `true`: All the text is bold.
+             *
+             * - `false`: None of the text is bold.
+             *
+             * - `null`: Returned if some, but not all, of the text is bold.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
@@ -127900,7 +127942,13 @@ declare namespace PowerPoint {
              */
             color?: boolean;
             /**
-             * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
+             * Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
+             *
+             * - `true`: All the text is italicized.
+             *
+             * - `false`: None of the text is italicized.
+             *
+             * - `null`: Returned if some, but not all, of the text is italicized.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
@@ -127940,25 +127988,25 @@ declare namespace PowerPoint {
              */
             $all?: boolean;
             /**
-            * For EACH ITEM in the collection: Returns the fill formatting of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.4]
-            */
+             * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.4]
+             */
             fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
             /**
-            * For EACH ITEM in the collection: Returns the line formatting of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.4]
-            */
+             * For EACH ITEM in the collection: Returns the line formatting of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.4]
+             */
             lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
             /**
-            * For EACH ITEM in the collection: Returns the text frame object of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.4]
-            */
+             * For EACH ITEM in the collection: Returns the text frame object of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.4]
+             */
             textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
             /**
              * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
@@ -128185,25 +128233,25 @@ declare namespace PowerPoint {
              */
             $all?: boolean;
             /**
-            * For EACH ITEM in the collection: Returns the fill formatting of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.5]
-            */
+             * For EACH ITEM in the collection: Returns the fill formatting of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.5]
+             */
             fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
             /**
-            * For EACH ITEM in the collection: Returns the line formatting of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.5]
-            */
+             * For EACH ITEM in the collection: Returns the line formatting of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.5]
+             */
             lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
             /**
-            * For EACH ITEM in the collection: Returns the text frame object of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.5]
-            */
+             * For EACH ITEM in the collection: Returns the text frame object of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.5]
+             */
             textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
             /**
              * For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
@@ -128490,25 +128538,25 @@ declare namespace PowerPoint {
              */
             $all?: boolean;
             /**
-            * Returns the fill formatting of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.4]
-            */
+             * Returns the fill formatting of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.4]
+             */
             fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
             /**
-            * Returns the line formatting of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.4]
-            */
+             * Returns the line formatting of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.4]
+             */
             lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
             /**
-            * Returns the text frame object of this shape.
-            *
-            * @remarks
-            * [Api set: PowerPointApi 1.4]
-            */
+             * Returns the text frame object of this shape.
+             *
+             * @remarks
+             * [Api set: PowerPointApi 1.4]
+             */
             textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
             /**
              * Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.

office-js/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js",
-    "version": "1.0.473",
+    "version": "1.0.474",
     "description": "TypeScript definitions for office-js",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
     "license": "MIT",
@@ -46,6 +46,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "18373658f65aad79784846a881f83e22fe4859c8f484c7e5c8742ffac8f8e7d2",
+    "typesPublisherContentHash": "2c3b0bb2b9e42aaf43a598224e667362fc47d07d0bfd07c5a58c7dc6e9a45a3d",
     "typeScriptVersion": "5.0"
 }