@types/office-js 1.0.455 → 1.0.457

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 +557 -556
  3. office-js/package.json +2 -2
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Mon, 13 Jan 2025 19:02:16 GMT
11
+ * Last updated: Tue, 21 Jan 2025 20:02:16 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -19910,9 +19910,10 @@ declare namespace Office {
19910
19910
  * your add-in has persisted changes.
19911
19911
  * The persisted changes will not be available until the task pane (or item in the case of UI-less add-ins) is closed and reopened.
19912
19912
  *
19913
- * - When set and saved through Outlook on Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} or classic) or on Mac,
19914
- * these settings are reflected in Outlook on the web only after a browser refresh.
19915
- *
19913
+ * - In classic Outlook on Windows, if roaming settings were configured on another Outlook client, the desktop client doesn't need to be restarted.
19914
+ * However, the add-in needs to be reloaded to access these settings. In Outlook on the web, on Mac, and in the new Outlook on Windows,
19915
+ * you must refresh the browser or restart the client to access roaming settings set on another client.
19916
+ *
19916
19917
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
19917
19918
  *
19918
19919
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
@@ -117817,6 +117818,128 @@ declare namespace PowerPoint {
117817
117818
  */
117818
117819
  toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
117819
117820
  }
117821
+ /**
117822
+ * Specifies the type of a shape.
117823
+ *
117824
+ * @remarks
117825
+ * [Api set: PowerPointApi 1.4]
117826
+ */
117827
+ enum ShapeType {
117828
+ /**
117829
+ * The given shape's type is unsupported.
117830
+ * @remarks
117831
+ * [Api set: PowerPointApi 1.4]
117832
+ */
117833
+ unsupported = "Unsupported",
117834
+ /**
117835
+ * The shape is an image.
117836
+ * @remarks
117837
+ * [Api set: PowerPointApi 1.4]
117838
+ */
117839
+ image = "Image",
117840
+ /**
117841
+ * The shape is a geometric shape such as rectangle.
117842
+ * @remarks
117843
+ * [Api set: PowerPointApi 1.4]
117844
+ */
117845
+ geometricShape = "GeometricShape",
117846
+ /**
117847
+ * The shape is a group shape which contains sub-shapes.
117848
+ * @remarks
117849
+ * [Api set: PowerPointApi 1.4]
117850
+ */
117851
+ group = "Group",
117852
+ /**
117853
+ * The shape is a line.
117854
+ * @remarks
117855
+ * [Api set: PowerPointApi 1.4]
117856
+ */
117857
+ line = "Line",
117858
+ /**
117859
+ * The shape is a table.
117860
+ * @remarks
117861
+ * [Api set: PowerPointApi 1.4]
117862
+ */
117863
+ table = "Table",
117864
+ /**
117865
+ * The shape is a callout.
117866
+ * @remarks
117867
+ * [Api set: PowerPointApi 1.4]
117868
+ */
117869
+ callout = "Callout",
117870
+ /**
117871
+ * The shape is a chart.
117872
+ * @remarks
117873
+ * [Api set: PowerPointApi 1.4]
117874
+ */
117875
+ chart = "Chart",
117876
+ /**
117877
+ * The shape is a content Office Add-in.
117878
+ * @remarks
117879
+ * [Api set: PowerPointApi 1.4]
117880
+ */
117881
+ contentApp = "ContentApp",
117882
+ /**
117883
+ * The shape is a diagram.
117884
+ * @remarks
117885
+ * [Api set: PowerPointApi 1.4]
117886
+ */
117887
+ diagram = "Diagram",
117888
+ /**
117889
+ * The shape is a freeform object.
117890
+ * @remarks
117891
+ * [Api set: PowerPointApi 1.4]
117892
+ */
117893
+ freeform = "Freeform",
117894
+ /**
117895
+ * The shape is a graphic.
117896
+ * @remarks
117897
+ * [Api set: PowerPointApi 1.4]
117898
+ */
117899
+ graphic = "Graphic",
117900
+ /**
117901
+ * The shape is an ink object.
117902
+ * @remarks
117903
+ * [Api set: PowerPointApi 1.4]
117904
+ */
117905
+ ink = "Ink",
117906
+ /**
117907
+ * The shape is a media object.
117908
+ * @remarks
117909
+ * [Api set: PowerPointApi 1.4]
117910
+ */
117911
+ media = "Media",
117912
+ /**
117913
+ * The shape is a 3D model.
117914
+ * @remarks
117915
+ * [Api set: PowerPointApi 1.4]
117916
+ */
117917
+ model3D = "Model3D",
117918
+ /**
117919
+ * The shape is an OLE (Object Linking and Embedding) object.
117920
+ * @remarks
117921
+ * [Api set: PowerPointApi 1.4]
117922
+ */
117923
+ ole = "Ole",
117924
+ /**
117925
+ * The shape is a placeholder.
117926
+ * @remarks
117927
+ * [Api set: PowerPointApi 1.4]
117928
+ */
117929
+ placeholder = "Placeholder",
117930
+ /**
117931
+ * The shape is a SmartArt graphic.
117932
+ * @remarks
117933
+ * [Api set: PowerPointApi 1.4]
117934
+ */
117935
+ smartArt = "SmartArt",
117936
+ /**
117937
+ * The shape is a text box.
117938
+ * @remarks
117939
+ * [Api set: PowerPointApi 1.4]
117940
+ */
117941
+ textBox = "TextBox",
117942
+ }
117820
117943
  /**
117821
117944
  * Represents a single hyperlink.
117822
117945
  *
@@ -119138,6 +119261,173 @@ declare namespace PowerPoint {
119138
119261
  */
