@types/office-js-preview 1.0.543 → 1.0.545

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.
@@ -94790,7 +94790,7 @@ declare namespace Word {
94790
94790
  */
94791
94791
  readonly parentSectionOrNullObject: Word.Section;
94792
94792
  /**
94793
- * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only TextBox shapes are supported.
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
94794
  *
94795
94795
  * @remarks
94796
94796
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -100002,7 +100002,7 @@ declare namespace Word {
100002
100002
  */
100003
100003
  readonly parentTableOrNullObject: Word.Table;
100004
100004
  /**
100005
- * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only TextBox shapes are supported.
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
100006
  *
100007
100007
  * @remarks
100008
100008
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -100337,6 +100337,28 @@ declare namespace Word {
100337
100337
  * @param insertLocation Required. The value must be 'Replace', 'Start', or 'End'.
100338
100338
  */
100339
100339
  insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
100340
+ /**
100341
+ * Inserts a geometric shape with its anchor at the beginning of the paragraph.
100342
+ *
100343
+ * @remarks
100344
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100345
+ * @beta
100346
+ *
100347
+ * @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
+ */
100350
+ insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
100351
+ /**
100352
+ * Inserts a geometric shape with its anchor at the beginning of the paragraph.
100353
+ *
100354
+ * @remarks
100355
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
100356
+ * @beta
100357
+ *
100358
+ * @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
+ */
100361
+ 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;
100340
100362
  /**
100341
100363
  * Inserts HTML into the paragraph at the specified location.
100342
100364
  *
@@ -100887,7 +100909,7 @@ declare namespace Word {
100887
100909
  */
100888
100910
  readonly parentTableOrNullObject: Word.Table;
100889
100911
  /**
100890
- * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only TextBox shapes are supported.
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.
100891
100913
  *
100892
100914
  * @remarks
100893
100915
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -101234,6 +101256,28 @@ declare namespace Word {
101234
101256
  * @param insertText Optional. Text to be inserted into the footnote body. The default is "".
101235
101257
  */
101236
101258
  insertFootnote(insertText?: string): Word.NoteItem;
101259
+ /**
101260
+ * Inserts a geometric shape with its anchor at the beginning of the range.
101261
+ *
101262
+ * @remarks
101263
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
101264
+ * @beta
101265
+ *
101266
+ * @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).
101268
+ */
101269
+ insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions): Word.Shape;
101270
+ /**
101271
+ * Inserts a geometric shape with its anchor at the beginning of the range.
101272
+ *
101273
+ * @remarks
101274
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
101275
+ * @beta
101276
+ *
101277
+ * @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).
101279
+ */
101280
+ 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;
101237
101281
  /**
101238
101282
  * Inserts HTML at the specified location.
101239
101283
  *
@@ -104059,7 +104103,7 @@ declare namespace Word {
104059
104103
  toJSON(): Word.Interfaces.TrackedChangeCollectionData;
104060
104104
  }
104061
104105
  /**
104062
- * Represents a shape in the header footer or document body. Currently, only TextBox shapes are supported.
104106
+ * Represents a shape in the header footer or document body. Currently, only text boxes and geometric shapes are supported.
104063
104107
  *
104064
104108
  * @remarks
104065
104109
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104069,7 +104113,7 @@ declare namespace Word {
104069
104113
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
104070
104114
  context: RequestContext;
104071
104115
  /**
104072
- * Represents the body object of the shape. Only applies to TextBox shapes.
104116
+ * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
104073
104117
  *
104074
104118
  * @remarks
104075
104119
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104125,13 +104169,13 @@ declare namespace Word {
104125
104169
  */
104126
104170
  top: number;
104127
104171
  /**
104128
- * Gets the shape type. Currently, only TextBox shapes are supported.
104172
+ * Gets the shape type. Currently, only text boxes and geometric shapes are supported.
104129
104173
  *
104130
104174
  * @remarks
104131
104175
  * [Api set: WordApi BETA (PREVIEW ONLY)]
104132
104176
  * @beta
104133
104177
  */
104134
- readonly type: Word.ShapeType | "Unsupported" | "TextBox";
104178
+ readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape";
104135
104179
  /**
104136
104180
  * The width, in points, of the shape.
104137
104181
  *
@@ -104202,7 +104246,7 @@ declare namespace Word {
104202
104246
  toJSON(): Word.Interfaces.ShapeData;
104203
104247
  }
104204
104248
  /**
104205
- * Contains a collection of {@link Word.Shape} objects. Currently, only TextBox shapes are supported.
104249
+ * Contains a collection of {@link Word.Shape} objects. Currently, only text boxes and geometric shapes are supported.
104206
104250
  *
104207
104251
  * @remarks
104208
104252
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -104213,6 +104257,16 @@ declare namespace Word {
104213
104257
  context: RequestContext;
104214
104258
  /** Gets the loaded child items in this collection. */
104215
104259
  readonly items: Word.Shape[];
104260
+ /**
104261
+ * Gets the shapes that have the specified geometric types. Only applied to geometric shapes.
104262
+ *
104263
+ * @remarks
104264
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
104265
+ * @beta
104266
+ *
104267
+ * @param types Required. An array of geometric shape subtypes.
104268
+ */
104269
+ getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection;
104216
104270
  /**
104217
104271
  * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection.
104218
104272
  *
@@ -108290,6 +108344,13 @@ declare namespace Word {
108290
108344
  * @beta
108291
108345
  */
108292
108346
  textBox = "TextBox",
108347
+ /**
108348
+ * Geometric shape.
108349
+ * @remarks
108350
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108351
+ * @beta
108352
+ */
108353
+ geometricShape = "GeometricShape",
108293
108354
  }
108294
108355
  /**
108295
108356
  * Represents what the horizontal position of a shape is relative to.
@@ -108423,6 +108484,1254 @@ declare namespace Word {
108423
108484
  */
108424
108485
  outsideMargin = "OutsideMargin",
108425
108486
  }
