@types/office-js-preview 1.0.458 → 1.0.459

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.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 26 Mar 2024 18:07:46 GMT
11
+ * Last updated: Thu, 28 Mar 2024 20:35:30 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -29242,6 +29242,24 @@ declare namespace Excel {
29242
29242
  * [Api set: ExcelApi 1.14]
29243
29243
  */
29244
29244
  readonly rowsLoadedCount: number;
29245
+ /**
29246
+ * Deletes the query and associated connection.
29247
+ Tables associated with the query will no longer be connected.
29248
+ *
29249
+ * @remarks
29250
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29251
+ * @beta
29252
+ */
29253
+ delete(): void;
29254
+ /**
29255
+ * Refreshes the query.
29256
+ This only starts the refresh.
29257
+ *
29258
+ * @remarks
29259
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29260
+ * @beta
29261
+ */
29262
+ refresh(): void;
29245
29263
  /**
29246
29264
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
29247
29265
  *
@@ -29297,6 +29315,14 @@ declare namespace Excel {
29297
29315
  * @returns The query with the given name. If there is no query by that name, then an error is thrown.
29298
29316
  */
29299
29317
  getItem(key: string): Excel.Query;
29318
+ /**
29319
+ * Refresh all queries.
29320
+ *
29321
+ * @remarks
29322
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29323
+ * @beta
29324
+ */
29325
+ refreshAll(): void;
29300
29326
  /**
29301
29327
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
29302
29328
  *
@@ -29711,7 +29737,7 @@ declare namespace Excel {
29711
29737
  */
29712
29738
  readonly title: string;
29713
29739
  /**
29714
- * Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.
29740
+ * Represents the action type of the task change record. Some examples of action types are `assign`, `undo`, and `setPriority`.
29715
29741
  *
29716
29742
  * @remarks
29717
29743
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -41190,6 +41216,7 @@ declare namespace Excel {
41190
41216
  markerForegroundColor: string;
41191
41217
  /**
41192
41218
  * Specifies the marker size of a chart series.
41219
+ 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.
41193
41220
  *
41194
41221
  * @remarks
41195
41222
  * [Api set: ExcelApi 1.7]
@@ -41571,6 +41598,7 @@ declare namespace Excel {
41571
41598
  markerForegroundColor: string;
41572
41599
  /**
41573
41600
  * Represents marker size of a data point.
41601
+ 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.
41574
41602
  *
41575
41603
  * @remarks
41576
41604
  * [Api set: ExcelApi 1.7]
@@ -66964,6 +66992,7 @@ declare namespace Excel {
66964
66992
  markerForegroundColor?: string;
66965
66993
  /**
66966
66994
  * Specifies the marker size of a chart series.
66995
+ 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.
66967
66996
  *
66968
66997
  * @remarks
66969
66998
  * [Api set: ExcelApi 1.7]
@@ -67114,6 +67143,7 @@ declare namespace Excel {
67114
67143
  markerForegroundColor?: string;
67115
67144
  /**
67116
67145
  * Represents marker size of a data point.
67146
+ 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.
67117
67147
  *
67118
67148
  * @remarks
67119
67149
  * [Api set: ExcelApi 1.7]
@@ -73035,6 +73065,7 @@ declare namespace Excel {
73035
73065
  markerForegroundColor?: string;
73036
73066
  /**
73037
73067
  * Specifies the marker size of a chart series.
73068
+ 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.
73038
73069
  *
73039
73070
  * @remarks
73040
73071
  * [Api set: ExcelApi 1.7]
@@ -73185,6 +73216,7 @@ declare namespace Excel {
73185
73216
  markerForegroundColor?: string;
73186
73217
  /**
73187
73218
  * Represents marker size of a data point.
73219
+ 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.
73188
73220
  *
73189
73221
  * @remarks
73190
73222
  * [Api set: ExcelApi 1.7]
@@ -77782,7 +77814,7 @@ declare namespace Excel {
77782
77814
  */
77783
77815
  title?: boolean;
77784
77816
  /**
77785
- * Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.
77817
+ * Represents the action type of the task change record. Some examples of action types are `assign`, `undo`, and `setPriority`.
77786
77818
  *
77787
77819
  * @remarks
77788
77820
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -81446,6 +81478,7 @@ declare namespace Excel {
81446
81478
  markerForegroundColor?: boolean;
81447
81479
  /**
81448
81480
  * For EACH ITEM in the collection: Specifies the marker size of a chart series.
81481
+ 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.
81449
81482
  *
81450
81483
  * @remarks
81451
81484
  * [Api set: ExcelApi 1.7]
@@ -81775,6 +81808,7 @@ declare namespace Excel {
81775
81808
  markerForegroundColor?: boolean;
81776
81809
  /**
81777
81810
  * Specifies the marker size of a chart series.
81811
+ 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.
81778
81812
  *
81779
81813
  * @remarks
81780
81814
  * [Api set: ExcelApi 1.7]
@@ -81939,6 +81973,7 @@ declare namespace Excel {
81939
81973
  markerForegroundColor?: boolean;
81940
81974
  /**
81941
81975
  * For EACH ITEM in the collection: Represents marker size of a data point.
81976
+ 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.
81942
81977
  *
81943
81978
  * @remarks
81944
81979
  * [Api set: ExcelApi 1.7]
@@ -82007,6 +82042,7 @@ declare namespace Excel {
82007
82042
  markerForegroundColor?: boolean;
82008
82043
  /**
82009
82044
  * Represents marker size of a data point.
82045
+ 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.
82010
82046
  *
82011
82047
  * @remarks
82012
82048
  * [Api set: ExcelApi 1.7]
@@ -121293,6 +121329,13 @@ declare namespace PowerPoint {
121293
121329
  * [Api set: PowerPointApi 1.3]
121294
121330
  */
121295
121331
  readonly tags: PowerPoint.TagCollection;
121332
+ /**
121333
+ * Gets the ID of the presentation.
121334
+ *
121335
+ * @remarks
121336
+ * [Api set: PowerPointApi 1.5]
121337
+ */
121338
+ readonly id: string;
121296
121339
  readonly title: string;
121297
121340
  /**
121298
121341
  * Returns the selected shapes in the current slide of the presentation.
@@ -121400,49 +121443,6 @@ declare namespace PowerPoint {
121400
121443
  */
121401
121444
  slideMasterId?: string;
121402
121445
  }
