@types/office-js 1.0.376 → 1.0.378

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 +470 -421
  3. office-js/package.json +3 -3
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: Thu, 15 Feb 2024 23:35:24 GMT
11
+ * Last updated: Thu, 28 Mar 2024 20:35:30 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -442,6 +442,9 @@ declare namespace Office {
442
442
  PC,
443
443
  /**
444
444
  * The platform is Office on the web (in a browser).
445
+ *
446
+ * **Important**: In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
447
+ * {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows (preview)}.
445
448
  */
446
449
  OfficeOnline,
447
450
  /**
@@ -954,11 +957,16 @@ declare namespace Office {
954
957
  * Provides the platform on which the add-in is running.
955
958
  *
956
959
  * @remarks
957
- * **Important**: In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
960
+ * **Important**:
961
+ *
962
+ * - In Outlook, this property is available from Mailbox requirement set 1.5. You can also use the
958
963
  * `Office.context.diagnostics` property to get the platform starting with requirement set 1.5. For all
959
964
  * Mailbox requirement sets, you can use the
960
965
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.mailbox?view=outlook-js-1.1&preserve-view=true#outlook-office-mailbox-diagnostics-member | Office.context.mailbox.diagnostics}
961
966
  * property to get similar information.
967
+ *
968
+ * - In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
969
+ * {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows (preview)}.
962
970
  */
963
971
  platform: PlatformType;
964
972
  /**
@@ -1668,6 +1676,10 @@ declare namespace Office {
1668
1676
  host: Office.HostType;
1669
1677
  /**
1670
1678
  * Gets the platform on which the add-in is running.
1679
+ *
1680
+ * @remarks
1681
+ * **Important**: In Outlook, `OfficeOnline` is returned if an add-is is running in Outlook on the web or in
1682
+ * {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows (preview)}.
1671
1683
  */
1672
1684
  platform: Office.PlatformType;
1673
1685
  /**
@@ -37627,6 +37639,7 @@ declare namespace Excel {
37627
37639
  markerForegroundColor: string;
37628
37640
  /**
37629
37641
  * Specifies the marker size of a chart series.
37642
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
37630
37643
  *
37631
37644
  * @remarks
37632
37645
  * [Api set: ExcelApi 1.7]
@@ -38008,6 +38021,7 @@ declare namespace Excel {
38008
38021
  markerForegroundColor: string;
38009
38022
  /**
38010
38023
  * Represents marker size of a data point.
38024
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
38011
38025
  *
38012
38026
  * @remarks
38013
38027
  * [Api set: ExcelApi 1.7]
@@ -62736,6 +62750,7 @@ declare namespace Excel {
62736
62750
  markerForegroundColor?: string;
62737
62751
  /**
62738
62752
  * Specifies the marker size of a chart series.
62753
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
62739
62754
  *
62740
62755
  * @remarks
62741
62756
  * [Api set: ExcelApi 1.7]
@@ -62886,6 +62901,7 @@ declare namespace Excel {
62886
62901
  markerForegroundColor?: string;
62887
62902
  /**
62888
62903
  * Represents marker size of a data point.
62904
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
62889
62905
  *
62890
62906
  * @remarks
62891
62907
  * [Api set: ExcelApi 1.7]
@@ -68543,6 +68559,7 @@ declare namespace Excel {
68543
68559
  markerForegroundColor?: string;
68544
68560
  /**
68545
68561
  * Specifies the marker size of a chart series.
68562
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
68546
68563
  *
68547
68564
  * @remarks
68548
68565
  * [Api set: ExcelApi 1.7]
@@ -68693,6 +68710,7 @@ declare namespace Excel {
68693
68710
  markerForegroundColor?: string;
68694
68711
  /**
68695
68712
  * Represents marker size of a data point.
68713
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
68696
68714
  *
68697
68715
  * @remarks
68698
68716
  * [Api set: ExcelApi 1.7]
@@ -76380,6 +76398,7 @@ declare namespace Excel {
76380
76398
  markerForegroundColor?: boolean;
76381
76399
  /**
76382
76400
  * For EACH ITEM in the collection: Specifies the marker size of a chart series.
76401
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
76383
76402
  *
76384
76403
  * @remarks
76385
76404
  * [Api set: ExcelApi 1.7]
@@ -76709,6 +76728,7 @@ declare namespace Excel {
76709
76728
  markerForegroundColor?: boolean;
76710
76729
  /**
76711
76730
  * Specifies the marker size of a chart series.
76731
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
76712
76732
  *
76713
76733
  * @remarks
76714
76734
  * [Api set: ExcelApi 1.7]
@@ -76873,6 +76893,7 @@ declare namespace Excel {
76873
76893
  markerForegroundColor?: boolean;
76874
76894
  /**
76875
76895
  * For EACH ITEM in the collection: Represents marker size of a data point.
76896
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
76876
76897
  *
76877
76898
  * @remarks
76878
76899
  * [Api set: ExcelApi 1.7]
@@ -76941,6 +76962,7 @@ declare namespace Excel {
76941
76962
  markerForegroundColor?: boolean;
76942
76963
  /**
76943
76964
  * Represents marker size of a data point.
76965
+ The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
76944
76966
  *
76945
76967
  * @remarks
76946
76968
  * [Api set: ExcelApi 1.7]
@@ -113025,6 +113047,13 @@ declare namespace PowerPoint {
113025
113047
  * [Api set: PowerPointApi 1.3]
113026
113048
  */
113027
113049
  readonly tags: PowerPoint.TagCollection;
113050
+ /**
113051
+ * Gets the ID of the presentation.
113052
+ *
113053
+ * @remarks
113054
+ * [Api set: PowerPointApi 1.5]
113055
+ */
113056
+ readonly id: string;
113028
113057
  readonly title: string;
113029
113058
  /**
113030
113059
  * Returns the selected shapes in the current slide of the presentation.
@@ -113132,49 +113161,6 @@ declare namespace PowerPoint {
113132
113161
  */
113133
113162
  slideMasterId?: string;
113134
113163
  }