108487
+ /**
108488
+ * Specifies the shape type for a `GeometricShape` object.
108489
+ *
108490
+ * @remarks
108491
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108492
+ * @beta
108493
+ */
108494
+ enum GeometricShapeType {
108495
+ /**
108496
+ * Line inverse geometric shape.
108497
+ * @remarks
108498
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108499
+ * @beta
108500
+ */
108501
+ lineInverse = "LineInverse",
108502
+ /**
108503
+ * Triangle geometric shape.
108504
+ * @remarks
108505
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108506
+ * @beta
108507
+ */
108508
+ triangle = "Triangle",
108509
+ /**
108510
+ * Right triangle geometric shape.
108511
+ * @remarks
108512
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108513
+ * @beta
108514
+ */
108515
+ rightTriangle = "RightTriangle",
108516
+ /**
108517
+ * Rectangle geometric shape.
108518
+ * @remarks
108519
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108520
+ * @beta
108521
+ */
108522
+ rectangle = "Rectangle",
108523
+ /**
108524
+ * Diamond geometric shape.
108525
+ * @remarks
108526
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108527
+ * @beta
108528
+ */
108529
+ diamond = "Diamond",
108530
+ /**
108531
+ * Parallelogram geometric shape.
108532
+ * @remarks
108533
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108534
+ * @beta
108535
+ */
108536
+ parallelogram = "Parallelogram",
108537
+ /**
108538
+ * Trapezoid geometric shape.
108539
+ * @remarks
108540
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108541
+ * @beta
108542
+ */
108543
+ trapezoid = "Trapezoid",
108544
+ /**
108545
+ * Non-isosceles trapezoid geometric shape.
108546
+ * @remarks
108547
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108548
+ * @beta
108549
+ */
108550
+ nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid",
108551
+ /**
108552
+ * Pentagon geometric shape.
108553
+ * @remarks
108554
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108555
+ * @beta
108556
+ */
108557
+ pentagon = "Pentagon",
108558
+ /**
108559
+ * Hexagon geometric shape.
108560
+ * @remarks
108561
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108562
+ * @beta
108563
+ */
108564
+ hexagon = "Hexagon",
108565
+ /**
108566
+ * Heptagon geometric shape.
108567
+ * @remarks
108568
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108569
+ * @beta
108570
+ */
108571
+ heptagon = "Heptagon",
108572
+ /**
108573
+ * Octagon geometric shape.
108574
+ * @remarks
108575
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108576
+ * @beta
108577
+ */
108578
+ octagon = "Octagon",
108579
+ /**
108580
+ * Decagon geometric shape.
108581
+ * @remarks
108582
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108583
+ * @beta
108584
+ */
108585
+ decagon = "Decagon",
108586
+ /**
108587
+ * Dodecagon geometric shape.
108588
+ * @remarks
108589
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108590
+ * @beta
108591
+ */
108592
+ dodecagon = "Dodecagon",
108593
+ /**
108594
+ * Star 4-point geometric shape.
108595
+ * @remarks
108596
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108597
+ * @beta
108598
+ */
108599
+ star4 = "Star4",
108600
+ /**
108601
+ * Star 5-point geometric shape.
108602
+ * @remarks
108603
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108604
+ * @beta
108605
+ */
108606
+ star5 = "Star5",
108607
+ /**
108608
+ * Star 6-point geometric shape.
108609
+ * @remarks
108610
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108611
+ * @beta
108612
+ */
108613
+ star6 = "Star6",
108614
+ /**
108615
+ * Star 7-point geometric shape.
108616
+ * @remarks
108617
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108618
+ * @beta
108619
+ */
108620
+ star7 = "Star7",
108621
+ /**
108622
+ * Star 8-point geometric shape.
108623
+ * @remarks
108624
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108625
+ * @beta
108626
+ */
108627
+ star8 = "Star8",
108628
+ /**
108629
+ * Star 10-point geometric shape.
108630
+ * @remarks
108631
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108632
+ * @beta
108633
+ */
108634
+ star10 = "Star10",
108635
+ /**
108636
+ * Star 12-point geometric shape.
108637
+ * @remarks
108638
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108639
+ * @beta
108640
+ */
108641
+ star12 = "Star12",
108642
+ /**
108643
+ * Star 16-point geometric shape.
108644
+ * @remarks
108645
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108646
+ * @beta
108647
+ */
108648
+ star16 = "Star16",
108649
+ /**
108650
+ * Star 24-point geometric shape.
108651
+ * @remarks
108652
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108653
+ * @beta
108654
+ */
108655
+ star24 = "Star24",
108656
+ /**
108657
+ * Star 32-point geometric shape.
108658
+ * @remarks
108659
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108660
+ * @beta
108661
+ */
108662
+ star32 = "Star32",
108663
+ /**
108664
+ * Round rectangle geometric shape.
108665
+ * @remarks
108666
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108667
+ * @beta
108668
+ */
108669
+ roundRectangle = "RoundRectangle",
108670
+ /**
108671
+ * Round one rectangle geometric shape.
108672
+ * @remarks
108673
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108674
+ * @beta
108675
+ */
108676
+ round1Rectangle = "Round1Rectangle",
108677
+ /**
108678
+ * Round two same rectangle geometric shape.
108679
+ * @remarks
108680
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108681
+ * @beta
108682
+ */
108683
+ round2SameRectangle = "Round2SameRectangle",
108684
+ /**
108685
+ * Round two diagonal rectangle geometric shape.
108686
+ * @remarks
108687
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108688
+ * @beta
108689
+ */
108690
+ round2DiagonalRectangle = "Round2DiagonalRectangle",
108691
+ /**
108692
+ * Snip round rectangle geometric shape.
108693
+ * @remarks
108694
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108695
+ * @beta
108696
+ */
108697
+ snipRoundRectangle = "SnipRoundRectangle",
108698
+ /**
108699
+ * Snip one rectangle geometric shape.
108700
+ * @remarks
108701
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108702
+ * @beta
108703
+ */
108704
+ snip1Rectangle = "Snip1Rectangle",
108705
+ /**
108706
+ * Snip two same rectangle geometric shape.
108707
+ * @remarks
108708
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108709
+ * @beta
108710
+ */
108711
+ snip2SameRectangle = "Snip2SameRectangle",
108712
+ /**
108713
+ * Snip two diagonal rectangle geometric shape.
108714
+ * @remarks
108715
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108716
+ * @beta
108717
+ */
108718
+ snip2DiagonalRectangle = "Snip2DiagonalRectangle",
108719
+ /**
108720
+ * Plaque geometric shape.
108721
+ * @remarks
108722
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108723
+ * @beta
108724
+ */
108725
+ plaque = "Plaque",
108726
+ /**
108727
+ * Ellipse geometric shape.
108728
+ * @remarks
108729
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108730
+ * @beta
108731
+ */
108732
+ ellipse = "Ellipse",
108733
+ /**
108734
+ * Teardrop geometric shape.
108735
+ * @remarks
108736
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108737
+ * @beta
108738
+ */
108739
+ teardrop = "Teardrop",
108740
+ /**
108741
+ * Home plate geometric shape.
108742
+ * @remarks
108743
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108744
+ * @beta
108745
+ */
108746
+ homePlate = "HomePlate",
108747
+ /**
108748
+ * Chevron geometric shape.
108749
+ * @remarks
108750
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108751
+ * @beta
108752
+ */
108753
+ chevron = "Chevron",
108754
+ /**
108755
+ * Pie wedge geometric shape.
108756
+ * @remarks
108757
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108758
+ * @beta
108759
+ */
108760
+ pieWedge = "PieWedge",
108761
+ /**
108762
+ * Pie geometric shape.
108763
+ * @remarks
108764
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108765
+ * @beta
108766
+ */
108767
+ pie = "Pie",
108768
+ /**
108769
+ * Block arc geometric shape.
108770
+ * @remarks
108771
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108772
+ * @beta
108773
+ */
108774
+ blockArc = "BlockArc",
108775
+ /**
108776
+ * Donut geometric shape.
108777
+ * @remarks
108778
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108779
+ * @beta
108780
+ */
108781
+ donut = "Donut",
108782
+ /**
108783
+ * No smoking geometric shape.
108784
+ * @remarks
108785
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108786
+ * @beta
108787
+ */
108788
+ noSmoking = "NoSmoking",
108789
+ /**
108790
+ * Right arrow geometric shape.
108791
+ * @remarks
108792
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108793
+ * @beta
108794
+ */
108795
+ rightArrow = "RightArrow",
108796
+ /**
108797
+ * Left arrow geometric shape.
108798
+ * @remarks
108799
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108800
+ * @beta
108801
+ */
108802
+ leftArrow = "LeftArrow",
108803
+ /**
108804
+ * Up arrow geometric shape.
108805
+ * @remarks
108806
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108807
+ * @beta
108808
+ */
108809
+ upArrow = "UpArrow",
108810
+ /**
108811
+ * Down arrow geometric shape.
108812
+ * @remarks
108813
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108814
+ * @beta
108815
+ */
108816
+ downArrow = "DownArrow",
108817
+ /**
108818
+ * Striped right arrow geometric shape.
108819
+ * @remarks
108820
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108821
+ * @beta
108822
+ */
108823
+ stripedRightArrow = "StripedRightArrow",
108824
+ /**
108825
+ * Notched right arrow geometric shape.
108826
+ * @remarks
108827
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108828
+ * @beta
108829
+ */
108830
+ notchedRightArrow = "NotchedRightArrow",
108831
+ /**
108832
+ * Bent up arrow geometric shape.
108833
+ * @remarks
108834
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108835
+ * @beta
108836
+ */
108837
+ bentUpArrow = "BentUpArrow",
108838
+ /**
108839
+ * Left-right arrow geometric shape.
108840
+ * @remarks
108841
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108842
+ * @beta
108843
+ */
108844
+ leftRightArrow = "LeftRightArrow",
108845
+ /**
108846
+ * Up-down arrow geometric shape.
108847
+ * @remarks
108848
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108849
+ * @beta
108850
+ */
108851
+ upDownArrow = "UpDownArrow",
108852
+ /**
108853
+ * Left-up arrow geometric shape.
108854
+ * @remarks
108855
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108856
+ * @beta
108857
+ */
108858
+ leftUpArrow = "LeftUpArrow",
108859
+ /**
108860
+ * Left-right-up arrow geometric shape.
108861
+ * @remarks
108862
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108863
+ * @beta
108864
+ */
108865
+ leftRightUpArrow = "LeftRightUpArrow",
108866
+ /**
108867
+ * Quad arrow geometric shape.
108868
+ * @remarks
108869
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108870
+ * @beta
108871
+ */
108872
+ quadArrow = "QuadArrow",
108873
+ /**
108874
+ * Left arrow callout geometric shape.
108875
+ * @remarks
108876
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108877
+ * @beta
108878
+ */
108879
+ leftArrowCallout = "LeftArrowCallout",
108880
+ /**
108881
+ * Right arrow callout geometric shape.
108882
+ * @remarks
108883
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108884
+ * @beta
108885
+ */
108886
+ rightArrowCallout = "RightArrowCallout",
108887
+ /**
108888
+ * Up arrow callout geometric shape.
108889
+ * @remarks
108890
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108891
+ * @beta
108892
+ */
108893
+ upArrowCallout = "UpArrowCallout",
108894
+ /**
108895
+ * Down arrow callout geometric shape.
108896
+ * @remarks
108897
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108898
+ * @beta
108899
+ */
108900
+ downArrowCallout = "DownArrowCallout",
108901
+ /**
108902
+ * Left-right arrow callout geometric shape.
108903
+ * @remarks
108904
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108905
+ * @beta
108906
+ */
108907
+ leftRightArrowCallout = "LeftRightArrowCallout",
108908
+ /**
108909
+ * Up-down arrow callout geometric shape.
108910
+ * @remarks
108911
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108912
+ * @beta
108913
+ */
108914
+ upDownArrowCallout = "UpDownArrowCallout",
108915
+ /**
108916
+ * Quad arrow callout geometric shape.
108917
+ * @remarks
108918
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108919
+ * @beta
108920
+ */
108921
+ quadArrowCallout = "QuadArrowCallout",
108922
+ /**
108923
+ * Bent arrow geometric shape.
108924
+ * @remarks
108925
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108926
+ * @beta
108927
+ */
108928
+ bentArrow = "BentArrow",
108929
+ /**
108930
+ * U-turn arrow geometric shape.
108931
+ * @remarks
108932
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108933
+ * @beta
108934
+ */
108935
+ uturnArrow = "UturnArrow",
108936
+ /**
108937
+ * Circular arrow geometric shape.
108938
+ * @remarks
108939
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108940
+ * @beta
108941
+ */
108942
+ circularArrow = "CircularArrow",
108943
+ /**
108944
+ * Left circular arrow geometric shape.
108945
+ * @remarks
108946
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108947
+ * @beta
108948
+ */
108949
+ leftCircularArrow = "LeftCircularArrow",
108950
+ /**
108951
+ * Left-right circular arrow geometric shape.
108952
+ * @remarks
108953
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108954
+ * @beta
108955
+ */
108956
+ leftRightCircularArrow = "LeftRightCircularArrow",
108957
+ /**
108958
+ * Curved right arrow geometric shape.
108959
+ * @remarks
108960
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108961
+ * @beta
108962
+ */
108963
+ curvedRightArrow = "CurvedRightArrow",
108964
+ /**
108965
+ * Curved left arrow geometric shape.
108966
+ * @remarks
108967
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108968
+ * @beta
108969
+ */
108970
+ curvedLeftArrow = "CurvedLeftArrow",
108971
+ /**
108972
+ * Curved up arrow geometric shape.
108973
+ * @remarks
108974
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108975
+ * @beta
108976
+ */
108977
+ curvedUpArrow = "CurvedUpArrow",
108978
+ /**
108979
+ * Curved down arrow geometric shape.
108980
+ * @remarks
108981
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108982
+ * @beta
108983
+ */
108984
+ curvedDownArrow = "CurvedDownArrow",
108985
+ /**
108986
+ * Swoosh arrow geometric shape.
108987
+ * @remarks
108988
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108989
+ * @beta
108990
+ */
108991
+ swooshArrow = "SwooshArrow",
108992
+ /**
108993
+ * Cube geometric shape.
108994
+ * @remarks
108995
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108996
+ * @beta
108997
+ */
108998
+ cube = "Cube",
108999
+ /**
109000
+ * Can geometric shape.
109001
+ * @remarks
109002
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109003
+ * @beta
109004
+ */
109005
+ can = "Can",
109006
+ /**
109007
+ * Lightning bolt geometric shape.
109008
+ * @remarks
109009
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109010
+ * @beta
109011
+ */
109012
+ lightningBolt = "LightningBolt",
109013
+ /**
109014
+ * Heart geometric shape.
109015
+ * @remarks
109016
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109017
+ * @beta
109018
+ */
109019
+ heart = "Heart",
109020
+ /**
109021
+ * Sun geometric shape.
109022
+ * @remarks
109023
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109024
+ * @beta
109025
+ */
109026
+ sun = "Sun",
109027
+ /**
109028
+ * Moon geometric shape.
109029
+ * @remarks
109030
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109031
+ * @beta
109032
+ */
109033
+ moon = "Moon",
109034
+ /**
109035
+ * Smiley face geometric shape.
109036
+ * @remarks
109037
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109038
+ * @beta
109039
+ */
109040
+ smileyFace = "SmileyFace",
109041
+ /**
109042
+ * Irregular seal 1 geometric shape.
109043
+ * @remarks
109044
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109045
+ * @beta
109046
+ */
109047
+ irregularSeal1 = "IrregularSeal1",
109048
+ /**
109049
+ * Irregular seal 2 geometric shape.
109050
+ * @remarks
109051
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109052
+ * @beta
109053
+ */
109054
+ irregularSeal2 = "IrregularSeal2",
109055
+ /**
109056
+ * Folded corner geometric shape.
109057
+ * @remarks
109058
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109059
+ * @beta
109060
+ */
109061
+ foldedCorner = "FoldedCorner",
109062
+ /**
109063
+ * Bevel geometric shape.
109064
+ * @remarks
109065
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109066
+ * @beta
109067
+ */
109068
+ bevel = "Bevel",
109069
+ /**
109070
+ * Frame geometric shape.
109071
+ * @remarks
109072
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109073
+ * @beta
109074
+ */
109075
+ frame = "Frame",
109076
+ /**
109077
+ * Half frame geometric shape.
109078
+ * @remarks
109079
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109080
+ * @beta
109081
+ */
109082
+ halfFrame = "HalfFrame",
109083
+ /**
109084
+ * Corner geometric shape.
109085
+ * @remarks
109086
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109087
+ * @beta
109088
+ */
109089
+ corner = "Corner",
109090
+ /**
109091
+ * Diagonal stripe geometric shape.
109092
+ * @remarks
109093
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109094
+ * @beta
109095
+ */
109096
+ diagonalStripe = "DiagonalStripe",
109097
+ /**
109098
+ * Chord geometric shape.
109099
+ * @remarks
109100
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109101
+ * @beta
109102
+ */
109103
+ chord = "Chord",
109104
+ /**
109105
+ * Arc geometric shape.
109106
+ * @remarks
109107
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109108
+ * @beta
109109
+ */
109110
+ arc = "Arc",
109111
+ /**
109112
+ * Left bracket geometric shape.
109113
+ * @remarks
109114
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109115
+ * @beta
109116
+ */
109117
+ leftBracket = "LeftBracket",
109118
+ /**
109119
+ * Right bracket geometric shape.
109120
+ * @remarks
109121
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109122
+ * @beta
109123
+ */
109124
+ rightBracket = "RightBracket",
109125
+ /**
109126
+ * Left brace geometric shape.
109127
+ * @remarks
109128
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109129
+ * @beta
109130
+ */
109131
+ leftBrace = "LeftBrace",
109132
+ /**
109133
+ * Right brace geometric shape.
109134
+ * @remarks
109135
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109136
+ * @beta
109137
+ */
109138
+ rightBrace = "RightBrace",
109139
+ /**
109140
+ * Bracket pair geometric shape.
109141
+ * @remarks
109142
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109143
+ * @beta
109144
+ */
109145
+ bracketPair = "BracketPair",
109146
+ /**
109147
+ * Brace pair geometric shape.
109148
+ * @remarks
109149
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109150
+ * @beta
109151
+ */
109152
+ bracePair = "BracePair",
109153
+ /**
109154
+ * Callout 1 geometric shape.
109155
+ * @remarks
109156
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109157
+ * @beta
109158
+ */
109159
+ callout1 = "Callout1",
109160
+ /**
109161
+ * Callout 2 geometric shape.
109162
+ * @remarks
109163
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109164
+ * @beta
109165
+ */
109166
+ callout2 = "Callout2",
109167
+ /**
109168
+ * Callout 3 geometric shape.
109169
+ * @remarks
109170
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109171
+ * @beta
109172
+ */
109173
+ callout3 = "Callout3",
109174
+ /**
109175
+ * Accent callout 1 geometric shape.
109176
+ * @remarks
109177
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109178
+ * @beta
109179
+ */
109180
+ accentCallout1 = "AccentCallout1",
109181
+ /**
109182
+ * Accent callout 2 geometric shape.
109183
+ * @remarks
109184
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109185
+ * @beta
109186
+ */
109187
+ accentCallout2 = "AccentCallout2",
109188
+ /**
109189
+ * Accent callout 3 geometric shape.
109190
+ * @remarks
109191
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109192
+ * @beta
109193
+ */
109194
+ accentCallout3 = "AccentCallout3",
109195
+ /**
109196
+ * Border callout 1 geometric shape.
109197
+ * @remarks
109198
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109199
+ * @beta
109200
+ */
109201
+ borderCallout1 = "BorderCallout1",
109202
+ /**
109203
+ * Border callout 2 geometric shape.
109204
+ * @remarks
109205
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109206
+ * @beta
109207
+ */
109208
+ borderCallout2 = "BorderCallout2",
109209
+ /**
109210
+ * Border callout 3 geometric shape.
109211
+ * @remarks
109212
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109213
+ * @beta
109214
+ */
109215
+ borderCallout3 = "BorderCallout3",
109216
+ /**
109217
+ * Accent border callout 1 geometric shape.
109218
+ * @remarks
109219
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109220
+ * @beta
109221
+ */
109222
+ accentBorderCallout1 = "AccentBorderCallout1",
109223
+ /**
109224
+ * Accent border callout 2 geometric shape.
109225
+ * @remarks
109226
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109227
+ * @beta
109228
+ */
109229
+ accentBorderCallout2 = "AccentBorderCallout2",
109230
+ /**
109231
+ * Accent border callout 3 geometric shape.
109232
+ * @remarks
109233
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109234
+ * @beta
109235
+ */
109236
+ accentBorderCallout3 = "AccentBorderCallout3",
109237
+ /**
109238
+ * Wedge rectangle callout geometric shape.
109239
+ * @remarks
109240
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109241
+ * @beta
109242
+ */
109243
+ wedgeRectCallout = "WedgeRectCallout",
109244
+ /**
109245
+ * Wedge rounded rectangle callout geometric shape.
109246
+ * @remarks
109247
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109248
+ * @beta
109249
+ */
109250
+ wedgeRRectCallout = "WedgeRRectCallout",
109251
+ /**
109252
+ * Wedge ellipse callout geometric shape.
109253
+ * @remarks
109254
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109255
+ * @beta
109256
+ */
109257
+ wedgeEllipseCallout = "WedgeEllipseCallout",
109258
+ /**
109259
+ * Cloud callout geometric shape.
109260
+ * @remarks
109261
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109262
+ * @beta
109263
+ */
109264
+ cloudCallout = "CloudCallout",
109265
+ /**
109266
+ * Cloud geometric shape.
109267
+ * @remarks
109268
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109269
+ * @beta
109270
+ */
109271
+ cloud = "Cloud",
109272
+ /**
109273
+ * Ribbon geometric shape.
109274
+ * @remarks
109275
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109276
+ * @beta
109277
+ */
109278
+ ribbon = "Ribbon",
109279
+ /**
109280
+ * Ribbon 2 geometric shape.
109281
+ * @remarks
109282
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109283
+ * @beta
109284
+ */
109285
+ ribbon2 = "Ribbon2",
109286
+ /**
109287
+ * Ellipse ribbon geometric shape.
109288
+ * @remarks
109289
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109290
+ * @beta
109291
+ */
109292
+ ellipseRibbon = "EllipseRibbon",
109293
+ /**
109294
+ * Ellipse ribbon 2 geometric shape.
109295
+ * @remarks
109296
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109297
+ * @beta
109298
+ */
109299
+ ellipseRibbon2 = "EllipseRibbon2",
109300
+ /**
109301
+ * Left-right ribbon geometric shape.
109302
+ * @remarks
109303
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109304
+ * @beta
109305
+ */
109306
+ leftRightRibbon = "LeftRightRibbon",
109307
+ /**
109308
+ * Vertical scroll geometric shape.
109309
+ * @remarks
109310
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109311
+ * @beta
109312
+ */
109313
+ verticalScroll = "VerticalScroll",
109314
+ /**
109315
+ * Horizontal scroll geometric shape.
109316
+ * @remarks
109317
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109318
+ * @beta
109319
+ */
109320
+ horizontalScroll = "HorizontalScroll",
109321
+ /**
109322
+ * Wave geometric shape.
109323
+ * @remarks
109324
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109325
+ * @beta
109326
+ */
109327
+ wave = "Wave",
109328
+ /**
109329
+ * Double wave geometric shape.
109330
+ * @remarks
109331
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109332
+ * @beta
109333
+ */
109334
+ doubleWave = "DoubleWave",
109335
+ /**
109336
+ * Plus geometric shape.
109337
+ * @remarks
109338
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109339
+ * @beta
109340
+ */
109341
+ plus = "Plus",
109342
+ /**
109343
+ * Flow chart process geometric shape.
109344
+ * @remarks
109345
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109346
+ * @beta
109347
+ */
109348
+ flowChartProcess = "FlowChartProcess",
109349
+ /**
109350
+ * Flow chart decision geometric shape.
109351
+ * @remarks
109352
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109353
+ * @beta
109354
+ */
109355
+ flowChartDecision = "FlowChartDecision",
109356
+ /**
109357
+ * Flow chart input-output geometric shape.
109358
+ * @remarks
109359
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109360
+ * @beta
109361
+ */
109362
+ flowChartInputOutput = "FlowChartInputOutput",
109363
+ /**
109364
+ * Flow chart predefined process geometric shape.
109365
+ * @remarks
109366
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109367
+ * @beta
109368
+ */
109369
+ flowChartPredefinedProcess = "FlowChartPredefinedProcess",
109370
+ /**
109371
+ * Flow chart internal storage geometric shape.
109372
+ * @remarks
109373
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109374
+ * @beta
109375
+ */
109376
+ flowChartInternalStorage = "FlowChartInternalStorage",
109377
+ /**
109378
+ * Flow chart document geometric shape.
109379
+ * @remarks
109380
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109381
+ * @beta
109382
+ */
109383
+ flowChartDocument = "FlowChartDocument",
109384
+ /**
109385
+ * Flow chart multidocument geometric shape.
109386
+ * @remarks
109387
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109388
+ * @beta
109389
+ */
109390
+ flowChartMultidocument = "FlowChartMultidocument",
109391
+ /**
109392
+ * Flow chart terminator geometric shape.
109393
+ * @remarks
109394
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109395
+ * @beta
109396
+ */
109397
+ flowChartTerminator = "FlowChartTerminator",
109398
+ /**
109399
+ * Flow chart preparation geometric shape.
109400
+ * @remarks
109401
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109402
+ * @beta
109403
+ */
109404
+ flowChartPreparation = "FlowChartPreparation",
109405
+ /**
109406
+ * Flow chart manual input geometric shape.
109407
+ * @remarks
109408
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109409
+ * @beta
109410
+ */
109411
+ flowChartManualInput = "FlowChartManualInput",
109412
+ /**
109413
+ * Flow chart manual operation geometric shape.
109414
+ * @remarks
109415
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109416
+ * @beta
109417
+ */
109418
+ flowChartManualOperation = "FlowChartManualOperation",
109419
+ /**
109420
+ * Flow chart connector geometric shape.
109421
+ * @remarks
109422
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109423
+ * @beta
109424
+ */
109425
+ flowChartConnector = "FlowChartConnector",
109426
+ /**
109427
+ * Flow chart punched card geometric shape.
109428
+ * @remarks
109429
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109430
+ * @beta
109431
+ */
109432
+ flowChartPunchedCard = "FlowChartPunchedCard",
109433
+ /**
109434
+ * Flow chart punched tape geometric shape.
109435
+ * @remarks
109436
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109437
+ * @beta
109438
+ */
109439
+ flowChartPunchedTape = "FlowChartPunchedTape",
109440
+ /**
109441
+ * Flow chart summing junction geometric shape.
109442
+ * @remarks
109443
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109444
+ * @beta
109445
+ */
109446
+ flowChartSummingJunction = "FlowChartSummingJunction",
109447
+ /**
109448
+ * Flow chart OR geometric shape.
109449
+ * @remarks
109450
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109451
+ * @beta
109452
+ */
109453
+ flowChartOr = "FlowChartOr",
109454
+ /**
109455
+ * Flow chart collate geometric shape.
109456
+ * @remarks
109457
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109458
+ * @beta
109459
+ */
109460
+ flowChartCollate = "FlowChartCollate",
109461
+ /**
109462
+ * Flow chart sort geometric shape.
109463
+ * @remarks
109464
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109465
+ * @beta
109466
+ */
109467
+ flowChartSort = "FlowChartSort",
109468
+ /**
109469
+ * Flow chart extract geometric shape.
109470
+ * @remarks
109471
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109472
+ * @beta
109473
+ */
109474
+ flowChartExtract = "FlowChartExtract",
109475
+ /**
109476
+ * Flow chart merge geometric shape.
109477
+ * @remarks
109478
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109479
+ * @beta
109480
+ */
109481
+ flowChartMerge = "FlowChartMerge",
109482
+ /**
109483
+ * Flow chart offline storage geometric shape.
109484
+ * @remarks
109485
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109486
+ * @beta
109487
+ */
109488
+ flowChartOfflineStorage = "FlowChartOfflineStorage",
109489
+ /**
109490
+ * Flow chart online storage geometric shape.
109491
+ * @remarks
109492
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109493
+ * @beta
109494
+ */
109495
+ flowChartOnlineStorage = "FlowChartOnlineStorage",
109496
+ /**
109497
+ * Flow chart magnetic tape geometric shape.
109498
+ * @remarks
109499
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109500
+ * @beta
109501
+ */
109502
+ flowChartMagneticTape = "FlowChartMagneticTape",
109503
+ /**
109504
+ * Flow chart magnetic disk geometric shape.
109505
+ * @remarks
109506
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109507
+ * @beta
109508
+ */
109509
+ flowChartMagneticDisk = "FlowChartMagneticDisk",
109510
+ /**
109511
+ * Flow chart magnetic drum geometric shape.
109512
+ * @remarks
109513
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109514
+ * @beta
109515
+ */
109516
+ flowChartMagneticDrum = "FlowChartMagneticDrum",
109517
+ /**
109518
+ * Flow chart display geometric shape.
109519
+ * @remarks
109520
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109521
+ * @beta
109522
+ */
109523
+ flowChartDisplay = "FlowChartDisplay",
109524
+ /**
109525
+ * Flow chart delay geometric shape.
109526
+ * @remarks
109527
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109528
+ * @beta
109529
+ */
109530
+ flowChartDelay = "FlowChartDelay",
109531
+ /**
109532
+ * Flow chart alternate process geometric shape.
109533
+ * @remarks
109534
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109535
+ * @beta
109536
+ */
109537
+ flowChartAlternateProcess = "FlowChartAlternateProcess",
109538
+ /**
109539
+ * Flow chart off-page connector geometric shape.
109540
+ * @remarks
109541
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109542
+ * @beta
109543
+ */
109544
+ flowChartOffpageConnector = "FlowChartOffpageConnector",
109545
+ /**
109546
+ * Action button blank geometric shape.
109547
+ * @remarks
109548
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109549
+ * @beta
109550
+ */
109551
+ actionButtonBlank = "ActionButtonBlank",
109552
+ /**
109553
+ * Action button home geometric shape.
109554
+ * @remarks
109555
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109556
+ * @beta
109557
+ */
109558
+ actionButtonHome = "ActionButtonHome",
109559
+ /**
109560
+ * Action button help geometric shape.
109561
+ * @remarks
109562
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109563
+ * @beta
109564
+ */
109565
+ actionButtonHelp = "ActionButtonHelp",
109566
+ /**
109567
+ * Action button information geometric shape.
109568
+ * @remarks
109569
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109570
+ * @beta
109571
+ */
109572
+ actionButtonInformation = "ActionButtonInformation",
109573
+ /**
109574
+ * Action button forward next geometric shape.
109575
+ * @remarks
109576
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109577
+ * @beta
109578
+ */
109579
+ actionButtonForwardNext = "ActionButtonForwardNext",
109580
+ /**
109581
+ * Action button back previous geometric shape.
109582
+ * @remarks
109583
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109584
+ * @beta
109585
+ */
109586
+ actionButtonBackPrevious = "ActionButtonBackPrevious",
109587
+ /**
109588
+ * Action button end geometric shape.
109589
+ * @remarks
109590
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109591
+ * @beta
109592
+ */
109593
+ actionButtonEnd = "ActionButtonEnd",
109594
+ /**
109595
+ * Action button beginning geometric shape.
109596
+ * @remarks
109597
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109598
+ * @beta
109599
+ */
109600
+ actionButtonBeginning = "ActionButtonBeginning",
109601
+ /**
109602
+ * Action button return geometric shape.
109603
+ * @remarks
109604
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109605
+ * @beta
109606
+ */
109607
+ actionButtonReturn = "ActionButtonReturn",
109608
+ /**
109609
+ * Action button document geometric shape.
109610
+ * @remarks
109611
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109612
+ * @beta
109613
+ */
109614
+ actionButtonDocument = "ActionButtonDocument",
109615
+ /**
109616
+ * Action button sound geometric shape.
109617
+ * @remarks
109618
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109619
+ * @beta
109620
+ */
109621
+ actionButtonSound = "ActionButtonSound",
109622
+ /**
109623
+ * Action button movie geometric shape.
109624
+ * @remarks
109625
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109626
+ * @beta
109627
+ */
109628
+ actionButtonMovie = "ActionButtonMovie",
109629
+ /**
109630
+ * Gear 6 geometric shape.
109631
+ * @remarks
109632
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109633
+ * @beta
109634
+ */
109635
+ gear6 = "Gear6",
109636
+ /**
109637
+ * Gear 9 geometric shape.
109638
+ * @remarks
109639
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109640
+ * @beta
109641
+ */
109642
+ gear9 = "Gear9",
109643
+ /**
109644
+ * Funnel geometric shape.
109645
+ * @remarks
109646
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109647
+ * @beta
109648
+ */
109649
+ funnel = "Funnel",
109650
+ /**
109651
+ * Math plus geometric shape.
109652
+ * @remarks
109653
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109654
+ * @beta
109655
+ */
109656
+ mathPlus = "MathPlus",
109657
+ /**
109658
+ * Math minus geometric shape.
109659
+ * @remarks
109660
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109661
+ * @beta
109662
+ */
109663
+ mathMinus = "MathMinus",
109664
+ /**
109665
+ * Math multiply geometric shape.
109666
+ * @remarks
109667
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109668
+ * @beta
109669
+ */
109670
+ mathMultiply = "MathMultiply",
109671
+ /**
109672
+ * Math divide geometric shape.
109673
+ * @remarks
109674
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109675
+ * @beta
109676
+ */
109677
+ mathDivide = "MathDivide",
109678
+ /**
109679
+ * Math equal geometric shape.
109680
+ * @remarks
109681
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109682
+ * @beta
109683
+ */
109684
+ mathEqual = "MathEqual",
109685
+ /**
109686
+ * Math not equal geometric shape.
109687
+ * @remarks
109688
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109689
+ * @beta
109690
+ */
109691
+ mathNotEqual = "MathNotEqual",
109692
+ /**
109693
+ * Corner tabs geometric shape.
109694
+ * @remarks
109695
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109696
+ * @beta
109697
+ */
109698
+ cornerTabs = "CornerTabs",
109699
+ /**
109700
+ * Square tabs geometric shape.
109701
+ * @remarks
109702
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109703
+ * @beta
109704
+ */
109705
+ squareTabs = "SquareTabs",
109706
+ /**
109707
+ * Plaque tabs geometric shape.
109708
+ * @remarks
109709
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109710
+ * @beta
109711
+ */
109712
+ plaqueTabs = "PlaqueTabs",
109713
+ /**
109714
+ * Chart X geometric shape.
109715
+ * @remarks
109716
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109717
+ * @beta
109718
+ */
109719
+ chartX = "ChartX",
109720
+ /**
109721
+ * Chart star geometric shape.
109722
+ * @remarks
109723
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109724
+ * @beta
109725
+ */
109726
+ chartStar = "ChartStar",
109727
+ /**
109728
+ * Chart plus geometric shape.
109729
+ * @remarks
109730
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
109731
+ * @beta
109732
+ */
109733
+ chartPlus = "ChartPlus",
109734
+ }
108426
109735
  enum ErrorCodes {
108427
109736
  accessDenied = "AccessDenied",
108428
109737
  generalException = "GeneralException",
@@ -109954,7 +111263,7 @@ declare namespace Word {
109954
111263
  /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
109955
111264
  interface ShapeUpdateData {
109956
111265
  /**
109957
- * Represents the body object of the shape. Only applies to TextBox shapes.
111266
+ * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
109958
111267
  *
109959
111268
  * @remarks
109960
111269
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -110092,7 +111401,7 @@ declare namespace Word {
110092
111401
  */
110093
111402
  paragraphs?: Word.Interfaces.ParagraphData[];
110094
111403
  /**
110095
- * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only TextBox shapes are supported.
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.
110096
111405
  *
110097
111406
  * @remarks
110098
111407
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -111290,7 +112599,7 @@ declare namespace Word {
111290
112599
  */
111291
112600
  listItemOrNullObject?: Word.Interfaces.ListItemData;
111292
112601
  /**
111293
- * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only TextBox shapes are supported.
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.
111294
112603
  *
111295
112604
  * @remarks
111296
112605
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -111546,7 +112855,7 @@ declare namespace Word {
111546
112855
  */
111547
112856
  inlinePictures?: Word.Interfaces.InlinePictureData[];
111548
112857
  /**
111549
- * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only TextBox shapes are supported.
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.
111550
112859
  *
111551
112860
  * @remarks
111552
112861
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -112264,7 +113573,7 @@ declare namespace Word {
112264
113573
  /** An interface describing the data returned by calling `shape.toJSON()`. */
112265
113574
  interface ShapeData {
112266
113575
  /**
112267
- * Represents the body object of the shape. Only applies to TextBox shapes.
113576
+ * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
112268
113577
  *
112269
113578
  * @remarks
112270
113579
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -112320,13 +113629,13 @@ declare namespace Word {
112320
113629
  */
112321
113630
  top?: number;
112322
113631
  /**
112323
- * Gets the shape type. Currently, only TextBox shapes are supported.
113632
+ * Gets the shape type. Currently, only text boxes and geometric shapes are supported.
112324
113633
  *
112325
113634
  * @remarks
112326
113635
  * [Api set: WordApi BETA (PREVIEW ONLY)]
112327
113636
  * @beta
112328
113637
  */
112329
- type?: Word.ShapeType | "Unsupported" | "TextBox";
113638
+ type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape";
112330
113639
  /**
112331
113640
  * The width, in points, of the shape.
112332
113641
  *
@@ -116720,7 +118029,7 @@ declare namespace Word {
116720
118029
  type?: boolean;
116721
118030
  }
116722
118031
  /**
116723
- * Represents a shape in the header footer or document body. Currently, only TextBox shapes are supported.
118032
+ * Represents a shape in the header footer or document body. Currently, only text boxes and geometric shapes are supported.
116724
118033
  *
116725
118034
  * @remarks
116726
118035
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -116732,7 +118041,7 @@ declare namespace Word {
116732
118041
  */
116733
118042
  $all?: boolean;
116734
118043
  /**
116735
- * Represents the body object of the shape. Only applies to TextBox shapes.
118044
+ * Represents the body object of the shape. Only applies to text boxes and geometric shapes.
116736
118045
  *
116737
118046
  * @remarks
116738
118047
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -116788,7 +118097,7 @@ declare namespace Word {
116788
118097
  */
116789
118098
  top?: boolean;
116790
118099
  /**
116791
- * Gets the shape type. Currently, only TextBox shapes are supported.
118100
+ * Gets the shape type. Currently, only text boxes and geometric shapes are supported.
116792
118101
  *
116793
118102
  * @remarks
116794
118103
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -116805,7 +118114,7 @@ declare namespace Word {
116805
118114
  width?: boolean;
116806
118115
  }
116807
118116
  /**
116808
- * Contains a collection of {@link Word.Shape} objects. Currently, only TextBox shapes are supported.
118117
+ * Contains a collection of {@link Word.Shape} objects. Currently, only text boxes and geometric shapes are supported.
116809
118118
  *
116810
118119
  * @remarks
116811
118120
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -116817,7 +118126,7 @@ declare namespace Word {
116817
118126
  */
116818
118127
  $all?: boolean;
116819
118128
  /**
116820
- * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to TextBox shapes.
118129
+ * For EACH ITEM in the collection: Represents the body object of the shape. Only applies to text boxes and geometric shapes.
116821
118130
  *
116822
118131
  * @remarks
116823
118132
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -116873,7 +118182,7 @@ declare namespace Word {
116873
118182
  */
116874
118183
  top?: boolean;
116875
118184
  /**
116876
- * For EACH ITEM in the collection: Gets the shape type. Currently, only TextBox shapes are supported.
118185
+ * For EACH ITEM in the collection: Gets the shape type. Currently, only text boxes and geometric shapes are supported.
116877
118186
  *
116878
118187
  * @remarks
116879
118188
  * [Api set: WordApi BETA (PREVIEW ONLY)]
@@ -127593,6 +128902,128 @@ declare namespace PowerPoint {
127593
128902
  */
127594
128903
  toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
127595
128904
  }
128905
+ /**
128906
+ * Specifies the type of a shape.
128907
+ *
128908
+ * @remarks
128909
+ * [Api set: PowerPointApi 1.4]
128910
+ */
128911
+ enum ShapeType {
128912
+ /**
128913
+ * The given shape's type is unsupported.
128914
+ * @remarks
128915
+ * [Api set: PowerPointApi 1.4]
128916
+ */
128917
+ unsupported = "Unsupported",
128918
+ /**
128919
+ * The shape is an image.
128920
+ * @remarks
128921
+ * [Api set: PowerPointApi 1.4]
128922
+ */
128923
+ image = "Image",
128924
+ /**
128925
+ * The shape is a geometric shape such as rectangle.
128926
+ * @remarks
128927
+ * [Api set: PowerPointApi 1.4]
128928
+ */
128929
+ geometricShape = "GeometricShape",
128930
+ /**
128931
+ * The shape is a group shape which contains sub-shapes.
128932
+ * @remarks
128933
+ * [Api set: PowerPointApi 1.4]
128934
+ */
128935
+ group = "Group",
128936
+ /**
128937
+ * The shape is a line.
128938
+ * @remarks
128939
+ * [Api set: PowerPointApi 1.4]
128940
+ */
128941
+ line = "Line",
128942
+ /**
128943
+ * The shape is a table.
128944
+ * @remarks
128945
+ * [Api set: PowerPointApi 1.4]
128946
+ */
128947
+ table = "Table",
128948
+ /**
128949
+ * The shape is a callout.
128950
+ * @remarks
128951
+ * [Api set: PowerPointApi 1.4]
128952
+ */
128953
+ callout = "Callout",
128954
+ /**
128955
+ * The shape is a chart.
128956
+ * @remarks
128957
+ * [Api set: PowerPointApi 1.4]
128958
+ */
128959
+ chart = "Chart",
128960
+ /**
128961
+ * The shape is a content Office Add-in.
128962
+ * @remarks
128963
+ * [Api set: PowerPointApi 1.4]
128964
+ */
128965
+ contentApp = "ContentApp",
128966
+ /**
128967
+ * The shape is a diagram.
128968
+ * @remarks
128969
+ * [Api set: PowerPointApi 1.4]
128970
+ */
128971
+ diagram = "Diagram",
128972
+ /**
128973
+ * The shape is a freeform object.
128974
+ * @remarks
128975
+ * [Api set: PowerPointApi 1.4]
128976
+ */
128977
+ freeform = "Freeform",
128978
+ /**
128979
+ * The shape is a graphic.
128980
+ * @remarks
128981
+ * [Api set: PowerPointApi 1.4]
128982
+ */
128983
+ graphic = "Graphic",
128984
+ /**
128985
+ * The shape is an ink object.
128986
+ * @remarks
128987
+ * [Api set: PowerPointApi 1.4]
128988
+ */
128989
+ ink = "Ink",
128990
+ /**
128991
+ * The shape is a media object.
128992
+ * @remarks
128993
+ * [Api set: PowerPointApi 1.4]
128994
+ */
128995
+ media = "Media",
128996
+ /**
128997
+ * The shape is a 3D model.
128998
+ * @remarks
128999
+ * [Api set: PowerPointApi 1.4]
129000
+ */
129001
+ model3D = "Model3D",
129002
+ /**
129003
+ * The shape is an OLE (Object Linking and Embedding) object.
129004
+ * @remarks
129005
+ * [Api set: PowerPointApi 1.4]
129006
+ */
129007
+ ole = "Ole",
129008
+ /**
129009
+ * The shape is a placeholder.
129010
+ * @remarks
129011
+ * [Api set: PowerPointApi 1.4]
129012
+ */
129013
+ placeholder = "Placeholder",
129014
+ /**
129015
+ * The shape is a SmartArt graphic.
129016
+ * @remarks
129017
+ * [Api set: PowerPointApi 1.4]
129018
+ */
129019
+ smartArt = "SmartArt",
129020
+ /**
129021
+ * The shape is a text box.
129022
+ * @remarks
129023
+ * [Api set: PowerPointApi 1.4]
129024
+ */
129025
+ textBox = "TextBox",
129026
+ }
127596
129027
  /**
127597
129028
  * Represents a single hyperlink.
127598
129029
  *
@@ -128914,6 +130345,173 @@ declare namespace PowerPoint {
128914
130345
  */
128915
130346
  systemDashDot = "SystemDashDot",
128916
130347
  }
130348
+ /**
130349
+ * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
130350
+ *
130351
+ * @remarks
130352
+ * [Api set: PowerPointApi 1.4]
130353
+ */
130354
+ enum ParagraphHorizontalAlignment {
130355
+ /**
130356
+ * Align text to the left margin.
130357
+ * @remarks
130358
+ * [Api set: PowerPointApi 1.4]
130359
+ */
130360
+ left = "Left",
130361
+ /**
130362
+ * Align text in the center.
130363
+ * @remarks
130364
+ * [Api set: PowerPointApi 1.4]
130365
+ */
130366
+ center = "Center",
130367
+ /**
130368
+ * Align text to the right margin.
130369
+ * @remarks
130370
+ * [Api set: PowerPointApi 1.4]
130371
+ */
130372
+ right = "Right",
130373
+ /**
130374
+ * Align text so that it is justified across the whole line.
130375
+ * @remarks
130376
+ * [Api set: PowerPointApi 1.4]
130377
+ */
130378
+ justify = "Justify",
130379
+ /**
130380
+ * Specifies the alignment or adjustment of kashida length in Arabic text.
130381
+ * @remarks
130382
+ * [Api set: PowerPointApi 1.4]
130383
+ */
130384
+ justifyLow = "JustifyLow",
130385
+ /**
130386
+ * Distributes the text words across an entire text line.
130387
+ * @remarks
130388
+ * [Api set: PowerPointApi 1.4]
130389
+ */
130390
+ distributed = "Distributed",
130391
+ /**
130392
+ * Distributes Thai text specially, because each character is treated as a word.
130393
+ * @remarks
130394
+ * [Api set: PowerPointApi 1.4]
130395
+ */
130396
+ thaiDistributed = "ThaiDistributed",
130397
+ }
130398
+ /**
130399
+ * Specifies a shape's fill type.
130400
+ *
130401
+ * @remarks
130402
+ * [Api set: PowerPointApi 1.4]
130403
+ */
130404
+ enum ShapeFillType {
130405
+ /**
130406
+ * Specifies that the shape should have no fill.
130407
+ * @remarks
130408
+ * [Api set: PowerPointApi 1.4]
130409
+ */
130410
+ noFill = "NoFill",
130411
+ /**
130412
+ * Specifies that the shape should have regular solid fill.
130413
+ * @remarks
130414
+ * [Api set: PowerPointApi 1.4]
130415
+ */
130416
+ solid = "Solid",
130417
+ /**
130418
+ * Specifies that the shape should have gradient fill.
130419
+ * @remarks
130420
+ * [Api set: PowerPointApi 1.4]
130421
+ */
130422
+ gradient = "Gradient",
130423
+ /**
130424
+ * Specifies that the shape should have pattern fill.
130425
+ * @remarks
130426
+ * [Api set: PowerPointApi 1.4]
130427
+ */
130428
+ pattern = "Pattern",
130429
+ /**
130430
+ * Specifies that the shape should have picture or texture fill.
130431
+ * @remarks
130432
+ * [Api set: PowerPointApi 1.4]
130433
+ */
130434
+ pictureAndTexture = "PictureAndTexture",
130435
+ /**
130436
+ * Specifies that the shape should have slide background fill.
130437
+ * @remarks
130438
+ * [Api set: PowerPointApi 1.4]
130439
+ */
130440
+ slideBackground = "SlideBackground",
130441
+ }
130442
+ /**
130443
+ * Represents the fill formatting of a shape object.
130444
+ *
130445
+ * @remarks
130446
+ * [Api set: PowerPointApi 1.4]
130447
+ */
130448
+ class ShapeFill extends OfficeExtension.ClientObject {
130449
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
130450
+ context: RequestContext;
130451
+ /**
130452
+ * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
130453
+ *
130454
+ * @remarks
130455
+ * [Api set: PowerPointApi 1.4]
130456
+ */
130457
+ foregroundColor: string;
130458
+ /**
130459
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
130460
+ *
130461
+ * @remarks
130462
+ * [Api set: PowerPointApi 1.4]
130463
+ */
130464
+ transparency: number;
130465
+ /**
130466
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
130467
+ *
130468
+ * @remarks
130469
+ * [Api set: PowerPointApi 1.4]
130470
+ */
130471
+ readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
130472
+ /**
130473
+ * Clears the fill formatting of this shape.
130474
+ *
130475
+ * @remarks
130476
+ * [Api set: PowerPointApi 1.4]
130477
+ */
130478
+ clear(): void;
130479
+ /**
130480
+ * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
130481
+ *
130482
+ * @remarks
130483
+ * [Api set: PowerPointApi 1.4]
130484
+ *
130485
+ * @param color A string that specifies the fill color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
130486
+ */
130487
+ setSolidColor(color: string): void;
130488
+ /**
130489
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130490
+ *
130491
+ * @param options Provides options for which properties of the object to load.
130492
+ */
130493
+ load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
130494
+ /**
130495
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130496
+ *
130497
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
130498
+ */
130499
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
130500
+ /**
130501
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130502
+ *
130503
+ * @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.
130504
+ */
130505
+ load(propertyNamesAndPaths?: {
130506
+ select?: string;
130507
+ expand?: string;
130508
+ }): PowerPoint.ShapeFill;
130509
+ /**
130510
+ * 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.)
130511
+ * Whereas the original `PowerPoint.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object.
130512
+ */
130513
+ toJSON(): PowerPoint.Interfaces.ShapeFillData;
130514
+ }
128917
130515
  /**
128918
130516
  * The type of underline applied to a font.
128919
130517
  *
@@ -129025,54 +130623,82 @@ declare namespace PowerPoint {
129025
130623
  wavyDouble = "WavyDouble",
129026
130624
  }
129027
130625
  /**
129028
- * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
130626
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
129029
130627
  *
129030
130628
  * @remarks
129031
130629
  * [Api set: PowerPointApi 1.4]
129032
130630
  */
129033
- enum ParagraphHorizontalAlignment {
130631
+ class ShapeFont extends OfficeExtension.ClientObject {
130632
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
130633
+ context: RequestContext;
129034
130634
  /**
129035
- * Align text to the left margin.
130635
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
130636
+ *
129036
130637
  * @remarks
129037
130638
  * [Api set: PowerPointApi 1.4]
129038
130639
  */
129039
- left = "Left",
130640
+ bold: boolean;
129040
130641
  /**
129041
- * Align text in the center.
130642
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
130643
+ *
129042
130644
  * @remarks
129043
130645
  * [Api set: PowerPointApi 1.4]
129044
130646
  */
129045
- center = "Center",
130647
+ color: string;
129046
130648
  /**
129047
- * Align text to the right margin.
130649
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
130650
+ *
129048
130651
  * @remarks
129049
130652
  * [Api set: PowerPointApi 1.4]
129050
130653
  */
129051
- right = "Right",
130654
+ italic: boolean;
129052
130655
  /**
129053
- * Align text so that it is justified across the whole line.
130656
+ * 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.
130657
+ *
129054
130658
  * @remarks
129055
130659
  * [Api set: PowerPointApi 1.4]
129056
130660
  */
129057
- justify = "Justify",
130661
+ name: string;
129058
130662
  /**
129059
- * Specifies the alignment or adjustment of kashida length in Arabic text.
130663
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
130664
+ *
129060
130665
  * @remarks
129061
130666
  * [Api set: PowerPointApi 1.4]
129062
130667
  */
129063
- justifyLow = "JustifyLow",
130668
+ size: number;
129064
130669
  /**
129065
- * Distributes the text words across an entire text line.
130670
+ * 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.
130671
+ *
129066
130672
  * @remarks
129067
130673
  * [Api set: PowerPointApi 1.4]
129068
130674
  */
129069
- distributed = "Distributed",
130675
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
129070
130676
  /**
129071
- * Distributes Thai text specially, because each character is treated as a word.
129072
- * @remarks
129073
- * [Api set: PowerPointApi 1.4]
130677
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130678
+ *
130679
+ * @param options Provides options for which properties of the object to load.
129074
130680
  */
129075
- thaiDistributed = "ThaiDistributed",
130681
+ load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
130682
+ /**
130683
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130684
+ *
130685
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
130686
+ */
130687
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
130688
+ /**
130689
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130690
+ *
130691
+ * @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.
130692
+ */
130693
+ load(propertyNamesAndPaths?: {
130694
+ select?: string;
130695
+ expand?: string;
130696
+ }): PowerPoint.ShapeFont;
130697
+ /**
130698
+ * 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.)
130699
+ * Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object.
130700
+ */
130701
+ toJSON(): PowerPoint.Interfaces.ShapeFontData;
129076
130702
  }
129077
130703
  /**
129078
130704
  * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
@@ -129153,6 +130779,17 @@ declare namespace PowerPoint {
129153
130779
  * @returns The newly inserted shape.
129154
130780
  */
129155
130781
  addGeometricShape(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", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
130782
+ /**
130783
+ * Create a shape group for several shapes.
130784
+ *
130785
+ * @remarks
130786
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130787
+ * @beta
130788
+ *
130789
+ * @param values An array of shape IDs or `Shape` objects.
130790
+ * @returns A `Shape` object that represents the shape group. Use the `Shape.group` property to access the `ShapeGroup` object for the group.
130791
+ */
130792
+ addGroup(values: Array<string | Shape>): PowerPoint.Shape;
129156
130793
  /**
129157
130794
  * Adds a line to the slide. Returns a `Shape` object that represents the new line.
129158
130795
  *
@@ -129273,6 +130910,274 @@ declare namespace PowerPoint {
129273
130910
  */
129274
130911
  width?: number;
129275
130912
  }
130913
+ /**
130914
+ * Specifies the type of a slide layout.
130915
+ *
130916
+ * @remarks
130917
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130918
+ * @beta
130919
+ */
130920
+ enum SlideLayoutType {
130921
+ /**
130922
+ * Blank layout.
130923
+ * @remarks
130924
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130925
+ * @beta
130926
+ */
130927
+ blank = "Blank",
130928
+ /**
130929
+ * Chart layout.
130930
+ * @remarks
130931
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130932
+ * @beta
130933
+ */
130934
+ chart = "Chart",
130935
+ /**
130936
+ * Chart and text layout.
130937
+ * @remarks
130938
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130939
+ * @beta
130940
+ */
130941
+ chartAndText = "ChartAndText",
130942
+ /**
130943
+ * ClipArt and text layout.
130944
+ * @remarks
130945
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130946
+ * @beta
130947
+ */
130948
+ clipArtAndText = "ClipArtAndText",
130949
+ /**
130950
+ * ClipArt and vertical text layout.
130951
+ * @remarks
130952
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130953
+ * @beta
130954
+ */
130955
+ clipArtAndVerticalText = "ClipArtAndVerticalText",
130956
+ /**
130957
+ * Comparison layout.
130958
+ * @remarks
130959
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130960
+ * @beta
130961
+ */
130962
+ comparison = "Comparison",
130963
+ /**
130964
+ * Content with caption layout.
130965
+ * @remarks
130966
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130967
+ * @beta
130968
+ */
130969
+ contentWithCaption = "ContentWithCaption",
130970
+ /**
130971
+ * Custom layout.
130972
+ * @remarks
130973
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130974
+ * @beta
130975
+ */
130976
+ custom = "Custom",
130977
+ /**
130978
+ * Four objects layout.
130979
+ * @remarks
130980
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130981
+ * @beta
130982
+ */
130983
+ fourObjects = "FourObjects",
130984
+ /**
130985
+ * Large object layout.
130986
+ * @remarks
130987
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130988
+ * @beta
130989
+ */
130990
+ largeObject = "LargeObject",
130991
+ /**
130992
+ * MediaClip and text layout.
130993
+ * @remarks
130994
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
130995
+ * @beta
130996
+ */
130997
+ mediaClipAndText = "MediaClipAndText",
130998
+ /**
130999
+ * Mixed layout.
131000
+ * @remarks
131001
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131002
+ * @beta
131003
+ */
131004
+ mixed = "Mixed",
131005
+ /**
131006
+ * Object layout.
131007
+ * @remarks
131008
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131009
+ * @beta
131010
+ */
131011
+ object = "Object",
131012
+ /**
131013
+ * Object and text layout.
131014
+ * @remarks
131015
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131016
+ * @beta
131017
+ */
131018
+ objectAndText = "ObjectAndText",
131019
+ /**
131020
+ * Object and two objects layout.
131021
+ * @remarks
131022
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131023
+ * @beta
131024
+ */
131025
+ objectAndTwoObjects = "ObjectAndTwoObjects",
131026
+ /**
131027
+ * Object over text layout.
131028
+ * @remarks
131029
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131030
+ * @beta
131031
+ */
131032
+ objectOverText = "ObjectOverText",
131033
+ /**
131034
+ * Organization chart layout.
131035
+ * @remarks
131036
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131037
+ * @beta
131038
+ */
131039
+ organizationChart = "OrganizationChart",
131040
+ /**
131041
+ * Picture with caption layout.
131042
+ * @remarks
131043
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131044
+ * @beta
131045
+ */
131046
+ pictureWithCaption = "PictureWithCaption",
131047
+ /**
131048
+ * Section header layout.
131049
+ * @remarks
131050
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131051
+ * @beta
131052
+ */
131053
+ sectionHeader = "SectionHeader",
131054
+ /**
131055
+ * Table layout.
131056
+ * @remarks
131057
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131058
+ * @beta
131059
+ */
131060
+ table = "Table",
131061
+ /**
131062
+ * Text layout.
131063
+ * @remarks
131064
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131065
+ * @beta
131066
+ */
131067
+ text = "Text",
131068
+ /**
131069
+ * Text and chart layout.
131070
+ * @remarks
131071
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131072
+ * @beta
131073
+ */
131074
+ textAndChart = "TextAndChart",
131075
+ /**
131076
+ * Text and ClipArt layout.
131077
+ * @remarks
131078
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131079
+ * @beta
131080
+ */
131081
+ textAndClipArt = "TextAndClipArt",
131082
+ /**
131083
+ * Text and MediaClip layout.
131084
+ * @remarks
131085
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131086
+ * @beta
131087
+ */
131088
+ textAndMediaClip = "TextAndMediaClip",
131089
+ /**
131090
+ * Text and object layout.
131091
+ * @remarks
131092
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131093
+ * @beta
131094
+ */
131095
+ textAndObject = "TextAndObject",
131096
+ /**
131097
+ * Text and two objects layout.
131098
+ * @remarks
131099
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131100
+ * @beta
131101
+ */
131102
+ textAndTwoObjects = "TextAndTwoObjects",
131103
+ /**
131104
+ * Text over object layout.
131105
+ * @remarks
131106
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131107
+ * @beta
131108
+ */
131109
+ textOverObject = "TextOverObject",
131110
+ /**
131111
+ * Title layout.
131112
+ * @remarks
131113
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131114
+ * @beta
131115
+ */
131116
+ title = "Title",
131117
+ /**
131118
+ * Title only layout.
131119
+ * @remarks
131120
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131121
+ * @beta
131122
+ */
131123
+ titleOnly = "TitleOnly",
131124
+ /**
131125
+ * Two-column text layout.
131126
+ * @remarks
131127
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131128
+ * @beta
131129
+ */
131130
+ twoColumnText = "TwoColumnText",
131131
+ /**
131132
+ * Two objects layout.
131133
+ * @remarks
131134
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131135
+ * @beta
131136
+ */
131137
+ twoObjects = "TwoObjects",
131138
+ /**
131139
+ * Two objects and object layout.
131140
+ * @remarks
131141
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131142
+ * @beta
131143
+ */
131144
+ twoObjectsAndObject = "TwoObjectsAndObject",
131145
+ /**
131146
+ * Two objects and text layout.
131147
+ * @remarks
131148
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131149
+ * @beta
131150
+ */
131151
+ twoObjectsAndText = "TwoObjectsAndText",
131152
+ /**
131153
+ * Two objects over text layout.
131154
+ * @remarks
131155
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131156
+ * @beta
131157
+ */
131158
+ twoObjectsOverText = "TwoObjectsOverText",
131159
+ /**
131160
+ * Vertical text layout.
131161
+ * @remarks
131162
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131163
+ * @beta
131164
+ */
131165
+ verticalText = "VerticalText",
131166
+ /**
131167
+ * Vertical title and text layout.
131168
+ * @remarks
131169
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131170
+ * @beta
131171
+ */
131172
+ verticalTitleAndText = "VerticalTitleAndText",
131173
+ /**
131174
+ * Vertical title and text over chart layout.
131175
+ * @remarks
131176
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131177
+ * @beta
131178
+ */
131179
+ verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
131180
+ }
129276
131181
  /**
129277
131182
  * Represents the layout of a slide.
129278
131183
  *
@@ -129310,6 +131215,14 @@ declare namespace PowerPoint {
129310
131215
  * [Api set: PowerPointApi 1.3]
129311
131216
  */
129312
131217
  readonly name: string;
131218
+ /**
131219
+ * Returns the type of the slide layout.
131220
+ *
131221
+ * @remarks
131222
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131223
+ * @beta
131224
+ */
131225
+ readonly type: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
129313
131226
  /**
129314
131227
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
129315
131228
  *
@@ -129682,6 +131595,24 @@ declare namespace PowerPoint {
129682
131595
  * [Api set: PowerPointApi 1.2]
129683
131596
  */
129684
131597
  readonly id: string;
131598
+ /**
131599
+ * Returns the zero-based index of the slide representing its position in the presentation.
131600
+ *
131601
+ * @remarks
131602
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131603
+ * @beta
131604
+ */
131605
+ readonly index: number;
131606
+ /**
131607
+ * Applies the specified layout to the slide, changing its design and structure according to the chosen layout.
131608
+ *
131609
+ * @remarks
131610
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131611
+ * @beta
131612
+ *
131613
+ * @param slideLayout The layout to be applied to the slide. This is typically an instance of a predefined layout from the slide master.
131614
+ */
131615
+ applyLayout(slideLayout: PowerPoint.SlideLayout): void;
129685
131616
  /**
129686
131617
  * Deletes the slide from the presentation. Does nothing if the slide does not exist.
129687
131618
  *
@@ -129710,6 +131641,16 @@ declare namespace PowerPoint {
129710
131641
  * @returns A base64 string of the slide image in PNG format.
129711
131642
  */
129712
131643
  getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;
131644
+ /**
131645
+ * Moves the slide to a new position within the presentation.
131646
+ *
131647
+ * @remarks
131648
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131649
+ * @beta
131650
+ *
131651
+ * @param slideIndex The zero-based index where the slide should be moved.
131652
+ */
131653
+ moveTo(slideIndex: number): void;
129713
131654
  /**
129714
131655
  * Selects the specified shapes. Existing shape selection is replaced with the new selection.
129715
131656
  *
@@ -129746,123 +131687,6 @@ declare namespace PowerPoint {
129746
131687
  */
129747
131688
  toJSON(): PowerPoint.Interfaces.SlideData;
129748
131689
  }
129749
- /**
129750
- * Specifies a shape's fill type.
129751
- *
129752
- * @remarks
129753
- * [Api set: PowerPointApi 1.4]
129754
- */
129755
- enum ShapeFillType {
129756
- /**
129757
- * Specifies that the shape should have no fill.
129758
- * @remarks
129759
- * [Api set: PowerPointApi 1.4]
129760
- */
129761
- noFill = "NoFill",
129762
- /**
129763
- * Specifies that the shape should have regular solid fill.
129764
- * @remarks
129765
- * [Api set: PowerPointApi 1.4]
129766
- */
129767
- solid = "Solid",
129768
- /**
129769
- * Specifies that the shape should have gradient fill.
129770
- * @remarks
129771
- * [Api set: PowerPointApi 1.4]
129772
- */
129773
- gradient = "Gradient",
129774
- /**
129775
- * Specifies that the shape should have pattern fill.
129776
- * @remarks
129777
- * [Api set: PowerPointApi 1.4]
129778
- */
129779
- pattern = "Pattern",
129780
- /**
129781
- * Specifies that the shape should have picture or texture fill.
129782
- * @remarks
129783
- * [Api set: PowerPointApi 1.4]
129784
- */
129785
- pictureAndTexture = "PictureAndTexture",
129786
- /**
129787
- * Specifies that the shape should have slide background fill.
129788
- * @remarks
129789
- * [Api set: PowerPointApi 1.4]
129790
- */
129791
- slideBackground = "SlideBackground",
129792
- }
129793
- /**
129794
- * Represents the fill formatting of a shape object.
129795
- *
129796
- * @remarks
129797
- * [Api set: PowerPointApi 1.4]
129798
- */
129799
- class ShapeFill extends OfficeExtension.ClientObject {
129800
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
129801
- context: RequestContext;
129802
- /**
129803
- * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
129804
- *
129805
- * @remarks
129806
- * [Api set: PowerPointApi 1.4]
129807
- */
129808
- foregroundColor: string;
129809
- /**
129810
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
129811
- *
129812
- * @remarks
129813
- * [Api set: PowerPointApi 1.4]
129814
- */
129815
- transparency: number;
129816
- /**
129817
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
129818
- *
129819
- * @remarks
129820
- * [Api set: PowerPointApi 1.4]
129821
- */
129822
- readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
129823
- /**
129824
- * Clears the fill formatting of this shape.
129825
- *
129826
- * @remarks
129827
- * [Api set: PowerPointApi 1.4]
129828
- */
129829
- clear(): void;
129830
- /**
129831
- * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
129832
- *
129833
- * @remarks
129834
- * [Api set: PowerPointApi 1.4]
129835
- *
129836
- * @param color A string that specifies the fill color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
129837
- */
129838
- setSolidColor(color: string): void;
129839
- /**
129840
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
129841
- *
129842
- * @param options Provides options for which properties of the object to load.
129843
- */
129844
- load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
129845
- /**
129846
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
129847
- *
129848
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
129849
- */
129850
- load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
129851
- /**
129852
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
129853
- *
129854
- * @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.
129855
- */
129856
- load(propertyNamesAndPaths?: {
129857
- select?: string;
129858
- expand?: string;
129859
- }): PowerPoint.ShapeFill;
129860
- /**
129861
- * 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.)
129862
- * Whereas the original `PowerPoint.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object.
129863
- */
129864
- toJSON(): PowerPoint.Interfaces.ShapeFillData;
129865
- }
129866
131690
  /**
129867
131691
  * Represents a collection of shapes.
129868
131692
  *
@@ -129912,6 +131736,16 @@ declare namespace PowerPoint {
129912
131736
  * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
129913
131737
  */
129914
131738
  getItemOrNullObject(id: string): PowerPoint.Shape;
131739
+ /**
131740
+ * Groups all shapes in this collection into a single shape.
131741
+ If the collection contains fewer than two shapes, then this method returns the `GeneralException` error.
131742
+ *
131743
+ * @remarks
131744
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131745
+ * @beta
131746
+ * @returns The newly created grouped shape as a {@link PowerPoint.Shape}.
131747
+ */
131748
+ group(): PowerPoint.Shape;
129915
131749
  /**
129916
131750
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
129917
131751
  *
@@ -129936,6 +131770,75 @@ declare namespace PowerPoint {
129936
131770
  */
129937
131771
  toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
129938
131772
  }
131773
+ /**
131774
+ * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
131775
+ *
131776
+ * @remarks
131777
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131778
+ * @beta
131779
+ */
131780
+ class ShapeGroup extends OfficeExtension.ClientObject {
131781
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
131782
+ context: RequestContext;
131783
+ /**
131784
+ * Returns the `Shape` object associated with the group.
131785
+ *
131786
+ * @remarks
131787
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131788
+ * @beta
131789
+ */
131790
+ readonly shape: PowerPoint.Shape;
131791
+ /**
131792
+ * Returns the collection of `Shape` objects in the group.
131793
+ *
131794
+ * @remarks
131795
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131796
+ * @beta
131797
+ */
131798
+ readonly shapes: PowerPoint.ShapeScopedCollection;
131799
+ /**
131800
+ * Gets the unique ID of the shape group.
131801
+ *
131802
+ * @remarks
131803
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131804
+ * @beta
131805
+ */
131806
+ readonly id: string;
131807
+ /**
131808
+ * Ungroups any grouped shapes in the specified shape group.
131809
+ *
131810
+ * @remarks
131811
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
131812
+ * @beta
131813
+ */
131814
+ ungroup(): void;
131815
+ /**
131816
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
131817
+ *
131818
+ * @param options Provides options for which properties of the object to load.
131819
+ */
131820
+ load(options?: PowerPoint.Interfaces.ShapeGroupLoadOptions): PowerPoint.ShapeGroup;
131821
+ /**
131822
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
131823
+ *
131824
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
131825
+ */
131826
+ load(propertyNames?: string | string[]): PowerPoint.ShapeGroup;
131827
+ /**
131828
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
131829
+ *
131830
+ * @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.
131831
+ */
131832
+ load(propertyNamesAndPaths?: {
131833
+ select?: string;
131834
+ expand?: string;
131835
+ }): PowerPoint.ShapeGroup;
131836
+ /**
131837
+ * 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.)
131838
+ * Whereas the original `PowerPoint.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
131839
+ */
131840
+ toJSON(): PowerPoint.Interfaces.ShapeGroupData;
131841
+ }
129939
131842
  /**
129940
131843
  * Specifies the style for a line.
129941
131844
  *
@@ -130052,128 +131955,6 @@ declare namespace PowerPoint {
130052
131955
  */
130053
131956
  toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
130054
131957
  }
