@types/office-js-preview 1.0.545 → 1.0.547

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 21 Jan 2025 19:02:30 GMT
11
+ * Last updated: Tue, 21 Jan 2025 20:02:16 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -22269,8 +22269,9 @@ declare namespace Office {
22269
22269
  * your add-in has persisted changes.
22270
22270
  * The persisted changes will not be available until the task pane (or item in the case of UI-less add-ins) is closed and reopened.
22271
22271
  *
22272
- * - When set and saved through Outlook on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} or classic) or on Mac,
22273
- * these settings are reflected in Outlook on the web only after a browser refresh.
22272
+ * - In classic Outlook on Windows, if roaming settings were configured on another Outlook client, the desktop client doesn't need to be restarted.
22273
+ * However, the add-in needs to be reloaded to access these settings. In Outlook on the web, on Mac, and in the new Outlook on Windows,
22274
+ * you must refresh the browser or restart the client to access roaming settings set on another client.
22274
22275
  *
22275
22276
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
22276
22277
  *
@@ -94790,7 +94791,7 @@ declare namespace Word {
94790
94791
  */
94791
94792
  readonly parentSectionOrNullObject: Word.Section;
94792
94793
  /**
94793
- * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only text boxes and geometric shapes are supported.
94794
+ * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
94794
94795
  *
94795
94796
  * @remarks
94796
94797
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -100002,7 +100003,7 @@ declare namespace Word {
100002
100003
  */
100003
100004
  readonly parentTableOrNullObject: Word.Table;
100004
100005
  /**
100005
- * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only text boxes and geometric shapes are supported.
100006
+ * 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, grouped, and picture.
100006
100007
  *
100007
100008
  * @remarks
100008
100009
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -100345,7 +100346,7 @@ declare namespace Word {
100345
100346
  * @beta
100346
100347
  *
100347
100348
  * @param geometricShapeType The geometric type of the shape to insert.
100348
- * @param insertShapeOptions Optional. The size and location of the geometric shape. The default location and size is (0, 0, 100, 100).
100349
+ * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
100349
100350
  */
100350
100351
  insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
100351
100352
  /**
@@ -100356,7 +100357,7 @@ declare namespace Word {
100356
100357
  * @beta
100357
100358
  *
100358
100359
  * @param geometricShapeType The geometric type of the shape to insert.
100359
- * @param insertShapeOptions Optional. The size and location of the geometric shape. The default location and size is (0, 0, 100, 100).
100360
+ * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
100360
100361
  */
100361
100362
  insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
100362
100363
  /**
@@ -100399,6 +100400,17 @@ declare namespace Word {
100399
100400
  * @param insertLocation Required. The value must be 'Before' or 'After'.
100400
100401
  */
100401
100402
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
100403
+ /**
100404
+ * Inserts a floating picture with its anchor at the beginning of the paragraph.
100405
+ *
100406
+ * @remarks
100407
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100408
+ * @beta
100409
+ *
100410
+ * @param base64EncodedImage Required. The Base64-encoded image to be inserted.
100411
+ * @param insertShapeOptions Optional. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size.
100412
+ */
100413
+ insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
100402
100414
  /**
100403
100415
  * Inserts a table with the specified number of rows and columns.
100404
100416
  *
@@ -100429,7 +100441,7 @@ declare namespace Word {
100429
100441
  * @beta
100430
100442
  *
100431
100443
  * @param text Optional. The text to insert into the text box.
100432
- * @param insertShapeOptions Optional. The size and location of the text box. The default location and size is (0, 0, 100, 100).
100444
+ * @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100).
100433
100445
  */
100434
100446
  insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
100435
100447
  /**
@@ -100909,7 +100921,7 @@ declare namespace Word {
100909
100921
  */
100910
100922
  readonly parentTableOrNullObject: Word.Table;
100911
100923
  /**
100912
- * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only text boxes and geometric shapes are supported.
100924
+ * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
100913
100925
  *
100914
100926
  * @remarks
100915
100927
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101264,7 +101276,7 @@ declare namespace Word {
101264
101276
  * @beta
101265
101277
  *
101266
101278
  * @param geometricShapeType The geometric type of the shape to insert.
101267
- * @param insertShapeOptions Optional. The size and location of the geometric shape. The default location and size is (0, 0, 100, 100).
101279
+ * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
101268
101280
  */
101269
101281
  insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
101270
101282
  /**
@@ -101275,7 +101287,7 @@ declare namespace Word {
101275
101287
  * @beta
101276
101288
  *
101277
101289
  * @param geometricShapeType The geometric type of the shape to insert.
101278
- * @param insertShapeOptions Optional. The size and location of the geometric shape. The default location and size is (0, 0, 100, 100).
101290
+ * @param insertShapeOptions Optional. The location and size of the geometric shape. The default location and size is (0, 0, 100, 100).
101279
101291
  */
101280
101292
  insertGeometricShape(geometricShapeType: "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus", insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
101281
101293
  /**
@@ -101318,6 +101330,17 @@ declare namespace Word {
101318
101330
  * @param insertLocation Required. The value must be 'Before' or 'After'.
101319
101331
  */
101320
101332
  insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
101333
+ /**
101334
+ * Inserts a floating picture with its anchor at the beginning of the range.
101335
+ *
101336
+ * @remarks
101337
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
101338
+ * @beta
101339
+ *
101340
+ * @param base64EncodedImage Required. The Base64-encoded image to be inserted.
101341
+ * @param insertShapeOptions Required. The location and size of the picture. The default location is (0, 0) and the default size is the image's original size.
101342
+ */
101343
+ insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
101321
101344
  /**
101322
101345
  * Inserts a table with the specified number of rows and columns.
101323
101346
  *
@@ -101348,7 +101371,7 @@ declare namespace Word {
101348
101371
  * @beta
101349
101372
  *
101350
101373
  * @param text Optional. The text to insert into the text box.
101351
- * @param insertShapeOptions Optional. The size and location of the text box. The default location and size is (0, 0, 100, 100).
101374
+ * @param insertShapeOptions Optional. The location and size of the text box. The default location and size is (0, 0, 100, 100).
101352
101375
  */
101353
101376
  insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
101354
101377
  /**
@@ -101557,7 +101580,7 @@ declare namespace Word {
101557
101580
  toJSON(): Word.Interfaces.RangeCollectionData;
101558
101581
  }
101559
101582
  /**
101560
- * Specifies the options to determine size and location when inserting a shape.
101583
+ * Specifies the options to determine location and size when inserting a shape.
101561
101584
  *
101562
101585
  * @remarks
101563
101586
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104103,7 +104126,7 @@ declare namespace Word {
104103
104126
  toJSON(): Word.Interfaces.TrackedChangeCollectionData;
104104
104127
  }
104105
104128
  /**
104106
- * Represents a shape in the header footer or document body. Currently, only text boxes and geometric shapes are supported.
104129
+ * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
104107
104130
  *
104108
104131
  * @remarks
104109
104132
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104120,6 +104143,22 @@ declare namespace Word {
104120
104143
  * @beta
104121
104144
  */
104122
104145
  readonly body: Word.Body;
104146
+ /**
104147
+ * 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}.
104148
+ *
104149
+ * @remarks
104150
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104151
+ * @beta
104152
+ */
104153
+ readonly shapeGroup: Word.ShapeGroup;
104154
+ /**
104155
+ * The geometric shape type of the shape. It will be null if isn't a geometric shape.
104156
+ *
104157
+ * @remarks
104158
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104159
+ * @beta
104160
+ */
104161
+ geometricShapeType: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
104123
104162
  /**
104124
104163
  * The height, in points, of the shape.
104125
104164
  *
@@ -104137,7 +104176,7 @@ declare namespace Word {
104137
104176
  */
104138
104177
  readonly id: number;
104139
104178
  /**
104140
- * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set.
104179
+ * 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.
104141
104180
  *
104142
104181
  * @remarks
104143
104182
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104145,7 +104184,15 @@ declare namespace Word {
104145
104184
  */
104146
104185
  left: number;
104147
104186
  /**
104148
- * The relative horizontal position of the shape. For a floating shape, it can't be set.
104187
+ * The name of the shape.
104188
+ *
104189
+ * @remarks
104190
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104191
+ * @beta
104192
+ */
104193
+ name: string;
104194
+ /**
104195
+ * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
104149
104196
  *
104150
104197
  * @remarks
104151
104198
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104153,7 +104200,7 @@ declare namespace Word {
104153
104200
  */
104154
104201
  relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
104155
104202
  /**
104156
- * The relative vertical position of the shape. For a floating shape, it can't be set.
104203
+ * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
104157
104204
  *
104158
104205
  * @remarks
104159
104206
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104161,7 +104208,7 @@ declare namespace Word {
104161
104208
  */
104162
104209
  relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
104163
104210
  /**
104164
- * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set.
104211
+ * 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.
104165
104212
  *
104166
104213
  * @remarks
104167
104214
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104169,13 +104216,13 @@ declare namespace Word {
104169
104216
  */
104170
104217
  top: number;
104171
104218
  /**
104172
- * Gets the shape type. Currently, only text boxes and geometric shapes are supported.
104219
+ * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
104173
104220
  *
104174
104221
  * @remarks
104175
104222
  * [Api set: WordApi BETA (PREVIEW ONLY)]
104176
104223
  * @beta
104177
104224
  */
104178
- readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape";
104225
+ readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture";
104179
104226
  /**
104180
104227
  * The width, in points, of the shape.
104181
104228
  *
@@ -104200,6 +104247,26 @@ declare namespace Word {
104200
104247
  * @beta
104201
104248
  */
104202
104249
  delete(): void;
104250
+ /**
104251
+ * Moves the shape horizontally by the number of points.
104252
+ *
104253
+ * @remarks
104254
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104255
+ * @beta
104256
+ *
104257
+ * @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left.
104258
+ */
104259
+ moveHorizontally(distance: number): void;
104260
+ /**
104261
+ * Moves the shape vertically by the number of points.
104262
+ *
104263
+ * @remarks
104264
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104265
+ * @beta
104266
+ *
104267
+ * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down.
104268
+ */
104269
+ moveVertically(distance: number): void;
104203
104270
  /**
104204
104271
  * Selects the shape.
104205
104272
  *
@@ -104246,7 +104313,92 @@ declare namespace Word {
104246
104313
  toJSON(): Word.Interfaces.ShapeData;
104247
104314
  }
104248
104315
  /**
104249
- * Contains a collection of {@link Word.Shape} objects. Currently, only text boxes and geometric shapes are supported.
104316
+ * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
104317
+ *
104318
+ * @remarks
104319
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104320
+ * @beta
104321
+ */
104322
+ class ShapeGroup extends OfficeExtension.ClientObject {
104323
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
104324
+ context: RequestContext;
104325
+ /**
104326
+ * Gets the Shape object associated with the group.
104327
+ *
104328
+ * @remarks
104329
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104330
+ * @beta
104331
+ */
104332
+ readonly shape: Word.Shape;
104333
+ /**
104334
+ * Gets the collection of Shape objects. Currently, only text boxes and geometric shapes are supported.
104335
+ *
104336
+ * @remarks
104337
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104338
+ * @beta
104339
+ */
104340
+ readonly shapes: Word.ShapeCollection;
104341
+ /**
104342
+ * Gets an integer that represents the shape group identifier.
104343
+ *
104344
+ * @remarks
104345
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104346
+ * @beta
104347
+ */
104348
+ readonly id: number;
104349
+ /**
104350
+ * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
104351
+ * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
104352
+ * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
104353
+ */
104354
+ set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void;
104355
+ /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
104356
+ set(properties: Word.ShapeGroup): void;
104357
+ /**
104358
+ * Ungroups any grouped shapes in the specified shape group.
104359
+ *
104360
+ * @remarks
104361
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104362
+ * @beta
104363
+ */
104364
+ unGroup(): Word.ShapeCollection;
104365
+ /**
104366
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
104367
+ *
104368
+ * @param options Provides options for which properties of the object to load.
104369
+ */
104370
+ load(options?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup;
104371
+ /**
104372
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
104373
+ *
104374
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
104375
+ */
104376
+ load(propertyNames?: string | string[]): Word.ShapeGroup;
104377
+ /**
104378
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
104379
+ *
104380
+ * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
104381
+ */
104382
+ load(propertyNamesAndPaths?: {
104383
+ select?: string;
104384
+ expand?: string;
104385
+ }): Word.ShapeGroup;
104386
+ /**
104387
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
104388
+ */
104389
+ track(): Word.ShapeGroup;
104390
+ /**
104391
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
104392
+ */
104393
+ untrack(): Word.ShapeGroup;
104394
+ /**
104395
+ * 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.)
104396
+ * 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.
104397
+ */
104398
+ toJSON(): Word.Interfaces.ShapeGroupData;
104399
+ }
104400
+ /**
104401
+ * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
104250
104402
  *
104251
104403
  * @remarks
104252
104404
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104287,6 +104439,16 @@ declare namespace Word {
104287
104439
  * @param id Required. A shape identifier.
104288
104440
  */
104289
104441
  getByIdOrNullObject(id: number): Word.Shape;
104442
+ /**
104443
+ * Gets the shapes by the identifiers.
104444
+ *
104445
+ * @remarks
104446
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104447
+ * @beta
104448
+ *
104449
+ * @param ids Required. An array of shape identifiers.
104450
+ */
104451
+ getByIds(ids: number[]): Word.ShapeCollection;
104290
104452
  /**
104291
104453
  * Gets the shapes that have the specified types.
104292
104454
  *
@@ -104313,6 +104475,14 @@ declare namespace Word {
104313
104475
  * @beta
104314
104476
  */
104315
104477
  getFirstOrNullObject(): Word.Shape;
104478
+ /**
104479
+ * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes.
104480
+ *
104481
+ * @remarks
104482
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104483
+ * @beta
104484
+ */
104485
+ group(): Word.Shape;
104316
104486
  /**
104317
104487
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
104318
104488
  *
@@ -108351,6 +108521,20 @@ declare namespace Word {
108351
108521
  * @beta
108352
108522
  */
108353
108523
  geometricShape = "GeometricShape",
108524
+ /**
108525
+ * Group shape.
108526
+ * @remarks
108527
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108528
+ * @beta
108529
+ */
108530
+ group = "Group",
108531
+ /**
108532
+ * Picture shape.
108533
+ * @remarks
108534
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108535
+ * @beta
108536
+ */
108537
+ picture = "Picture",
108354
108538
  }
108355
108539
  /**
108356
108540
  * Represents what the horizontal position of a shape is relative to.
@@ -111270,6 +111454,22 @@ declare namespace Word {
111270
111454
  * @beta
111271
111455
  */
111272
111456
  body?: Word.Interfaces.BodyUpdateData;
111457
+ /**
111458
+ * 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}.
111459
+ *
111460
+ * @remarks
111461
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
111462
+ * @beta
111463
+ */
111464
+ shapeGroup?: Word.Interfaces.ShapeGroupUpdateData;
111465
+ /**
111466
+ * The geometric shape type of the shape. It will be null if isn't a geometric shape.
111467
+ *
111468
+ * @remarks
111469
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
111470
+ * @beta
111471
+ */
111472
+ geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
111273
111473
  /**
111274
111474
  * The height, in points, of the shape.
111275
111475
  *
@@ -111279,7 +111479,7 @@ declare namespace Word {
111279
111479
  */
111280
111480
  height?: number;
111281
111481
  /**
111282
- * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set.
111482
+ * 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.
111283
111483
  *
111284
111484
  * @remarks
111285
111485
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -111287,7 +111487,15 @@ declare namespace Word {
111287
111487
  */
111288
111488
  left?: number;
111289
111489
  /**
111290
- * The relative horizontal position of the shape. For a floating shape, it can't be set.
111490
+ * The name of the shape.
111491
+ *
111492
+ * @remarks
111493
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
111494
+ * @beta
111495
+ */
111496
+ name?: string;
111497
+ /**
111498
+ * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
111291
111499
  *
111292
111500
  * @remarks
111293
111501
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -111295,7 +111503,7 @@ declare namespace Word {
111295
111503
  */
111296
111504
  relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
111297
111505
  /**
111298
- * The relative vertical position of the shape. For a floating shape, it can't be set.
111506
+ * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
111299
111507
  *
111300
111508
  * @remarks
111301
111509
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -111303,7 +111511,7 @@ declare namespace Word {
111303
111511
  */
111304
111512
  relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
111305
111513
  /**
111306
- * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set.
111514
+ * 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.
111307
111515
  *
111308
111516
  * @remarks
111309
111517
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -111319,6 +111527,17 @@ declare namespace Word {
111319
111527
  */
111320
111528
  width?: number;
111321
111529
  }
111530
+ /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */
111531
+ interface ShapeGroupUpdateData {
111532
+ /**
111533
+ * Gets the Shape object associated with the group.
111534
+ *
111535
+ * @remarks
111536
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
111537
+ * @beta
111538
+ */
111539
+ shape?: Word.Interfaces.ShapeUpdateData;
111540
+ }
111322
111541
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
111323
111542
  interface ShapeCollectionUpdateData {
111324
111543
  items?: Word.Interfaces.ShapeData[];
@@ -111401,7 +111620,7 @@ declare namespace Word {
111401
111620
  */
111402
111621
  paragraphs?: Word.Interfaces.ParagraphData[];
111403
111622
  /**
111404
- * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only text boxes and geometric shapes are supported.
111623
+ * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
111405
111624
  *
111406
111625
  * @remarks
111407
111626
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -112592,19 +112811,19 @@ declare namespace Word {
112592
112811
  */
112593
112812
  listItem?: Word.Interfaces.ListItemData;
112594
112813
  /**
112595
- * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. 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}.
112596
- *
112597
- * @remarks
112598
- * [Api set: WordApi 1.3]
112599
- */
112814
+ * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return an object with its `isNullObject` property set to `true`. 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}.
112815
+ *
112816
+ * @remarks
112817
+ * [Api set: WordApi 1.3]
112818
+ */
112600
112819
  listItemOrNullObject?: Word.Interfaces.ListItemData;
112601
112820
  /**
112602
- * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only text boxes and geometric shapes are supported.
112603
- *
112604
- * @remarks
112605
- * [Api set: WordApi BETA (PREVIEW ONLY)]
112606
- * @beta
112607
- */
112821
+ * 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, grouped, and picture.
112822
+ *
112823
+ * @remarks
112824
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
112825
+ * @beta
112826
+ */
112608
112827
  shapes?: Word.Interfaces.ShapeData[];
112609
112828
  /**
112610
112829
  * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'.
@@ -112834,33 +113053,33 @@ declare namespace Word {
112834
113053
  /** An interface describing the data returned by calling `range.toJSON()`. */
112835
113054
  interface RangeData {
112836
113055
  /**
112837
- * Gets the collection of field objects in the range.
112838
- *
112839
- * @remarks
112840
- * [Api set: WordApi 1.4]
112841
- */
113056
+ * Gets the collection of field objects in the range.
113057
+ *
113058
+ * @remarks
113059
+ * [Api set: WordApi 1.4]
113060
+ */
112842
113061
  fields?: Word.Interfaces.FieldData[];
112843
113062
  /**
112844
- * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
112845
- *
112846
- * @remarks
112847
- * [Api set: WordApi 1.1]
112848
- */
113063
+ * Gets the text format of the range. Use this to get and set font name, size, color, and other properties.
113064
+ *
113065
+ * @remarks
113066
+ * [Api set: WordApi 1.1]
113067
+ */
112849
113068
  font?: Word.Interfaces.FontData;
112850
113069
  /**
112851
- * Gets the collection of inline picture objects in the range.
112852
- *
112853
- * @remarks
112854
- * [Api set: WordApi 1.2]
112855
- */
113070
+ * Gets the collection of inline picture objects in the range.
113071
+ *
113072
+ * @remarks
113073
+ * [Api set: WordApi 1.2]
113074
+ */
112856
113075
  inlinePictures?: Word.Interfaces.InlinePictureData[];
112857
113076
  /**
112858
- * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only text boxes and geometric shapes are supported.
112859
- *
112860
- * @remarks
112861
- * [Api set: WordApi BETA (PREVIEW ONLY)]
112862
- * @beta
112863
- */
113077
+ * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
113078
+ *
113079
+ * @remarks
113080
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
113081
+ * @beta
113082
+ */
112864
113083
  shapes?: Word.Interfaces.ShapeData[];
112865
113084
  /**
112866
113085
  * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part.
@@ -113573,13 +113792,29 @@ declare namespace Word {
113573
113792
  /** An interface describing the data returned by calling `shape.toJSON()`. */
113574
113793
  interface ShapeData {
113575
113794
  /**
113576
- * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
113577
- *
113578
- * @remarks
113579
- * [Api set: WordApi BETA (PREVIEW ONLY)]
113580
- * @beta
113581
- */
113795
+ * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
113796
+ *
113797
+ * @remarks
113798
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
113799
+ * @beta
113800
+ */
113582
113801
  body?: Word.Interfaces.BodyData;
113802
+ /**
113803
+ * 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}.
113804
+ *
113805
+ * @remarks
113806
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
113807
+ * @beta
113808
+ */
113809
+ shapeGroup?: Word.Interfaces.ShapeGroupData;
113810
+ /**
113811
+ * The geometric shape type of the shape. It will be null if isn't a geometric shape.
113812
+ *
113813
+ * @remarks
113814
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
113815
+ * @beta
113816
+ */
113817
+ geometricShapeType?: Word.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
113583
113818
  /**
113584
113819
  * The height, in points, of the shape.
113585
113820
  *
@@ -113597,7 +113832,7 @@ declare namespace Word {
113597
113832
  */
113598
113833
  id?: number;
113599
113834
  /**
113600
- * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set.
113835
+ * 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.
113601
113836
  *
113602
113837
  * @remarks
113603
113838
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -113605,7 +113840,15 @@ declare namespace Word {
113605
113840
  */
113606
113841
  left?: number;
113607
113842
  /**
113608
- * The relative horizontal position of the shape. For a floating shape, it can't be set.
113843
+ * The name of the shape.
113844
+ *
113845
+ * @remarks
113846
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
113847
+ * @beta
113848
+ */
113849
+ name?: string;
113850
+ /**
113851
+ * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
113609
113852
  *
113610
113853
  * @remarks
113611
113854
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -113613,7 +113856,7 @@ declare namespace Word {
113613
113856
  */
113614
113857
  relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";
113615
113858
  /**
113616
- * The relative vertical position of the shape. For a floating shape, it can't be set.
113859
+ * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
113617
113860
  *
113618
113861
  * @remarks
113619
113862
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -113621,7 +113864,7 @@ declare namespace Word {
113621
113864
  */
113622
113865
  relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
113623
113866
  /**
113624
- * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set.
113867
+ * 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.
113625
113868
  *
113626
113869
  * @remarks
113627
113870
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -113629,13 +113872,13 @@ declare namespace Word {
113629
113872
  */
113630
113873
  top?: number;
113631
113874
  /**
113632
- * Gets the shape type. Currently, only text boxes and geometric shapes are supported.
113875
+ * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
113633
113876
  *
113634
113877
  * @remarks
113635
113878
  * [Api set: WordApi BETA (PREVIEW ONLY)]
113636
113879
  * @beta
113637
113880
  */
113638
- type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape";
113881
+ type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture";
113639
113882
  /**
113640
113883
  * The width, in points, of the shape.
113641
113884
  *
@@ -113645,6 +113888,33 @@ declare namespace Word {
113645
113888
  */
113646
113889
  width?: number;
113647
113890
  }
113891
+ /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
113892
+ interface ShapeGroupData {
113893
+ /**
113894
+ * Gets the Shape object associated with the group.
113895
+ *
113896
+ * @remarks
113897
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
113898
+ * @beta
113899
+ */
113900
+ shape?: Word.Interfaces.ShapeData;
113901
+ /**
113902
+ * Gets the collection of Shape objects. Currently, only text boxes and geometric shapes are supported.
113903
+ *
113904
+ * @remarks
113905
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
113906
+ * @beta
113907
+ */
113908
+ shapes?: Word.Interfaces.ShapeData[];
113909
+ /**
113910
+ * Gets an integer that represents the shape group identifier.
113911
+ *
113912
+ * @remarks
113913
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
113914
+ * @beta
113915
+ */
113916
+ id?: number;
113917
+ }
113648
113918
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
113649
113919
  interface ShapeCollectionData {
113650
113920
  items?: Word.Interfaces.ShapeData[];
@@ -118029,7 +118299,7 @@ declare namespace Word {
118029
118299
  type?: boolean;
118030
118300
  }
118031
118301
  /**
118032
- * Represents a shape in the header footer or document body. Currently, only text boxes and geometric shapes are supported.
118302
+ * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
118033
118303
  *
118034
118304
  * @remarks
118035
118305
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118048,6 +118318,22 @@ declare namespace Word {
118048
118318
  * @beta
118049
118319
  */
118050
118320
  body?: Word.Interfaces.BodyLoadOptions;
118321
+ /**
118322
+ * 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}.
118323
+ *
118324
+ * @remarks
118325
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118326
+ * @beta
118327
+ */
118328
+ shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
118329
+ /**
118330
+ * The geometric shape type of the shape. It will be null if isn't a geometric shape.
118331
+ *
118332
+ * @remarks
118333
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118334
+ * @beta
118335
+ */
118336
+ geometricShapeType?: boolean;
118051
118337
  /**
118052
118338
  * The height, in points, of the shape.
118053
118339
  *
@@ -118065,7 +118351,7 @@ declare namespace Word {
118065
118351
  */
118066
118352
  id?: boolean;
118067
118353
  /**
118068
- * The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set.
118354
+ * 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.
118069
118355
  *
118070
118356
  * @remarks
118071
118357
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118073,7 +118359,15 @@ declare namespace Word {
118073
118359
  */
118074
118360
  left?: boolean;
118075
118361
  /**
118076
- * The relative horizontal position of the shape. For a floating shape, it can't be set.
118362
+ * The name of the shape.
118363
+ *
118364
+ * @remarks
118365
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118366
+ * @beta
118367
+ */
118368
+ name?: boolean;
118369
+ /**
118370
+ * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
118077
118371
  *
118078
118372
  * @remarks
118079
118373
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118081,7 +118375,7 @@ declare namespace Word {
118081
118375
  */
118082
118376
  relativeHorizontalPosition?: boolean;
118083
118377
  /**
118084
- * The relative vertical position of the shape. For a floating shape, it can't be set.
118378
+ * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
118085
118379
  *
118086
118380
  * @remarks
118087
118381
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118089,7 +118383,7 @@ declare namespace Word {
118089
118383
  */
118090
118384
  relativeVerticalPosition?: boolean;
118091
118385
  /**
118092
- * The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set.
118386
+ * 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.
118093
118387
  *
118094
118388
  * @remarks
118095
118389
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118097,7 +118391,7 @@ declare namespace Word {
118097
118391
  */
118098
118392
  top?: boolean;
118099
118393
  /**
118100
- * Gets the shape type. Currently, only text boxes and geometric shapes are supported.
118394
+ * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
118101
118395
  *
118102
118396
  * @remarks
118103
118397
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118114,7 +118408,36 @@ declare namespace Word {
118114
118408
  width?: boolean;
118115
118409
  }
118116
118410
  /**
118117
- * Contains a collection of {@link Word.Shape} objects. Currently, only text boxes and geometric shapes are supported.
118411
+ * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape.
118412
+ *
118413
+ * @remarks
118414
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118415
+ * @beta
118416
+ */
118417
+ interface ShapeGroupLoadOptions {
118418
+ /**
118419
+ Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
118420
+ */
118421
+ $all?: boolean;
118422
+ /**
118423
+ * Gets the Shape object associated with the group.
118424
+ *
118425
+ * @remarks
118426
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118427
+ * @beta
118428
+ */
118429
+ shape?: Word.Interfaces.ShapeLoadOptions;
118430
+ /**
118431
+ * Gets an integer that represents the shape group identifier.
118432
+ *
118433
+ * @remarks
118434
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118435
+ * @beta
118436
+ */
118437
+ id?: boolean;
118438
+ }
118439
+ /**
118440
+ * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
118118
118441
  *
118119
118442
  * @remarks
118120
118443
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118133,6 +118456,22 @@ declare namespace Word {
118133
118456
  * @beta
118134
118457
  */
118135
118458
  body?: Word.Interfaces.BodyLoadOptions;
118459
+ /**
118460
+ * 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}.
118461
+ *
118462
+ * @remarks
118463
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118464
+ * @beta
118465
+ */
118466
+ shapeGroup?: Word.Interfaces.ShapeGroupLoadOptions;
118467
+ /**
118468
+ * For EACH ITEM in the collection: The geometric shape type of the shape. It will be null if isn't a geometric shape.
118469
+ *
118470
+ * @remarks
118471
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118472
+ * @beta
118473
+ */
118474
+ geometricShapeType?: boolean;
118136
118475
  /**
118137
118476
  * For EACH ITEM in the collection: The height, in points, of the shape.
118138
118477
  *
@@ -118150,7 +118489,7 @@ declare namespace Word {
118150
118489
  */
118151
118490
  id?: boolean;
118152
118491
  /**
118153
- * For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the horizontal relative position. For a floating shape, it will return 0 and can't be set.
118492
+ * 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.
118154
118493
  *
118155
118494
  * @remarks
118156
118495
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118158,7 +118497,15 @@ declare namespace Word {
118158
118497
  */
118159
118498
  left?: boolean;
118160
118499
  /**
118161
- * For EACH ITEM in the collection: The relative horizontal position of the shape. For a floating shape, it can't be set.
118500
+ * For EACH ITEM in the collection: The name of the shape.
118501
+ *
118502
+ * @remarks
118503
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
118504
+ * @beta
118505
+ */
118506
+ name?: boolean;
118507
+ /**
118508
+ * For EACH ITEM in the collection: The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}.
118162
118509
  *
118163
118510
  * @remarks
118164
118511
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118166,7 +118513,7 @@ declare namespace Word {
118166
118513
  */
118167
118514
  relativeHorizontalPosition?: boolean;
118168
118515
  /**
118169
- * For EACH ITEM in the collection: The relative vertical position of the shape. For a floating shape, it can't be set.
118516
+ * 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}.
118170
118517
  *
118171
118518
  * @remarks
118172
118519
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118174,7 +118521,7 @@ declare namespace Word {
118174
118521
  */
118175
118522
  relativeVerticalPosition?: boolean;
118176
118523
  /**
118177
- * For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position. For a floating shape, it will return 0 and can't be set.
118524
+ * 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.
118178
118525
  *
118179
118526
  * @remarks
118180
118527
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -118182,7 +118529,7 @@ declare namespace Word {
118182
118529
  */
118183
118530
  top?: boolean;
118184
118531
  /**
118185
- * For EACH ITEM in the collection: Gets the shape type. Currently, only text boxes and geometric shapes are supported.
118532
+ * For EACH ITEM in the collection: Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric, grouped, and picture.
118186
118533
  *
118187
118534
  * @remarks
118188
118535
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.545",
3
+ "version": "1.0.547",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -46,7 +46,7 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "f484d925a7f838116cb6ff25af7d159b71171daa6e291cbd2ee50a750911f870",
49
+ "typesPublisherContentHash": "4db040c5d81dea9385acbf01809334ae557c25ff403a53e754644cbdc08bed55",
50
50
  "typeScriptVersion": "5.0",
51
51
  "nonNpm": true
52
52
  }