@types/office-js-preview 1.0.547 → 1.0.549

office-js-preview/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
 
 ### Additional Details
- * Last updated: Tue, 21 Jan 2025 20:02:16 GMT
+ * Last updated: Wed, 29 Jan 2025 23:02:16 GMT
  * Dependencies: none
 
 # Credits

office-js-preview/index.d.ts

@@ -104143,6 +104143,14 @@ declare namespace Word {
          * @beta
          */
         readonly body: Word.Body;
+        /**
+         * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        readonly parentGroup: Word.Shape;
         /**
          * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
          *
@@ -104175,6 +104183,14 @@ declare namespace Word {
          * @beta
          */
         readonly id: number;
+        /**
+         * Check whether this shape is a child of a group shape or a canvas shape.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         */
+        readonly isChild: boolean;
         /**
          * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set.
          *
@@ -104361,7 +104377,7 @@ declare namespace Word {
          * [Api set: WordApi BETA (PREVIEW ONLY)]
          * @beta
          */
-        unGroup(): Word.ShapeCollection;
+        ungroup(): Word.ShapeCollection;
         /**
          * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
          *
@@ -104449,6 +104465,16 @@ declare namespace Word {
          * @param ids Required. An array of shape identifiers.
          */
         getByIds(ids: number[]): Word.ShapeCollection;
+        /**
+         * Gets the shapes that have the specified names.
+         *
+         * @remarks
+         * [Api set: WordApi BETA (PREVIEW ONLY)]
+         * @beta
+         *
+         * @param names Required. An array of shape names.
+         */
+        getByNames(names: string[]): Word.ShapeCollection;
         /**
          * Gets the shapes that have the specified types.
          *
@@ -111447,13 +111473,21 @@ declare namespace Word {
         /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
         interface ShapeUpdateData {
             /**
-            * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
-            *
-            * @remarks
-            * [Api set: WordApi BETA (PREVIEW ONLY)]
-            * @beta
-            */
+             * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
             body?: Word.Interfaces.BodyUpdateData;
+            /**
+             * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            parentGroup?: Word.Interfaces.ShapeUpdateData;
             /**
              * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
              *
@@ -113799,6 +113833,14 @@ declare namespace Word {
              * @beta
              */
             body?: Word.Interfaces.BodyData;
+            /**
+             * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            parentGroup?: Word.Interfaces.ShapeData;
             /**
              * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
              *
@@ -113831,6 +113873,14 @@ declare namespace Word {
              * @beta
              */
             id?: number;
+            /**
+             * Check whether this shape is a child of a group shape or a canvas shape.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            isChild?: boolean;
             /**
              * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set.
              *
@@ -118311,13 +118361,21 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-            * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
-            *
-            * @remarks
-            * [Api set: WordApi BETA (PREVIEW ONLY)]
-            * @beta
-            */
+             * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
             body?: Word.Interfaces.BodyLoadOptions;
+            /**
+             * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            parentGroup?: Word.Interfaces.ShapeLoadOptions;
             /**
              * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
              *
@@ -118350,6 +118408,14 @@ declare namespace Word {
              * @beta
              */
             id?: boolean;
+            /**
+             * Check whether this shape is a child of a group shape or a canvas shape.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            isChild?: boolean;
             /**
              * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set.
              *
@@ -118449,13 +118515,21 @@ declare namespace Word {
              */
             $all?: boolean;
             /**
-            * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.
-            *
-            * @remarks
-            * [Api set: WordApi BETA (PREVIEW ONLY)]
-            * @beta
-            */
+             * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
             body?: Word.Interfaces.BodyLoadOptions;
+            /**
+             * For EACH ITEM in the collection: Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            parentGroup?: Word.Interfaces.ShapeLoadOptions;
             /**
              * For EACH ITEM in the collection: Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
              *
@@ -118488,6 +118562,14 @@ declare namespace Word {
              * @beta
              */
             id?: boolean;
+            /**
+             * For EACH ITEM in the collection: Check whether this shape is a child of a group shape or a canvas shape.
+             *
+             * @remarks
+             * [Api set: WordApi BETA (PREVIEW ONLY)]
+             * @beta
+             */
+            isChild?: boolean;
             /**
              * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set.
              *
@@ -130979,47 +131061,47 @@ 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;
         /**
-         * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
+         * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
          *
          * @remarks
          * [Api set: PowerPointApi 1.4]
          */
-        bold: boolean;
+        bold: boolean | null;
         /**
-         * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
+         * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
          *
          * @remarks
          * [Api set: PowerPointApi 1.4]
          */
-        color: string;
+        color: string | null;
         /**
-         * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
+         * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
          *
          * @remarks
          * [Api set: PowerPointApi 1.4]
          */
-        italic: boolean;
+        italic: boolean | null;
         /**
-         * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
+         * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
          *
          * @remarks
          * [Api set: PowerPointApi 1.4]
          */
-        name: string;
+        name: string | null;
         /**
-         * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
+         * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
          *
          * @remarks
          * [Api set: PowerPointApi 1.4]
          */
-        size: number;
+        size: number | null;
         /**
-         * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+         * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
          *
          * @remarks
          * [Api set: PowerPointApi 1.4]
          */
-        underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
+        underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
         /**
          * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
          *
@@ -133492,47 +133574,47 @@ declare namespace PowerPoint {
         /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
         interface ShapeFontUpdateData {
             /**
-             * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
+             * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            bold?: boolean;
+            bold?: boolean | null;
             /**
-             * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
+             * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            color?: string;
+            color?: string | null;
             /**
-             * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
+             * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            italic?: boolean;
+            italic?: boolean | null;
             /**
-             * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
+             * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            name?: string;
+            name?: string | null;
             /**
-             * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
+             * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            size?: number;
+            size?: number | null;
             /**
-             * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+             * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
+            underline?: ShapeFontUnderlineStyle | null;
         }
         /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
         interface ShapeCollectionUpdateData {
@@ -133918,47 +134000,47 @@ declare namespace PowerPoint {
         /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
         interface ShapeFontData {
             /**
-             * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
+             * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            bold?: boolean;
+            bold?: boolean | null;
             /**
-             * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
+             * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            color?: string;
+            color?: string | null;
             /**
-             * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
+             * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            italic?: boolean;
+            italic?: boolean | null;
             /**
-             * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
+             * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            name?: string;
+            name?: string | null;
             /**
-             * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
+             * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            size?: number;
+            size?: number | null;
             /**
-             * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+             * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
-            underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
+            underline?: ShapeFontUnderlineStyle | null;
         }
         /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
         interface ShapeCollectionData {
@@ -134603,42 +134685,42 @@ declare namespace PowerPoint {
              */
             $all?: boolean;
             /**
-             * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
+             * Specifies the bold status of font. Returns `null` if the `TextRange` contains both bold and non-bold text fragments.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
             bold?: boolean;
             /**
-             * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
+             * Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` contains text fragments with different colors.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
             color?: boolean;
             /**
-             * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
+             * Specifies the italic status of font. Returns 'null' if the 'TextRange' contains both italic and non-italic text fragments.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
             italic?: boolean;
             /**
-             * Represents font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name.
+             * Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it is the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
             name?: boolean;
             /**
-             * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
+             * Specifies the font size in points (e.g., 11). Returns `null` if the `TextRange` contains text fragments with different font sizes.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]
              */
             size?: boolean;
             /**
-             * Type of underline applied to the font. Returns `null` if the `TextRange` includes text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
+             * Specifies the type of underline applied to the font. Returns `null` if the `TextRange` contains text fragments with different underline styles. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
              *
              * @remarks
              * [Api set: PowerPointApi 1.4]

office-js-preview/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/office-js-preview",
-    "version": "1.0.547",
+    "version": "1.0.549",
     "description": "TypeScript definitions for office-js-preview",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
     "license": "MIT",
@@ -46,7 +46,7 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "4db040c5d81dea9385acbf01809334ae557c25ff403a53e754644cbdc08bed55",
+    "typesPublisherContentHash": "673eb8768e78d6dc665ef5b699e4c6258e6d23fbf13608bd248ce5298fe828fc",
     "typeScriptVersion": "5.0",
     "nonNpm": true
 }