121403
- /**
121404
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
121405
- *
121406
- * @remarks
121407
- * [Api set: PowerPointApi 1.4]
121408
- */
121409
- class BulletFormat extends OfficeExtension.ClientObject {
121410
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
121411
- context: RequestContext;
121412
- /**
121413
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
121414
- *
121415
- * @remarks
121416
- * [Api set: PowerPointApi 1.4]
121417
- */
121418
- visible: boolean;
121419
- /**
121420
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
121421
- *
121422
- * @param options Provides options for which properties of the object to load.
121423
- */
121424
- load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
121425
- /**
121426
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
121427
- *
121428
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
121429
- */
121430
- load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
121431
- /**
121432
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
121433
- *
121434
- * @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.
121435
- */
121436
- load(propertyNamesAndPaths?: {
121437
- select?: string;
121438
- expand?: string;
121439
- }): PowerPoint.BulletFormat;
121440
- /**
121441
- * 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.)
121442
- * 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.
121443
- */
121444
- toJSON(): PowerPoint.Interfaces.BulletFormatData;
121445
- }
121446
121446
  /**
121447
121447
  * Specifies the connector type for line shapes.
121448
121448
  *
@@ -122540,59 +122540,236 @@ declare namespace PowerPoint {
122540
122540
  chartPlus = "ChartPlus",
122541
122541
  }
122542
122542
  /**
122543
- * Specifies the formatting options for when slides are inserted.
122543
+ * Represents the available options when adding shapes.
122544
122544
  *
122545
122545
  * @remarks
122546
- * [Api set: PowerPointApi 1.2]
122546
+ * [Api set: PowerPointApi 1.4]
122547
122547
  */