130055
- /**
130056
- * Specifies the type of a shape.
130057
- *
130058
- * @remarks
130059
- * [Api set: PowerPointApi 1.4]
130060
- */
130061
- enum ShapeType {
130062
- /**
130063
- * The given shape's type is unsupported.
130064
- * @remarks
130065
- * [Api set: PowerPointApi 1.4]
130066
- */
130067
- unsupported = "Unsupported",
130068
- /**
130069
- * The shape is an image.
130070
- * @remarks
130071
- * [Api set: PowerPointApi 1.4]
130072
- */
130073
- image = "Image",
130074
- /**
130075
- * The shape is a geometric shape such as rectangle.
130076
- * @remarks
130077
- * [Api set: PowerPointApi 1.4]
130078
- */
130079
- geometricShape = "GeometricShape",
130080
- /**
130081
- * The shape is a group shape which contains sub-shapes.
130082
- * @remarks
130083
- * [Api set: PowerPointApi 1.4]
130084
- */
130085
- group = "Group",
130086
- /**
130087
- * The shape is a line.
130088
- * @remarks
130089
- * [Api set: PowerPointApi 1.4]
130090
- */
130091
- line = "Line",
130092
- /**
130093
- * The shape is a table.
130094
- * @remarks
130095
- * [Api set: PowerPointApi 1.4]
130096
- */
130097
- table = "Table",
130098
- /**
130099
- * The shape is a callout.
130100
- * @remarks
130101
- * [Api set: PowerPointApi 1.4]
130102
- */
130103
- callout = "Callout",
130104
- /**
130105
- * The shape is a chart.
130106
- * @remarks
130107
- * [Api set: PowerPointApi 1.4]
130108
- */
130109
- chart = "Chart",
130110
- /**
130111
- * The shape is a content Office Add-in.
130112
- * @remarks
130113
- * [Api set: PowerPointApi 1.4]
130114
- */
130115
- contentApp = "ContentApp",
130116
- /**
130117
- * The shape is a diagram.
130118
- * @remarks
130119
- * [Api set: PowerPointApi 1.4]
130120
- */
130121
- diagram = "Diagram",
130122
- /**
130123
- * The shape is a freeform object.
130124
- * @remarks
130125
- * [Api set: PowerPointApi 1.4]
130126
- */
130127
- freeform = "Freeform",
130128
- /**
130129
- * The shape is a graphic.
130130
- * @remarks
130131
- * [Api set: PowerPointApi 1.4]
130132
- */
130133
- graphic = "Graphic",
130134
- /**
130135
- * The shape is an ink object.
130136
- * @remarks
130137
- * [Api set: PowerPointApi 1.4]
130138
- */
130139
- ink = "Ink",
130140
- /**
130141
- * The shape is a media object.
130142
- * @remarks
130143
- * [Api set: PowerPointApi 1.4]
130144
- */
130145
- media = "Media",
130146
- /**
130147
- * The shape is a 3D model.
130148
- * @remarks
130149
- * [Api set: PowerPointApi 1.4]
130150
- */
130151
- model3D = "Model3D",
130152
- /**
130153
- * The shape is an OLE (Object Linking and Embedding) object.
130154
- * @remarks
130155
- * [Api set: PowerPointApi 1.4]
130156
- */
130157
- ole = "Ole",
130158
- /**
130159
- * The shape is a placeholder.
130160
- * @remarks
130161
- * [Api set: PowerPointApi 1.4]
130162
- */
130163
- placeholder = "Placeholder",
130164
- /**
130165
- * The shape is a SmartArt graphic.
130166
- * @remarks
130167
- * [Api set: PowerPointApi 1.4]
130168
- */
130169
- smartArt = "SmartArt",
130170
- /**
130171
- * The shape is a text box.
130172
- * @remarks
130173
- * [Api set: PowerPointApi 1.4]
130174
- */
130175
- textBox = "TextBox",
130176
- }
130177
131958
  /**
130178
131959
  * Determines the type of automatic sizing allowed.
130179
131960
  *
@@ -130299,84 +132080,6 @@ declare namespace PowerPoint {
130299
132080
  */
