@types/office-js 1.0.454 → 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 +562 -557
  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: Tue, 31 Dec 2024 00:04:03 GMT
11
+ * Last updated: Tue, 21 Jan 2025 19:02:30 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -21359,8 +21359,6 @@ declare namespace Office {
21359
21359
  /**
21360
21360
  * Gets the account type of the user associated with the mailbox.
21361
21361
  *
21362
- * **Note**: This member is currently only supported in Outlook on Mac starting in Version 16.9 (17121200).
21363
- *
21364
21362
  * @remarks
21365
21363
  * [Api set: Mailbox 1.6]
21366
21364
  *
@@ -21392,8 +21390,15 @@ declare namespace Office {
21392
21390
  * <td>The mailbox is associated with a personal Outlook.com account.</td>
21393
21391
  * </tr>
21394
21392
  * </table>
21395
- *
21396
- * **Note**: For hybrid Exchange environments, the returned account type value depends on where the mailbox is hosted.
21393
+ *
21394
+ * **Important**:
21395
+ *
21396
+ * - Volume-licensed perpetual Outlook 2016 doesn’t support the `accountType` property.
21397
+ * To work around this, use Exchange Web Services (EWS) to call the
21398
+ * {@link https://learn.microsoft.com/exchange/client-developer/web-service-reference/resolvenames-operation | ResolveNames}
21399
+ * operation on the Exchange on-premise server.
21400
+ *
21401
+ * - For hybrid Exchange environments, the returned account type value depends on where the mailbox is hosted.
21397
21402
  * If the mailbox is on an on-premises server, the account type value is **enterprise**. However, if it's hosted on
21398
21403
  * Exchange Online, the account type value is **office365**.
21399
21404
  */
@@ -117812,6 +117817,128 @@ declare namespace PowerPoint {
117812
117817
  */
117813
117818
  toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;
117814
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
+ }
117815
117942
  /**
117816
117943
  * Represents a single hyperlink.
117817
117944
  *
@@ -119133,6 +119260,173 @@ declare namespace PowerPoint {
119133
119260
  */
119134
119261
  systemDashDot = "SystemDashDot",
119135
119262
  }
