@types/office-js 1.0.455 → 1.0.456

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.
Files changed (3) hide show
  1. office-js/README.md +1 -1
  2. office-js/index.d.ts +633 -633
  3. office-js/package.json +2 -2
office-js/index.d.ts CHANGED
@@ -117817,6 +117817,128 @@ declare namespace PowerPoint {
117817
117817
  */
117818
117818
  toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
117819
117819
  }
117820
+ /**
117821
+ * Specifies the type of a shape.
117822
+ *
117823
+ * @remarks
117824
+ * [Api set: PowerPointApi 1.4]
117825
+ */
117826
+ enum ShapeType {
117827
+ /**
117828
+ * The given shape's type is unsupported.
117829
+ * @remarks
117830
+ * [Api set: PowerPointApi 1.4]
117831
+ */
117832
+ unsupported = "Unsupported",
117833
+ /**
117834
+ * The shape is an image.
117835
+ * @remarks
117836
+ * [Api set: PowerPointApi 1.4]
117837
+ */
117838
+ image = "Image",
117839
+ /**
117840
+ * The shape is a geometric shape such as rectangle.
117841
+ * @remarks
117842
+ * [Api set: PowerPointApi 1.4]
117843
+ */
117844
+ geometricShape = "GeometricShape",
117845
+ /**
117846
+ * The shape is a group shape which contains sub-shapes.
117847
+ * @remarks
117848
+ * [Api set: PowerPointApi 1.4]
117849
+ */
117850
+ group = "Group",
117851
+ /**
117852
+ * The shape is a line.
117853
+ * @remarks
117854
+ * [Api set: PowerPointApi 1.4]
117855
+ */
117856
+ line = "Line",
117857
+ /**
117858
+ * The shape is a table.
117859
+ * @remarks
117860
+ * [Api set: PowerPointApi 1.4]
117861
+ */
117862
+ table = "Table",
117863
+ /**
117864
+ * The shape is a callout.
117865
+ * @remarks
117866
+ * [Api set: PowerPointApi 1.4]
117867
+ */
117868
+ callout = "Callout",
117869
+ /**
117870
+ * The shape is a chart.
117871
+ * @remarks
117872
+ * [Api set: PowerPointApi 1.4]
117873
+ */
117874
+ chart = "Chart",
117875
+ /**
117876
+ * The shape is a content Office Add-in.
117877
+ * @remarks
117878
+ * [Api set: PowerPointApi 1.4]
117879
+ */
117880
+ contentApp = "ContentApp",
117881
+ /**
117882
+ * The shape is a diagram.
117883
+ * @remarks
117884
+ * [Api set: PowerPointApi 1.4]
117885
+ */
117886
+ diagram = "Diagram",
117887
+ /**
117888
+ * The shape is a freeform object.
117889
+ * @remarks
117890
+ * [Api set: PowerPointApi 1.4]
117891
+ */
117892
+ freeform = "Freeform",
117893
+ /**
117894
+ * The shape is a graphic.
117895
+ * @remarks
117896
+ * [Api set: PowerPointApi 1.4]
117897
+ */
117898
+ graphic = "Graphic",
117899
+ /**
117900
+ * The shape is an ink object.
117901
+ * @remarks
117902
+ * [Api set: PowerPointApi 1.4]
117903
+ */
117904
+ ink = "Ink",
117905
+ /**
117906
+ * The shape is a media object.
117907
+ * @remarks
117908
+ * [Api set: PowerPointApi 1.4]
117909
+ */
117910
+ media = "Media",
117911
+ /**
117912
+ * The shape is a 3D model.
117913
+ * @remarks
117914
+ * [Api set: PowerPointApi 1.4]
117915
+ */
117916
+ model3D = "Model3D",
117917
+ /**
117918
+ * The shape is an OLE (Object Linking and Embedding) object.
117919
+ * @remarks
117920
+ * [Api set: PowerPointApi 1.4]
117921
+ */
117922
+ ole = "Ole",
117923
+ /**
117924
+ * The shape is a placeholder.
117925
+ * @remarks
117926
+ * [Api set: PowerPointApi 1.4]
117927
+ */
117928
+ placeholder = "Placeholder",
117929
+ /**
117930
+ * The shape is a SmartArt graphic.
117931
+ * @remarks
117932
+ * [Api set: PowerPointApi 1.4]
117933
+ */
117934
+ smartArt = "SmartArt",
117935
+ /**
117936
+ * The shape is a text box.
117937
+ * @remarks
117938
+ * [Api set: PowerPointApi 1.4]
117939
+ */
117940
+ textBox = "TextBox",
117941
+ }
117820
117942
  /**
117821
117943
  * Represents a single hyperlink.
117822
117944
  *
@@ -119139,164 +119261,359 @@ declare namespace PowerPoint {
119139
119261
  systemDashDot = "SystemDashDot",
119140
119262
  }
119141
119263
  /**
119142
- * The type of underline applied to a font.
119264
+ * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
119143
119265
  *
119144
119266
  * @remarks
119145
119267
  * [Api set: PowerPointApi 1.4]
119146
119268
  */