130300
132081
  toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
130301
132082
  }
130302
- /**
130303
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
130304
- *
130305
- * @remarks
130306
- * [Api set: PowerPointApi 1.4]
130307
- */
130308
- class ShapeFont extends OfficeExtension.ClientObject {
130309
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
130310
- context: RequestContext;
130311
- /**
130312
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
130313
- *
130314
- * @remarks
130315
- * [Api set: PowerPointApi 1.4]
130316
- */
130317
- bold: boolean;
130318
- /**
130319
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
130320
- *
130321
- * @remarks
130322
- * [Api set: PowerPointApi 1.4]
130323
- */
130324
- color: string;
130325
- /**
130326
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
130327
- *
130328
- * @remarks
130329
- * [Api set: PowerPointApi 1.4]
130330
- */
130331
- italic: boolean;
130332
- /**
130333
- * 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.
130334
- *
130335
- * @remarks
130336
- * [Api set: PowerPointApi 1.4]
130337
- */
130338
- name: string;
130339
- /**
130340
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
130341
- *
130342
- * @remarks
130343
- * [Api set: PowerPointApi 1.4]
130344
- */
130345
- size: number;
130346
- /**
130347
- * 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.
130348
- *
130349
- * @remarks
130350
- * [Api set: PowerPointApi 1.4]
130351
- */
130352
- underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
130353
- /**
130354
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130355
- *
130356
- * @param options Provides options for which properties of the object to load.
130357
- */
130358
- load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
130359
- /**
130360
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130361
- *
130362
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
130363
- */
130364
- load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
130365
- /**
130366
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
130367
- *
130368
- * @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.
130369
- */
130370
- load(propertyNamesAndPaths?: {
130371
- select?: string;
130372
- expand?: string;
130373
- }): PowerPoint.ShapeFont;
130374
- /**
130375
- * 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.)
130376
- * Whereas the original `PowerPoint.ShapeFont` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeFontData`) that contains shallow copies of any loaded child properties from the original object.
130377
- */
130378
- toJSON(): PowerPoint.Interfaces.ShapeFontData;
130379
- }
130380
132083
  /**
130381
132084
  * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
130382
132085
  *
@@ -130610,6 +132313,15 @@ declare namespace PowerPoint {
130610
132313
  * [Api set: PowerPointApi 1.4]
130611
132314
  */