119263
+ /**
119264
+ * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
119265
+ *
119266
+ * @remarks
119267
+ * [Api set: PowerPointApi 1.4]
119268
+ */
119269
+ enum ParagraphHorizontalAlignment {
119270
+ /**
119271
+ * Align text to the left margin.
119272
+ * @remarks
119273
+ * [Api set: PowerPointApi 1.4]
119274
+ */
119275
+ left = "Left",
119276
+ /**
119277
+ * Align text in the center.
119278
+ * @remarks
119279
+ * [Api set: PowerPointApi 1.4]
119280
+ */
119281
+ center = "Center",
119282
+ /**
119283
+ * Align text to the right margin.
119284
+ * @remarks
119285
+ * [Api set: PowerPointApi 1.4]
119286
+ */
119287
+ right = "Right",
119288
+ /**
119289
+ * Align text so that it is justified across the whole line.
119290
+ * @remarks
119291
+ * [Api set: PowerPointApi 1.4]
119292
+ */
119293
+ justify = "Justify",
119294
+ /**
119295
+ * Specifies the alignment or adjustment of kashida length in Arabic text.
119296
+ * @remarks
119297
+ * [Api set: PowerPointApi 1.4]
119298
+ */
119299
+ justifyLow = "JustifyLow",
119300
+ /**
119301
+ * Distributes the text words across an entire text line.
119302
+ * @remarks
119303
+ * [Api set: PowerPointApi 1.4]
119304
+ */
119305
+ distributed = "Distributed",
119306
+ /**
119307
+ * Distributes Thai text specially, because each character is treated as a word.
119308
+ * @remarks
119309
+ * [Api set: PowerPointApi 1.4]
119310
+ */
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 {
119320
+ /**
119321
+ * Specifies that the shape should have no fill.
119322
+ * @remarks
119323
+ * [Api set: PowerPointApi 1.4]
119324
+ */
119325
+ noFill = "NoFill",
119326
+ /**
119327
+ * Specifies that the shape should have regular solid fill.
119328
+ * @remarks
119329
+ * [Api set: PowerPointApi 1.4]
119330
+ */
119331
+ solid = "Solid",
119332
+ /**
119333
+ * Specifies that the shape should have gradient fill.
119334
+ * @remarks
119335
+ * [Api set: PowerPointApi 1.4]
119336
+ */
119337
+ gradient = "Gradient",
119338
+ /**
119339
+ * Specifies that the shape should have pattern fill.
119340
+ * @remarks
119341
+ * [Api set: PowerPointApi 1.4]
119342
+ */
119343
+ pattern = "Pattern",
119344
+ /**
119345
+ * Specifies that the shape should have picture or texture fill.
119346
+ * @remarks
119347
+ * [Api set: PowerPointApi 1.4]
119348
+ */
119349
+ pictureAndTexture = "PictureAndTexture",
119350
+ /**
119351
+ * Specifies that the shape should have slide background fill.
119352
+ * @remarks
119353
+ * [Api set: PowerPointApi 1.4]
119354
+ */
119355
+ slideBackground = "SlideBackground",
119356
+ }
119357
+ /**
119358
+ * Represents the fill formatting of a shape object.
119359
+ *
119360
+ * @remarks
119361
+ * [Api set: PowerPointApi 1.4]
119362
+ */
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;
119366
+ /**
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
+ *
119369
+ * @remarks
119370
+ * [Api set: PowerPointApi 1.4]
119371
+ */
119372
+ foregroundColor: string;
119373
+ /**
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
+ *
119376
+ * @remarks
119377
+ * [Api set: PowerPointApi 1.4]
119378
+ */
119379
+ transparency: number;
119380
+ /**
119381
+ * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
119382
+ *
119383
+ * @remarks
119384
+ * [Api set: PowerPointApi 1.4]
119385
+ */
119386
+ readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
119387
+ /**
119388
+ * Clears the fill formatting of this shape.
119389
+ *
119390
+ * @remarks
119391
+ * [Api set: PowerPointApi 1.4]
119392
+ */
119393
+ clear(): void;
119394
+ /**
119395
+ * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
119396
+ *
119397
+ * @remarks
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").
119401
+ */
119402
+ setSolidColor(color: string): void;
119403
+ /**
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.
119407
+ */
119408
+ load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
119409
+ /**
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
+ }
119136
119430
  /**
119137
119431
  * The type of underline applied to a font.
119138
119432
  *
@@ -119244,54 +119538,82 @@ declare namespace PowerPoint {
119244
119538
  wavyDouble = "WavyDouble",
119245
119539
  }
119246
119540
  /**
119247
- * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
119541
+ * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
119248
119542
  *
119249
119543
  * @remarks
119250
119544
  * [Api set: PowerPointApi 1.4]
119251
119545
  */
119252
- enum ParagraphHorizontalAlignment {
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;
119253
119549
  /**
119254
- * Align text to the left margin.
119550
+ * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
119551
+ *
119255
119552
  * @remarks
119256
119553
  * [Api set: PowerPointApi 1.4]
119257
119554
  */
119258
- left = "Left",
119555
+ bold: boolean;
119259
119556
  /**
119260
- * Align text in the center.
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
+ *
119261
119559
  * @remarks
119262
119560
  * [Api set: PowerPointApi 1.4]
119263
119561
  */
119264
- center = "Center",
119562
+ color: string;
119265
119563
  /**
119266
- * Align text to the right margin.
119564
+ * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
119565
+ *
119267
119566
  * @remarks
119268
119567
  * [Api set: PowerPointApi 1.4]
119269
119568
  */
119270
- right = "Right",
119569
+ italic: boolean;
119271
119570
  /**
119272
- * Align text so that it is justified across the whole line.
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
+ *
119273
119573
  * @remarks
119274
119574
  * [Api set: PowerPointApi 1.4]
119275
119575
  */
119276
- justify = "Justify",
119576
+ name: string;
119277
119577
  /**
119278
- * Specifies the alignment or adjustment of kashida length in Arabic text.
119578
+ * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
119579
+ *
119279
119580
  * @remarks
119280
119581
  * [Api set: PowerPointApi 1.4]
119281
119582
  */
119282
- justifyLow = "JustifyLow",
119583
+ size: number;
119283
119584
  /**
119284
- * Distributes the text words across an entire text line.
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
+ *
119285
119587
  * @remarks
119286
119588
  * [Api set: PowerPointApi 1.4]
119287
119589
  */
119288
- distributed = "Distributed",
119590
+ underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
119289
119591
  /**
119290
- * Distributes Thai text specially, because each character is treated as a word.
119291
- * @remarks
119292
- * [Api set: PowerPointApi 1.4]
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.
119293
119595
  */
119294
- thaiDistributed = "ThaiDistributed",
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;
119295
119617
  }
119296
119618
  /**
119297
119619
  * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
@@ -119919,123 +120241,6 @@ declare namespace PowerPoint {
119919
120241
  */
119920
120242
  toJSON(): PowerPoint.Interfaces.SlideData;
119921
120243
  }