119147
- enum ShapeFontUnderlineStyle {
119148
- /**
119149
- * No underlining.
119150
- * @remarks
119151
- * [Api set: PowerPointApi 1.4]
119152
- */
119153
- none = "None",
119154
- /**
119155
- * Regular single line underlining.
119156
- * @remarks
119157
- * [Api set: PowerPointApi 1.4]
119158
- */
119159
- single = "Single",
119160
- /**
119161
- * Underlining of text with double lines.
119162
- * @remarks
119163
- * [Api set: PowerPointApi 1.4]
119164
- */
119165
- double = "Double",
119166
- /**
119167
- * Underlining of text with a thick line.
119168
- * @remarks
119169
- * [Api set: PowerPointApi 1.4]
119170
- */
119171
- heavy = "Heavy",
119269
+ enum ParagraphHorizontalAlignment {
119172
119270
  /**
119173
- * Underlining of text with a dotted line.
119271
+ * Align text to the left margin.
119174
119272
  * @remarks
119175
119273
  * [Api set: PowerPointApi 1.4]
119176
119274
  */
119177
- dotted = "Dotted",
119275
+ left = "Left",
119178
119276
  /**
119179
- * Underlining of text with a thick, dotted line.
119277
+ * Align text in the center.
119180
119278
  * @remarks
119181
119279
  * [Api set: PowerPointApi 1.4]
119182
119280
  */
119183
- dottedHeavy = "DottedHeavy",
119281
+ center = "Center",
119184
119282
  /**
119185
- * Underlining of text with a line containing dashes.
119283
+ * Align text to the right margin.
119186
119284
  * @remarks
119187
119285
  * [Api set: PowerPointApi 1.4]
119188
119286
  */
119189
- dash = "Dash",
119287
+ right = "Right",
119190
119288
  /**
119191
- * Underlining of text with a thick line containing dashes.
119289
+ * Align text so that it is justified across the whole line.
119192
119290
  * @remarks
119193
119291
  * [Api set: PowerPointApi 1.4]
119194
119292
  */
119195
- dashHeavy = "DashHeavy",
119293
+ justify = "Justify",
119196
119294
  /**
119197
- * Underlining of text with a line containing long dashes.
119295
+ * Specifies the alignment or adjustment of kashida length in Arabic text.
119198
119296
  * @remarks
119199
119297
  * [Api set: PowerPointApi 1.4]
119200
119298
  */
119201
- dashLong = "DashLong",
119299
+ justifyLow = "JustifyLow",
119202
119300
  /**
119203
- * Underlining of text with a thick line containing long dashes.
119301
+ * Distributes the text words across an entire text line.
119204
119302
  * @remarks
119205
119303
  * [Api set: PowerPointApi 1.4]
119206
119304
  */
119207
- dashLongHeavy = "DashLongHeavy",
119305
+ distributed = "Distributed",
119208
119306
  /**
119209
- * Underlining of text with a line containing dots and dashes.
119307
+ * Distributes Thai text specially, because each character is treated as a word.
119210
119308
  * @remarks
119211
119309
  * [Api set: PowerPointApi 1.4]
119212
119310
  */
119213
- dotDash = "DotDash",
119311
+ thaiDistributed = "ThaiDistributed",
119312
+ }
119313
+ /**
119314
+ * Specifies a shape's fill type.
119315
+ *
119316
+ * @remarks
119317
+ * [Api set: PowerPointApi 1.4]
119318
+ */
119319
+ enum ShapeFillType {
119214
119320
  /**
119215
- * Underlining of text with a thick line containing dots and dashes.
119321
+ * Specifies that the shape should have no fill.
119216
119322
  * @remarks
119217
119323
  * [Api set: PowerPointApi 1.4]
119218
119324
  */
119219
- dotDashHeavy = "DotDashHeavy",
119325
+ noFill = "NoFill",
119220
119326
  /**
119221
- * Underlining of text with a line containing double dots and dashes.
119327
+ * Specifies that the shape should have regular solid fill.
119222
119328
  * @remarks
119223
119329
  * [Api set: PowerPointApi 1.4]
119224
119330
  */
119225
- dotDotDash = "DotDotDash",
119331
+ solid = "Solid",
119226
119332
  /**
119227
- * Underlining of text with a thick line containing double dots and dashes.
119333
+ * Specifies that the shape should have gradient fill.
119228
119334
  * @remarks
119229
119335
  * [Api set: PowerPointApi 1.4]
119230
119336
  */
119231
- dotDotDashHeavy = "DotDotDashHeavy",
119337
+ gradient = "Gradient",
119232
119338
  /**
119233
- * Underlining of text with a wavy line.
119339
+ * Specifies that the shape should have pattern fill.
119234
119340
  * @remarks
119235
119341
  * [Api set: PowerPointApi 1.4]
119236
119342
  */
119237
- wavy = "Wavy",
119343
+ pattern = "Pattern",
119238
119344
  /**
119239
- * Underlining of text with a thick, wavy line.
119345
+ * Specifies that the shape should have picture or texture fill.
119240
119346
  * @remarks
119241
119347
  * [Api set: PowerPointApi 1.4]
119242
119348
  */
119243
- wavyHeavy = "WavyHeavy",
119349
+ pictureAndTexture = "PictureAndTexture",
119244
119350
  /**
119245
- * Underlining of text with double wavy lines.
119351
+ * Specifies that the shape should have slide background fill.
119246
119352
  * @remarks
119247
119353
  * [Api set: PowerPointApi 1.4]
119248
119354
  */
119249
- wavyDouble = "WavyDouble",
119355
+ slideBackground = "SlideBackground",
119250
119356
  }
119251
119357
  /**
119252
- * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
119358
+ * Represents the fill formatting of a shape object.
119253
119359
  *
119254
119360
  * @remarks
119255
119361
  * [Api set: PowerPointApi 1.4]
119256
119362
  */
119257
- enum ParagraphHorizontalAlignment {
119363
+ class ShapeFill extends OfficeExtension.ClientObject {
119364
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119365
+ context: RequestContext;
119258
119366
  /**
119259
- * Align text to the left margin.
119367
+ * 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").
119368
+ *
119260
119369
  * @remarks
119261
119370
  * [Api set: PowerPointApi 1.4]
119262
119371
  */
119263
- left = "Left",
119372
+ foregroundColor: string;
119264
119373
  /**
119265
- * Align text in the center.
119374
+ * 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.
119375
+ *
119266
119376
  * @remarks
119267
119377
  * [Api set: PowerPointApi 1.4]
119268
119378
  */
119269
- center = "Center",
119379
+ transparency: number;
119270
119380
  /**
119271
- * Align text to the right margin.
119381
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
119382
+ *
119272
119383
  * @remarks
119273
119384
  * [Api set: PowerPointApi 1.4]
119274
119385
  */
119275
- right = "Right",
119386
+ readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
119276
119387
  /**
119277
- * Align text so that it is justified across the whole line.
119388
+ * Clears the fill formatting of this shape.
119389
+ *
119278
119390
  * @remarks
119279
119391
  * [Api set: PowerPointApi 1.4]
119280
119392
  */
119281
- justify = "Justify",
119393
+ clear(): void;
119282
119394
  /**
119283
- * Specifies the alignment or adjustment of kashida length in Arabic text.
119395
+ * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
119396
+ *
119284
119397
  * @remarks
119285
119398
  * [Api set: PowerPointApi 1.4]
119399
+ *
119400
+ * @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").
119286
119401
  */
119287
- justifyLow = "JustifyLow",
119402
+ setSolidColor(color: string): void;
119288
119403
  /**
119289
- * Distributes the text words across an entire text line.
119290
- * @remarks
119291
- * [Api set: PowerPointApi 1.4]
119404
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119405
+ *
119406
+ * @param options Provides options for which properties of the object to load.
119292
119407
  */
119293
- distributed = "Distributed",
119408
+ load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
119294
119409
  /**
119295
- * Distributes Thai text specially, because each character is treated as a word.
119296
- * @remarks
119297
- * [Api set: PowerPointApi 1.4]
119298
- */
119299
- thaiDistributed = "ThaiDistributed",
119410
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119411
+ *
119412
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
119413
+ */
119414
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
119415
+ /**
119416
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119417
+ *
119418
+ * @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.
119419
+ */
119420
+ load(propertyNamesAndPaths?: {
119421
+ select?: string;
119422
+ expand?: string;
119423
+ }): PowerPoint.ShapeFill;
119424
+ /**
119425
+ * 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.)
119426
+ * 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.
119427
+ */
119428
+ toJSON(): PowerPoint.Interfaces.ShapeFillData;
119429
+ }
119430
+ /**
119431
+ * The type of underline applied to a font.
119432
+ *
119433
+ * @remarks
119434
+ * [Api set: PowerPointApi 1.4]
119435
+ */
119436
+ enum ShapeFontUnderlineStyle {
119437
+ /**
119438
+ * No underlining.
119439
+ * @remarks
119440
+ * [Api set: PowerPointApi 1.4]
119441
+ */
119442
+ none = "None",
119443
+ /**
119444
+ * Regular single line underlining.
119445
+ * @remarks
119446
+ * [Api set: PowerPointApi 1.4]
119447
+ */
119448
+ single = "Single",
119449
+ /**
119450
+ * Underlining of text with double lines.
119451
+ * @remarks
119452
+ * [Api set: PowerPointApi 1.4]
119453
+ */
119454
+ double = "Double",
119455
+ /**
119456
+ * Underlining of text with a thick line.
119457
+ * @remarks
119458
+ * [Api set: PowerPointApi 1.4]
119459
+ */
119460
+ heavy = "Heavy",
119461
+ /**
119462
+ * Underlining of text with a dotted line.
119463
+ * @remarks
119464
+ * [Api set: PowerPointApi 1.4]
119465
+ */
119466
+ dotted = "Dotted",
119467
+ /**
119468
+ * Underlining of text with a thick, dotted line.
119469
+ * @remarks
119470
+ * [Api set: PowerPointApi 1.4]
119471
+ */
119472
+ dottedHeavy = "DottedHeavy",
119473
+ /**
119474
+ * Underlining of text with a line containing dashes.
119475
+ * @remarks
119476
+ * [Api set: PowerPointApi 1.4]
119477
+ */
119478
+ dash = "Dash",
119479
+ /**
119480
+ * Underlining of text with a thick line containing dashes.
119481
+ * @remarks
119482
+ * [Api set: PowerPointApi 1.4]
119483
+ */
119484
+ dashHeavy = "DashHeavy",
119485
+ /**
119486
+ * Underlining of text with a line containing long dashes.
119487
+ * @remarks
119488
+ * [Api set: PowerPointApi 1.4]
119489
+ */
119490
+ dashLong = "DashLong",
119491
+ /**
119492
+ * Underlining of text with a thick line containing long dashes.
119493
+ * @remarks
119494
+ * [Api set: PowerPointApi 1.4]
119495
+ */
119496
+ dashLongHeavy = "DashLongHeavy",
119497
+ /**
119498
+ * Underlining of text with a line containing dots and dashes.
119499
+ * @remarks
119500
+ * [Api set: PowerPointApi 1.4]
119501
+ */
119502
+ dotDash = "DotDash",
119503
+ /**
119504
+ * Underlining of text with a thick line containing dots and dashes.
119505
+ * @remarks
119506
+ * [Api set: PowerPointApi 1.4]
119507
+ */
119508
+ dotDashHeavy = "DotDashHeavy",
119509
+ /**
119510
+ * Underlining of text with a line containing double dots and dashes.
119511
+ * @remarks
119512
+ * [Api set: PowerPointApi 1.4]
119513
+ */
119514
+ dotDotDash = "DotDotDash",
119515
+ /**
119516
+ * Underlining of text with a thick line containing double dots and dashes.
119517
+ * @remarks
119518
+ * [Api set: PowerPointApi 1.4]
119519
+ */
119520
+ dotDotDashHeavy = "DotDotDashHeavy",
119521
+ /**
119522
+ * Underlining of text with a wavy line.
119523
+ * @remarks
119524
+ * [Api set: PowerPointApi 1.4]
119525
+ */
119526
+ wavy = "Wavy",
119527
+ /**
119528
+ * Underlining of text with a thick, wavy line.
119529
+ * @remarks
119530
+ * [Api set: PowerPointApi 1.4]
119531
+ */
119532
+ wavyHeavy = "WavyHeavy",
119533
+ /**
119534
+ * Underlining of text with double wavy lines.
119535
+ * @remarks
119536
+ * [Api set: PowerPointApi 1.4]
119537
+ */
119538
+ wavyDouble = "WavyDouble",
119539
+ }
119540
+ /**
119541
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
119542
+ *
119543
+ * @remarks
119544
+ * [Api set: PowerPointApi 1.4]
119545
+ */
119546
+ class ShapeFont extends OfficeExtension.ClientObject {
119547
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119548
+ context: RequestContext;
119549
+ /**
119550
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
119551
+ *
119552
+ * @remarks
119553
+ * [Api set: PowerPointApi 1.4]
119554
+ */
119555
+ bold: boolean;
119556
+ /**
119557
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
119558
+ *
119559
+ * @remarks
119560
+ * [Api set: PowerPointApi 1.4]
119561
+ */
119562
+ color: string;
119563
+ /**
119564
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
119565
+ *
119566
+ * @remarks
119567
+ * [Api set: PowerPointApi 1.4]
119568
+ */
119569
+ italic: boolean;
119570
+ /**
119571
+ * 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.
119572
+ *
119573
+ * @remarks
119574
+ * [Api set: PowerPointApi 1.4]
119575
+ */
119576
+ name: string;
119577
+ /**
119578
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
119579
+ *
119580
+ * @remarks
119581
+ * [Api set: PowerPointApi 1.4]
119582
+ */
119583
+ size: number;
119584
+ /**
119585
+ * 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.
119586
+ *
119587
+ * @remarks
119588
+ * [Api set: PowerPointApi 1.4]
119589
+ */
119590
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
119591
+ /**
119592
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119593
+ *
119594
+ * @param options Provides options for which properties of the object to load.
119595
+ */
119596
+ load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
119597
+ /**
119598
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119599
+ *
119600
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
119601
+ */
119602
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
119603
+ /**
119604
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119605
+ *
119606
+ * @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.
119607
+ */
119608
+ load(propertyNamesAndPaths?: {
119609
+ select?: string;
119610
+ expand?: string;
119611
+ }): PowerPoint.ShapeFont;
119612
+ /**
119613
+ * 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.)
119614
+ * 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.
119615
+ */
119616
+ toJSON(): PowerPoint.Interfaces.ShapeFontData;
119300
119617
  }
119301
119618
  /**
119302
119619
  * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
@@ -119924,123 +120241,6 @@ declare namespace PowerPoint {
119924
120241
  */
119925
120242
  toJSON(): PowerPoint.Interfaces.SlideData;
119926
120243
  }
119927
- /**
119928
- * Specifies a shape's fill type.
119929
- *
119930
- * @remarks
119931
- * [Api set: PowerPointApi 1.4]
119932
- */
119933
- enum ShapeFillType {
119934
- /**
119935
- * Specifies that the shape should have no fill.
119936
- * @remarks
119937
- * [Api set: PowerPointApi 1.4]
119938
- */
119939
- noFill = "NoFill",
119940
- /**
119941
- * Specifies that the shape should have regular solid fill.
119942
- * @remarks
119943
- * [Api set: PowerPointApi 1.4]
119944
- */
119945
- solid = "Solid",
119946
- /**
119947
- * Specifies that the shape should have gradient fill.
119948
- * @remarks
119949
- * [Api set: PowerPointApi 1.4]
119950
- */
119951
- gradient = "Gradient",
119952
- /**
119953
- * Specifies that the shape should have pattern fill.
119954
- * @remarks
119955
- * [Api set: PowerPointApi 1.4]
119956
- */
119957
- pattern = "Pattern",
119958
- /**
119959
- * Specifies that the shape should have picture or texture fill.
119960
- * @remarks
119961
- * [Api set: PowerPointApi 1.4]
119962
- */
119963
- pictureAndTexture = "PictureAndTexture",
119964
- /**
119965
- * Specifies that the shape should have slide background fill.
119966
- * @remarks
119967
- * [Api set: PowerPointApi 1.4]
119968
- */
119969
- slideBackground = "SlideBackground",
119970
- }
119971
- /**
119972
- * Represents the fill formatting of a shape object.
119973
- *
119974
- * @remarks
119975
- * [Api set: PowerPointApi 1.4]
119976
- */
119977
- class ShapeFill extends OfficeExtension.ClientObject {
119978
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119979
- context: RequestContext;
119980
- /**
119981
- * 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").
119982
- *
119983
- * @remarks
119984
- * [Api set: PowerPointApi 1.4]
119985
- */
119986
- foregroundColor: string;
119987
- /**
119988
- * 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.
119989
- *
119990
- * @remarks
119991
- * [Api set: PowerPointApi 1.4]
119992
- */
119993
- transparency: number;
119994
- /**
119995
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
119996
- *
119997
- * @remarks
119998
- * [Api set: PowerPointApi 1.4]
119999
- */
120000
- readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
120001
- /**
120002
- * Clears the fill formatting of this shape.
120003
- *
120004
- * @remarks
120005
- * [Api set: PowerPointApi 1.4]
120006
- */
120007
- clear(): void;
120008
- /**
120009
- * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
120010
- *
120011
- * @remarks
120012
- * [Api set: PowerPointApi 1.4]
120013
- *
120014
- * @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").
120015
- */
120016
- setSolidColor(color: string): void;
120017
- /**
120018
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120019
- *
120020
- * @param options Provides options for which properties of the object to load.
120021
- */
120022
- load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
120023
- /**
120024
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120025
- *
120026
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
120027
- */
120028
- load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
120029
- /**
120030
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120031
- *
120032
- * @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.
120033
- */
120034
- load(propertyNamesAndPaths?: {
120035
- select?: string;
120036
- expand?: string;
120037
- }): PowerPoint.ShapeFill;
120038
- /**
120039
- * 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.)
120040
- * 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.
120041
- */
120042
- toJSON(): PowerPoint.Interfaces.ShapeFillData;
120043
- }
120044
120244
  /**
120045
120245
  * Represents a collection of shapes.
120046
120246
  *
@@ -120230,128 +120430,6 @@ declare namespace PowerPoint {
120230
120430
  */
120231
120431
  toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
120232
120432
  }