113135
- /**
113136
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
113137
- *
113138
- * @remarks
113139
- * [Api set: PowerPointApi 1.4]
113140
- */
113141
- class BulletFormat extends OfficeExtension.ClientObject {
113142
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
113143
- context: RequestContext;
113144
- /**
113145
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
113146
- *
113147
- * @remarks
113148
- * [Api set: PowerPointApi 1.4]
113149
- */
113150
- visible: boolean;
113151
- /**
113152
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
113153
- *
113154
- * @param options Provides options for which properties of the object to load.
113155
- */
113156
- load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
113157
- /**
113158
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
113159
- *
113160
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
113161
- */
113162
- load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
113163
- /**
113164
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
113165
- *
113166
- * @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.
113167
- */
113168
- load(propertyNamesAndPaths?: {
113169
- select?: string;
113170
- expand?: string;
113171
- }): PowerPoint.BulletFormat;
113172
- /**
113173
- * 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 is passed to it.)
113174
- * Whereas the original PowerPoint.BulletFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
113175
- */
113176
- toJSON(): PowerPoint.Interfaces.BulletFormatData;
113177
- }
113178
113164
  /**
113179
113165
  * Specifies the connector type for line shapes.
113180
113166
  *
@@ -114272,59 +114258,236 @@ declare namespace PowerPoint {
114272
114258
  chartPlus = "ChartPlus",
114273
114259
  }
114274
114260
  /**
114275
- * Specifies the formatting options for when slides are inserted.
114261
+ * Represents the available options when adding shapes.
114276
114262
  *
114277
114263
  * @remarks
114278
- * [Api set: PowerPointApi 1.2]
114264
+ * [Api set: PowerPointApi 1.4]
114279
114265
  */