119922
- /**
119923
- * Specifies a shape's fill type.
119924
- *
119925
- * @remarks
119926
- * [Api set: PowerPointApi 1.4]
119927
- */
119928
- enum ShapeFillType {
119929
- /**
119930
- * Specifies that the shape should have no fill.
119931
- * @remarks
119932
- * [Api set: PowerPointApi 1.4]
119933
- */
119934
- noFill = "NoFill",
119935
- /**
119936
- * Specifies that the shape should have regular solid fill.
119937
- * @remarks
119938
- * [Api set: PowerPointApi 1.4]
119939
- */
119940
- solid = "Solid",
119941
- /**
119942
- * Specifies that the shape should have gradient fill.
119943
- * @remarks
119944
- * [Api set: PowerPointApi 1.4]
119945
- */
119946
- gradient = "Gradient",
119947
- /**
119948
- * Specifies that the shape should have pattern fill.
119949
- * @remarks
119950
- * [Api set: PowerPointApi 1.4]
119951
- */
119952
- pattern = "Pattern",
119953
- /**
119954
- * Specifies that the shape should have picture or texture fill.
119955
- * @remarks
119956
- * [Api set: PowerPointApi 1.4]
119957
- */
119958
- pictureAndTexture = "PictureAndTexture",
119959
- /**
119960
- * Specifies that the shape should have slide background fill.
119961
- * @remarks
119962
- * [Api set: PowerPointApi 1.4]
119963
- */
119964
- slideBackground = "SlideBackground",
119965
- }
119966
- /**
119967
- * Represents the fill formatting of a shape object.
119968
- *
119969
- * @remarks
119970
- * [Api set: PowerPointApi 1.4]
119971
- */
119972
- class ShapeFill extends OfficeExtension.ClientObject {
119973
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
119974
- context: RequestContext;
119975
- /**
119976
- * 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").
119977
- *
119978
- * @remarks
119979
- * [Api set: PowerPointApi 1.4]
119980
- */
119981
- foregroundColor: string;
119982
- /**
119983
- * 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.
119984
- *
119985
- * @remarks
119986
- * [Api set: PowerPointApi 1.4]
119987
- */
119988
- transparency: number;
119989
- /**
119990
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
119991
- *
119992
- * @remarks
119993
- * [Api set: PowerPointApi 1.4]
119994
- */
119995
- readonly type: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
119996
- /**
119997
- * Clears the fill formatting of this shape.
119998
- *
119999
- * @remarks
120000
- * [Api set: PowerPointApi 1.4]
120001
- */
120002
- clear(): void;
120003
- /**
120004
- * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
120005
- *
120006
- * @remarks
120007
- * [Api set: PowerPointApi 1.4]
120008
- *
120009
- * @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").
120010
- */
120011
- setSolidColor(color: string): void;
120012
- /**
120013
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120014
- *
120015
- * @param options Provides options for which properties of the object to load.
120016
- */
120017
- load(options?: PowerPoint.Interfaces.ShapeFillLoadOptions): PowerPoint.ShapeFill;
120018
- /**
120019
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120020
- *
120021
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
120022
- */
120023
- load(propertyNames?: string | string[]): PowerPoint.ShapeFill;
120024
- /**
120025
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120026
- *
120027
- * @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.
120028
- */
120029
- load(propertyNamesAndPaths?: {
120030
- select?: string;
120031
- expand?: string;
120032
- }): PowerPoint.ShapeFill;
120033
- /**
120034
- * 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.)
120035
- * 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.
120036
- */
120037
- toJSON(): PowerPoint.Interfaces.ShapeFillData;
120038
- }
120039
120244
  /**
120040
120245
  * Represents a collection of shapes.
120041
120246
  *
@@ -120225,128 +120430,6 @@ declare namespace PowerPoint {
120225
120430
  */