130612
132315
  readonly fill: PowerPoint.ShapeFill;
132316
+ /**
132317
+ * Returns the `ShapeGroup` associated with the shape.
132318
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
132319
+ *
132320
+ * @remarks
132321
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
132322
+ * @beta
132323
+ */
132324
+ readonly group: PowerPoint.ShapeGroup;
130613
132325
  /**
130614
132326
  * Returns the line formatting of this shape.
130615
132327
  *
@@ -130617,6 +132329,15 @@ declare namespace PowerPoint {
130617
132329
  * [Api set: PowerPointApi 1.4]
130618
132330
  */
130619
132331
  readonly lineFormat: PowerPoint.ShapeLineFormat;
132332
+ /**
132333
+ * Returns the parent group of this shape.
132334
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
132335
+ *
132336
+ * @remarks
132337
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
132338
+ * @beta
132339
+ */
132340
+ readonly parentGroup: PowerPoint.Shape;
130620
132341
  /**
130621
132342
  * Returns a collection of tags in the shape.
130622
132343
  *
@@ -130652,6 +132373,20 @@ declare namespace PowerPoint {
130652
132373
  * [Api set: PowerPointApi 1.4]
130653
132374
  */
130654
132375
  left: number;
132376
+ /**
132377
+ * Returns the level of the specified shape.
132378
+
132379
+ - A level of 0 means the shape isn't part of a group.
132380
+
132381
+ - A level of 1 means the shape is part of a top-level group.
132382
+
132383
+ - A level greater than 1 indicates the shape is a nested group.
132384
+ *
132385
+ * @remarks
132386
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
132387
+ * @beta
132388
+ */
132389
+ readonly level: number;
130655
132390
  /**
130656
132391
  * Specifies the name of this shape.
130657
132392
  *
@@ -131390,6 +133125,68 @@ declare namespace PowerPoint {
131390
133125
  interface HyperlinkCollectionUpdateData {
131391
133126
  items?: PowerPoint.Interfaces.HyperlinkData[];
131392
133127
  }
133128
+ /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */
133129
+ interface ShapeFillUpdateData {
133130
+ /**
133131
+ * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
133132
+ *
133133
+ * @remarks
133134
+ * [Api set: PowerPointApi 1.4]
133135
+ */
133136
+ foregroundColor?: string;
133137
+ /**
133138
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
133139
+ *
133140
+ * @remarks
133141
+ * [Api set: PowerPointApi 1.4]
133142
+ */
133143
+ transparency?: number;
133144
+ }
133145
+ /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
133146
+ interface ShapeFontUpdateData {
133147
+ /**
133148
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
133149
+ *
133150
+ * @remarks
133151
+ * [Api set: PowerPointApi 1.4]
133152
+ */
133153
+ bold?: boolean;
133154
+ /**
133155
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
133156
+ *
133157
+ * @remarks
133158
+ * [Api set: PowerPointApi 1.4]
133159
+ */
133160
+ color?: string;
133161
+ /**
133162
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
133163
+ *
133164
+ * @remarks
133165
+ * [Api set: PowerPointApi 1.4]
133166
+ */
133167
+ italic?: boolean;
133168
+ /**
133169
+ * 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.
133170
+ *
133171
+ * @remarks
133172
+ * [Api set: PowerPointApi 1.4]
133173
+ */
133174
+ name?: string;
133175
+ /**
133176
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
133177
+ *
133178
+ * @remarks
133179
+ * [Api set: PowerPointApi 1.4]
133180
+ */
133181
+ size?: number;
133182
+ /**
133183
+ * 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.
133184
+ *
133185
+ * @remarks
133186
+ * [Api set: PowerPointApi 1.4]
133187
+ */
133188
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
133189
+ }
131393
133190
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
131394
133191
  interface ShapeCollectionUpdateData {
131395
133192
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -131412,23 +133209,6 @@ declare namespace PowerPoint {
131412
133209
  interface TagCollectionUpdateData {
131413
133210
  items?: PowerPoint.Interfaces.TagData[];
131414
133211
  }
131415
- /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */
131416
- interface ShapeFillUpdateData {
131417
- /**
131418
- * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
131419
- *
131420
- * @remarks
131421
- * [Api set: PowerPointApi 1.4]
131422
- */
131423
- foregroundColor?: string;
131424
- /**
131425
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
131426
- *
131427
- * @remarks
131428
- * [Api set: PowerPointApi 1.4]
131429
- */
131430
- transparency?: number;
131431
- }
131432
133212
  /** An interface for updating data on the `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */
131433
133213
  interface ShapeScopedCollectionUpdateData {
131434
133214
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -131498,51 +133278,6 @@ declare namespace PowerPoint {
131498
133278
  */
131499
133279
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
131500
133280
  }
131501
- /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
131502
- interface ShapeFontUpdateData {
131503
- /**
131504
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
131505
- *
131506
- * @remarks
131507
- * [Api set: PowerPointApi 1.4]
131508
- */
131509
- bold?: boolean;
131510
- /**
131511
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
131512
- *
131513
- * @remarks
131514
- * [Api set: PowerPointApi 1.4]
131515
- */
131516
- color?: string;
131517
- /**
131518
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
131519
- *
131520
- * @remarks
131521
- * [Api set: PowerPointApi 1.4]
131522
- */
131523
- italic?: boolean;
131524
- /**
131525
- * 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.
131526
- *
131527
- * @remarks
131528
- * [Api set: PowerPointApi 1.4]
131529
- */
131530
- name?: string;
131531
- /**
131532
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
131533
- *
131534
- * @remarks
131535
- * [Api set: PowerPointApi 1.4]
131536
- */
131537
- size?: number;
131538
- /**
131539
- * 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.
131540
- *
131541
- * @remarks
131542
- * [Api set: PowerPointApi 1.4]
131543
- */
131544
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
131545
- }
131546
133281
  /** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */
131547
133282
  interface TextRangeUpdateData {
131548
133283
  /**
@@ -131809,6 +133544,75 @@ declare namespace PowerPoint {
131809
133544
  interface HyperlinkCollectionData {
131810
133545
  items?: PowerPoint.Interfaces.HyperlinkData[];
131811
133546
  }
133547
+ /** An interface describing the data returned by calling `shapeFill.toJSON()`. */
133548
+ interface ShapeFillData {
133549
+ /**
133550
+ * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
133551
+ *
133552
+ * @remarks
133553
+ * [Api set: PowerPointApi 1.4]
133554
+ */
133555
+ foregroundColor?: string;
133556
+ /**
133557
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
133558
+ *
133559
+ * @remarks
133560
+ * [Api set: PowerPointApi 1.4]
133561
+ */
133562
+ transparency?: number;
133563
+ /**
133564
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
133565
+ *
133566
+ * @remarks
133567
+ * [Api set: PowerPointApi 1.4]
133568
+ */
133569
+ type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
133570
+ }
133571
+ /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
133572
+ interface ShapeFontData {
133573
+ /**
133574
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
133575
+ *
133576
+ * @remarks
133577
+ * [Api set: PowerPointApi 1.4]
133578
+ */
133579
+ bold?: boolean;
133580
+ /**
133581
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
133582
+ *
133583
+ * @remarks
133584
+ * [Api set: PowerPointApi 1.4]
133585
+ */
133586
+ color?: string;
133587
+ /**
133588
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
133589
+ *
133590
+ * @remarks
133591
+ * [Api set: PowerPointApi 1.4]
133592
+ */
133593
+ italic?: boolean;
133594
+ /**
133595
+ * 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.
133596
+ *
133597
+ * @remarks
133598
+ * [Api set: PowerPointApi 1.4]
133599
+ */
133600
+ name?: string;
133601
+ /**
133602
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
133603
+ *
133604
+ * @remarks
133605
+ * [Api set: PowerPointApi 1.4]
133606
+ */
133607
+ size?: number;
133608
+ /**
133609
+ * 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.
133610
+ *
133611
+ * @remarks
133612
+ * [Api set: PowerPointApi 1.4]
133613
+ */
133614
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
133615
+ }
131812
133616
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
131813
133617
  interface ShapeCollectionData {
131814
133618
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -131829,6 +133633,14 @@ declare namespace PowerPoint {
131829
133633
  * [Api set: PowerPointApi 1.3]
131830
133634
  */
131831
133635
  name?: string;
133636
+ /**
133637
+ * Returns the type of the slide layout.
133638
+ *
133639
+ * @remarks
133640
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
133641
+ * @beta
133642
+ */
133643
+ type?: PowerPoint.SlideLayoutType | "Blank" | "Chart" | "ChartAndText" | "ClipArtAndText" | "ClipArtAndVerticalText" | "Comparison" | "ContentWithCaption" | "Custom" | "FourObjects" | "LargeObject" | "MediaClipAndText" | "Mixed" | "Object" | "ObjectAndText" | "ObjectAndTwoObjects" | "ObjectOverText" | "OrganizationChart" | "PictureWithCaption" | "SectionHeader" | "Table" | "Text" | "TextAndChart" | "TextAndClipArt" | "TextAndMediaClip" | "TextAndObject" | "TextAndTwoObjects" | "TextOverObject" | "Title" | "TitleOnly" | "TwoColumnText" | "TwoObjects" | "TwoObjectsAndObject" | "TwoObjectsAndText" | "TwoObjectsOverText" | "VerticalText" | "VerticalTitleAndText" | "VerticalTitleAndTextOverChart";
131832
133644
  }
131833
133645
  /** An interface describing the data returned by calling `slideLayoutCollection.toJSON()`. */
131834
133646
  interface SlideLayoutCollectionData {
@@ -131881,35 +133693,30 @@ declare namespace PowerPoint {
131881
133693
  * [Api set: PowerPointApi 1.2]
131882
133694
  */
131883
133695
  id?: string;
131884
- }
131885
- /** An interface describing the data returned by calling `shapeFill.toJSON()`. */
131886
- interface ShapeFillData {
131887
133696
  /**
131888
- * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
133697
+ * Returns the zero-based index of the slide representing its position in the presentation.
131889
133698
  *
131890
133699
  * @remarks
131891
- * [Api set: PowerPointApi 1.4]
131892
- */
131893
- foregroundColor?: string;
131894
- /**
131895
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
131896
- *
131897
- * @remarks
131898
- * [Api set: PowerPointApi 1.4]
131899
- */
131900
- transparency?: number;
131901
- /**
131902
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
131903
- *
131904
- * @remarks
131905
- * [Api set: PowerPointApi 1.4]
133700
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
133701
+ * @beta
131906
133702
  */
131907
- type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
133703
+ index?: number;
131908
133704
  }
131909
133705
  /** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
131910
133706
  interface ShapeScopedCollectionData {
131911
133707
  items?: PowerPoint.Interfaces.ShapeData[];
131912
133708
  }
133709
+ /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
133710
+ interface ShapeGroupData {
133711
+ /**
133712
+ * Gets the unique ID of the shape group.
133713
+ *
133714
+ * @remarks
133715
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
133716
+ * @beta
133717
+ */
133718
+ id?: string;
133719
+ }
131913
133720
  /** An interface describing the data returned by calling `shapeLineFormat.toJSON()`. */
131914
133721
  interface ShapeLineFormatData {
131915
133722
  /**
@@ -131975,51 +133782,6 @@ declare namespace PowerPoint {
131975
133782
  */
131976
133783
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
131977
133784
  }
131978
- /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
131979
- interface ShapeFontData {
131980
- /**
131981
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
131982
- *
131983
- * @remarks
131984
- * [Api set: PowerPointApi 1.4]
131985
- */
131986
- bold?: boolean;
131987
- /**
131988
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
131989
- *
131990
- * @remarks
131991
- * [Api set: PowerPointApi 1.4]
131992
- */
131993
- color?: string;
131994
- /**
131995
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
131996
- *
131997
- * @remarks
131998
- * [Api set: PowerPointApi 1.4]
131999
- */
132000
- italic?: boolean;
132001
- /**
132002
- * 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.
132003
- *
132004
- * @remarks
132005
- * [Api set: PowerPointApi 1.4]
132006
- */
132007
- name?: string;
132008
- /**
132009
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
132010
- *
132011
- * @remarks
132012
- * [Api set: PowerPointApi 1.4]
132013
- */
132014
- size?: number;
132015
- /**
132016
- * 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.
132017
- *
132018
- * @remarks
132019
- * [Api set: PowerPointApi 1.4]
132020
- */
132021
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
132022
- }
132023
133785
  /** An interface describing the data returned by calling `textRange.toJSON()`. */
132024
133786
  interface TextRangeData {
132025
133787
  /**
@@ -132128,6 +133890,20 @@ declare namespace PowerPoint {
132128
133890
  * [Api set: PowerPointApi 1.4]
132129
133891
  */
132130
133892
  left?: number;
133893
+ /**
133894
+ * Returns the level of the specified shape.
133895
+
133896
+ - A level of 0 means the shape isn't part of a group.
133897
+
133898
+ - A level of 1 means the shape is part of a top-level group.
133899
+
133900
+ - A level greater than 1 indicates the shape is a nested group.
133901
+ *
133902
+ * @remarks
133903
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
133904
+ * @beta
133905
+ */
133906
+ level?: number;
132131
133907
  /**
132132
133908
  * Specifies the name of this shape.
132133
133909
  *
@@ -132435,6 +134211,93 @@ declare namespace PowerPoint {
132435
134211
  */
132436
134212
  screenTip?: boolean;
132437
134213
  }
134214
+ /**
134215
+ * Represents the fill formatting of a shape object.
134216
+ *
134217
+ * @remarks
134218
+ * [Api set: PowerPointApi 1.4]
134219
+ */
134220
+ interface ShapeFillLoadOptions {
134221
+ /**
134222
+ 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`).
134223
+ */
134224
+ $all?: boolean;
134225
+ /**
134226
+ * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
134227
+ *
134228
+ * @remarks
134229
+ * [Api set: PowerPointApi 1.4]
134230
+ */
134231
+ foregroundColor?: boolean;
134232
+ /**
134233
+ * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
134234
+ *
134235
+ * @remarks
134236
+ * [Api set: PowerPointApi 1.4]
134237
+ */
134238
+ transparency?: boolean;
134239
+ /**
134240
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
134241
+ *
134242
+ * @remarks
134243
+ * [Api set: PowerPointApi 1.4]
134244
+ */
134245
+ type?: boolean;
134246
+ }
134247
+ /**
134248
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
134249
+ *
134250
+ * @remarks
134251
+ * [Api set: PowerPointApi 1.4]
134252
+ */
134253
+ interface ShapeFontLoadOptions {
134254
+ /**
134255
+ 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`).
134256
+ */
134257
+ $all?: boolean;
134258
+ /**
134259
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
134260
+ *
134261
+ * @remarks
134262
+ * [Api set: PowerPointApi 1.4]
134263
+ */
134264
+ bold?: boolean;
134265
+ /**
134266
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
134267
+ *
134268
+ * @remarks
134269
+ * [Api set: PowerPointApi 1.4]
134270
+ */
134271
+ color?: boolean;
134272
+ /**
134273
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
134274
+ *
134275
+ * @remarks
134276
+ * [Api set: PowerPointApi 1.4]
134277
+ */
134278
+ italic?: boolean;
134279
+ /**
134280
+ * 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.
134281
+ *
134282
+ * @remarks
134283
+ * [Api set: PowerPointApi 1.4]
134284
+ */
134285
+ name?: boolean;
134286
+ /**
134287
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
134288
+ *
134289
+ * @remarks
134290
+ * [Api set: PowerPointApi 1.4]
134291
+ */
134292
+ size?: boolean;
134293
+ /**
134294
+ * 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.
134295
+ *
134296
+ * @remarks
134297
+ * [Api set: PowerPointApi 1.4]
134298
+ */
134299
+ underline?: boolean;
134300
+ }
132438
134301
  /**
132439
134302
  * Represents the collection of shapes.
132440
134303
  *
@@ -132454,6 +134317,15 @@ declare namespace PowerPoint {
132454
134317
  */
132455
134318
  fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
132456
134319
  /**
134320
+ * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
134321
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
134322
+ *
134323
+ * @remarks
134324
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134325
+ * @beta
134326
+ */
134327
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
134328
+ /**
132457
134329
  * For EACH ITEM in the collection: Returns the line formatting of this shape.
132458
134330
  *
132459
134331
  * @remarks
@@ -132461,6 +134333,15 @@ declare namespace PowerPoint {
132461
134333
  */
132462
134334
  lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
132463
134335
  /**
134336
+ * For EACH ITEM in the collection: Returns the parent group of this shape.
134337
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
134338
+ *
134339
+ * @remarks
134340
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134341
+ * @beta
134342
+ */
134343
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
134344
+ /**
132464
134345
  * For EACH ITEM in the collection: Returns the text frame object of this shape.
132465
134346
  *
132466
134347
  * @remarks
@@ -132488,6 +134369,20 @@ declare namespace PowerPoint {
132488
134369
  * [Api set: PowerPointApi 1.4]
132489
134370
  */
132490
134371
  left?: boolean;
134372
+ /**
134373
+ * For EACH ITEM in the collection: Returns the level of the specified shape.
134374
+
134375
+ - A level of 0 means the shape isn't part of a group.
134376
+
134377
+ - A level of 1 means the shape is part of a top-level group.
134378
+
134379
+ - A level greater than 1 indicates the shape is a nested group.
134380
+ *
134381
+ * @remarks
134382
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134383
+ * @beta
134384
+ */
134385
+ level?: boolean;
132491
134386
  /**
132492
134387
  * For EACH ITEM in the collection: Specifies the name of this shape.
132493
134388
  *
@@ -132542,6 +134437,14 @@ declare namespace PowerPoint {
132542
134437
  * [Api set: PowerPointApi 1.3]
132543
134438
  */
132544
134439
  name?: boolean;
134440
+ /**
134441
+ * Returns the type of the slide layout.
134442
+ *
134443
+ * @remarks
134444
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134445
+ * @beta
134446
+ */
134447
+ type?: boolean;
132545
134448
  }
132546
134449
  /**
132547
134450
  * Represents the collection of layouts provided by the Slide Master for slides.
@@ -132568,6 +134471,14 @@ declare namespace PowerPoint {
132568
134471
  * [Api set: PowerPointApi 1.3]
132569
134472
  */
132570
134473
  name?: boolean;
134474
+ /**
134475
+ * For EACH ITEM in the collection: Returns the type of the slide layout.
134476
+ *
134477
+ * @remarks
134478
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134479
+ * @beta
134480
+ */
134481
+ type?: boolean;
132571
134482
  }
132572
134483
  /**
132573
134484
  * Represents the Slide Master of a slide.
@@ -132679,39 +134590,14 @@ declare namespace PowerPoint {
132679
134590
  * [Api set: PowerPointApi 1.2]
132680
134591
  */
132681
134592
  id?: boolean;
132682
- }
132683
- /**
132684
- * Represents the fill formatting of a shape object.
132685
- *
132686
- * @remarks
132687
- * [Api set: PowerPointApi 1.4]
132688
- */
132689
- interface ShapeFillLoadOptions {
132690
134593
  /**
132691
- 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`).
132692
- */
132693
- $all?: boolean;
132694
- /**
132695
- * Represents the shape fill foreground color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
134594
+ * Returns the zero-based index of the slide representing its position in the presentation.
132696
134595
  *
132697
134596
  * @remarks
132698
- * [Api set: PowerPointApi 1.4]
132699
- */
132700
- foregroundColor?: boolean;
132701
- /**
132702
- * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
132703
- *
132704
- * @remarks
132705
- * [Api set: PowerPointApi 1.4]
132706
- */
132707
- transparency?: boolean;
132708
- /**
132709
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
132710
- *
132711
- * @remarks
132712
- * [Api set: PowerPointApi 1.4]
134597
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134598
+ * @beta
132713
134599
  */
132714
- type?: boolean;
134600
+ index?: boolean;
132715
134601
  }
132716
134602
  /**
132717
134603
  * Represents a collection of shapes.
@@ -132732,6 +134618,15 @@ declare namespace PowerPoint {
132732
134618
  */
132733
134619
  fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
132734
134620
  /**
134621
+ * For EACH ITEM in the collection: Returns the `ShapeGroup` associated with the shape.
134622
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
134623
+ *
134624
+ * @remarks
134625
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134626
+ * @beta
134627
+ */
134628
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
134629
+ /**
132735
134630
  * For EACH ITEM in the collection: Returns the line formatting of this shape.
132736
134631
  *
132737
134632
  * @remarks
@@ -132739,6 +134634,15 @@ declare namespace PowerPoint {
132739
134634
  */
132740
134635
  lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
132741
134636
  /**
134637
+ * For EACH ITEM in the collection: Returns the parent group of this shape.
134638
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
134639
+ *
134640
+ * @remarks
134641
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134642
+ * @beta
134643
+ */
134644
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
134645
+ /**
132742
134646
  * For EACH ITEM in the collection: Returns the text frame object of this shape.
132743
134647
  *
132744
134648
  * @remarks
@@ -132766,6 +134670,20 @@ declare namespace PowerPoint {
132766
134670
  * [Api set: PowerPointApi 1.4]
132767
134671
  */
132768
134672
  left?: boolean;
134673
+ /**
134674
+ * For EACH ITEM in the collection: Returns the level of the specified shape.
134675
+
134676
+ - A level of 0 means the shape isn't part of a group.
134677
+
134678
+ - A level of 1 means the shape is part of a top-level group.
134679
+
134680
+ - A level greater than 1 indicates the shape is a nested group.
134681
+ *
134682
+ * @remarks
134683
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134684
+ * @beta
134685
+ */
134686
+ level?: boolean;
132769
134687
  /**
132770
134688
  * For EACH ITEM in the collection: Specifies the name of this shape.
132771
134689
  *
@@ -132795,6 +134713,35 @@ declare namespace PowerPoint {
132795
134713
  */
132796
134714
  width?: boolean;
132797
134715
  }
134716
+ /**
134717
+ * Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
134718
+ *
134719
+ * @remarks
134720
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134721
+ * @beta
134722
+ */
134723
+ interface ShapeGroupLoadOptions {
134724
+ /**
134725
+ 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`).
134726
+ */
134727
+ $all?: boolean;
134728
+ /**
134729
+ * Returns the `Shape` object associated with the group.
134730
+ *
134731
+ * @remarks
134732
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134733
+ * @beta
134734
+ */
134735
+ shape?: PowerPoint.Interfaces.ShapeLoadOptions;
134736
+ /**
134737
+ * Gets the unique ID of the shape group.
134738
+ *
134739
+ * @remarks
134740
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134741
+ * @beta
134742
+ */
134743
+ id?: boolean;
134744
+ }
132798
134745
  /**
132799
134746
  * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
132800
134747
  *
@@ -132894,60 +134841,6 @@ declare namespace PowerPoint {
132894
134841
  */
132895
134842
  horizontalAlignment?: boolean;
132896
134843
  }