114280
- enum InsertSlideFormatting {
114266
+ interface ShapeAddOptions {
114281
114267
  /**
114282
- * Copy the source theme into the target presentation and use that theme.
114268
+ * Specifies the height, in points, of the shape.
114269
+ When not provided, a default value will be used.
114270
+ Throws an `InvalidArgument` exception when set with a negative value.
114271
+ *
114283
114272
  * @remarks
114284
- * [Api set: PowerPointApi 1.2]
114273
+ * [Api set: PowerPointApi 1.4]
114285
114274
  */
114286
- keepSourceFormatting = "KeepSourceFormatting",
114275
+ height?: number;
114287
114276
  /**
114288
- * Use the existing theme in the target presentation.
114277
+ * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
114278
+ When not provided, a default value will be used.
114279
+ *
114289
114280
  * @remarks
114290
- * [Api set: PowerPointApi 1.2]
114281
+ * [Api set: PowerPointApi 1.4]
114291
114282
  */
114292
- useDestinationTheme = "UseDestinationTheme",
114283
+ left?: number;
114284
+ /**
114285
+ * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
114286
+ When not provided, a default value will be used.
114287
+ *
114288
+ * @remarks
114289
+ * [Api set: PowerPointApi 1.4]
114290
+ */
114291
+ top?: number;
114292
+ /**
114293
+ * Specifies the width, in points, of the shape.
114294
+ When not provided, a default value will be used.
114295
+ Throws an `InvalidArgument` exception when set with a negative value.
114296
+ *
114297
+ * @remarks
114298
+ * [Api set: PowerPointApi 1.4]
114299
+ */
114300
+ width?: number;
114293
114301
  }
114294
114302
  /**
114295
- * Represents the available options when inserting slides.
114303
+ * Specifies the dash style for a line.
114296
114304
  *
114297
114305
  * @remarks
114298
- * [Api set: PowerPointApi 1.2]
114306
+ * [Api set: PowerPointApi 1.4]
114299
114307
  */
114300
- interface InsertSlideOptions {
114308
+ enum ShapeLineDashStyle {
114301
114309
  /**
114302
- * Specifies which formatting to use during slide insertion.
114303
- The default option is to use "KeepSourceFormatting".
114304
- *
114310
+ * The dash line pattern
114305
114311
  * @remarks
114306
- * [Api set: PowerPointApi 1.2]
114312
+ * [Api set: PowerPointApi 1.4]
114307
114313
  */
114308
- formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
114314
+ dash = "Dash",
114309
114315
  /**
114310
- * Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
114311
- The order of these slides is preserved during the insertion.
114312
- If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
114313
- All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
114314
- *
114316
+ * The dash-dot line pattern
114315
114317
  * @remarks
114316
- * [Api set: PowerPointApi 1.2]
114318
+ * [Api set: PowerPointApi 1.4]
114317
114319
  */
114318
- sourceSlideIds?: string[];
114320
+ dashDot = "DashDot",
114319
114321
  /**
114320
- * Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
114321
- If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
114322
- If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
114323
- *
114322
+ * The dash-dot-dot line pattern
114324
114323
  * @remarks
114325
- * [Api set: PowerPointApi 1.2]
114324
+ * [Api set: PowerPointApi 1.4]
114326
114325
  */
114327
- targetSlideId?: string;
114326
+ dashDotDot = "DashDotDot",
114327
+ /**
114328
+ * The long dash line pattern
114329
+ * @remarks
114330
+ * [Api set: PowerPointApi 1.4]
114331
+ */
114332
+ longDash = "LongDash",
114333
+ /**
114334
+ * The long dash-dot line pattern
114335
+ * @remarks
114336
+ * [Api set: PowerPointApi 1.4]
114337
+ */
114338
+ longDashDot = "LongDashDot",
114339
+ /**
114340
+ * The round dot line pattern
114341
+ * @remarks
114342
+ * [Api set: PowerPointApi 1.4]
114343
+ */
114344
+ roundDot = "RoundDot",
114345
+ /**
114346
+ * The solid line pattern
114347
+ * @remarks
114348
+ * [Api set: PowerPointApi 1.4]
114349
+ */
114350
+ solid = "Solid",
114351
+ /**
114352
+ * The square dot line pattern
114353
+ * @remarks
114354
+ * [Api set: PowerPointApi 1.4]
114355
+ */
114356
+ squareDot = "SquareDot",
114357
+ /**
114358
+ * The long dash-dot-dot line pattern
114359
+ * @remarks
114360
+ * [Api set: PowerPointApi 1.4]
114361
+ */
114362
+ longDashDotDot = "LongDashDotDot",
114363
+ /**
114364
+ * The system dash line pattern
114365
+ * @remarks
114366
+ * [Api set: PowerPointApi 1.4]
114367
+ */
114368
+ systemDash = "SystemDash",
114369
+ /**
114370
+ * The system dot line pattern
114371
+ * @remarks
114372
+ * [Api set: PowerPointApi 1.4]
114373
+ */
114374
+ systemDot = "SystemDot",
114375
+ /**
114376
+ * The system dash-dot line pattern
114377
+ * @remarks
114378
+ * [Api set: PowerPointApi 1.4]
114379
+ */
114380
+ systemDashDot = "SystemDashDot",
114381
+ }
114382
+ /**
114383
+ * The type of underline applied to a font.
114384
+ *
114385
+ * @remarks
114386
+ * [Api set: PowerPointApi 1.4]
114387
+ */
114388
+ enum ShapeFontUnderlineStyle {
114389
+ /**
114390
+ * No underlining.
114391
+ * @remarks
114392
+ * [Api set: PowerPointApi 1.4]
114393
+ */
114394
+ none = "None",
114395
+ /**
114396
+ * Regular single line underlining.
114397
+ * @remarks
114398
+ * [Api set: PowerPointApi 1.4]
114399
+ */
114400
+ single = "Single",
114401
+ /**
114402
+ * Underlining of text with double lines.
114403
+ * @remarks
114404
+ * [Api set: PowerPointApi 1.4]
114405
+ */
114406
+ double = "Double",
114407
+ /**
114408
+ * Underlining of text with a thick line.
114409
+ * @remarks
114410
+ * [Api set: PowerPointApi 1.4]
114411
+ */
114412
+ heavy = "Heavy",
114413
+ /**
114414
+ * Underlining of text with a dotted line.
114415
+ * @remarks
114416
+ * [Api set: PowerPointApi 1.4]
114417
+ */
114418
+ dotted = "Dotted",
114419
+ /**
114420
+ * Underlining of text with a thick, dotted line.
114421
+ * @remarks
114422
+ * [Api set: PowerPointApi 1.4]
114423
+ */
114424
+ dottedHeavy = "DottedHeavy",
114425
+ /**
114426
+ * Underlining of text with a line containing dashes.
114427
+ * @remarks
114428
+ * [Api set: PowerPointApi 1.4]
114429
+ */
114430
+ dash = "Dash",
114431
+ /**
114432
+ * Underlining of text with a thick line containing dashes.
114433
+ * @remarks
114434
+ * [Api set: PowerPointApi 1.4]
114435
+ */
114436
+ dashHeavy = "DashHeavy",
114437
+ /**
114438
+ * Underlining of text with a line containing long dashes.
114439
+ * @remarks
114440
+ * [Api set: PowerPointApi 1.4]
114441
+ */
114442
+ dashLong = "DashLong",
114443
+ /**
114444
+ * Underlining of text with a thick line containing long dashes.
114445
+ * @remarks
114446
+ * [Api set: PowerPointApi 1.4]
114447
+ */
114448
+ dashLongHeavy = "DashLongHeavy",
114449
+ /**
114450
+ * Underlining of text with a line containing dots and dashes.
114451
+ * @remarks
114452
+ * [Api set: PowerPointApi 1.4]
114453
+ */
114454
+ dotDash = "DotDash",
114455
+ /**
114456
+ * Underlining of text with a thick line containing dots and dashes.
114457
+ * @remarks
114458
+ * [Api set: PowerPointApi 1.4]
114459
+ */
114460
+ dotDashHeavy = "DotDashHeavy",
114461
+ /**
114462
+ * Underlining of text with a line containing double dots and dashes.
114463
+ * @remarks
114464
+ * [Api set: PowerPointApi 1.4]
114465
+ */
114466
+ dotDotDash = "DotDotDash",
114467
+ /**
114468
+ * Underlining of text with a thick line containing double dots and dashes.
114469
+ * @remarks
114470
+ * [Api set: PowerPointApi 1.4]
114471
+ */
114472
+ dotDotDashHeavy = "DotDotDashHeavy",
114473
+ /**
114474
+ * Underlining of text with a wavy line.
114475
+ * @remarks
114476
+ * [Api set: PowerPointApi 1.4]
114477
+ */
114478
+ wavy = "Wavy",
114479
+ /**
114480
+ * Underlining of text with a thick, wavy line.
114481
+ * @remarks
114482
+ * [Api set: PowerPointApi 1.4]
114483
+ */
114484
+ wavyHeavy = "WavyHeavy",
114485
+ /**
114486
+ * Underlining of text with double wavy lines.
114487
+ * @remarks
114488
+ * [Api set: PowerPointApi 1.4]
114489
+ */
114490
+ wavyDouble = "WavyDouble",
114328
114491
  }
114329
114492
  /**
114330
114493
  * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
@@ -114377,96 +114540,50 @@ declare namespace PowerPoint {
114377
114540
  thaiDistributed = "ThaiDistributed",
114378
114541
  }
114379
114542
  /**
114380
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
114543
+ * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
114544
+ If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
114545
+ To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
114381
114546
  *
114382
114547
  * @remarks
114383
114548
  * [Api set: PowerPointApi 1.4]
114384
114549
  */
114385
- class ParagraphFormat extends OfficeExtension.ClientObject {
114386
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
114387
- context: RequestContext;
114550
+ enum TextVerticalAlignment {
114388
114551
  /**
114389
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
114390
- *
114552
+ * Specifies that the `TextFrame` should be top aligned to the `Shape`.
114391
114553
  * @remarks
114392
114554
  * [Api set: PowerPointApi 1.4]
114393
114555
  */
114394
- readonly bulletFormat: PowerPoint.BulletFormat;
114556
+ top = "Top",
114395
114557
  /**
114396
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
114397
- *
114558
+ * Specifies that the `TextFrame` should be center aligned to the `Shape`.
114398
114559
  * @remarks
114399
114560
  * [Api set: PowerPointApi 1.4]
114400
114561
  */
114401
- horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
114402
- /**
114403
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
114404
- *
114405
- * @param options Provides options for which properties of the object to load.
114406
- */
114407
- load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
114408
- /**
114409
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
114410
- *
114411
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
114412
- */
114413
- load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
114414
- /**
114415
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
114416
- *
114417
- * @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.
114418
- */
114419
- load(propertyNamesAndPaths?: {
114420
- select?: string;
114421
- expand?: string;
114422
- }): PowerPoint.ParagraphFormat;
114423
- /**
114424
- * 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 is passed to it.)
114425
- * Whereas the original PowerPoint.ParagraphFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
114426
- */
114427
- toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
114428
- }
114429
- /**
114430
- * Represents the available options when adding shapes.
114431
- *
114432
- * @remarks
114433
- * [Api set: PowerPointApi 1.4]
114434
- */
114435
- interface ShapeAddOptions {
114562
+ middle = "Middle",
114436
114563
  /**
114437
- * Specifies the height, in points, of the shape.
114438
- When not provided, a default value will be used.
114439
- Throws an `InvalidArgument` exception when set with a negative value.
114440
- *
114564
+ * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
114441
114565
  * @remarks
114442
114566
  * [Api set: PowerPointApi 1.4]
114443
114567
  */
114444
- height?: number;
114568
+ bottom = "Bottom",
114445
114569
  /**
114446
- * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
114447
- When not provided, a default value will be used.
114448
- *
114570
+ * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
114449
114571
  * @remarks
114450
114572
  * [Api set: PowerPointApi 1.4]
114451
114573
  */
114452
- left?: number;
114574
+ topCentered = "TopCentered",
114453
114575
  /**
114454
- * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
114455
- When not provided, a default value will be used.
114456
- *
114576
+ * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
114457
114577
  * @remarks
114458
114578
  * [Api set: PowerPointApi 1.4]
114459
114579
  */
114460
- top?: number;
114580
+ middleCentered = "MiddleCentered",
114461
114581
  /**
114462
- * Specifies the width, in points, of the shape.
114463
- When not provided, a default value will be used.
114464
- Throws an `InvalidArgument` exception when set with a negative value.
114465
- *
114582
+ * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
114466
114583
  * @remarks
114467
114584
  * [Api set: PowerPointApi 1.4]
114468
114585
  */
114469
- width?: number;
114586
+ bottomCentered = "BottomCentered",
114470
114587
  }
114471
114588
  /**
114472
114589
  * Represents the collection of shapes.
@@ -114853,22 +114970,22 @@ declare namespace PowerPoint {
114853
114970
  /** Gets the loaded child items in this collection. */
114854
114971
  readonly items: PowerPoint.Tag[];
114855
114972
  /**
114856
- * Adds a new tag at the end of the collection. If the `key` already exists in the collection, the value of the existing tag will be replaced with the given `value`.
114973
+ * Adds a new tag at the end of the collection. If the key already exists in the collection, the value of the existing tag will be replaced with the given `value`.
114857
114974
  *
114858
114975
  * @remarks
114859
114976
  * [Api set: PowerPointApi 1.3]
114860
114977
  *
114861
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it is always capitalized when saved in the document.
114978
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. The key string is capitalized when saved in the document.
114862
114979
  * @param value The value of the tag.
114863
114980
  */
114864
114981
  add(key: string, value: string): void;
114865
114982
  /**
114866
- * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
114983
+ * Deletes the tag with the given key in this collection. Does nothing if the key does not exist.
114867
114984
  *
114868
114985
  * @remarks
114869
114986
  * [Api set: PowerPointApi 1.3]
114870
114987
  *
114871
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
114988
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. This parameter is case-insensitive.
114872
114989
  */
114873
114990
  delete(key: string): void;
114874
114991
  /**
@@ -114885,7 +115002,7 @@ declare namespace PowerPoint {
114885
115002
  * @remarks
114886
115003
  * [Api set: PowerPointApi 1.3]
114887
115004
  *
114888
- * @param key The ID of the tag. The `key` parameter is case-sensitive.
115005
+ * @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
114889
115006
  * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
114890
115007
  */
114891
115008
  getItem(key: string): PowerPoint.Tag;
@@ -114905,7 +115022,7 @@ declare namespace PowerPoint {
114905
115022
  * @remarks
114906
115023
  * [Api set: PowerPointApi 1.3]
114907
115024
  *
114908
- * @param key The ID of the tag. The `key` parameter is case-sensitive.
115025
+ * @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
114909
115026
  * @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
114910
115027
  */
114911
115028
  getItemOrNullObject(key: string): PowerPoint.Tag;
@@ -115175,86 +115292,6 @@ declare namespace PowerPoint {
115175
115292
  */
115176
115293
  thinThin = "ThinThin",
115177
115294
  }
115178
- /**
115179
- * Specifies the dash style for a line.
115180
- *
115181
- * @remarks
115182
- * [Api set: PowerPointApi 1.4]
115183
- */
115184
- enum ShapeLineDashStyle {
115185
- /**
115186
- * The dash line pattern
115187
- * @remarks
115188
- * [Api set: PowerPointApi 1.4]
115189
- */
115190
- dash = "Dash",
115191
- /**
115192
- * The dash-dot line pattern
115193
- * @remarks
115194
- * [Api set: PowerPointApi 1.4]
115195
- */
115196
- dashDot = "DashDot",
115197
- /**
115198
- * The dash-dot-dot line pattern
115199
- * @remarks
115200
- * [Api set: PowerPointApi 1.4]
115201
- */
115202
- dashDotDot = "DashDotDot",
115203
- /**
115204
- * The long dash line pattern
115205
- * @remarks
115206
- * [Api set: PowerPointApi 1.4]
115207
- */
115208
- longDash = "LongDash",
115209
- /**
115210
- * The long dash-dot line pattern
115211
- * @remarks
115212
- * [Api set: PowerPointApi 1.4]
115213
- */
115214
- longDashDot = "LongDashDot",
115215
- /**
115216
- * The round dot line pattern
115217
- * @remarks
115218
- * [Api set: PowerPointApi 1.4]
115219
- */
115220
- roundDot = "RoundDot",
115221
- /**
115222
- * The solid line pattern
115223
- * @remarks
115224
- * [Api set: PowerPointApi 1.4]
115225
- */
115226
- solid = "Solid",
115227
- /**
115228
- * The square dot line pattern
115229
- * @remarks
115230
- * [Api set: PowerPointApi 1.4]
115231
- */
115232
- squareDot = "SquareDot",
115233
- /**
115234
- * The long dash-dot-dot line pattern
115235
- * @remarks
115236
- * [Api set: PowerPointApi 1.4]
115237
- */
115238
- longDashDotDot = "LongDashDotDot",
115239
- /**
115240
- * The system dash line pattern
115241
- * @remarks
115242
- * [Api set: PowerPointApi 1.4]
115243
- */
115244
- systemDash = "SystemDash",
115245
- /**
115246
- * The system dot line pattern
115247
- * @remarks
115248
- * [Api set: PowerPointApi 1.4]
115249
- */
115250
- systemDot = "SystemDot",
115251
- /**
115252
- * The system dash-dot line pattern
115253
- * @remarks
115254
- * [Api set: PowerPointApi 1.4]
115255
- */
115256
- systemDashDot = "SystemDashDot",
115257
- }
115258
115295
  /**
115259
115296
  * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
115260
115297
  *
@@ -115370,6 +115407,12 @@ declare namespace PowerPoint {
115370
115407
  * [Api set: PowerPointApi 1.4]
115371
115408
  */
115372
115409
  line = "Line",
115410
+ /**
115411
+ * The shape is a table
115412
+ * @remarks
115413
+ * [Api set: PowerPointApi 1.4]
115414
+ */
115415
+ table = "Table",
115373
115416
  }
115374
115417
  /**
115375
115418
  * Determines the type of automatic sizing allowed.
@@ -115404,160 +115447,97 @@ declare namespace PowerPoint {
115404
115447
  autoSizeMixed = "AutoSizeMixed",
115405
115448
  }
115406
115449
  /**
115407
- * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
115408
- If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
115409
- To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
115450
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
115410
115451
  *
115411
115452
  * @remarks
115412
115453
  * [Api set: PowerPointApi 1.4]
115413
115454
  */
115414
- enum TextVerticalAlignment {
115415
- /**
115416
- * Specifies that the `TextFrame` should be top aligned to the `Shape`.
115417
- * @remarks
115418
- * [Api set: PowerPointApi 1.4]
115419
- */
115420
- top = "Top",
115455
+ class BulletFormat extends OfficeExtension.ClientObject {
115456
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
115457
+ context: RequestContext;
115421
115458
  /**
115422
- * Specifies that the `TextFrame` should be center aligned to the `Shape`.
115459
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
115460
+ *
115423
115461
  * @remarks
115424
115462
  * [Api set: PowerPointApi 1.4]
115425
115463
  */
115426
- middle = "Middle",
115464
+ visible: boolean;
115427
115465
  /**
115428
- * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
115429
- * @remarks
115430
- * [Api set: PowerPointApi 1.4]
115466
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115467
+ *
115468
+ * @param options Provides options for which properties of the object to load.
115431
115469
  */
115432
- bottom = "Bottom",
115470
+ load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
115433
115471
  /**
115434
- * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
115435
- * @remarks
115436
- * [Api set: PowerPointApi 1.4]
115472
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115473
+ *
115474
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
115437
115475
  */
115438
- topCentered = "TopCentered",
115476
+ load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
115439
115477
  /**
115440
- * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
115441
- * @remarks
115442
- * [Api set: PowerPointApi 1.4]
115478
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115479
+ *
115480
+ * @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.
115443
115481
  */
115444
- middleCentered = "MiddleCentered",
115482
+ load(propertyNamesAndPaths?: {
115483
+ select?: string;
115484
+ expand?: string;
115485
+ }): PowerPoint.BulletFormat;
115445
115486
  /**
115446
- * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
115447
- * @remarks
115448
- * [Api set: PowerPointApi 1.4]
115449
- */
115450
- bottomCentered = "BottomCentered",
115487
+ * 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 is passed to it.)
115488
+ * Whereas the original PowerPoint.BulletFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
115489
+ */
115490
+ toJSON(): PowerPoint.Interfaces.BulletFormatData;
115451
115491
  }
115452
115492
  /**
115453
- * The type of underline applied to a font.
115493
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
115454
115494
  *
115455
115495
  * @remarks
115456
115496
  * [Api set: PowerPointApi 1.4]
115457
115497
  */
115458
- enum ShapeFontUnderlineStyle {
115459
- /**
115460
- * No underlining.
115461
- * @remarks
115462
- * [Api set: PowerPointApi 1.4]
115463
- */
115464
- none = "None",
115465
- /**
115466
- * Regular single line underlining.
115467
- * @remarks
115468
- * [Api set: PowerPointApi 1.4]
115469
- */
115470
- single = "Single",
115471
- /**
115472
- * Underlining of text with double lines.
115473
- * @remarks
115474
- * [Api set: PowerPointApi 1.4]
115475
- */
115476
- double = "Double",
115477
- /**
115478
- * Underlining of text with a thick line.
115479
- * @remarks
115480
- * [Api set: PowerPointApi 1.4]
115481
- */
115482
- heavy = "Heavy",
115483
- /**
115484
- * Underlining of text with a dotted line.
115485
- * @remarks
115486
- * [Api set: PowerPointApi 1.4]
115487
- */
115488
- dotted = "Dotted",
115489
- /**
115490
- * Underlining of text with a thick, dotted line.
115491
- * @remarks
115492
- * [Api set: PowerPointApi 1.4]
115493
- */
115494
- dottedHeavy = "DottedHeavy",
115495
- /**
115496
- * Underlining of text with a line containing dashes.
115497
- * @remarks
115498
- * [Api set: PowerPointApi 1.4]
115499
- */
115500
- dash = "Dash",
115501
- /**
115502
- * Underlining of text with a thick line containing dashes.
115503
- * @remarks
115504
- * [Api set: PowerPointApi 1.4]
115505
- */
115506
- dashHeavy = "DashHeavy",
115507
- /**
115508
- * Underlining of text with a line containing long dashes.
115509
- * @remarks
115510
- * [Api set: PowerPointApi 1.4]
115511
- */
115512
- dashLong = "DashLong",
115513
- /**
115514
- * Underlining of text with a thick line containing long dashes.
115515
- * @remarks
115516
- * [Api set: PowerPointApi 1.4]
115517
- */
115518
- dashLongHeavy = "DashLongHeavy",
115519
- /**
115520
- * Underlining of text with a line containing dots and dashes.
115521
- * @remarks
115522
- * [Api set: PowerPointApi 1.4]
115523
- */
115524
- dotDash = "DotDash",
115498
+ class ParagraphFormat extends OfficeExtension.ClientObject {
115499
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
115500
+ context: RequestContext;
115525
115501
  /**
115526
- * Underlining of text with a thick line containing dots and dashes.
115502
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
115503
+ *
115527
115504
  * @remarks
115528
115505
  * [Api set: PowerPointApi 1.4]
115529
115506
  */
115530
- dotDashHeavy = "DotDashHeavy",
115507
+ readonly bulletFormat: PowerPoint.BulletFormat;
115531
115508
  /**
115532
- * Underlining of text with a line containing double dots and dashes.
115509
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
115510
+ *
115533
115511
  * @remarks
115534
115512
  * [Api set: PowerPointApi 1.4]
115535
115513
  */
115536
- dotDotDash = "DotDotDash",
115514
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
115537
115515
  /**
115538
- * Underlining of text with a thick line containing double dots and dashes.
115539
- * @remarks
115540
- * [Api set: PowerPointApi 1.4]
115516
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115517
+ *
115518
+ * @param options Provides options for which properties of the object to load.
115541
115519
  */
115542
- dotDotDashHeavy = "DotDotDashHeavy",
115520
+ load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
115543
115521
  /**
115544
- * Underlining of text with a wavy line.
115545
- * @remarks
115546
- * [Api set: PowerPointApi 1.4]
115522
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115523
+ *
115524
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
115547
115525
  */
115548
- wavy = "Wavy",
115526
+ load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
115549
115527
  /**
115550
- * Underlining of text with a thick, wavy line.
115551
- * @remarks
115552
- * [Api set: PowerPointApi 1.4]
115528
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115529
+ *
115530
+ * @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.
115553
115531
  */
115554
- wavyHeavy = "WavyHeavy",
115532
+ load(propertyNamesAndPaths?: {
115533
+ select?: string;
115534
+ expand?: string;
115535
+ }): PowerPoint.ParagraphFormat;
115555
115536
  /**
115556
- * Underlining of text with double wavy lines.
115557
- * @remarks
115558
- * [Api set: PowerPointApi 1.4]
115559
- */
115560
- wavyDouble = "WavyDouble",
115537
+ * 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 is passed to it.)
115538
+ * Whereas the original PowerPoint.ParagraphFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
115539
+ */
115540
+ toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
115561
115541
  }
115562
115542
  /**
115563
115543
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -115925,7 +115905,7 @@ declare namespace PowerPoint {
115925
115905
  * @remarks
115926
115906
  * [Api set: PowerPointApi 1.4]
115927
115907
  */
115928
- readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
115908
+ readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
115929
115909
  /**
115930
115910
  * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
115931
115911
  *
@@ -116009,6 +115989,61 @@ declare namespace PowerPoint {
116009
115989
  */
116010
115990
  toJSON(): PowerPoint.Interfaces.ShapeData;
116011
115991
  }
115992
+ /**
115993
+ * Specifies the formatting options for when slides are inserted.
115994
+ *
115995
+ * @remarks
115996
+ * [Api set: PowerPointApi 1.2]
115997
+ */
115998
+ enum InsertSlideFormatting {
115999
+ /**
116000
+ * Copy the source theme into the target presentation and use that theme.
116001
+ * @remarks
116002
+ * [Api set: PowerPointApi 1.2]
116003
+ */
116004
+ keepSourceFormatting = "KeepSourceFormatting",
116005
+ /**
116006
+ * Use the existing theme in the target presentation.
116007
+ * @remarks
116008
+ * [Api set: PowerPointApi 1.2]
116009
+ */
116010
+ useDestinationTheme = "UseDestinationTheme",
116011
+ }
116012
+ /**
116013
+ * Represents the available options when inserting slides.
116014
+ *
116015
+ * @remarks
116016
+ * [Api set: PowerPointApi 1.2]
116017
+ */
116018
+ interface InsertSlideOptions {
116019
+ /**
116020
+ * Specifies which formatting to use during slide insertion.
116021
+ The default option is to use "KeepSourceFormatting".
116022
+ *
116023
+ * @remarks
116024
+ * [Api set: PowerPointApi 1.2]
116025
+ */
116026
+ formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
116027
+ /**
116028
+ * Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
116029
+ The order of these slides is preserved during the insertion.
116030
+ If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
116031
+ All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
116032
+ *
116033
+ * @remarks
116034
+ * [Api set: PowerPointApi 1.2]
116035
+ */
116036
+ sourceSlideIds?: string[];
116037
+ /**
116038
+ * Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
116039
+ If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
116040
+ If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
116041
+ *
116042
+ * @remarks
116043
+ * [Api set: PowerPointApi 1.2]
116044
+ */
116045
+ targetSlideId?: string;
116046
+ }
116012
116047
  /**
116013
116048
  * Represents a collection of shapes.
116014
116049
  *
@@ -116333,26 +116368,6 @@ declare namespace PowerPoint {
116333
116368
  */
116334
116369
  $skip?: number;
116335
116370
  }
116336
- /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
116337
- interface BulletFormatUpdateData {
116338
- /**
116339
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
116340
- *
116341
- * @remarks
116342
- * [Api set: PowerPointApi 1.4]
116343
- */
116344
- visible?: boolean;
116345
- }
116346
- /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
116347
- interface ParagraphFormatUpdateData {
116348
- /**
116349
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
116350
- *
116351
- * @remarks
116352
- * [Api set: PowerPointApi 1.4]
116353
- */
116354
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
116355
- }
116356
116371
  /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
116357
116372
  interface ShapeCollectionUpdateData {
116358
116373
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -116437,6 +116452,26 @@ declare namespace PowerPoint {
116437
116452
  */
116438
116453
  weight?: number;
116439
116454
  }
116455
+ /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
116456
+ interface BulletFormatUpdateData {
116457
+ /**
116458
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
116459
+ *
116460
+ * @remarks
116461
+ * [Api set: PowerPointApi 1.4]
116462
+ */
116463
+ visible?: boolean;
116464
+ }
116465
+ /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
116466
+ interface ParagraphFormatUpdateData {
116467
+ /**
116468
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
116469
+ *
116470
+ * @remarks
116471
+ * [Api set: PowerPointApi 1.4]
116472
+ */
116473
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
116474
+ }
116440
116475
  /** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
116441
116476
  interface ShapeFontUpdateData {
116442
116477
  /**
@@ -116616,27 +116651,14 @@ declare namespace PowerPoint {
116616
116651
  }
116617
116652
  /** An interface describing the data returned by calling `presentation.toJSON()`. */
116618
116653
  interface PresentationData {
116619
- title?: string;
116620
- }
116621
- /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
116622
- interface BulletFormatData {
116623
116654
  /**
116624
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
116655
+ * Gets the ID of the presentation.
116625
116656
  *
116626
116657
  * @remarks
116627
- * [Api set: PowerPointApi 1.4]
116628
- */
116629
- visible?: boolean;
116630
- }
116631
- /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
116632
- interface ParagraphFormatData {
116633
- /**
116634
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
116635
- *
116636
- * @remarks
116637
- * [Api set: PowerPointApi 1.4]
116658
+ * [Api set: PowerPointApi 1.5]
116638
116659
  */
116639
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
116660
+ id?: string;
116661
+ title?: string;
116640
116662
  }
116641
116663
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
116642
116664
  interface ShapeCollectionData {
@@ -116780,6 +116802,26 @@ declare namespace PowerPoint {
116780
116802
  */
116781
116803
  weight?: number;
116782
116804
  }
116805
+ /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
116806
+ interface BulletFormatData {
116807
+ /**
116808
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
116809
+ *
116810
+ * @remarks
116811
+ * [Api set: PowerPointApi 1.4]
116812
+ */
116813
+ visible?: boolean;
116814
+ }
116815
+ /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
116816
+ interface ParagraphFormatData {
116817
+ /**
116818
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
116819
+ *
116820
+ * @remarks
116821
+ * [Api set: PowerPointApi 1.4]
116822
+ */
116823
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
116824
+ }
116783
116825
  /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
116784
116826
  interface ShapeFontData {
116785
116827
  /**
@@ -116953,7 +116995,7 @@ declare namespace PowerPoint {
116953
116995
  * @remarks
116954
116996
  * [Api set: PowerPointApi 1.4]
116955
116997
  */
116956
- type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
116998
+ type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
116957
116999
  /**
116958
117000
  * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
116959
117001
  *
@@ -116983,56 +117025,18 @@ declare namespace PowerPoint {
116983
117025
  * [Api set: PowerPointApi 1.0]
116984
117026
  */
116985
117027
  interface PresentationLoadOptions {
116986
- /**
116987
- Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
116988
- */
116989
- $all?: boolean;
116990
- title?: boolean;
116991
- }
116992
- /**
116993
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
116994
- *
116995
- * @remarks
116996
- * [Api set: PowerPointApi 1.4]
116997
- */
116998
- interface BulletFormatLoadOptions {
116999
- /**
117000
- Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
117001
- */
117002
- $all?: boolean;
117003
- /**
117004
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
117005
- *
117006
- * @remarks
117007
- * [Api set: PowerPointApi 1.4]
117008
- */
117009
- visible?: boolean;
117010
- }
117011
- /**
117012
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
117013
- *
117014
- * @remarks
117015
- * [Api set: PowerPointApi 1.4]
117016
- */
117017
- interface ParagraphFormatLoadOptions {
117018
117028
  /**
117019
117029
  Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
117020
117030
  */
117021
117031
  $all?: boolean;
117022
117032
  /**
117023
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
117024
- *
117025
- * @remarks
117026
- * [Api set: PowerPointApi 1.4]
117027
- */
117028
- bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
117029
- /**
117030
- * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
117033
+ * Gets the ID of the presentation.
117031
117034
  *
117032
117035
  * @remarks
117033
- * [Api set: PowerPointApi 1.4]
117036
+ * [Api set: PowerPointApi 1.5]
117034
117037
  */
117035
- horizontalAlignment?: boolean;
117038
+ id?: boolean;
117039
+ title?: boolean;
117036
117040
  }
117037
117041
  /**
117038
117042
  * Represents the collection of shapes.
@@ -117366,6 +117370,51 @@ declare namespace PowerPoint {
117366
117370
  */
117367
117371
  weight?: boolean;
117368
117372
  }
117373
+ /**
117374
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
117375
+ *
117376
+ * @remarks
117377
+ * [Api set: PowerPointApi 1.4]
117378
+ */
117379
+ interface BulletFormatLoadOptions {
117380
+ /**
117381
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
117382
+ */
117383
+ $all?: boolean;
117384
+ /**
117385
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
117386
+ *
117387
+ * @remarks
117388
+ * [Api set: PowerPointApi 1.4]
117389
+ */
117390
+ visible?: boolean;
117391
+ }
117392
+ /**
117393
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
117394
+ *
117395
+ * @remarks
117396
+ * [Api set: PowerPointApi 1.4]
117397
+ */
117398
+ interface ParagraphFormatLoadOptions {
117399
+ /**
117400
+ Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
117401
+ */
117402
+ $all?: boolean;
117403
+ /**
117404
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
117405
+ *
117406
+ * @remarks
117407
+ * [Api set: PowerPointApi 1.4]
117408
+ */
117409
+ bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
117410
+ /**
117411
+ * Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
117412
+ *
117413
+ * @remarks
117414
+ * [Api set: PowerPointApi 1.4]
117415
+ */
117416
+ horizontalAlignment?: boolean;
117417
+ }
117369
117418
  /**
117370
117419
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
117371
117420
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.376",
3
+ "version": "1.0.378",
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",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "cbcdf02dd9e85a1071020e51c13df083e7afd21ca231703812c15dd89dab33a1",
49
- "typeScriptVersion": "4.6"
48
+ "typesPublisherContentHash": "bcc55dc00af5d598cb779a049b17524cf96d7c0ddb9b6406bab86a02222978d6",
49
+ "typeScriptVersion": "4.7"
50
50
  }