120226
120431
  toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;
120227
120432
  }
120228
- /**
120229
- * Specifies the type of a shape.
120230
- *
120231
- * @remarks
120232
- * [Api set: PowerPointApi 1.4]
120233
- */
120234
- enum ShapeType {
120235
- /**
120236
- * The given shape's type is unsupported.
120237
- * @remarks
120238
- * [Api set: PowerPointApi 1.4]
120239
- */
120240
- unsupported = "Unsupported",
120241
- /**
120242
- * The shape is an image.
120243
- * @remarks
120244
- * [Api set: PowerPointApi 1.4]
120245
- */
120246
- image = "Image",
120247
- /**
120248
- * The shape is a geometric shape such as rectangle.
120249
- * @remarks
120250
- * [Api set: PowerPointApi 1.4]
120251
- */
120252
- geometricShape = "GeometricShape",
120253
- /**
120254
- * The shape is a group shape which contains sub-shapes.
120255
- * @remarks
120256
- * [Api set: PowerPointApi 1.4]
120257
- */
120258
- group = "Group",
120259
- /**
120260
- * The shape is a line.
120261
- * @remarks
120262
- * [Api set: PowerPointApi 1.4]
120263
- */
120264
- line = "Line",
120265
- /**
120266
- * The shape is a table.
120267
- * @remarks
120268
- * [Api set: PowerPointApi 1.4]
120269
- */
120270
- table = "Table",
120271
- /**
120272
- * The shape is a callout.
120273
- * @remarks
120274
- * [Api set: PowerPointApi 1.4]
120275
- */
120276
- callout = "Callout",
120277
- /**
120278
- * The shape is a chart.
120279
- * @remarks
120280
- * [Api set: PowerPointApi 1.4]
120281
- */
120282
- chart = "Chart",
120283
- /**
120284
- * The shape is a content Office Add-in.
120285
- * @remarks
120286
- * [Api set: PowerPointApi 1.4]
120287
- */
120288
- contentApp = "ContentApp",
120289
- /**
120290
- * The shape is a diagram.
120291
- * @remarks
120292
- * [Api set: PowerPointApi 1.4]
120293
- */
120294
- diagram = "Diagram",
120295
- /**
120296
- * The shape is a freeform object.
120297
- * @remarks
120298
- * [Api set: PowerPointApi 1.4]
120299
- */
120300
- freeform = "Freeform",
120301
- /**
120302
- * The shape is a graphic.
120303
- * @remarks
120304
- * [Api set: PowerPointApi 1.4]
120305
- */
120306
- graphic = "Graphic",
120307
- /**
120308
- * The shape is an ink object.
120309
- * @remarks
120310
- * [Api set: PowerPointApi 1.4]
120311
- */
120312
- ink = "Ink",
120313
- /**
120314
- * The shape is a media object.
120315
- * @remarks
120316
- * [Api set: PowerPointApi 1.4]
120317
- */
120318
- media = "Media",
120319
- /**
120320
- * The shape is a 3D model.
120321
- * @remarks
120322
- * [Api set: PowerPointApi 1.4]
120323
- */
120324
- model3D = "Model3D",
120325
- /**
120326
- * The shape is an OLE (Object Linking and Embedding) object.
120327
- * @remarks
120328
- * [Api set: PowerPointApi 1.4]
120329
- */
120330
- ole = "Ole",
120331
- /**
120332
- * The shape is a placeholder.
120333
- * @remarks
120334
- * [Api set: PowerPointApi 1.4]
120335
- */
120336
- placeholder = "Placeholder",
120337
- /**
120338
- * The shape is a SmartArt graphic.
120339
- * @remarks
120340
- * [Api set: PowerPointApi 1.4]
120341
- */
120342
- smartArt = "SmartArt",
120343
- /**
120344
- * The shape is a text box.
120345
- * @remarks
120346
- * [Api set: PowerPointApi 1.4]
120347
- */
120348
- textBox = "TextBox",
120349
- }
120350
120433
  /**
120351
120434
  * Determines the type of automatic sizing allowed.
120352
120435
  *
@@ -120472,84 +120555,6 @@ declare namespace PowerPoint {
120472
120555
  */