119139
119262
  systemDashDot = "SystemDashDot",
119140
119263
  }
119264
+ /**
119265
+ * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
119266
+ *
119267
+ * @remarks
119268
+ * [Api set: PowerPointApi 1.4]
119269
+ */
119270
+ enum ParagraphHorizontalAlignment {
119271
+ /**
119272
+ * Align text to the left margin.
119273
+ * @remarks
119274
+ * [Api set: PowerPointApi 1.4]
119275
+ */
119276
+ left = "Left",
119277
+ /**
119278
+ * Align text in the center.
119279
+ * @remarks
119280
+ * [Api set: PowerPointApi 1.4]
119281
+ */
119282
+ center = "Center",
119283
+ /**
119284
+ * Align text to the right margin.
119285
+ * @remarks
119286
+ * [Api set: PowerPointApi 1.4]
119287
+ */
119288
+ right = "Right",
119289
+ /**
119290
+ * Align text so that it is justified across the whole line.
119291
+ * @remarks
119292
+ * [Api set: PowerPointApi 1.4]
119293
+ */
119294
+ justify = "Justify",
119295
+ /**
119296
+ * Specifies the alignment or adjustment of kashida length in Arabic text.
119297
+ * @remarks
119298
+ * [Api set: PowerPointApi 1.4]
119299
+ */
119300
+ justifyLow = "JustifyLow",
119301
+ /**
119302
+ * Distributes the text words across an entire text line.
119303
+ * @remarks
119304
+ * [Api set: PowerPointApi 1.4]
119305
+ */
119306
+ distributed = "Distributed",
119307
+ /**
119308
+ * Distributes Thai text specially, because each character is treated as a word.
119309
+ * @remarks
119310
+ * [Api set: PowerPointApi 1.4]
119311
+ */
119312
+ thaiDistributed = "ThaiDistributed",
119313
+ }
119314
+ /**
119315
+ * Specifies a shape's fill type.
119316
+ *
119317
+ * @remarks
119318
+ * [Api set: PowerPointApi 1.4]
119319
+ */
119320
+ enum ShapeFillType {
119321
+ /**
119322
+ * Specifies that the shape should have no fill.
119323
+ * @remarks
119324
+ * [Api set: PowerPointApi 1.4]
119325
+ */
119326
+ noFill = "NoFill",
119327
+ /**
119328
+ * Specifies that the shape should have regular solid fill.
119329
+ * @remarks
119330
+ * [Api set: PowerPointApi 1.4]
119331
+ */
119332
+ solid = "Solid",
119333
+ /**
119334
+ * Specifies that the shape should have gradient fill.
119335
+ * @remarks
119336
+ * [Api set: PowerPointApi 1.4]
119337
+ */
119338
+ gradient = "Gradient",
119339
+ /**
119340
+ * Specifies that the shape should have pattern fill.
119341
+ * @remarks
119342
+ * [Api set: PowerPointApi 1.4]
119343
+ */
119344
+ pattern = "Pattern",
119345
+ /**
119346
+ * Specifies that the shape should have picture or texture fill.
119347
+ * @remarks
119348
+ * [Api set: PowerPointApi 1.4]
119349
+ */
119350
+ pictureAndTexture = "PictureAndTexture",
119351
+ /**
119352
+ * Specifies that the shape should have slide background fill.
119353
+ * @remarks
119354
+ * [Api set: PowerPointApi 1.4]
119355
+ */
119356
+ slideBackground = "SlideBackground",
119357
+ }
119358
+ /**
119359
+ * Represents the fill formatting of a shape object.
119360
+ *
119361
+ * @remarks
119362
+ * [Api set: PowerPointApi 1.4]
119363
+ */
119364
+ class ShapeFill extends OfficeExtension.ClientObject {
119365
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119366
+ context: RequestContext;
119367
+ /**
119368
+ * 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").
119369
+ *
119370
+ * @remarks
119371
+ * [Api set: PowerPointApi 1.4]
119372
+ */
119373
+ foregroundColor: string;
119374
+ /**
119375
+ * 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.
119376
+ *
119377
+ * @remarks
119378
+ * [Api set: PowerPointApi 1.4]
119379
+ */
119380
+ transparency: number;
119381
+ /**
119382
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
119383
+ *
119384
+ * @remarks
119385
+ * [Api set: PowerPointApi 1.4]
119386
+ */
119387
+ readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
119388
+ /**
119389
+ * Clears the fill formatting of this shape.
119390
+ *
119391
+ * @remarks
119392
+ * [Api set: PowerPointApi 1.4]
119393
+ */
119394
+ clear(): void;
119395
+ /**
119396
+ * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
119397
+ *
119398
+ * @remarks
119399
+ * [Api set: PowerPointApi 1.4]
119400
+ *
119401
+ * @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").
119402
+ */
119403
+ setSolidColor(color: string): void;
119404
+ /**
119405
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119406
+ *
119407
+ * @param options Provides options for which properties of the object to load.
119408
+ */
119409
+ load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
119410
+ /**
119411
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119412
+ *
119413
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
119414
+ */
119415
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
119416
+ /**
119417
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119418
+ *
119419
+ * @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.
119420
+ */
119421
+ load(propertyNamesAndPaths?: {
119422
+ select?: string;
119423
+ expand?: string;
119424
+ }): PowerPoint.ShapeFill;
119425
+ /**
119426
+ * 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.)
119427
+ * 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.
119428
+ */
119429
+ toJSON(): PowerPoint.Interfaces.ShapeFillData;
119430
+ }
119141
119431
  /**
119142
119432
  * The type of underline applied to a font.
119143
119433
  *
@@ -119249,54 +119539,82 @@ declare namespace PowerPoint {
119249
119539
  wavyDouble = "WavyDouble",
119250
119540
  }
119251
119541
  /**
119252
- * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
119542
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
119253
119543
  *
119254
119544
  * @remarks
119255
119545
  * [Api set: PowerPointApi 1.4]
119256
119546
  */