120233
- /**
120234
- * Specifies the type of a shape.
120235
- *
120236
- * @remarks
120237
- * [Api set: PowerPointApi 1.4]
120238
- */
120239
- enum ShapeType {
120240
- /**
120241
- * The given shape's type is unsupported.
120242
- * @remarks
120243
- * [Api set: PowerPointApi 1.4]
120244
- */
120245
- unsupported = "Unsupported",
120246
- /**
120247
- * The shape is an image.
120248
- * @remarks
120249
- * [Api set: PowerPointApi 1.4]
120250
- */
120251
- image = "Image",
120252
- /**
120253
- * The shape is a geometric shape such as rectangle.
120254
- * @remarks
120255
- * [Api set: PowerPointApi 1.4]
120256
- */
120257
- geometricShape = "GeometricShape",
120258
- /**
120259
- * The shape is a group shape which contains sub-shapes.
120260
- * @remarks
120261
- * [Api set: PowerPointApi 1.4]
120262
- */
120263
- group = "Group",
120264
- /**
120265
- * The shape is a line.
120266
- * @remarks
120267
- * [Api set: PowerPointApi 1.4]
120268
- */
120269
- line = "Line",
120270
- /**
120271
- * The shape is a table.
120272
- * @remarks
120273
- * [Api set: PowerPointApi 1.4]
120274
- */
120275
- table = "Table",
120276
- /**
120277
- * The shape is a callout.
120278
- * @remarks
120279
- * [Api set: PowerPointApi 1.4]
120280
- */
120281
- callout = "Callout",
120282
- /**
120283
- * The shape is a chart.
120284
- * @remarks
120285
- * [Api set: PowerPointApi 1.4]
120286
- */
120287
- chart = "Chart",
120288
- /**
120289
- * The shape is a content Office Add-in.
120290
- * @remarks
120291
- * [Api set: PowerPointApi 1.4]
120292
- */
120293
- contentApp = "ContentApp",
120294
- /**
120295
- * The shape is a diagram.
120296
- * @remarks
120297
- * [Api set: PowerPointApi 1.4]
120298
- */
120299
- diagram = "Diagram",
120300
- /**
120301
- * The shape is a freeform object.
120302
- * @remarks
120303
- * [Api set: PowerPointApi 1.4]
120304
- */
120305
- freeform = "Freeform",
120306
- /**
120307
- * The shape is a graphic.
120308
- * @remarks
120309
- * [Api set: PowerPointApi 1.4]
120310
- */
120311
- graphic = "Graphic",
120312
- /**
120313
- * The shape is an ink object.
120314
- * @remarks
120315
- * [Api set: PowerPointApi 1.4]
120316
- */
120317
- ink = "Ink",
120318
- /**
120319
- * The shape is a media object.
120320
- * @remarks
120321
- * [Api set: PowerPointApi 1.4]
120322
- */
120323
- media = "Media",
120324
- /**
120325
- * The shape is a 3D model.
120326
- * @remarks
120327
- * [Api set: PowerPointApi 1.4]
120328
- */
120329
- model3D = "Model3D",
120330
- /**
120331
- * The shape is an OLE (Object Linking and Embedding) object.
120332
- * @remarks
120333
- * [Api set: PowerPointApi 1.4]
120334
- */
120335
- ole = "Ole",
120336
- /**
120337
- * The shape is a placeholder.
120338
- * @remarks
120339
- * [Api set: PowerPointApi 1.4]
120340
- */
120341
- placeholder = "Placeholder",
120342
- /**
120343
- * The shape is a SmartArt graphic.
120344
- * @remarks
120345
- * [Api set: PowerPointApi 1.4]
120346
- */
120347
- smartArt = "SmartArt",
120348
- /**
120349
- * The shape is a text box.
120350
- * @remarks
120351
- * [Api set: PowerPointApi 1.4]
120352
- */
120353
- textBox = "TextBox",
120354
- }
120355
120433
  /**
120356
120434
  * Determines the type of automatic sizing allowed.
120357
120435
  *
@@ -120399,69 +120477,19 @@ declare namespace PowerPoint {
120399
120477
  * @remarks
120400
120478
  * [Api set: PowerPointApi 1.4]
120401
120479
  */