120473
120556
  toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
120474
120557
  }
120475
- /**
120476
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
120477
- *
120478
- * @remarks
120479
- * [Api set: PowerPointApi 1.4]
120480
- */
120481
- class ShapeFont extends OfficeExtension.ClientObject {
120482
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
120483
- context: RequestContext;
120484
- /**
120485
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
120486
- *
120487
- * @remarks
120488
- * [Api set: PowerPointApi 1.4]
120489
- */
120490
- bold: boolean;
120491
- /**
120492
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
120493
- *
120494
- * @remarks
120495
- * [Api set: PowerPointApi 1.4]
120496
- */
120497
- color: string;
120498
- /**
120499
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
120500
- *
120501
- * @remarks
120502
- * [Api set: PowerPointApi 1.4]
120503
- */
120504
- italic: boolean;
120505
- /**
120506
- * 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.
120507
- *
120508
- * @remarks
120509
- * [Api set: PowerPointApi 1.4]
120510
- */
120511
- name: string;
120512
- /**
120513
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
120514
- *
120515
- * @remarks
120516
- * [Api set: PowerPointApi 1.4]
120517
- */
120518
- size: number;
120519
- /**
120520
- * 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.
120521
- *
120522
- * @remarks
120523
- * [Api set: PowerPointApi 1.4]
120524
- */
120525
- underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
120526
- /**
120527
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120528
- *
120529
- * @param options Provides options for which properties of the object to load.
120530
- */
120531
- load(options?: PowerPoint.Interfaces.ShapeFontLoadOptions): PowerPoint.ShapeFont;
120532
- /**
120533
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120534
- *
120535
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
120536
- */
120537
- load(propertyNames?: string | string[]): PowerPoint.ShapeFont;
120538
- /**
120539
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
120540
- *
120541
- * @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.
120542
- */
120543
- load(propertyNamesAndPaths?: {
120544
- select?: string;
120545
- expand?: string;
120546
- }): PowerPoint.ShapeFont;
120547
- /**
120548
- * 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.)
120549
- * 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.
120550
- */
120551
- toJSON(): PowerPoint.Interfaces.ShapeFontData;
120552
- }
120553
120558
  /**
120554
120559
  * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
120555
120560
  *
@@ -121563,6 +121568,68 @@ declare namespace PowerPoint {
121563
121568
  interface HyperlinkCollectionUpdateData {
121564
121569
  items?: PowerPoint.Interfaces.HyperlinkData[];
121565
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
+ }
121566
121633
  /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
121567
121634
  interface ShapeCollectionUpdateData {
121568
121635
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -121585,23 +121652,6 @@ declare namespace PowerPoint {
121585
121652
  interface TagCollectionUpdateData {
121586
121653
  items?: PowerPoint.Interfaces.TagData[];
121587
121654
  }
121588
- /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */
121589
- interface ShapeFillUpdateData {
121590
- /**
121591
- * 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").
121592
- *
121593
- * @remarks
121594
- * [Api set: PowerPointApi 1.4]
121595
- */
121596
- foregroundColor?: string;
121597
- /**
121598
- * 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.
121599
- *
121600
- * @remarks
121601
- * [Api set: PowerPointApi 1.4]
121602
- */
121603
- transparency?: number;
121604
- }
121605
121655
  /** An interface for updating data on the `ShapeScopedCollection` object, for use in `shapeScopedCollection.set({ ... })`. */