122548
- enum InsertSlideFormatting {
122548
+ interface ShapeAddOptions {
122549
122549
  /**
122550
- * Copy the source theme into the target presentation and use that theme.
122550
+ * Specifies the height, in points, of the shape.
122551
+ When not provided, a default value will be used.
122552
+ Throws an `InvalidArgument` exception when set with a negative value.
122553
+ *
122551
122554
  * @remarks
122552
- * [Api set: PowerPointApi 1.2]
122555
+ * [Api set: PowerPointApi 1.4]
122553
122556
  */
122554
- keepSourceFormatting = "KeepSourceFormatting",
122557
+ height?: number;
122555
122558
  /**
122556
- * Use the existing theme in the target presentation.
122559
+ * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
122560
+ When not provided, a default value will be used.
122561
+ *
122557
122562
  * @remarks
122558
- * [Api set: PowerPointApi 1.2]
122563
+ * [Api set: PowerPointApi 1.4]
122559
122564
  */
122560
- useDestinationTheme = "UseDestinationTheme",
122565
+ left?: number;
122566
+ /**
122567
+ * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
122568
+ When not provided, a default value will be used.
122569
+ *
122570
+ * @remarks
122571
+ * [Api set: PowerPointApi 1.4]
122572
+ */
122573
+ top?: number;
122574
+ /**
122575
+ * Specifies the width, in points, of the shape.
122576
+ When not provided, a default value will be used.
122577
+ Throws an `InvalidArgument` exception when set with a negative value.
122578
+ *
122579
+ * @remarks
122580
+ * [Api set: PowerPointApi 1.4]
122581
+ */
122582
+ width?: number;
122561
122583
  }
122562
122584
  /**
122563
- * Represents the available options when inserting slides.
122585
+ * Specifies the dash style for a line.
122564
122586
  *
122565
122587
  * @remarks
122566
- * [Api set: PowerPointApi 1.2]
122588
+ * [Api set: PowerPointApi 1.4]
122567
122589
  */
122568
- interface InsertSlideOptions {
122590
+ enum ShapeLineDashStyle {
122569
122591
  /**
122570
- * Specifies which formatting to use during slide insertion.
122571
- The default option is to use "KeepSourceFormatting".
122572
- *
122592
+ * The dash line pattern
122573
122593
  * @remarks
122574
- * [Api set: PowerPointApi 1.2]
122594
+ * [Api set: PowerPointApi 1.4]
122575
122595
  */
122576
- formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
122596
+ dash = "Dash",
122577
122597
  /**
122578
- * 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.
122579
- The order of these slides is preserved during the insertion.
122580
- 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.
122581
- All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
122582
- *
122598
+ * The dash-dot line pattern
122583
122599
  * @remarks
122584
- * [Api set: PowerPointApi 1.2]
122600
+ * [Api set: PowerPointApi 1.4]
122585
122601
  */
122586
- sourceSlideIds?: string[];
122602
+ dashDot = "DashDot",
122587
122603
  /**
122588
- * 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.
122589
- If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
122590
- 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.
122591
- *
122604
+ * The dash-dot-dot line pattern
122592
122605
  * @remarks
122593
- * [Api set: PowerPointApi 1.2]
122606
+ * [Api set: PowerPointApi 1.4]
122594
122607
  */
122595
- targetSlideId?: string;
122608
+ dashDotDot = "DashDotDot",
122609
+ /**
122610
+ * The long dash line pattern
122611
+ * @remarks
122612
+ * [Api set: PowerPointApi 1.4]
122613
+ */
122614
+ longDash = "LongDash",
122615
+ /**
122616
+ * The long dash-dot line pattern
122617
+ * @remarks
122618
+ * [Api set: PowerPointApi 1.4]
122619
+ */
122620
+ longDashDot = "LongDashDot",
122621
+ /**
122622
+ * The round dot line pattern
122623
+ * @remarks
122624
+ * [Api set: PowerPointApi 1.4]
122625
+ */
122626
+ roundDot = "RoundDot",
122627
+ /**
122628
+ * The solid line pattern
122629
+ * @remarks
122630
+ * [Api set: PowerPointApi 1.4]
122631
+ */
122632
+ solid = "Solid",
122633
+ /**
122634
+ * The square dot line pattern
122635
+ * @remarks
122636
+ * [Api set: PowerPointApi 1.4]
122637
+ */
122638
+ squareDot = "SquareDot",
122639
+ /**
122640
+ * The long dash-dot-dot line pattern
122641
+ * @remarks
122642
+ * [Api set: PowerPointApi 1.4]
122643
+ */
122644
+ longDashDotDot = "LongDashDotDot",
122645
+ /**
122646
+ * The system dash line pattern
122647
+ * @remarks
122648
+ * [Api set: PowerPointApi 1.4]
122649
+ */
122650
+ systemDash = "SystemDash",
122651
+ /**
122652
+ * The system dot line pattern
122653
+ * @remarks
122654
+ * [Api set: PowerPointApi 1.4]
122655
+ */
122656
+ systemDot = "SystemDot",
122657
+ /**
122658
+ * The system dash-dot line pattern
122659
+ * @remarks
122660
+ * [Api set: PowerPointApi 1.4]
122661
+ */
122662
+ systemDashDot = "SystemDashDot",
122663
+ }
122664
+ /**
122665
+ * The type of underline applied to a font.
122666
+ *
122667
+ * @remarks
122668
+ * [Api set: PowerPointApi 1.4]
122669
+ */
122670
+ enum ShapeFontUnderlineStyle {
122671
+ /**
122672
+ * No underlining.
122673
+ * @remarks
122674
+ * [Api set: PowerPointApi 1.4]
122675
+ */
122676
+ none = "None",
122677
+ /**
122678
+ * Regular single line underlining.
122679
+ * @remarks
122680
+ * [Api set: PowerPointApi 1.4]
122681
+ */
122682
+ single = "Single",
122683
+ /**
122684
+ * Underlining of text with double lines.
122685
+ * @remarks
122686
+ * [Api set: PowerPointApi 1.4]
122687
+ */
122688
+ double = "Double",
122689
+ /**
122690
+ * Underlining of text with a thick line.
122691
+ * @remarks
122692
+ * [Api set: PowerPointApi 1.4]
122693
+ */
122694
+ heavy = "Heavy",
122695
+ /**
122696
+ * Underlining of text with a dotted line.
122697
+ * @remarks
122698
+ * [Api set: PowerPointApi 1.4]
122699
+ */
122700
+ dotted = "Dotted",
122701
+ /**
122702
+ * Underlining of text with a thick, dotted line.
122703
+ * @remarks
122704
+ * [Api set: PowerPointApi 1.4]
122705
+ */
122706
+ dottedHeavy = "DottedHeavy",
122707
+ /**
122708
+ * Underlining of text with a line containing dashes.
122709
+ * @remarks
122710
+ * [Api set: PowerPointApi 1.4]
122711
+ */
122712
+ dash = "Dash",
122713
+ /**
122714
+ * Underlining of text with a thick line containing dashes.
122715
+ * @remarks
122716
+ * [Api set: PowerPointApi 1.4]
122717
+ */
122718
+ dashHeavy = "DashHeavy",
122719
+ /**
122720
+ * Underlining of text with a line containing long dashes.
122721
+ * @remarks
122722
+ * [Api set: PowerPointApi 1.4]
122723
+ */
122724
+ dashLong = "DashLong",
122725
+ /**
122726
+ * Underlining of text with a thick line containing long dashes.
122727
+ * @remarks
122728
+ * [Api set: PowerPointApi 1.4]
122729
+ */
122730
+ dashLongHeavy = "DashLongHeavy",
122731
+ /**
122732
+ * Underlining of text with a line containing dots and dashes.
122733
+ * @remarks
122734
+ * [Api set: PowerPointApi 1.4]
122735
+ */
122736
+ dotDash = "DotDash",
122737
+ /**
122738
+ * Underlining of text with a thick line containing dots and dashes.
122739
+ * @remarks
122740
+ * [Api set: PowerPointApi 1.4]
122741
+ */
122742
+ dotDashHeavy = "DotDashHeavy",
122743
+ /**
122744
+ * Underlining of text with a line containing double dots and dashes.
122745
+ * @remarks
122746
+ * [Api set: PowerPointApi 1.4]
122747
+ */
122748
+ dotDotDash = "DotDotDash",
122749
+ /**
122750
+ * Underlining of text with a thick line containing double dots and dashes.
122751
+ * @remarks
122752
+ * [Api set: PowerPointApi 1.4]
122753
+ */
122754
+ dotDotDashHeavy = "DotDotDashHeavy",
122755
+ /**
122756
+ * Underlining of text with a wavy line.
122757
+ * @remarks
122758
+ * [Api set: PowerPointApi 1.4]
122759
+ */
122760
+ wavy = "Wavy",
122761
+ /**
122762
+ * Underlining of text with a thick, wavy line.
122763
+ * @remarks
122764
+ * [Api set: PowerPointApi 1.4]
122765
+ */
122766
+ wavyHeavy = "WavyHeavy",
122767
+ /**
122768
+ * Underlining of text with double wavy lines.
122769
+ * @remarks
122770
+ * [Api set: PowerPointApi 1.4]
122771
+ */
122772
+ wavyDouble = "WavyDouble",
122596
122773
  }
122597
122774
  /**
122598
122775
  * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
@@ -122645,96 +122822,50 @@ declare namespace PowerPoint {
122645
122822
  thaiDistributed = "ThaiDistributed",
122646
122823
  }
122647
122824
  /**
122648
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
122825
+ * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
122826
+ If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
122827
+ To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
122649
122828
  *
122650
122829
  * @remarks
122651
122830
  * [Api set: PowerPointApi 1.4]
122652
122831
  */
122653
- class ParagraphFormat extends OfficeExtension.ClientObject {
122654
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
122655
- context: RequestContext;
122832
+ enum TextVerticalAlignment {
122656
122833
  /**
122657
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
122658
- *
122834
+ * Specifies that the `TextFrame` should be top aligned to the `Shape`.
122659
122835
  * @remarks
122660
122836
  * [Api set: PowerPointApi 1.4]
122661
122837
  */
122662
- readonly bulletFormat: PowerPoint.BulletFormat;
122838
+ top = "Top",
122663
122839
  /**
122664
- * 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.
122665
- *
122840
+ * Specifies that the `TextFrame` should be center aligned to the `Shape`.
122666
122841
  * @remarks
122667
122842
  * [Api set: PowerPointApi 1.4]
122668
122843
  */
122669
- horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
122670
- /**
122671
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122672
- *
122673
- * @param options Provides options for which properties of the object to load.
122674
- */
122675
- load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
122676
- /**
122677
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122678
- *
122679
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
122680
- */
122681
- load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
122682
- /**
122683
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
122684
- *
122685
- * @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.
122686
- */
122687
- load(propertyNamesAndPaths?: {
122688
- select?: string;
122689
- expand?: string;
122690
- }): PowerPoint.ParagraphFormat;
122691
- /**
122692
- * 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.)
122693
- * 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.
122694
- */
122695
- toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
122696
- }
122697
- /**
122698
- * Represents the available options when adding shapes.
122699
- *
122700
- * @remarks
122701
- * [Api set: PowerPointApi 1.4]
122702
- */
122703
- interface ShapeAddOptions {
122844
+ middle = "Middle",
122704
122845
  /**
122705
- * Specifies the height, in points, of the shape.
122706
- When not provided, a default value will be used.
122707
- Throws an `InvalidArgument` exception when set with a negative value.
122708
- *
122846
+ * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
122709
122847
  * @remarks
122710
122848
  * [Api set: PowerPointApi 1.4]
122711
122849
  */
122712
- height?: number;
122850
+ bottom = "Bottom",
122713
122851
  /**
122714
- * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
122715
- When not provided, a default value will be used.
122716
- *
122852
+ * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
122717
122853
  * @remarks
122718
122854
  * [Api set: PowerPointApi 1.4]
122719
122855
  */
122720
- left?: number;
122856
+ topCentered = "TopCentered",
122721
122857
  /**
122722
- * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
122723
- When not provided, a default value will be used.
122724
- *
122858
+ * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
122725
122859
  * @remarks
122726
122860
  * [Api set: PowerPointApi 1.4]
122727
122861
  */
122728
- top?: number;
122862
+ middleCentered = "MiddleCentered",
122729
122863
  /**
122730
- * Specifies the width, in points, of the shape.
122731
- When not provided, a default value will be used.
122732
- Throws an `InvalidArgument` exception when set with a negative value.
122733
- *
122864
+ * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
122734
122865
  * @remarks
122735
122866
  * [Api set: PowerPointApi 1.4]
122736
122867
  */
122737
- width?: number;
122868
+ bottomCentered = "BottomCentered",
122738
122869
  }
122739
122870
  /**
122740
122871
  * Represents the collection of shapes.
@@ -122864,6 +122995,31 @@ declare namespace PowerPoint {
122864
122995
  */
122865
122996
  toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
122866
122997
  }
122998
+ /**
122999
+ * Represents the available options when getting an image of a slide.
123000
+ *
123001
+ * @remarks
123002
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123003
+ * @beta
123004
+ */
123005
+ interface SlideGetImageOptions {
123006
+ /**
123007
+ * The desired height of the resulting image in pixels.
123008
+ *
123009
+ * @remarks
123010
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123011
+ * @beta
123012
+ */
123013
+ height?: number;
123014
+ /**
123015
+ * The desired width of the resulting image in pixels.
123016
+ *
123017
+ * @remarks
123018
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123019
+ * @beta
123020
+ */
123021
+ width?: number;
123022
+ }
122867
123023
  /**
122868
123024
  * Represents the layout of a slide.
122869
123025
  *
@@ -123121,22 +123277,22 @@ declare namespace PowerPoint {
123121
123277
  /** Gets the loaded child items in this collection. */
123122
123278
  readonly items: PowerPoint.Tag[];
123123
123279
  /**
123124
- * 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`.
123280
+ * 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`.
123125
123281
  *
123126
123282
  * @remarks
123127
123283
  * [Api set: PowerPointApi 1.3]
123128
123284
  *
123129
- * @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.
123285
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. The key string is capitalized when saved in the document.
123130
123286
  * @param value The value of the tag.
123131
123287
  */
123132
123288
  add(key: string, value: string): void;
123133
123289
  /**
123134
- * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
123290
+ * Deletes the tag with the given key in this collection. Does nothing if the key does not exist.
123135
123291
  *
123136
123292
  * @remarks
123137
123293
  * [Api set: PowerPointApi 1.3]
123138
123294
  *
123139
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
123295
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. This parameter is case-insensitive.
123140
123296
  */
123141
123297
  delete(key: string): void;
123142
123298
  /**
@@ -123153,7 +123309,7 @@ declare namespace PowerPoint {
123153
123309
  * @remarks
123154
123310
  * [Api set: PowerPointApi 1.3]
123155
123311
  *
123156
- * @param key The ID of the tag. The `key` parameter is case-sensitive.
123312
+ * @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
123157
123313
  * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
123158
123314
  */
123159
123315
  getItem(key: string): PowerPoint.Tag;
@@ -123173,7 +123329,7 @@ declare namespace PowerPoint {
123173
123329
  * @remarks
123174
123330
  * [Api set: PowerPointApi 1.3]
123175
123331
  *
123176
- * @param key The ID of the tag. The `key` parameter is case-sensitive.
123332
+ * @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
123177
123333
  * @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.
123178
123334
  */
123179
123335
  getItemOrNullObject(key: string): PowerPoint.Tag;
@@ -123252,6 +123408,27 @@ declare namespace PowerPoint {
123252
123408
  * [Api set: PowerPointApi 1.2]
123253
123409
  */
123254
123410
  delete(): void;
123411
+ /**
123412
+ * Exports the slide to its own presentation file, returned as base64-encoded data.
123413
+ *
123414
+ * @remarks
123415
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123416
+ * @beta
123417
+ */
123418
+ exportAsBase64(): OfficeExtension.ClientResult<string>;
123419
+ /**
123420
+ * Renders an image of the slide. The image is scaled to fit into the desired dimensions.
123421
+ If width and height aren't specified, the true size of the slide is used. If only one
123422
+ of either width or height is specified, the other will be calculated to preserve aspect ratio.
123423
+ *
123424
+ * @remarks
123425
+ * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
123426
+ * @beta
123427
+ *
123428
+ * @param options Optional. Options to specify the desired size of the slide image.
123429
+ * @returns A base64 string of the slide image in PNG format.
123430
+ */
123431
+ getImageAsBase64(options?: PowerPoint.SlideGetImageOptions): OfficeExtension.ClientResult<string>;
123255
123432
  /**
123256
123433
  * Selects the specified shapes. Existing shape selection is replaced with the new selection.
123257
123434
  *
@@ -123443,86 +123620,6 @@ declare namespace PowerPoint {
123443
123620
  */
123444
123621
  thinThin = "ThinThin",
123445
123622
  }
123446
- /**
123447
- * Specifies the dash style for a line.
123448
- *
123449
- * @remarks
123450
- * [Api set: PowerPointApi 1.4]
123451
- */
123452
- enum ShapeLineDashStyle {
123453
- /**
123454
- * The dash line pattern
123455
- * @remarks
123456
- * [Api set: PowerPointApi 1.4]
123457
- */
123458
- dash = "Dash",
123459
- /**
123460
- * The dash-dot line pattern
123461
- * @remarks
123462
- * [Api set: PowerPointApi 1.4]
123463
- */
123464
- dashDot = "DashDot",
123465
- /**
123466
- * The dash-dot-dot line pattern
123467
- * @remarks
123468
- * [Api set: PowerPointApi 1.4]
123469
- */
123470
- dashDotDot = "DashDotDot",
123471
- /**
123472
- * The long dash line pattern
123473
- * @remarks
123474
- * [Api set: PowerPointApi 1.4]
123475
- */
123476
- longDash = "LongDash",
123477
- /**
123478
- * The long dash-dot line pattern
123479
- * @remarks
123480
- * [Api set: PowerPointApi 1.4]
123481
- */
123482
- longDashDot = "LongDashDot",
123483
- /**
123484
- * The round dot line pattern
123485
- * @remarks
123486
- * [Api set: PowerPointApi 1.4]
123487
- */
123488
- roundDot = "RoundDot",
123489
- /**
123490
- * The solid line pattern
123491
- * @remarks
123492
- * [Api set: PowerPointApi 1.4]
123493
- */
123494
- solid = "Solid",
123495
- /**
123496
- * The square dot line pattern
123497
- * @remarks
123498
- * [Api set: PowerPointApi 1.4]
123499
- */
123500
- squareDot = "SquareDot",
123501
- /**
123502
- * The long dash-dot-dot line pattern
123503
- * @remarks
123504
- * [Api set: PowerPointApi 1.4]
123505
- */
123506
- longDashDotDot = "LongDashDotDot",
123507
- /**
123508
- * The system dash line pattern
123509
- * @remarks
123510
- * [Api set: PowerPointApi 1.4]
123511
- */
123512
- systemDash = "SystemDash",
123513
- /**
123514
- * The system dot line pattern
123515
- * @remarks
123516
- * [Api set: PowerPointApi 1.4]
123517
- */
123518
- systemDot = "SystemDot",
123519
- /**
123520
- * The system dash-dot line pattern
123521
- * @remarks
123522
- * [Api set: PowerPointApi 1.4]
123523
- */
123524
- systemDashDot = "SystemDashDot",
123525
- }
123526
123623
  /**
123527
123624
  * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
123528
123625
  *
@@ -123638,6 +123735,12 @@ declare namespace PowerPoint {
123638
123735
  * [Api set: PowerPointApi 1.4]
123639
123736
  */
123640
123737
  line = "Line",
123738
+ /**
123739
+ * The shape is a table
123740
+ * @remarks
123741
+ * [Api set: PowerPointApi 1.4]
123742
+ */
123743
+ table = "Table",
123641
123744
  }
123642
123745
  /**
123643
123746
  * Determines the type of automatic sizing allowed.
@@ -123672,160 +123775,97 @@ declare namespace PowerPoint {
123672
123775
  autoSizeMixed = "AutoSizeMixed",
123673
123776
  }
123674
123777
  /**
123675
- * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
123676
- If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
123677
- To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
123778
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
123678
123779
  *
123679
123780
  * @remarks
123680
123781
  * [Api set: PowerPointApi 1.4]
123681
123782
  */
123682
- enum TextVerticalAlignment {
123683
- /**
123684
- * Specifies that the `TextFrame` should be top aligned to the `Shape`.
123685
- * @remarks
123686
- * [Api set: PowerPointApi 1.4]
123687
- */
123688
- top = "Top",
123783
+ class BulletFormat extends OfficeExtension.ClientObject {
123784
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
123785
+ context: RequestContext;
123689
123786
  /**
123690
- * Specifies that the `TextFrame` should be center aligned to the `Shape`.
123787
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
123788
+ *
123691
123789
  * @remarks
123692
123790
  * [Api set: PowerPointApi 1.4]
123693
123791
  */
123694
- middle = "Middle",
123792
+ visible: boolean;
123695
123793
  /**
123696
- * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
123697
- * @remarks
123698
- * [Api set: PowerPointApi 1.4]
123794
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123795
+ *
123796
+ * @param options Provides options for which properties of the object to load.
123699
123797
  */
123700
- bottom = "Bottom",
123798
+ load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
123701
123799
  /**
123702
- * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
123703
- * @remarks
123704
- * [Api set: PowerPointApi 1.4]
123800
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123801
+ *
123802
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
123705
123803
  */
123706
- topCentered = "TopCentered",
123804
+ load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
123707
123805
  /**
123708
- * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
123709
- * @remarks
123710
- * [Api set: PowerPointApi 1.4]
123806
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123807
+ *
123808
+ * @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.
123711
123809
  */
123712
- middleCentered = "MiddleCentered",
123810
+ load(propertyNamesAndPaths?: {
123811
+ select?: string;
123812
+ expand?: string;
123813
+ }): PowerPoint.BulletFormat;
123713
123814
  /**
123714
- * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
123715
- * @remarks
123716
- * [Api set: PowerPointApi 1.4]
123717
- */
123718
- bottomCentered = "BottomCentered",
123815
+ * 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.)
123816
+ * 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.
123817
+ */
123818
+ toJSON(): PowerPoint.Interfaces.BulletFormatData;
123719
123819
  }
123720
123820
  /**
123721
- * The type of underline applied to a font.
123821
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
123722
123822
  *
123723
123823
  * @remarks
123724
123824
  * [Api set: PowerPointApi 1.4]
123725
123825
  */
123726
- enum ShapeFontUnderlineStyle {
123727
- /**
123728
- * No underlining.
123729
- * @remarks
123730
- * [Api set: PowerPointApi 1.4]
123731
- */
123732
- none = "None",
123733
- /**
123734
- * Regular single line underlining.
123735
- * @remarks
123736
- * [Api set: PowerPointApi 1.4]
123737
- */
123738
- single = "Single",
123739
- /**
123740
- * Underlining of text with double lines.
123741
- * @remarks
123742
- * [Api set: PowerPointApi 1.4]
123743
- */
123744
- double = "Double",
123745
- /**
123746
- * Underlining of text with a thick line.
123747
- * @remarks
123748
- * [Api set: PowerPointApi 1.4]
123749
- */
123750
- heavy = "Heavy",
123751
- /**
123752
- * Underlining of text with a dotted line.
123753
- * @remarks
123754
- * [Api set: PowerPointApi 1.4]
123755
- */
123756
- dotted = "Dotted",
123757
- /**
123758
- * Underlining of text with a thick, dotted line.
123759
- * @remarks
123760
- * [Api set: PowerPointApi 1.4]
123761
- */
123762
- dottedHeavy = "DottedHeavy",
123763
- /**
123764
- * Underlining of text with a line containing dashes.
123765
- * @remarks
123766
- * [Api set: PowerPointApi 1.4]
123767
- */
123768
- dash = "Dash",
123769
- /**
123770
- * Underlining of text with a thick line containing dashes.
123771
- * @remarks
123772
- * [Api set: PowerPointApi 1.4]
123773
- */
123774
- dashHeavy = "DashHeavy",
123775
- /**
123776
- * Underlining of text with a line containing long dashes.
123777
- * @remarks
123778
- * [Api set: PowerPointApi 1.4]
123779
- */
123780
- dashLong = "DashLong",
123781
- /**
123782
- * Underlining of text with a thick line containing long dashes.
123783
- * @remarks
123784
- * [Api set: PowerPointApi 1.4]
123785
- */
123786
- dashLongHeavy = "DashLongHeavy",
123787
- /**
123788
- * Underlining of text with a line containing dots and dashes.
123789
- * @remarks
123790
- * [Api set: PowerPointApi 1.4]
123791
- */
123792
- dotDash = "DotDash",
123826
+ class ParagraphFormat extends OfficeExtension.ClientObject {
123827
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
123828
+ context: RequestContext;
123793
123829
  /**
123794
- * Underlining of text with a thick line containing dots and dashes.
123830
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
123831
+ *
123795
123832
  * @remarks
123796
123833
  * [Api set: PowerPointApi 1.4]
123797
123834
  */
123798
- dotDashHeavy = "DotDashHeavy",
123835
+ readonly bulletFormat: PowerPoint.BulletFormat;
123799
123836
  /**
123800
- * Underlining of text with a line containing double dots and dashes.
123837
+ * 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.
123838
+ *
123801
123839
  * @remarks
123802
123840
  * [Api set: PowerPointApi 1.4]
123803
123841
  */
123804
- dotDotDash = "DotDotDash",
123842
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
123805
123843
  /**
123806
- * Underlining of text with a thick line containing double dots and dashes.
123807
- * @remarks
123808
- * [Api set: PowerPointApi 1.4]
123844
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123845
+ *
123846
+ * @param options Provides options for which properties of the object to load.
123809
123847
  */
123810
- dotDotDashHeavy = "DotDotDashHeavy",
123848
+ load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
123811
123849
  /**
123812
- * Underlining of text with a wavy line.
123813
- * @remarks
123814
- * [Api set: PowerPointApi 1.4]
123850
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123851
+ *
123852
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
123815
123853
  */
123816
- wavy = "Wavy",
123854
+ load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
123817
123855
  /**
123818
- * Underlining of text with a thick, wavy line.
123819
- * @remarks
123820
- * [Api set: PowerPointApi 1.4]
123856
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
123857
+ *
123858
+ * @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.
123821
123859
  */
123822
- wavyHeavy = "WavyHeavy",
123860
+ load(propertyNamesAndPaths?: {
123861
+ select?: string;
123862
+ expand?: string;
123863
+ }): PowerPoint.ParagraphFormat;
123823
123864
  /**
123824
- * Underlining of text with double wavy lines.
123825
- * @remarks
123826
- * [Api set: PowerPointApi 1.4]
123827
- */
123828
- wavyDouble = "WavyDouble",
123865
+ * 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.)
123866
+ * 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.
123867
+ */
123868
+ toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
123829
123869
  }
123830
123870
  /**
123831
123871
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -124193,7 +124233,7 @@ declare namespace PowerPoint {
124193
124233
  * @remarks
124194
124234
  * [Api set: PowerPointApi 1.4]
124195
124235
  */
124196
- readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
124236
+ readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
124197
124237
  /**
124198
124238
  * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
124199
124239
  *
@@ -124277,6 +124317,61 @@ declare namespace PowerPoint {
124277
124317
  */
124278
124318
  toJSON(): PowerPoint.Interfaces.ShapeData;
124279
124319
  }
124320
+ /**
124321
+ * Specifies the formatting options for when slides are inserted.
124322
+ *
124323
+ * @remarks
124324
+ * [Api set: PowerPointApi 1.2]
124325
+ */
124326
+ enum InsertSlideFormatting {
124327
+ /**
124328
+ * Copy the source theme into the target presentation and use that theme.
124329
+ * @remarks
124330
+ * [Api set: PowerPointApi 1.2]
124331
+ */
124332
+ keepSourceFormatting = "KeepSourceFormatting",
124333
+ /**
124334
+ * Use the existing theme in the target presentation.
124335
+ * @remarks
124336
+ * [Api set: PowerPointApi 1.2]
124337
+ */
124338
+ useDestinationTheme = "UseDestinationTheme",
124339
+ }
124340
+ /**
124341
+ * Represents the available options when inserting slides.
124342
+ *
124343
+ * @remarks
124344
+ * [Api set: PowerPointApi 1.2]
124345
+ */
124346
+ interface InsertSlideOptions {
124347
+ /**
124348
+ * Specifies which formatting to use during slide insertion.
124349
+ The default option is to use "KeepSourceFormatting".
124350
+ *
124351
+ * @remarks
124352
+ * [Api set: PowerPointApi 1.2]
124353
+ */
124354
+ formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
124355
+ /**
124356
+ * 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.
124357
+ The order of these slides is preserved during the insertion.
124358
+ 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.
124359
+ All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
124360
+ *
124361
+ * @remarks
124362
+ * [Api set: PowerPointApi 1.2]
124363
+ */
124364
+ sourceSlideIds?: string[];
124365
+ /**
124366
+ * 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.
124367
+ If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
124368
+ 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.
124369
+ *
124370
+ * @remarks
124371
+ * [Api set: PowerPointApi 1.2]
124372
+ */
124373
+ targetSlideId?: string;
124374
+ }
124280
124375
  /**
124281
124376
  * Represents a collection of shapes.
124282
124377
  *
@@ -124601,26 +124696,6 @@ declare namespace PowerPoint {
124601
124696
  */
124602
124697
  $skip?: number;
124603
124698
  }