120402
- visible: boolean;
120403
- /**
120404
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120405
- *
120406
- * @param options Provides options for which properties of the object to load.
120407
- */
120408
- load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
120409
- /**
120410
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120411
- *
120412
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
120413
- */
120414
- load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
120415
- /**
120416
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120417
- *
120418
- * @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.
120419
- */
120420
- load(propertyNamesAndPaths?: {
120421
- select?: string;
120422
- expand?: string;
120423
- }): PowerPoint.BulletFormat;
120424
- /**
120425
- * 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.)
120426
- * Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
120427
- */
120428
- toJSON(): PowerPoint.Interfaces.BulletFormatData;
120429
- }
120430
- /**
120431
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
120432
- *
120433
- * @remarks
120434
- * [Api set: PowerPointApi 1.4]
120435
- */
120436
- class ParagraphFormat extends OfficeExtension.ClientObject {
120437
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
120438
- context: RequestContext;
120439
- /**
120440
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
120441
- *
120442
- * @remarks
120443
- * [Api set: PowerPointApi 1.4]
120444
- */
120445
- readonly bulletFormat: PowerPoint.BulletFormat;
120446
- /**
120447
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
120448
- *
120449
- * @remarks
120450
- * [Api set: PowerPointApi 1.4]
120451
- */
120452
- horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
120480
+ visible: boolean;
120453
120481
  /**
120454
120482
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120455
120483
  *
120456
120484
  * @param options Provides options for which properties of the object to load.
120457
120485
  */
120458
- load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
120486
+ load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
120459
120487
  /**
120460
120488
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120461
120489
  *
120462
120490
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
120463
120491
  */
120464
- load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
120492
+ load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
120465
120493
  /**
120466
120494
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120467
120495
  *
@@ -120470,76 +120498,48 @@ declare namespace PowerPoint {
120470
120498
  load(propertyNamesAndPaths?: {
120471
120499
  select?: string;
120472
120500
  expand?: string;
120473
- }): PowerPoint.ParagraphFormat;
120501
+ }): PowerPoint.BulletFormat;
120474
120502
  /**
120475
120503
  * 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.)
120476
- * Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
120504
+ * Whereas the original `PowerPoint.BulletFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
120477
120505
  */
120478
- toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
120506
+ toJSON(): PowerPoint.Interfaces.BulletFormatData;
120479
120507
  }