121606
121656
  interface ShapeScopedCollectionUpdateData {
121607
121657
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -121671,51 +121721,6 @@ declare namespace PowerPoint {
121671
121721
  */
121672
121722
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
121673
121723
  }
121674
- /** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
121675
- interface ShapeFontUpdateData {
121676
- /**
121677
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
121678
- *
121679
- * @remarks
121680
- * [Api set: PowerPointApi 1.4]
121681
- */
121682
- bold?: boolean;
121683
- /**
121684
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
121685
- *
121686
- * @remarks
121687
- * [Api set: PowerPointApi 1.4]
121688
- */
121689
- color?: string;
121690
- /**
121691
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
121692
- *
121693
- * @remarks
121694
- * [Api set: PowerPointApi 1.4]
121695
- */
121696
- italic?: boolean;
121697
- /**
121698
- * 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.
121699
- *
121700
- * @remarks
121701
- * [Api set: PowerPointApi 1.4]
121702
- */
121703
- name?: string;
121704
- /**
121705
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
121706
- *
121707
- * @remarks
121708
- * [Api set: PowerPointApi 1.4]
121709
- */
121710
- size?: number;
121711
- /**
121712
- * 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.
121713
- *
121714
- * @remarks
121715
- * [Api set: PowerPointApi 1.4]
121716
- */
121717
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
121718
- }
121719
121724
  /** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */
121720
121725
  interface TextRangeUpdateData {
121721
121726
  /**
@@ -121982,6 +121987,75 @@ declare namespace PowerPoint {
121982
121987
  interface HyperlinkCollectionData {
121983
121988
  items?: PowerPoint.Interfaces.HyperlinkData[];
121984
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;
122051
+ /**
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.
122053
+ *
122054
+ * @remarks
122055
+ * [Api set: PowerPointApi 1.4]
122056
+ */
122057
+ underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
122058
+ }
121985
122059
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
121986
122060
  interface ShapeCollectionData {
121987
122061
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -122055,30 +122129,6 @@ declare namespace PowerPoint {
122055
122129
  */
122056
122130
  id?: string;
122057
122131
  }
122058
- /** An interface describing the data returned by calling `shapeFill.toJSON()`. */
122059
- interface ShapeFillData {
122060
- /**
122061
- * 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").
122062
- *
122063
- * @remarks
122064
- * [Api set: PowerPointApi 1.4]
122065
- */
122066
- foregroundColor?: string;
122067
- /**
122068
- * 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.
122069
- *
122070
- * @remarks
122071
- * [Api set: PowerPointApi 1.4]
122072
- */
122073
- transparency?: number;
122074
- /**
122075
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
122076
- *
122077
- * @remarks
122078
- * [Api set: PowerPointApi 1.4]
122079
- */
122080
- type?: PowerPoint.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "SlideBackground";
122081
- }
122082
122132
  /** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
122083
122133
  interface ShapeScopedCollectionData {
122084
122134
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -122148,51 +122198,6 @@ declare namespace PowerPoint {
122148
122198
  */
122149
122199
  horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
122150
122200
  }
122151
- /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
122152
- interface ShapeFontData {
122153
- /**
122154
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
122155
- *
122156
- * @remarks
122157
- * [Api set: PowerPointApi 1.4]
122158
- */
122159
- bold?: boolean;
122160
- /**
122161
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
122162
- *
122163
- * @remarks
122164
- * [Api set: PowerPointApi 1.4]
122165
- */
122166
- color?: string;
122167
- /**
122168
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
122169
- *
122170
- * @remarks
122171
- * [Api set: PowerPointApi 1.4]
122172
- */
122173
- italic?: boolean;
122174
- /**
122175
- * 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.
122176
- *
122177
- * @remarks
122178
- * [Api set: PowerPointApi 1.4]
122179
- */
122180
- name?: string;
122181
- /**
122182
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
122183
- *
122184
- * @remarks
122185
- * [Api set: PowerPointApi 1.4]
122186
- */
122187
- size?: number;
122188
- /**
122189
- * 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.
122190
- *
122191
- * @remarks
122192
- * [Api set: PowerPointApi 1.4]
122193
- */
122194
- underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
122195
- }
122196
122201
  /** An interface describing the data returned by calling `textRange.toJSON()`. */