124604
- /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
124605
- interface BulletFormatUpdateData {
124606
- /**
124607
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
124608
- *
124609
- * @remarks
124610
- * [Api set: PowerPointApi 1.4]
124611
- */
124612
- visible?: boolean;
124613
- }
124614
- /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
124615
- interface ParagraphFormatUpdateData {
124616
- /**
124617
- * 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.
124618
- *
124619
- * @remarks
124620
- * [Api set: PowerPointApi 1.4]
124621
- */
124622
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
124623
- }
124624
124699
  /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
124625
124700
  interface ShapeCollectionUpdateData {
124626
124701
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -124705,6 +124780,26 @@ declare namespace PowerPoint {
124705
124780
  */
124706
124781
  weight?: number;
124707
124782
  }
124783
+ /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
124784
+ interface BulletFormatUpdateData {
124785
+ /**
124786
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
124787
+ *
124788
+ * @remarks
124789
+ * [Api set: PowerPointApi 1.4]
124790
+ */
124791
+ visible?: boolean;
124792
+ }
124793
+ /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
124794
+ interface ParagraphFormatUpdateData {
124795
+ /**
124796
+ * 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.
124797
+ *
124798
+ * @remarks
124799
+ * [Api set: PowerPointApi 1.4]
124800
+ */
124801
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
124802
+ }
124708
124803
  /** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
124709
124804
  interface ShapeFontUpdateData {
124710
124805
  /**
@@ -124884,27 +124979,14 @@ declare namespace PowerPoint {
124884
124979
  }
124885
124980
  /** An interface describing the data returned by calling `presentation.toJSON()`. */
124886
124981
  interface PresentationData {
124887
- title?: string;
124888
- }
124889
- /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
124890
- interface BulletFormatData {
124891
- /**
124892
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
124893
- *
124894
- * @remarks
124895
- * [Api set: PowerPointApi 1.4]
124896
- */
124897
- visible?: boolean;
124898
- }
124899
- /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
124900
- interface ParagraphFormatData {
124901
124982
  /**
124902
- * 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.
124983
+ * Gets the ID of the presentation.
124903
124984
  *
124904
124985
  * @remarks
124905
- * [Api set: PowerPointApi 1.4]
124986
+ * [Api set: PowerPointApi 1.5]
124906
124987
  */
124907
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
124988
+ id?: string;
124989
+ title?: string;
124908
124990
  }
124909
124991
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
124910
124992
  interface ShapeCollectionData {
@@ -125048,6 +125130,26 @@ declare namespace PowerPoint {
125048
125130
  */
125049
125131
  weight?: number;
125050
125132
  }
125133
+ /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
125134
+ interface BulletFormatData {
125135
+ /**
125136
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
125137
+ *
125138
+ * @remarks
125139
+ * [Api set: PowerPointApi 1.4]
125140
+ */
125141
+ visible?: boolean;
125142
+ }
125143
+ /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
125144
+ interface ParagraphFormatData {
125145
+ /**
125146
+ * 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.
125147
+ *
125148
+ * @remarks
125149
+ * [Api set: PowerPointApi 1.4]
125150
+ */
125151
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
125152
+ }
125051
125153
  /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
125052
125154
  interface ShapeFontData {
125053
125155
  /**
@@ -125221,7 +125323,7 @@ declare namespace PowerPoint {
125221
125323
  * @remarks
125222
125324
  * [Api set: PowerPointApi 1.4]
125223
125325
  */
125224
- type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
125326
+ type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
125225
125327
  /**
125226
125328
  * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
125227
125329
  *
@@ -125251,56 +125353,18 @@ declare namespace PowerPoint {
125251
125353
  * [Api set: PowerPointApi 1.0]
125252
125354
  */
125253
125355
  interface PresentationLoadOptions {
125254
- /**
125255
- 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`).
125256
- */
125257
- $all?: boolean;
125258
- title?: boolean;
125259
- }
125260
- /**
125261
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
125262
- *
125263
- * @remarks
125264
- * [Api set: PowerPointApi 1.4]
125265
- */
125266
- interface BulletFormatLoadOptions {
125267
125356
  /**
125268
125357
  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`).
125269
125358
  */
125270
125359
  $all?: boolean;
125271
125360
  /**
125272
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
125361
+ * Gets the ID of the presentation.
125273
125362
  *
125274
125363
  * @remarks
125275
- * [Api set: PowerPointApi 1.4]
125276
- */
125277
- visible?: boolean;
125278
- }
125279
- /**
125280
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
125281
- *
125282
- * @remarks
125283
- * [Api set: PowerPointApi 1.4]
125284
- */
125285
- interface ParagraphFormatLoadOptions {
125286
- /**
125287
- 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`).
125288
- */
125289
- $all?: boolean;
125290
- /**
125291
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
125292
- *
125293
- * @remarks
125294
- * [Api set: PowerPointApi 1.4]
125295
- */
125296
- bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
125297
- /**
125298
- * 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.
125299
- *
125300
- * @remarks
125301
- * [Api set: PowerPointApi 1.4]
125364
+ * [Api set: PowerPointApi 1.5]
125302
125365
  */
125303
- horizontalAlignment?: boolean;
125366
+ id?: boolean;
125367
+ title?: boolean;
125304
125368
  }
125305
125369
  /**
125306
125370
  * Represents the collection of shapes.
@@ -125634,6 +125698,51 @@ declare namespace PowerPoint {
125634
125698
  */
125635
125699
  weight?: boolean;
125636
125700
  }
125701
+ /**
125702
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
125703
+ *
125704
+ * @remarks
125705
+ * [Api set: PowerPointApi 1.4]
125706
+ */
125707
+ interface BulletFormatLoadOptions {
125708
+ /**
125709
+ 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`).
125710
+ */
125711
+ $all?: boolean;
125712
+ /**
125713
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
125714
+ *
125715
+ * @remarks
125716
+ * [Api set: PowerPointApi 1.4]
125717
+ */
125718
+ visible?: boolean;
125719
+ }
125720
+ /**
125721
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
125722
+ *
125723
+ * @remarks
125724
+ * [Api set: PowerPointApi 1.4]
125725
+ */
125726
+ interface ParagraphFormatLoadOptions {
125727
+ /**
125728
+ 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`).
125729
+ */
125730
+ $all?: boolean;
125731
+ /**
125732
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
125733
+ *
125734
+ * @remarks
125735
+ * [Api set: PowerPointApi 1.4]
125736
+ */
125737
+ bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
125738
+ /**
125739
+ * 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.
125740
+ *
125741
+ * @remarks
125742
+ * [Api set: PowerPointApi 1.4]
125743
+ */
125744
+ horizontalAlignment?: boolean;
125745
+ }
125637
125746
  /**
125638
125747
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
125639
125748
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.458",
3
+ "version": "1.0.459",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,7 +45,7 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "cecd1f6b0ef9fb9f807df77422ba586803f5344ad77fed0ae1311593787ec02a",
48
+ "typesPublisherContentHash": "2d57a9d62eb0100a08fbfd514d6790146b0bfd1209e54d070281ec7ea46a4dac",
49
49
  "typeScriptVersion": "4.7",
50
50
  "nonNpm": true
51
51
  }