119257
- enum ParagraphHorizontalAlignment {
119547
+ class ShapeFont extends OfficeExtension.ClientObject {
119548
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119549
+ context: RequestContext;
119258
119550
  /**
119259
- * Align text to the left margin.
119551
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
119552
+ *
119260
119553
  * @remarks
119261
119554
  * [Api set: PowerPointApi 1.4]
119262
119555
  */
119263
- left = "Left",
119556
+ bold: boolean;
119264
119557
  /**
119265
- * Align text in the center.
119558
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
119559
+ *
119266
119560
  * @remarks
119267
119561
  * [Api set: PowerPointApi 1.4]
119268
119562
  */
119269
- center = "Center",
119563
+ color: string;
119270
119564
  /**
119271
- * Align text to the right margin.
119565
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
119566
+ *
119272
119567
  * @remarks
119273
119568
  * [Api set: PowerPointApi 1.4]
119274
119569
  */
119275
- right = "Right",
119570
+ italic: boolean;
119276
119571
  /**
119277
- * Align text so that it is justified across the whole line.
119572
+ * 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.
119573
+ *
119278
119574
  * @remarks
119279
119575
  * [Api set: PowerPointApi 1.4]
119280
119576
  */
119281
- justify = "Justify",
119577
+ name: string;
119282
119578
  /**
119283
- * Specifies the alignment or adjustment of kashida length in Arabic text.
119579
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
119580
+ *
119284
119581
  * @remarks
119285
119582
  * [Api set: PowerPointApi 1.4]
119286
119583
  */
119287
- justifyLow = "JustifyLow",
119584
+ size: number;
119288
119585
  /**
119289
- * Distributes the text words across an entire text line.
119586
+ * 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.
119587
+ *
119290
119588
  * @remarks
119291
119589
  * [Api set: PowerPointApi 1.4]
119292
119590
  */
119293
- distributed = "Distributed",
119591
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
119294
119592
  /**
119295
- * Distributes Thai text specially, because each character is treated as a word.
119296
- * @remarks
119297
- * [Api set: PowerPointApi 1.4]
119593
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119594
+ *
119595
+ * @param options Provides options for which properties of the object to load.
119298
119596
  */
119299
- thaiDistributed = "ThaiDistributed",
119597
+ load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
119598
+ /**
119599
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119600
+ *
119601
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
119602
+ */
119603
+ load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
119604
+ /**
119605
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
119606
+ *
119607
+ * @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.
119608
+ */
119609
+ load(propertyNamesAndPaths?: {
119610
+ select?: string;
119611
+ expand?: string;
119612
+ }): PowerPoint.ShapeFont;
119613
+ /**
119614
+ * 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.)
119615
+ * 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.
119616
+ */
119617
+ toJSON(): PowerPoint.Interfaces.ShapeFontData;
119300
119618
  }
119301
119619
  /**
119302
119620
  * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
@@ -119924,123 +120242,6 @@ declare namespace PowerPoint {
119924
120242
  */
119925
120243
  toJSON(): PowerPoint.Interfaces.SlideData;
119926
120244
  }
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
120245
  /**
120045
120246
  * Represents a collection of shapes.
120046
120247
  *
@@ -120230,128 +120431,6 @@ declare namespace PowerPoint {
120230
120431
  */