132897
- /**
132898
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
132899
- *
132900
- * @remarks
132901
- * [Api set: PowerPointApi 1.4]
132902
- */
132903
- interface ShapeFontLoadOptions {
132904
- /**
132905
- 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`).
132906
- */
132907
- $all?: boolean;
132908
- /**
132909
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
132910
- *
132911
- * @remarks
132912
- * [Api set: PowerPointApi 1.4]
132913
- */
132914
- bold?: boolean;
132915
- /**
132916
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
132917
- *
132918
- * @remarks
132919
- * [Api set: PowerPointApi 1.4]
132920
- */
132921
- color?: boolean;
132922
- /**
132923
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
132924
- *
132925
- * @remarks
132926
- * [Api set: PowerPointApi 1.4]
132927
- */
132928
- italic?: boolean;
132929
- /**
132930
- * 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.
132931
- *
132932
- * @remarks
132933
- * [Api set: PowerPointApi 1.4]
132934
- */
132935
- name?: boolean;
132936
- /**
132937
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
132938
- *
132939
- * @remarks
132940
- * [Api set: PowerPointApi 1.4]
132941
- */
132942
- size?: boolean;
132943
- /**
132944
- * 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.
132945
- *
132946
- * @remarks
132947
- * [Api set: PowerPointApi 1.4]
132948
- */
132949
- underline?: boolean;
132950
- }
132951
134844
  /**
132952
134845
  * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
132953
134846
  *
@@ -133091,6 +134984,15 @@ declare namespace PowerPoint {
133091
134984
  */