122197
122202
  interface TextRangeData {
122198
122203
  /**
@@ -122608,6 +122613,93 @@ declare namespace PowerPoint {
122608
122613
  */
122609
122614
  screenTip?: boolean;
122610
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
+ }
122611
122703
  /**
122612
122704
  * Represents the collection of shapes.
122613
122705
  *
@@ -122853,39 +122945,6 @@ declare namespace PowerPoint {
122853
122945
  */
122854
122946
  id?: boolean;
122855
122947
  }
122856
- /**
122857
- * Represents the fill formatting of a shape object.
122858
- *
122859
- * @remarks
122860
- * [Api set: PowerPointApi 1.4]
122861
- */
122862
- interface ShapeFillLoadOptions {
122863
- /**
122864
- 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`).
122865
- */
122866
- $all?: boolean;
122867
- /**
122868
- * 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").
122869
- *
122870
- * @remarks
122871
- * [Api set: PowerPointApi 1.4]
122872
- */
122873
- foregroundColor?: boolean;
122874
- /**
122875
- * 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.
122876
- *
122877
- * @remarks
122878
- * [Api set: PowerPointApi 1.4]
122879
- */
122880
- transparency?: boolean;
122881
- /**
122882
- * Returns the fill type of the shape. See {@link PowerPoint.ShapeFillType} for details.
122883
- *
122884
- * @remarks
122885
- * [Api set: PowerPointApi 1.4]
122886
- */
122887
- type?: boolean;
122888
- }
122889
122948
  /**
122890
122949
  * Represents a collection of shapes.
122891
122950
  *
@@ -123067,60 +123126,6 @@ declare namespace PowerPoint {
123067
123126
  */
123068
123127
  horizontalAlignment?: boolean;
123069
123128
  }
123070
- /**
123071
- * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
123072
- *
123073
- * @remarks
123074
- * [Api set: PowerPointApi 1.4]
123075
- */
123076
- interface ShapeFontLoadOptions {
123077
- /**
123078
- 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`).
123079
- */
123080
- $all?: boolean;
123081
- /**
123082
- * Represents the bold status of font. Returns `null` if the `TextRange` includes both bold and non-bold text fragments.
123083
- *
123084
- * @remarks
123085
- * [Api set: PowerPointApi 1.4]
123086
- */
123087
- bold?: boolean;
123088
- /**
123089
- * HTML color code representation of the text color (e.g., "#FF0000" represents red). Returns `null` if the `TextRange` includes text fragments with different colors.
123090
- *
123091
- * @remarks
123092
- * [Api set: PowerPointApi 1.4]
123093
- */
123094
- color?: boolean;
123095
- /**
123096
- * Represents the italic status of font. Returns 'null' if the 'TextRange' includes both italic and non-italic text fragments.
123097
- *
123098
- * @remarks
123099
- * [Api set: PowerPointApi 1.4]
123100
- */
123101
- italic?: boolean;
123102
- /**
123103
- * 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.
123104
- *
123105
- * @remarks
123106
- * [Api set: PowerPointApi 1.4]
123107
- */
123108
- name?: boolean;
123109
- /**
123110
- * Represents font size in points (e.g., 11). Returns null if the TextRange includes text fragments with different font sizes.
123111
- *
123112
- * @remarks
123113
- * [Api set: PowerPointApi 1.4]
123114
- */
123115
- size?: boolean;
123116
- /**
123117
- * 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.
123118
- *
123119
- * @remarks
123120
- * [Api set: PowerPointApi 1.4]
123121
- */
123122
- underline?: boolean;
123123
- }
123124
123129
  /**
123125
123130
  * Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
123126
123131
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.454",
3
+ "version": "1.0.456",
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": "8727a33f7773073b5303e238b95e002523f442c7a216a72375916aef39c83527",
49
+ "typesPublisherContentHash": "0256f2db3a0b32621585d0f7a4874d5ec9a92a9d244661abf2187a8b0b297274",
50
50
  "typeScriptVersion": "5.0"
51
51
  }