120231
120432
  toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
120232
120433
  }
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
120434
  /**
120356
120435
  * Determines the type of automatic sizing allowed.
120357
120436
  *
@@ -120477,84 +120556,6 @@ declare namespace PowerPoint {
120477
120556
  */
120478
120557
  toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
120479
120558
  }
120480
- /**
120481
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
120482
- *
120483
- * @remarks
120484
- * [Api set: PowerPointApi 1.4]
120485
- */
120486
- class ShapeFont extends OfficeExtension.ClientObject {
120487
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
120488
- context: RequestContext;
120489
- /**
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.
120519
- *
120520
- * @remarks
120521
- * [Api set: PowerPointApi 1.4]
120522
- */
120523
- size: number;
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.
120526
- *
120527
- * @remarks
120528
- * [Api set: PowerPointApi 1.4]
120529
- */
120530
- underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
120531
- /**
120532
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120533
- *
120534
- * @param options Provides options for which properties of the object to load.
120535
- */
120536
- load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
120537
- /**
120538
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120539
- *
120540
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
120541
- */
120542
- load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
120543
- /**
120544
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120545
- *
120546
- * @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.
120547
- */
120548
- load(propertyNamesAndPaths?: {
120549
- select?: string;
120550
- expand?: string;
120551
- }): PowerPoint.ShapeFont;
120552
- /**
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.
120555
- */
120556
- toJSON(): PowerPoint.Interfaces.ShapeFontData;
120557
- }
120558
120559
  /**
120559
120560
  * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
120560
120561
  *
@@ -121568,6 +121569,68 @@ declare namespace PowerPoint {
121568
121569
  interface HyperlinkCollectionUpdateData {
121569
121570
  items?: PowerPoint.Interfaces.HyperlinkData[];
121570
121571
  }
121572
+ /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */
121573
+ interface ShapeFillUpdateData {
121574
+ /**
121575
+ * 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").
121576
+ *
121577
+ * @remarks
121578
+ * [Api set: PowerPointApi 1.4]
121579
+ */
121580
+ foregroundColor?: string;
121581
+ /**
121582
+ * 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.
121583
+ *
121584
+ * @remarks
121585
+ * [Api set: PowerPointApi 1.4]
121586
+ */
121587
+ transparency?: number;
121588
+ }
121589
+ /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
121590
+ interface ShapeFontUpdateData {
121591
+ /**
121592
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
121593
+ *
121594
+ * @remarks
121595
+ * [Api set: PowerPointApi 1.4]
121596
+ */
121597
+ bold?: boolean;
121598
+ /**
121599
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
121600
+ *
121601
+ * @remarks
121602
+ * [Api set: PowerPointApi 1.4]
121603
+ */
121604
+ color?: string;
121605
+ /**
121606
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
121607
+ *
121608
+ * @remarks
121609
+ * [Api set: PowerPointApi 1.4]
121610
+ */
121611
+ italic?: boolean;
121612
+ /**
121613
+ * 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.
121614
+ *
121615
+ * @remarks
121616
+ * [Api set: PowerPointApi 1.4]
121617
+ */
121618
+ name?: string;
121619
+ /**
121620
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
121621
+ *
121622
+ * @remarks
121623
+ * [Api set: PowerPointApi 1.4]
121624
+ */
121625
+ size?: number;
121626
+ /**
121627
+ * 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.
121628
+ *
121629
+ * @remarks
121630
+ * [Api set: PowerPointApi 1.4]
121631
+ */
121632
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
121633
+ }
121571
121634
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
121572
121635
  interface ShapeCollectionUpdateData {
121573
121636
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -121590,23 +121653,6 @@ declare namespace PowerPoint {
121590
121653
  interface TagCollectionUpdateData {
121591
121654
  items?: PowerPoint.Interfaces.TagData[];
121592
121655
  }
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
121656
  /** An interface for updating data on the `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */
121611
121657
  interface ShapeScopedCollectionUpdateData {
121612
121658
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -121676,51 +121722,6 @@ declare namespace PowerPoint {
121676
121722
  */
121677
121723
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
121678
121724
  }
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
121725
  /** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */
121725
121726
  interface TextRangeUpdateData {
121726
121727
  /**
@@ -121987,6 +121988,75 @@ declare namespace PowerPoint {
121987
121988
  interface HyperlinkCollectionData {
121988
121989
  items?: PowerPoint.Interfaces.HyperlinkData[];
121989
121990
  }
121991
+ /** An interface describing the data returned by calling `shapeFill.toJSON()`. */
121992
+ interface ShapeFillData {
121993
+ /**
121994
+ * 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").
121995
+ *
121996
+ * @remarks
121997
+ * [Api set: PowerPointApi 1.4]
121998
+ */
121999
+ foregroundColor?: string;
122000
+ /**
122001
+ * 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.
122002
+ *
122003
+ * @remarks
122004
+ * [Api set: PowerPointApi 1.4]
122005
+ */
122006
+ transparency?: number;
122007
+ /**
122008
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
122009
+ *
122010
+ * @remarks
122011
+ * [Api set: PowerPointApi 1.4]
122012
+ */
122013
+ type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
122014
+ }
122015
+ /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
122016
+ interface ShapeFontData {
122017
+ /**
122018
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122019
+ *
122020
+ * @remarks
122021
+ * [Api set: PowerPointApi 1.4]
122022
+ */
122023
+ bold?: boolean;
122024
+ /**
122025
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122026
+ *
122027
+ * @remarks
122028
+ * [Api set: PowerPointApi 1.4]
122029
+ */
122030
+ color?: string;
122031
+ /**
122032
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122033
+ *
122034
+ * @remarks
122035
+ * [Api set: PowerPointApi 1.4]
122036
+ */
122037
+ italic?: boolean;
122038
+ /**
122039
+ * 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.
122040
+ *
122041
+ * @remarks
122042
+ * [Api set: PowerPointApi 1.4]
122043
+ */
122044
+ name?: string;
122045
+ /**
122046
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122047
+ *
122048
+ * @remarks
122049
+ * [Api set: PowerPointApi 1.4]
122050
+ */
122051
+ size?: number;
122052
+ /**
122053
+ * 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.
122054
+ *
122055
+ * @remarks
122056
+ * [Api set: PowerPointApi 1.4]
122057
+ */
122058
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
122059
+ }
121990
122060
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
121991
122061
  interface ShapeCollectionData {
121992
122062
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -122060,30 +122130,6 @@ declare namespace PowerPoint {
122060
122130
  */
122061
122131
  id?: string;
122062
122132
  }
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
122133
  /** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
122088
122134
  interface ShapeScopedCollectionData {
122089
122135
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -122153,51 +122199,6 @@ declare namespace PowerPoint {
122153
122199
  */
122154
122200
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
122155
122201
  }
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
122202
  /** An interface describing the data returned by calling `textRange.toJSON()`. */
122202
122203
  interface TextRangeData {
122203
122204
  /**
@@ -122613,6 +122614,93 @@ declare namespace PowerPoint {
122613
122614
  */
122614
122615
  screenTip?: boolean;
122615
122616
  }
122617
+ /**
122618
+ * Represents the fill formatting of a shape object.
122619
+ *
122620
+ * @remarks
122621
+ * [Api set: PowerPointApi 1.4]
122622
+ */
122623
+ interface ShapeFillLoadOptions {
122624
+ /**
122625
+ 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`).
122626
+ */
122627
+ $all?: boolean;
122628
+ /**
122629
+ * 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").
122630
+ *
122631
+ * @remarks
122632
+ * [Api set: PowerPointApi 1.4]
122633
+ */
122634
+ foregroundColor?: boolean;
122635
+ /**
122636
+ * 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.
122637
+ *
122638
+ * @remarks
122639
+ * [Api set: PowerPointApi 1.4]
122640
+ */
122641
+ transparency?: boolean;
122642
+ /**
122643
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
122644
+ *
122645
+ * @remarks
122646
+ * [Api set: PowerPointApi 1.4]
122647
+ */
122648
+ type?: boolean;
122649
+ }
122650
+ /**
122651
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
122652
+ *
122653
+ * @remarks
122654
+ * [Api set: PowerPointApi 1.4]
122655
+ */
122656
+ interface ShapeFontLoadOptions {
122657
+ /**
122658
+ 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`).
122659
+ */
122660
+ $all?: boolean;
122661
+ /**
122662
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122663
+ *
122664
+ * @remarks
122665
+ * [Api set: PowerPointApi 1.4]
122666
+ */
122667
+ bold?: boolean;
122668
+ /**
122669
+ * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122670
+ *
122671
+ * @remarks
122672
+ * [Api set: PowerPointApi 1.4]
122673
+ */
122674
+ color?: boolean;
122675
+ /**
122676
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122677
+ *
122678
+ * @remarks
122679
+ * [Api set: PowerPointApi 1.4]
122680
+ */
122681
+ italic?: boolean;
122682
+ /**
122683
+ * 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.
122684
+ *
122685
+ * @remarks
122686
+ * [Api set: PowerPointApi 1.4]
122687
+ */
122688
+ name?: boolean;
122689
+ /**
122690
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122691
+ *
122692
+ * @remarks
122693
+ * [Api set: PowerPointApi 1.4]
122694
+ */
122695
+ size?: boolean;
122696
+ /**
122697
+ * 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.
122698
+ *
122699
+ * @remarks
122700
+ * [Api set: PowerPointApi 1.4]
122701
+ */
122702
+ underline?: boolean;
122703
+ }
122616
122704
  /**
122617
122705
  * Represents the collection of shapes.
122618
122706
  *
@@ -122858,39 +122946,6 @@ declare namespace PowerPoint {
122858
122946
  */
122859
122947
  id?: boolean;
122860
122948
  }
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
122949
  /**
122895
122950
  * Represents a collection of shapes.
122896
122951
  *
@@ -123072,60 +123127,6 @@ declare namespace PowerPoint {
123072
123127
  */
123073
123128
  horizontalAlignment?: boolean;
123074
123129
  }
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
123130
  /**
123130
123131
  * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
123131
123132
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.455",
3
+ "version": "1.0.457",
4
4
  "description": "TypeScript definitions for office-js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
6
6
  "license": "MIT",
@@ -46,6 +46,6 @@
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
48
  "peerDependencies": {},
49
- "typesPublisherContentHash": "15f369a0124087d4a9d5bd22a41c1a6e6f6b8b1555527dec80fbb457b74dc9dc",
49
+ "typesPublisherContentHash": "1f81cd9d53a0170782bbee6021fda6bbfd4ff3ef48583941a288fa6f5bf903ff",
50
50
  "typeScriptVersion": "5.0"
51
51
  }