133092
134985
  fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
133093
134986
  /**
134987
+ * Returns the `ShapeGroup` associated with the shape.
134988
+ If the shape type isn't `group`, then this method returns the `GeneralException` error.
134989
+ *
134990
+ * @remarks
134991
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
134992
+ * @beta
134993
+ */
134994
+ group?: PowerPoint.Interfaces.ShapeGroupLoadOptions;
134995
+ /**
133094
134996
  * Returns the line formatting of this shape.
133095
134997
  *
133096
134998
  * @remarks
@@ -133098,6 +135000,15 @@ declare namespace PowerPoint {
133098
135000
  */
133099
135001
  lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
133100
135002
  /**
135003
+ * Returns the parent group of this shape.
135004
+ If the shape isn't part of a group, then this method returns the `GeneralException` error.
135005
+ *
135006
+ * @remarks
135007
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
135008
+ * @beta
135009
+ */
135010
+ parentGroup?: PowerPoint.Interfaces.ShapeLoadOptions;
135011
+ /**
133101
135012
  * Returns the text frame object of this shape.
133102
135013
  *
133103
135014
  * @remarks
@@ -133125,6 +135036,20 @@ declare namespace PowerPoint {
133125
135036
  * [Api set: PowerPointApi 1.4]
133126
135037
  */