120480
120508
  /**
120481
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
120509
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
120482
120510
  *
120483
120511
  * @remarks
120484
120512
  * [Api set: PowerPointApi 1.4]
120485
120513
  */
120486
- class ShapeFont extends OfficeExtension.ClientObject {
120514
+ class ParagraphFormat extends OfficeExtension.ClientObject {
120487
120515
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
120488
120516
  context: RequestContext;
120489
120517
  /**
120490
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
120491
- *
120492
- * @remarks
120493
- * [Api set: PowerPointApi 1.4]
120494
- */
120495
- bold: boolean;
120496
- /**
120497
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
120498
- *
120499
- * @remarks
120500
- * [Api set: PowerPointApi 1.4]
120501
- */
120502
- color: string;
120503
- /**
120504
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
120505
- *
120506
- * @remarks
120507
- * [Api set: PowerPointApi 1.4]
120508
- */
120509
- italic: boolean;
120510
- /**
120511
- * 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.
120512
- *
120513
- * @remarks
120514
- * [Api set: PowerPointApi 1.4]
120515
- */
120516
- name: string;
120517
- /**
120518
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
120518
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
120519
120519
  *
120520
120520
  * @remarks
120521
120521
  * [Api set: PowerPointApi 1.4]
120522
120522
  */
120523
- size: number;
120523
+ readonly bulletFormat: PowerPoint.BulletFormat;
120524
120524
  /**
120525
- * 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.
120525
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
120526
120526
  *
120527
120527
  * @remarks
120528
120528
  * [Api set: PowerPointApi 1.4]
120529
120529
  */
120530
- underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
120530
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
120531
120531
  /**
120532
120532
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120533
120533
  *
120534
120534
  * @param options Provides options for which properties of the object to load.
120535
120535
  */
120536
- load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
120536
+ load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
120537
120537
  /**
120538
120538
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120539
120539
  *
120540
120540
  * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
120541
120541
  */
120542
- load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
120542
+ load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
120543
120543
  /**
120544
120544
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120545
120545
  *
@@ -120548,12 +120548,12 @@ declare namespace PowerPoint {
120548
120548
  load(propertyNamesAndPaths?: {
120549
120549
  select?: string;
120550
120550
  expand?: string;
120551
- }): PowerPoint.ShapeFont;
120551
+ }): PowerPoint.ParagraphFormat;
120552
120552
  /**
120553
120553
  * 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.)
120554
- * 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.
120554
+ * Whereas the original `PowerPoint.ParagraphFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
120555
120555
  */
120556
- toJSON(): PowerPoint.Interfaces.ShapeFontData;
120556
+ toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
120557
120557
  }
120558
120558
  /**
120559
120559
  * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
@@ -121568,6 +121568,68 @@ declare namespace PowerPoint {
121568
121568
  interface HyperlinkCollectionUpdateData {
121569
121569
  items?: PowerPoint.Interfaces.HyperlinkData[];
121570
121570
  }
121571
+ /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */
121572
+ interface ShapeFillUpdateData {
121573
+ /**
121574
+ * 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").
121575
+ *
121576
+ * @remarks
121577
+ * [Api set: PowerPointApi 1.4]
121578
+ */
121579
+ foregroundColor?: string;
121580
+ /**
121581
+ * 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.
121582
+ *
121583
+ * @remarks
121584
+ * [Api set: PowerPointApi 1.4]
121585
+ */
121586
+ transparency?: number;
121587
+ }
121588
+ /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
121589
+ interface ShapeFontUpdateData {
121590
+ /**
121591
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
121592
+ *
121593
+ * @remarks
121594
+ * [Api set: PowerPointApi 1.4]
121595
+ */
121596
+ bold?: boolean;
121597
+ /**
121598
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
121599
+ *
121600
+ * @remarks
121601
+ * [Api set: PowerPointApi 1.4]
121602
+ */
121603
+ color?: string;
121604
+ /**
121605
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
121606
+ *
121607
+ * @remarks
121608
+ * [Api set: PowerPointApi 1.4]
121609
+ */
121610
+ italic?: boolean;
121611
+ /**
121612
+ * 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.
121613
+ *
121614
+ * @remarks
121615
+ * [Api set: PowerPointApi 1.4]
121616
+ */
121617
+ name?: string;
121618
+ /**
121619
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
121620
+ *
121621
+ * @remarks
121622
+ * [Api set: PowerPointApi 1.4]
121623
+ */
121624
+ size?: number;
121625
+ /**
121626
+ * 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.
121627
+ *
121628
+ * @remarks
121629
+ * [Api set: PowerPointApi 1.4]
121630
+ */
121631
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
121632
+ }
121571
121633
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
121572
121634
  interface ShapeCollectionUpdateData {
121573
121635
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -121590,23 +121652,6 @@ declare namespace PowerPoint {
121590
121652
  interface TagCollectionUpdateData {
121591
121653
  items?: PowerPoint.Interfaces.TagData[];
121592
121654
  }
121593
- /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */
121594
- interface ShapeFillUpdateData {
121595
- /**
121596
- * 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").
121597
- *
121598
- * @remarks
121599
- * [Api set: PowerPointApi 1.4]
121600
- */
121601
- foregroundColor?: string;
121602
- /**
121603
- * 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.
121604
- *
121605
- * @remarks
121606
- * [Api set: PowerPointApi 1.4]
121607
- */
121608
- transparency?: number;
121609
- }
121610
121655
  /** An interface for updating data on the `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */
121611
121656
  interface ShapeScopedCollectionUpdateData {
121612
121657
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -121676,51 +121721,6 @@ declare namespace PowerPoint {
121676
121721
  */
121677
121722
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
121678
121723
  }
121679
- /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
121680
- interface ShapeFontUpdateData {
121681
- /**
121682
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
121683
- *
121684
- * @remarks
121685
- * [Api set: PowerPointApi 1.4]
121686
- */
121687
- bold?: boolean;
121688
- /**
121689
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
121690
- *
121691
- * @remarks
121692
- * [Api set: PowerPointApi 1.4]
121693
- */
121694
- color?: string;
121695
- /**
121696
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
121697
- *
121698
- * @remarks
121699
- * [Api set: PowerPointApi 1.4]
121700
- */
121701
- italic?: boolean;
121702
- /**
121703
- * 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.
121704
- *
121705
- * @remarks
121706
- * [Api set: PowerPointApi 1.4]
121707
- */
121708
- name?: string;
121709
- /**
121710
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
121711
- *
121712
- * @remarks
121713
- * [Api set: PowerPointApi 1.4]
121714
- */
121715
- size?: number;
121716
- /**
121717
- * 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.
121718
- *
121719
- * @remarks
121720
- * [Api set: PowerPointApi 1.4]
121721
- */
121722
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
121723
- }
121724
121724
  /** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */
121725
121725
  interface TextRangeUpdateData {
121726
121726
  /**
@@ -121974,18 +121974,87 @@ declare namespace PowerPoint {
121974
121974
  * @remarks
121975
121975
  * [Api set: PowerPointApi 1.6]
121976
121976
  */
121977
- address?: string;
121977
+ address?: string;
121978
+ /**
121979
+ * Specifies the string displayed when hovering over the hyperlink.
121980
+ *
121981
+ * @remarks
121982
+ * [Api set: PowerPointApi 1.6]
121983
+ */
121984
+ screenTip?: string;
121985
+ }
121986
+ /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */
121987
+ interface HyperlinkCollectionData {
121988
+ items?: PowerPoint.Interfaces.HyperlinkData[];
121989
+ }
121990
+ /** An interface describing the data returned by calling `shapeFill.toJSON()`. */
121991
+ interface ShapeFillData {
121992
+ /**
121993
+ * 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").
121994
+ *
121995
+ * @remarks
121996
+ * [Api set: PowerPointApi 1.4]
121997
+ */
121998
+ foregroundColor?: string;
121999
+ /**
122000
+ * 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.
122001
+ *
122002
+ * @remarks
122003
+ * [Api set: PowerPointApi 1.4]
122004
+ */
122005
+ transparency?: number;
122006
+ /**
122007
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
122008
+ *
122009
+ * @remarks
122010
+ * [Api set: PowerPointApi 1.4]
122011
+ */
122012
+ type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
122013
+ }
122014
+ /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
122015
+ interface ShapeFontData {
122016
+ /**
122017
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122018
+ *
122019
+ * @remarks
122020
+ * [Api set: PowerPointApi 1.4]
122021
+ */
122022
+ bold?: boolean;
122023
+ /**
122024
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122025
+ *
122026
+ * @remarks
122027
+ * [Api set: PowerPointApi 1.4]
122028
+ */
122029
+ color?: string;
122030
+ /**
122031
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122032
+ *
122033
+ * @remarks
122034
+ * [Api set: PowerPointApi 1.4]
122035
+ */
122036
+ italic?: boolean;
122037
+ /**
122038
+ * 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.
122039
+ *
122040
+ * @remarks
122041
+ * [Api set: PowerPointApi 1.4]
122042
+ */
122043
+ name?: string;
122044
+ /**
122045
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122046
+ *
122047
+ * @remarks
122048
+ * [Api set: PowerPointApi 1.4]
122049
+ */
122050
+ size?: number;
121978
122051
  /**
121979
- * Specifies the string displayed when hovering over the hyperlink.
122052
+ * 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.
121980
122053
  *
121981
122054
  * @remarks
121982
- * [Api set: PowerPointApi 1.6]
122055
+ * [Api set: PowerPointApi 1.4]
121983
122056
  */
121984
- screenTip?: string;
121985
- }
121986
- /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */
121987
- interface HyperlinkCollectionData {
121988
- items?: PowerPoint.Interfaces.HyperlinkData[];
122057
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
121989
122058
  }
121990
122059
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
121991
122060
  interface ShapeCollectionData {
@@ -122060,30 +122129,6 @@ declare namespace PowerPoint {
122060
122129
  */
122061
122130
  id?: string;
122062
122131
  }
122063
- /** An interface describing the data returned by calling `shapeFill.toJSON()`. */
122064
- interface ShapeFillData {
122065
- /**
122066
- * 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").
122067
- *
122068
- * @remarks
122069
- * [Api set: PowerPointApi 1.4]
122070
- */
122071
- foregroundColor?: string;
122072
- /**
122073
- * 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.
122074
- *
122075
- * @remarks
122076
- * [Api set: PowerPointApi 1.4]
122077
- */
122078
- transparency?: number;
122079
- /**
122080
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
122081
- *
122082
- * @remarks
122083
- * [Api set: PowerPointApi 1.4]
122084
- */
122085
- type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
122086
- }
122087
122132
  /** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
122088
122133
  interface ShapeScopedCollectionData {
122089
122134
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -122153,51 +122198,6 @@ declare namespace PowerPoint {
122153
122198
  */
122154
122199
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
122155
122200
  }
122156
- /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
122157
- interface ShapeFontData {
122158
- /**
122159
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122160
- *
122161
- * @remarks
122162
- * [Api set: PowerPointApi 1.4]
122163
- */
122164
- bold?: boolean;
122165
- /**
122166
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122167
- *
122168
- * @remarks
122169
- * [Api set: PowerPointApi 1.4]
122170
- */
122171
- color?: string;
122172
- /**
122173
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122174
- *
122175
- * @remarks
122176
- * [Api set: PowerPointApi 1.4]
122177
- */
122178
- italic?: boolean;
122179
- /**
122180
- * 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.
122181
- *
122182
- * @remarks
122183
- * [Api set: PowerPointApi 1.4]
122184
- */
122185
- name?: string;
122186
- /**
122187
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122188
- *
122189
- * @remarks
122190
- * [Api set: PowerPointApi 1.4]
122191
- */
122192
- size?: number;
122193
- /**
122194
- * 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.
122195
- *
122196
- * @remarks
122197
- * [Api set: PowerPointApi 1.4]
122198
- */
122199
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
122200
- }
122201
122201
  /** An interface describing the data returned by calling `textRange.toJSON()`. */
122202
122202
  interface TextRangeData {
122203
122203
  /**
@@ -122613,6 +122613,93 @@ declare namespace PowerPoint {
122613
122613
  */
122614
122614
  screenTip?: boolean;
122615
122615
  }
122616
+ /**
122617
+ * Represents the fill formatting of a shape object.
122618
+ *
122619
+ * @remarks
122620
+ * [Api set: PowerPointApi 1.4]
122621
+ */
122622
+ interface ShapeFillLoadOptions {
122623
+ /**
122624
+ 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`).
122625
+ */
122626
+ $all?: boolean;
122627
+ /**
122628
+ * 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").
122629
+ *
122630
+ * @remarks
122631
+ * [Api set: PowerPointApi 1.4]
122632
+ */
122633
+ foregroundColor?: boolean;
122634
+ /**
122635
+ * 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.
122636
+ *
122637
+ * @remarks
122638
+ * [Api set: PowerPointApi 1.4]
122639
+ */
122640
+ transparency?: boolean;
122641
+ /**
122642
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
122643
+ *
122644
+ * @remarks
122645
+ * [Api set: PowerPointApi 1.4]
122646
+ */
122647
+ type?: boolean;
122648
+ }
122649
+ /**
122650
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
122651
+ *
122652
+ * @remarks
122653
+ * [Api set: PowerPointApi 1.4]
122654
+ */
122655
+ interface ShapeFontLoadOptions {
122656
+ /**
122657
+ 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`).
122658
+ */
122659
+ $all?: boolean;
122660
+ /**
122661
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122662
+ *
122663
+ * @remarks
122664
+ * [Api set: PowerPointApi 1.4]
122665
+ */
122666
+ bold?: boolean;
122667
+ /**
122668
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122669
+ *
122670
+ * @remarks
122671
+ * [Api set: PowerPointApi 1.4]
122672
+ */
122673
+ color?: boolean;
122674
+ /**
122675
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122676
+ *
122677
+ * @remarks
122678
+ * [Api set: PowerPointApi 1.4]
122679
+ */
122680
+ italic?: boolean;
122681
+ /**
122682
+ * 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.
122683
+ *
122684
+ * @remarks
122685
+ * [Api set: PowerPointApi 1.4]
122686
+ */
122687
+ name?: boolean;
122688
+ /**
122689
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122690
+ *
122691
+ * @remarks
122692
+ * [Api set: PowerPointApi 1.4]
122693
+ */
122694
+ size?: boolean;
122695
+ /**
122696
+ * 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.
122697
+ *
122698
+ * @remarks
122699
+ * [Api set: PowerPointApi 1.4]
122700
+ */
122701
+ underline?: boolean;
122702
+ }
122616
122703
  /**
122617
122704
  * Represents the collection of shapes.
122618
122705
  *
@@ -122858,39 +122945,6 @@ declare namespace PowerPoint {
122858
122945
  */
122859
122946
  id?: boolean;
122860
122947
  }
122861
- /**
122862
- * Represents the fill formatting of a shape object.
122863
- *
122864
- * @remarks
122865
- * [Api set: PowerPointApi 1.4]
122866
- */
122867
- interface ShapeFillLoadOptions {
122868
- /**
122869
- 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`).
122870
- */
122871
- $all?: boolean;
122872
- /**
122873
- * 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").
122874
- *
122875
- * @remarks
122876
- * [Api set: PowerPointApi 1.4]
122877
- */
122878
- foregroundColor?: boolean;
122879
- /**
122880
- * 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.
122881
- *
122882
- * @remarks
122883
- * [Api set: PowerPointApi 1.4]
122884
- */
122885
- transparency?: boolean;
122886
- /**
122887
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
122888
- *
122889
- * @remarks
122890
- * [Api set: PowerPointApi 1.4]
122891
- */
122892
- type?: boolean;
122893
- }
122894
122948
  /**
122895
122949
  * Represents a collection of shapes.
122896
122950
  *
@@ -123072,60 +123126,6 @@ declare namespace PowerPoint {
123072
123126
  */
123073
123127
  horizontalAlignment?: boolean;
123074
123128
  }
123075
- /**
123076
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
123077
- *
123078
- * @remarks
123079
- * [Api set: PowerPointApi 1.4]
123080
- */
123081
- interface ShapeFontLoadOptions {
123082
- /**
123083
- 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`).
123084
- */
123085
- $all?: boolean;
123086
- /**
123087
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
123088
- *
123089
- * @remarks
123090
- * [Api set: PowerPointApi 1.4]
123091
- */
123092
- bold?: boolean;
123093
- /**
123094
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
123095
- *
123096
- * @remarks
123097
- * [Api set: PowerPointApi 1.4]
123098
- */
123099
- color?: boolean;
123100
- /**
123101
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
123102
- *
123103
- * @remarks
123104
- * [Api set: PowerPointApi 1.4]
123105
- */
123106
- italic?: boolean;
123107
- /**
123108
- * 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.
123109
- *
123110
- * @remarks
123111
- * [Api set: PowerPointApi 1.4]
123112
- */
123113
- name?: boolean;
123114
- /**
123115
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
123116
- *
123117
- * @remarks
123118
- * [Api set: PowerPointApi 1.4]
123119
- */
123120
- size?: boolean;
123121
- /**
123122
- * 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.
123123
- *
123124
- * @remarks
123125
- * [Api set: PowerPointApi 1.4]
123126
- */
123127
- underline?: boolean;
123128
- }
123129
123129
  /**
123130
123130
  * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
123131
123131
  *