133127
135038
  left?: boolean;
135039
+ /**
135040
+ * Returns the level of the specified shape.
135041
+
135042
+ - A level of 0 means the shape isn't part of a group.
135043
+
135044
+ - A level of 1 means the shape is part of a top-level group.
135045
+
135046
+ - A level greater than 1 indicates the shape is a nested group.
135047
+ *
135048
+ * @remarks
135049
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
135050
+ * @beta
135051
+ */
135052
+ level?: boolean;
133128
135053
  /**
133129
135054
  * Specifies the name of this shape.
133130
135055
  *
@@ -133343,6 +135268,14 @@ declare namespace PowerPoint {
133343
135268
  * [Api set: PowerPointApi 1.2]
133344
135269
  */
133345
135270
  id?: boolean;
135271
+ /**
135272
+ * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
135273
+ *
135274
+ * @remarks
135275
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
135276
+ * @beta
135277
+ */
135278
+ index?: boolean;
133346
135279
  }
133347
135280
  /**
133348
135281
  * Represents a collection of slides in the presentation.
@@ -133376,6 +135309,14 @@ declare namespace PowerPoint {
133376
135309
  * [Api set: PowerPointApi 1.2]
133377
135310
  */
133378
135311
  id?: boolean;
135312
+ /**
135313
+ * For EACH ITEM in the collection: Returns the zero-based index of the slide representing its position in the presentation.
135314
+ *
135315
+ * @remarks
135316
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
135317
+ * @beta
135318
+ */
135319
+ index?: boolean;
133379
135320
  }
133380
135321
  /**
133381
135322
  * Represents the collection of Slide Masters in the presentation.