@types/office-js 1.0.377 → 1.0.379

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 +460 -442
  3. office-js/package.json +2 -2
office-js/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 07 Mar 2024 19:06:39 GMT
11
+ * Last updated: Mon, 08 Apr 2024 18:09:13 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
office-js/index.d.ts CHANGED
@@ -11129,9 +11129,9 @@ declare namespace Office {
11129
11129
  */
11130
11130
  enhancedLocation: EnhancedLocation;
11131
11131
  /**
11132
- * Gets the Exchange Web Services item class of the selected item.
11132
+ * Gets the Exchange Web Services item class of the selected appointment.
11133
11133
  *
11134
- * You can create custom message classes that extends a default message class, for example, a custom appointment message class `IPM.Appointment.Contoso`.
11134
+ * Returns `IPM.Appointment` for non-recurring appointments and `IPM.Appointment.Occurrence` for recurring appointments.
11135
11135
  *
11136
11136
  * @remarks
11137
11137
  *
@@ -11139,26 +11139,7 @@ declare namespace Office {
11139
11139
  *
11140
11140
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee
11141
11141
  *
11142
- * The `itemClass` property specifies the message class of the selected item. The following are the default message classes for the message or appointment item.
11143
- *
11144
- * <table>
11145
- * <tr>
11146
- * <th>Type</th>
11147
- * <th>Description</th>
11148
- * <th>Item Class</th>
11149
- * </tr>
11150
- * <tr>
11151
- * <td>Appointment items</td>
11152
- * <td>These are calendar items of the item class IPM.Appointment or IPM.Appointment.Occurrence.</td>
11153
- * <td>IPM.Appointment, IPM.Appointment.Occurrence</td>
11154
- * </tr>
11155
- * <tr>
11156
- * <td>Message items</td>
11157
- * <td>These include email messages that have the default message class IPM.Note, and meeting requests, responses, and cancellations, that use IPM.Schedule.Meeting as the base message class.</td>
11158
- * <td>IPM.Note, IPM.Schedule.Meeting.Request, IPM.Schedule.Meeting.Neg, IPM.Schedule.Meeting.Pos, IPM.Schedule.Meeting.Tent, IPM.Schedule.Meeting.Canceled</td>
11159
- * </tr>
11160
- * </table>
11161
- *
11142
+ * **Important**: You can create custom classes that extend a default item class. For example, `IPM.Appointment.Contoso`.
11162
11143
  */
11163
11144
  itemClass: string;
11164
11145
  /**
@@ -37639,6 +37620,7 @@ declare namespace Excel {
37639
37620
  markerForegroundColor: string;
37640
37621
  /**
37641
37622
  * Specifies the marker size of a chart series.
37623
+ 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.
37642
37624
  *
37643
37625
  * @remarks
37644
37626
  * [Api set: ExcelApi 1.7]
@@ -38020,6 +38002,7 @@ declare namespace Excel {
38020
38002
  markerForegroundColor: string;
38021
38003
  /**
38022
38004
  * Represents marker size of a data point.
38005
+ 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.
38023
38006
  *
38024
38007
  * @remarks
38025
38008
  * [Api set: ExcelApi 1.7]
@@ -62748,6 +62731,7 @@ declare namespace Excel {
62748
62731
  markerForegroundColor?: string;
62749
62732
  /**
62750
62733
  * Specifies the marker size of a chart series.
62734
+ 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.
62751
62735
  *
62752
62736
  * @remarks
62753
62737
  * [Api set: ExcelApi 1.7]
@@ -62898,6 +62882,7 @@ declare namespace Excel {
62898
62882
  markerForegroundColor?: string;
62899
62883
  /**
62900
62884
  * Represents marker size of a data point.
62885
+ 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.
62901
62886
  *
62902
62887
  * @remarks
62903
62888
  * [Api set: ExcelApi 1.7]
@@ -68555,6 +68540,7 @@ declare namespace Excel {
68555
68540
  markerForegroundColor?: string;
68556
68541
  /**
68557
68542
  * Specifies the marker size of a chart series.
68543
+ 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.
68558
68544
  *
68559
68545
  * @remarks
68560
68546
  * [Api set: ExcelApi 1.7]
@@ -68705,6 +68691,7 @@ declare namespace Excel {
68705
68691
  markerForegroundColor?: string;
68706
68692
  /**
68707
68693
  * Represents marker size of a data point.
68694
+ 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.
68708
68695
  *
68709
68696
  * @remarks
68710
68697
  * [Api set: ExcelApi 1.7]
@@ -76392,6 +76379,7 @@ declare namespace Excel {
76392
76379
  markerForegroundColor?: boolean;
76393
76380
  /**
76394
76381
  * For EACH ITEM in the collection: Specifies the marker size of a chart series.
76382
+ 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.
76395
76383
  *
76396
76384
  * @remarks
76397
76385
  * [Api set: ExcelApi 1.7]
@@ -76721,6 +76709,7 @@ declare namespace Excel {
76721
76709
  markerForegroundColor?: boolean;
76722
76710
  /**
76723
76711
  * Specifies the marker size of a chart series.
76712
+ 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.
76724
76713
  *
76725
76714
  * @remarks
76726
76715
  * [Api set: ExcelApi 1.7]
@@ -76885,6 +76874,7 @@ declare namespace Excel {
76885
76874
  markerForegroundColor?: boolean;
76886
76875
  /**
76887
76876
  * For EACH ITEM in the collection: Represents marker size of a data point.
76877
+ 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.
76888
76878
  *
76889
76879
  * @remarks
76890
76880
  * [Api set: ExcelApi 1.7]
@@ -76953,6 +76943,7 @@ declare namespace Excel {
76953
76943
  markerForegroundColor?: boolean;
76954
76944
  /**
76955
76945
  * Represents marker size of a data point.
76946
+ 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.
76956
76947
  *
76957
76948
  * @remarks
76958
76949
  * [Api set: ExcelApi 1.7]
@@ -113037,6 +113028,13 @@ declare namespace PowerPoint {
113037
113028
  * [Api set: PowerPointApi 1.3]
113038
113029
  */
113039
113030
  readonly tags: PowerPoint.TagCollection;
113031
+ /**
113032
+ * Gets the ID of the presentation.
113033
+ *
113034
+ * @remarks
113035
+ * [Api set: PowerPointApi 1.5]
113036
+ */
113037
+ readonly id: string;
113040
113038
  readonly title: string;
113041
113039
  /**
113042
113040
  * Returns the selected shapes in the current slide of the presentation.
@@ -113144,49 +113142,6 @@ declare namespace PowerPoint {
113144
113142
  */
113145
113143
  slideMasterId?: string;
113146
113144
  }
113147
- /**
113148
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
113149
- *
113150
- * @remarks
113151
- * [Api set: PowerPointApi 1.4]
113152
- */
113153
- class BulletFormat extends OfficeExtension.ClientObject {
113154
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
113155
- context: RequestContext;
113156
- /**
113157
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
113158
- *
113159
- * @remarks
113160
- * [Api set: PowerPointApi 1.4]
113161
- */
113162
- visible: boolean;
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 options Provides options for which properties of the object to load.
113167
- */
113168
- load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
113169
- /**
113170
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
113171
- *
113172
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
113173
- */
113174
- load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
113175
- /**
113176
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
113177
- *
113178
- * @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.
113179
- */
113180
- load(propertyNamesAndPaths?: {
113181
- select?: string;
113182
- expand?: string;
113183
- }): PowerPoint.BulletFormat;
113184
- /**
113185
- * 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.)
113186
- * 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.
113187
- */
113188
- toJSON(): PowerPoint.Interfaces.BulletFormatData;
113189
- }
113190
113145
  /**
113191
113146
  * Specifies the connector type for line shapes.
113192
113147
  *
@@ -114284,59 +114239,236 @@ declare namespace PowerPoint {
114284
114239
  chartPlus = "ChartPlus",
114285
114240
  }
114286
114241
  /**
114287
- * Specifies the formatting options for when slides are inserted.
114242
+ * Represents the available options when adding shapes.
114288
114243
  *
114289
114244
  * @remarks
114290
- * [Api set: PowerPointApi 1.2]
114245
+ * [Api set: PowerPointApi 1.4]
114291
114246
  */
114292
- enum InsertSlideFormatting {
114247
+ interface ShapeAddOptions {
114293
114248
  /**
114294
- * Copy the source theme into the target presentation and use that theme.
114249
+ * Specifies the height, in points, of the shape.
114250
+ When not provided, a default value will be used.
114251
+ Throws an `InvalidArgument` exception when set with a negative value.
114252
+ *
114295
114253
  * @remarks
114296
- * [Api set: PowerPointApi 1.2]
114254
+ * [Api set: PowerPointApi 1.4]
114297
114255
  */
114298
- keepSourceFormatting = "KeepSourceFormatting",
114256
+ height?: number;
114299
114257
  /**
114300
- * Use the existing theme in the target presentation.
114258
+ * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
114259
+ When not provided, a default value will be used.
114260
+ *
114301
114261
  * @remarks
114302
- * [Api set: PowerPointApi 1.2]
114262
+ * [Api set: PowerPointApi 1.4]
114303
114263
  */
114304
- useDestinationTheme = "UseDestinationTheme",
114264
+ left?: number;
114265
+ /**
114266
+ * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
114267
+ When not provided, a default value will be used.
114268
+ *
114269
+ * @remarks
114270
+ * [Api set: PowerPointApi 1.4]
114271
+ */
114272
+ top?: number;
114273
+ /**
114274
+ * Specifies the width, in points, of the shape.
114275
+ When not provided, a default value will be used.
114276
+ Throws an `InvalidArgument` exception when set with a negative value.
114277
+ *
114278
+ * @remarks
114279
+ * [Api set: PowerPointApi 1.4]
114280
+ */
114281
+ width?: number;
114305
114282
  }
114306
114283
  /**
114307
- * Represents the available options when inserting slides.
114284
+ * Specifies the dash style for a line.
114308
114285
  *
114309
114286
  * @remarks
114310
- * [Api set: PowerPointApi 1.2]
114287
+ * [Api set: PowerPointApi 1.4]
114311
114288
  */
114312
- interface InsertSlideOptions {
114289
+ enum ShapeLineDashStyle {
114313
114290
  /**
114314
- * Specifies which formatting to use during slide insertion.
114315
- The default option is to use "KeepSourceFormatting".
114316
- *
114291
+ * The dash line pattern
114317
114292
  * @remarks
114318
- * [Api set: PowerPointApi 1.2]
114293
+ * [Api set: PowerPointApi 1.4]
114319
114294
  */
114320
- formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
114295
+ dash = "Dash",
114321
114296
  /**
114322
- * 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.
114323
- The order of these slides is preserved during the insertion.
114324
- 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.
114325
- All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
114326
- *
114297
+ * The dash-dot line pattern
114327
114298
  * @remarks
114328
- * [Api set: PowerPointApi 1.2]
114299
+ * [Api set: PowerPointApi 1.4]
114329
114300
  */
114330
- sourceSlideIds?: string[];
114301
+ dashDot = "DashDot",
114331
114302
  /**
114332
- * 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.
114333
- If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
114334
- 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.
114335
- *
114303
+ * The dash-dot-dot line pattern
114336
114304
  * @remarks
114337
- * [Api set: PowerPointApi 1.2]
114305
+ * [Api set: PowerPointApi 1.4]
114338
114306
  */
114339
- targetSlideId?: string;
114307
+ dashDotDot = "DashDotDot",
114308
+ /**
114309
+ * The long dash line pattern
114310
+ * @remarks
114311
+ * [Api set: PowerPointApi 1.4]
114312
+ */
114313
+ longDash = "LongDash",
114314
+ /**
114315
+ * The long dash-dot line pattern
114316
+ * @remarks
114317
+ * [Api set: PowerPointApi 1.4]
114318
+ */
114319
+ longDashDot = "LongDashDot",
114320
+ /**
114321
+ * The round dot line pattern
114322
+ * @remarks
114323
+ * [Api set: PowerPointApi 1.4]
114324
+ */
114325
+ roundDot = "RoundDot",
114326
+ /**
114327
+ * The solid line pattern
114328
+ * @remarks
114329
+ * [Api set: PowerPointApi 1.4]
114330
+ */
114331
+ solid = "Solid",
114332
+ /**
114333
+ * The square dot line pattern
114334
+ * @remarks
114335
+ * [Api set: PowerPointApi 1.4]
114336
+ */
114337
+ squareDot = "SquareDot",
114338
+ /**
114339
+ * The long dash-dot-dot line pattern
114340
+ * @remarks
114341
+ * [Api set: PowerPointApi 1.4]
114342
+ */
114343
+ longDashDotDot = "LongDashDotDot",
114344
+ /**
114345
+ * The system dash line pattern
114346
+ * @remarks
114347
+ * [Api set: PowerPointApi 1.4]
114348
+ */
114349
+ systemDash = "SystemDash",
114350
+ /**
114351
+ * The system dot line pattern
114352
+ * @remarks
114353
+ * [Api set: PowerPointApi 1.4]
114354
+ */
114355
+ systemDot = "SystemDot",
114356
+ /**
114357
+ * The system dash-dot line pattern
114358
+ * @remarks
114359
+ * [Api set: PowerPointApi 1.4]
114360
+ */
114361
+ systemDashDot = "SystemDashDot",
114362
+ }
114363
+ /**
114364
+ * The type of underline applied to a font.
114365
+ *
114366
+ * @remarks
114367
+ * [Api set: PowerPointApi 1.4]
114368
+ */
114369
+ enum ShapeFontUnderlineStyle {
114370
+ /**
114371
+ * No underlining.
114372
+ * @remarks
114373
+ * [Api set: PowerPointApi 1.4]
114374
+ */
114375
+ none = "None",
114376
+ /**
114377
+ * Regular single line underlining.
114378
+ * @remarks
114379
+ * [Api set: PowerPointApi 1.4]
114380
+ */
114381
+ single = "Single",
114382
+ /**
114383
+ * Underlining of text with double lines.
114384
+ * @remarks
114385
+ * [Api set: PowerPointApi 1.4]
114386
+ */
114387
+ double = "Double",
114388
+ /**
114389
+ * Underlining of text with a thick line.
114390
+ * @remarks
114391
+ * [Api set: PowerPointApi 1.4]
114392
+ */
114393
+ heavy = "Heavy",
114394
+ /**
114395
+ * Underlining of text with a dotted line.
114396
+ * @remarks
114397
+ * [Api set: PowerPointApi 1.4]
114398
+ */
114399
+ dotted = "Dotted",
114400
+ /**
114401
+ * Underlining of text with a thick, dotted line.
114402
+ * @remarks
114403
+ * [Api set: PowerPointApi 1.4]
114404
+ */
114405
+ dottedHeavy = "DottedHeavy",
114406
+ /**
114407
+ * Underlining of text with a line containing dashes.
114408
+ * @remarks
114409
+ * [Api set: PowerPointApi 1.4]
114410
+ */
114411
+ dash = "Dash",
114412
+ /**
114413
+ * Underlining of text with a thick line containing dashes.
114414
+ * @remarks
114415
+ * [Api set: PowerPointApi 1.4]
114416
+ */
114417
+ dashHeavy = "DashHeavy",
114418
+ /**
114419
+ * Underlining of text with a line containing long dashes.
114420
+ * @remarks
114421
+ * [Api set: PowerPointApi 1.4]
114422
+ */
114423
+ dashLong = "DashLong",
114424
+ /**
114425
+ * Underlining of text with a thick line containing long dashes.
114426
+ * @remarks
114427
+ * [Api set: PowerPointApi 1.4]
114428
+ */
114429
+ dashLongHeavy = "DashLongHeavy",
114430
+ /**
114431
+ * Underlining of text with a line containing dots and dashes.
114432
+ * @remarks
114433
+ * [Api set: PowerPointApi 1.4]
114434
+ */
114435
+ dotDash = "DotDash",
114436
+ /**
114437
+ * Underlining of text with a thick line containing dots and dashes.
114438
+ * @remarks
114439
+ * [Api set: PowerPointApi 1.4]
114440
+ */
114441
+ dotDashHeavy = "DotDashHeavy",
114442
+ /**
114443
+ * Underlining of text with a line containing double dots and dashes.
114444
+ * @remarks
114445
+ * [Api set: PowerPointApi 1.4]
114446
+ */
114447
+ dotDotDash = "DotDotDash",
114448
+ /**
114449
+ * Underlining of text with a thick line containing double dots and dashes.
114450
+ * @remarks
114451
+ * [Api set: PowerPointApi 1.4]
114452
+ */
114453
+ dotDotDashHeavy = "DotDotDashHeavy",
114454
+ /**
114455
+ * Underlining of text with a wavy line.
114456
+ * @remarks
114457
+ * [Api set: PowerPointApi 1.4]
114458
+ */
114459
+ wavy = "Wavy",
114460
+ /**
114461
+ * Underlining of text with a thick, wavy line.
114462
+ * @remarks
114463
+ * [Api set: PowerPointApi 1.4]
114464
+ */
114465
+ wavyHeavy = "WavyHeavy",
114466
+ /**
114467
+ * Underlining of text with double wavy lines.
114468
+ * @remarks
114469
+ * [Api set: PowerPointApi 1.4]
114470
+ */
114471
+ wavyDouble = "WavyDouble",
114340
114472
  }
114341
114473
  /**
114342
114474
  * Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
@@ -114389,96 +114521,50 @@ declare namespace PowerPoint {
114389
114521
  thaiDistributed = "ThaiDistributed",
114390
114522
  }
114391
114523
  /**
114392
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
114524
+ * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
114525
+ If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
114526
+ To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
114393
114527
  *
114394
114528
  * @remarks
114395
114529
  * [Api set: PowerPointApi 1.4]
114396
114530
  */
114397
- class ParagraphFormat extends OfficeExtension.ClientObject {
114398
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
114399
- context: RequestContext;
114531
+ enum TextVerticalAlignment {
114400
114532
  /**
114401
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
114402
- *
114533
+ * Specifies that the `TextFrame` should be top aligned to the `Shape`.
114403
114534
  * @remarks
114404
114535
  * [Api set: PowerPointApi 1.4]
114405
114536
  */
114406
- readonly bulletFormat: PowerPoint.BulletFormat;
114537
+ top = "Top",
114407
114538
  /**
114408
- * 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.
114409
- *
114539
+ * Specifies that the `TextFrame` should be center aligned to the `Shape`.
114410
114540
  * @remarks
114411
114541
  * [Api set: PowerPointApi 1.4]
114412
114542
  */
114413
- horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
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 options Provides options for which properties of the object to load.
114418
- */
114419
- load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
114420
- /**
114421
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
114422
- *
114423
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
114424
- */
114425
- load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
114426
- /**
114427
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
114428
- *
114429
- * @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.
114430
- */
114431
- load(propertyNamesAndPaths?: {
114432
- select?: string;
114433
- expand?: string;
114434
- }): PowerPoint.ParagraphFormat;
114435
- /**
114436
- * 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.)
114437
- * 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.
114438
- */
114439
- toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
114440
- }
114441
- /**
114442
- * Represents the available options when adding shapes.
114443
- *
114444
- * @remarks
114445
- * [Api set: PowerPointApi 1.4]
114446
- */
114447
- interface ShapeAddOptions {
114543
+ middle = "Middle",
114448
114544
  /**
114449
- * Specifies the height, in points, of the shape.
114450
- When not provided, a default value will be used.
114451
- Throws an `InvalidArgument` exception when set with a negative value.
114452
- *
114545
+ * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
114453
114546
  * @remarks
114454
114547
  * [Api set: PowerPointApi 1.4]
114455
114548
  */
114456
- height?: number;
114549
+ bottom = "Bottom",
114457
114550
  /**
114458
- * Specifies the distance, in points, from the left side of the shape to the left side of the slide.
114459
- When not provided, a default value will be used.
114460
- *
114551
+ * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
114461
114552
  * @remarks
114462
114553
  * [Api set: PowerPointApi 1.4]
114463
114554
  */
114464
- left?: number;
114555
+ topCentered = "TopCentered",
114465
114556
  /**
114466
- * Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
114467
- When not provided, a default value will be used.
114468
- *
114557
+ * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
114469
114558
  * @remarks
114470
114559
  * [Api set: PowerPointApi 1.4]
114471
114560
  */
114472
- top?: number;
114561
+ middleCentered = "MiddleCentered",
114473
114562
  /**
114474
- * Specifies the width, in points, of the shape.
114475
- When not provided, a default value will be used.
114476
- Throws an `InvalidArgument` exception when set with a negative value.
114477
- *
114563
+ * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
114478
114564
  * @remarks
114479
114565
  * [Api set: PowerPointApi 1.4]
114480
114566
  */
114481
- width?: number;
114567
+ bottomCentered = "BottomCentered",
114482
114568
  }
114483
114569
  /**
114484
114570
  * Represents the collection of shapes.
@@ -114865,22 +114951,22 @@ declare namespace PowerPoint {
114865
114951
  /** Gets the loaded child items in this collection. */
114866
114952
  readonly items: PowerPoint.Tag[];
114867
114953
  /**
114868
- * 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`.
114954
+ * 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`.
114869
114955
  *
114870
114956
  * @remarks
114871
114957
  * [Api set: PowerPointApi 1.3]
114872
114958
  *
114873
- * @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.
114959
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. The key string is capitalized when saved in the document.
114874
114960
  * @param value The value of the tag.
114875
114961
  */
114876
114962
  add(key: string, value: string): void;
114877
114963
  /**
114878
- * Deletes the tag with the given `key` in this collection. Does nothing if the `key` does not exist.
114964
+ * Deletes the tag with the given key in this collection. Does nothing if the key does not exist.
114879
114965
  *
114880
114966
  * @remarks
114881
114967
  * [Api set: PowerPointApi 1.3]
114882
114968
  *
114883
- * @param key The unique ID of a tag, which is unique within this `TagCollection`. `key` parameter is case-insensitive.
114969
+ * @param key The unique ID of a tag, which is unique within this `TagCollection`. This parameter is case-insensitive.
114884
114970
  */
114885
114971
  delete(key: string): void;
114886
114972
  /**
@@ -114897,7 +114983,7 @@ declare namespace PowerPoint {
114897
114983
  * @remarks
114898
114984
  * [Api set: PowerPointApi 1.3]
114899
114985
  *
114900
- * @param key The ID of the tag. The `key` parameter is case-sensitive.
114986
+ * @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
114901
114987
  * @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
114902
114988
  */
114903
114989
  getItem(key: string): PowerPoint.Tag;
@@ -114917,7 +115003,7 @@ declare namespace PowerPoint {
114917
115003
  * @remarks
114918
115004
  * [Api set: PowerPointApi 1.3]
114919
115005
  *
114920
- * @param key The ID of the tag. The `key` parameter is case-sensitive.
115006
+ * @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
114921
115007
  * @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.
114922
115008
  */
114923
115009
  getItemOrNullObject(key: string): PowerPoint.Tag;
@@ -115187,86 +115273,6 @@ declare namespace PowerPoint {
115187
115273
  */
115188
115274
  thinThin = "ThinThin",
115189
115275
  }
115190
- /**
115191
- * Specifies the dash style for a line.
115192
- *
115193
- * @remarks
115194
- * [Api set: PowerPointApi 1.4]
115195
- */
115196
- enum ShapeLineDashStyle {
115197
- /**
115198
- * The dash line pattern
115199
- * @remarks
115200
- * [Api set: PowerPointApi 1.4]
115201
- */
115202
- dash = "Dash",
115203
- /**
115204
- * The dash-dot line pattern
115205
- * @remarks
115206
- * [Api set: PowerPointApi 1.4]
115207
- */
115208
- dashDot = "DashDot",
115209
- /**
115210
- * The dash-dot-dot line pattern
115211
- * @remarks
115212
- * [Api set: PowerPointApi 1.4]
115213
- */
115214
- dashDotDot = "DashDotDot",
115215
- /**
115216
- * The long dash line pattern
115217
- * @remarks
115218
- * [Api set: PowerPointApi 1.4]
115219
- */
115220
- longDash = "LongDash",
115221
- /**
115222
- * The long dash-dot line pattern
115223
- * @remarks
115224
- * [Api set: PowerPointApi 1.4]
115225
- */
115226
- longDashDot = "LongDashDot",
115227
- /**
115228
- * The round dot line pattern
115229
- * @remarks
115230
- * [Api set: PowerPointApi 1.4]
115231
- */
115232
- roundDot = "RoundDot",
115233
- /**
115234
- * The solid line pattern
115235
- * @remarks
115236
- * [Api set: PowerPointApi 1.4]
115237
- */
115238
- solid = "Solid",
115239
- /**
115240
- * The square dot line pattern
115241
- * @remarks
115242
- * [Api set: PowerPointApi 1.4]
115243
- */
115244
- squareDot = "SquareDot",
115245
- /**
115246
- * The long dash-dot-dot line pattern
115247
- * @remarks
115248
- * [Api set: PowerPointApi 1.4]
115249
- */
115250
- longDashDotDot = "LongDashDotDot",
115251
- /**
115252
- * The system dash line pattern
115253
- * @remarks
115254
- * [Api set: PowerPointApi 1.4]
115255
- */
115256
- systemDash = "SystemDash",
115257
- /**
115258
- * The system dot line pattern
115259
- * @remarks
115260
- * [Api set: PowerPointApi 1.4]
115261
- */
115262
- systemDot = "SystemDot",
115263
- /**
115264
- * The system dash-dot line pattern
115265
- * @remarks
115266
- * [Api set: PowerPointApi 1.4]
115267
- */
115268
- systemDashDot = "SystemDashDot",
115269
- }
115270
115276
  /**
115271
115277
  * Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
115272
115278
  *
@@ -115382,6 +115388,12 @@ declare namespace PowerPoint {
115382
115388
  * [Api set: PowerPointApi 1.4]
115383
115389
  */
115384
115390
  line = "Line",
115391
+ /**
115392
+ * The shape is a table
115393
+ * @remarks
115394
+ * [Api set: PowerPointApi 1.4]
115395
+ */
115396
+ table = "Table",
115385
115397
  }
115386
115398
  /**
115387
115399
  * Determines the type of automatic sizing allowed.
@@ -115416,160 +115428,97 @@ declare namespace PowerPoint {
115416
115428
  autoSizeMixed = "AutoSizeMixed",
115417
115429
  }
115418
115430
  /**
115419
- * Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
115420
- If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
115421
- To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
115431
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
115422
115432
  *
115423
115433
  * @remarks
115424
115434
  * [Api set: PowerPointApi 1.4]
115425
115435
  */
115426
- enum TextVerticalAlignment {
115427
- /**
115428
- * Specifies that the `TextFrame` should be top aligned to the `Shape`.
115429
- * @remarks
115430
- * [Api set: PowerPointApi 1.4]
115431
- */
115432
- top = "Top",
115436
+ class BulletFormat extends OfficeExtension.ClientObject {
115437
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
115438
+ context: RequestContext;
115433
115439
  /**
115434
- * Specifies that the `TextFrame` should be center aligned to the `Shape`.
115440
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
115441
+ *
115435
115442
  * @remarks
115436
115443
  * [Api set: PowerPointApi 1.4]
115437
115444
  */
115438
- middle = "Middle",
115445
+ visible: boolean;
115439
115446
  /**
115440
- * Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
115441
- * @remarks
115442
- * [Api set: PowerPointApi 1.4]
115447
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115448
+ *
115449
+ * @param options Provides options for which properties of the object to load.
115443
115450
  */
115444
- bottom = "Bottom",
115451
+ load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
115445
115452
  /**
115446
- * Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
115447
- * @remarks
115448
- * [Api set: PowerPointApi 1.4]
115453
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115454
+ *
115455
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
115449
115456
  */
115450
- topCentered = "TopCentered",
115457
+ load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
115451
115458
  /**
115452
- * Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
115453
- * @remarks
115454
- * [Api set: PowerPointApi 1.4]
115459
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115460
+ *
115461
+ * @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.
115455
115462
  */
115456
- middleCentered = "MiddleCentered",
115463
+ load(propertyNamesAndPaths?: {
115464
+ select?: string;
115465
+ expand?: string;
115466
+ }): PowerPoint.BulletFormat;
115457
115467
  /**
115458
- * Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
115459
- * @remarks
115460
- * [Api set: PowerPointApi 1.4]
115461
- */
115462
- bottomCentered = "BottomCentered",
115468
+ * 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.)
115469
+ * 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.
115470
+ */
115471
+ toJSON(): PowerPoint.Interfaces.BulletFormatData;
115463
115472
  }
115464
115473
  /**
115465
- * The type of underline applied to a font.
115474
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
115466
115475
  *
115467
115476
  * @remarks
115468
115477
  * [Api set: PowerPointApi 1.4]
115469
115478
  */
115470
- enum ShapeFontUnderlineStyle {
115471
- /**
115472
- * No underlining.
115473
- * @remarks
115474
- * [Api set: PowerPointApi 1.4]
115475
- */
115476
- none = "None",
115477
- /**
115478
- * Regular single line underlining.
115479
- * @remarks
115480
- * [Api set: PowerPointApi 1.4]
115481
- */
115482
- single = "Single",
115483
- /**
115484
- * Underlining of text with double lines.
115485
- * @remarks
115486
- * [Api set: PowerPointApi 1.4]
115487
- */
115488
- double = "Double",
115489
- /**
115490
- * Underlining of text with a thick line.
115491
- * @remarks
115492
- * [Api set: PowerPointApi 1.4]
115493
- */
115494
- heavy = "Heavy",
115495
- /**
115496
- * Underlining of text with a dotted line.
115497
- * @remarks
115498
- * [Api set: PowerPointApi 1.4]
115499
- */
115500
- dotted = "Dotted",
115501
- /**
115502
- * Underlining of text with a thick, dotted line.
115503
- * @remarks
115504
- * [Api set: PowerPointApi 1.4]
115505
- */
115506
- dottedHeavy = "DottedHeavy",
115507
- /**
115508
- * Underlining of text with a line containing dashes.
115509
- * @remarks
115510
- * [Api set: PowerPointApi 1.4]
115511
- */
115512
- dash = "Dash",
115513
- /**
115514
- * Underlining of text with a thick line containing dashes.
115515
- * @remarks
115516
- * [Api set: PowerPointApi 1.4]
115517
- */
115518
- dashHeavy = "DashHeavy",
115519
- /**
115520
- * Underlining of text with a line containing long dashes.
115521
- * @remarks
115522
- * [Api set: PowerPointApi 1.4]
115523
- */
115524
- dashLong = "DashLong",
115525
- /**
115526
- * Underlining of text with a thick line containing long dashes.
115527
- * @remarks
115528
- * [Api set: PowerPointApi 1.4]
115529
- */
115530
- dashLongHeavy = "DashLongHeavy",
115531
- /**
115532
- * Underlining of text with a line containing dots and dashes.
115533
- * @remarks
115534
- * [Api set: PowerPointApi 1.4]
115535
- */
115536
- dotDash = "DotDash",
115479
+ class ParagraphFormat extends OfficeExtension.ClientObject {
115480
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
115481
+ context: RequestContext;
115537
115482
  /**
115538
- * Underlining of text with a thick line containing dots and dashes.
115483
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
115484
+ *
115539
115485
  * @remarks
115540
115486
  * [Api set: PowerPointApi 1.4]
115541
115487
  */
115542
- dotDashHeavy = "DotDashHeavy",
115488
+ readonly bulletFormat: PowerPoint.BulletFormat;
115543
115489
  /**
115544
- * Underlining of text with a line containing double dots and dashes.
115490
+ * 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.
115491
+ *
115545
115492
  * @remarks
115546
115493
  * [Api set: PowerPointApi 1.4]
115547
115494
  */
115548
- dotDotDash = "DotDotDash",
115495
+ horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
115549
115496
  /**
115550
- * Underlining of text with a thick line containing double dots and dashes.
115551
- * @remarks
115552
- * [Api set: PowerPointApi 1.4]
115497
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115498
+ *
115499
+ * @param options Provides options for which properties of the object to load.
115553
115500
  */
115554
- dotDotDashHeavy = "DotDotDashHeavy",
115501
+ load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
115555
115502
  /**
115556
- * Underlining of text with a wavy line.
115557
- * @remarks
115558
- * [Api set: PowerPointApi 1.4]
115503
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115504
+ *
115505
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
115559
115506
  */
115560
- wavy = "Wavy",
115507
+ load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
115561
115508
  /**
115562
- * Underlining of text with a thick, wavy line.
115563
- * @remarks
115564
- * [Api set: PowerPointApi 1.4]
115509
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
115510
+ *
115511
+ * @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.
115565
115512
  */
115566
- wavyHeavy = "WavyHeavy",
115513
+ load(propertyNamesAndPaths?: {
115514
+ select?: string;
115515
+ expand?: string;
115516
+ }): PowerPoint.ParagraphFormat;
115567
115517
  /**
115568
- * Underlining of text with double wavy lines.
115569
- * @remarks
115570
- * [Api set: PowerPointApi 1.4]
115571
- */
115572
- wavyDouble = "WavyDouble",
115518
+ * 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.)
115519
+ * 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.
115520
+ */
115521
+ toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
115573
115522
  }
115574
115523
  /**
115575
115524
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
@@ -115937,7 +115886,7 @@ declare namespace PowerPoint {
115937
115886
  * @remarks
115938
115887
  * [Api set: PowerPointApi 1.4]
115939
115888
  */
115940
- readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
115889
+ readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
115941
115890
  /**
115942
115891
  * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
115943
115892
  *
@@ -116021,6 +115970,61 @@ declare namespace PowerPoint {
116021
115970
  */
116022
115971
  toJSON(): PowerPoint.Interfaces.ShapeData;
116023
115972
  }
115973
+ /**
115974
+ * Specifies the formatting options for when slides are inserted.
115975
+ *
115976
+ * @remarks
115977
+ * [Api set: PowerPointApi 1.2]
115978
+ */
115979
+ enum InsertSlideFormatting {
115980
+ /**
115981
+ * Copy the source theme into the target presentation and use that theme.
115982
+ * @remarks
115983
+ * [Api set: PowerPointApi 1.2]
115984
+ */
115985
+ keepSourceFormatting = "KeepSourceFormatting",
115986
+ /**
115987
+ * Use the existing theme in the target presentation.
115988
+ * @remarks
115989
+ * [Api set: PowerPointApi 1.2]
115990
+ */
115991
+ useDestinationTheme = "UseDestinationTheme",
115992
+ }
115993
+ /**
115994
+ * Represents the available options when inserting slides.
115995
+ *
115996
+ * @remarks
115997
+ * [Api set: PowerPointApi 1.2]
115998
+ */
115999
+ interface InsertSlideOptions {
116000
+ /**
116001
+ * Specifies which formatting to use during slide insertion.
116002
+ The default option is to use "KeepSourceFormatting".
116003
+ *
116004
+ * @remarks
116005
+ * [Api set: PowerPointApi 1.2]
116006
+ */
116007
+ formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
116008
+ /**
116009
+ * 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.
116010
+ The order of these slides is preserved during the insertion.
116011
+ 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.
116012
+ All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
116013
+ *
116014
+ * @remarks
116015
+ * [Api set: PowerPointApi 1.2]
116016
+ */
116017
+ sourceSlideIds?: string[];
116018
+ /**
116019
+ * 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.
116020
+ If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
116021
+ 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.
116022
+ *
116023
+ * @remarks
116024
+ * [Api set: PowerPointApi 1.2]
116025
+ */
116026
+ targetSlideId?: string;
116027
+ }
116024
116028
  /**
116025
116029
  * Represents a collection of shapes.
116026
116030
  *
@@ -116345,26 +116349,6 @@ declare namespace PowerPoint {
116345
116349
  */
116346
116350
  $skip?: number;
116347
116351
  }
116348
- /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
116349
- interface BulletFormatUpdateData {
116350
- /**
116351
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
116352
- *
116353
- * @remarks
116354
- * [Api set: PowerPointApi 1.4]
116355
- */
116356
- visible?: boolean;
116357
- }
116358
- /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
116359
- interface ParagraphFormatUpdateData {
116360
- /**
116361
- * 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.
116362
- *
116363
- * @remarks
116364
- * [Api set: PowerPointApi 1.4]
116365
- */
116366
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
116367
- }
116368
116352
  /** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
116369
116353
  interface ShapeCollectionUpdateData {
116370
116354
  items?: PowerPoint.Interfaces.ShapeData[];
@@ -116449,6 +116433,26 @@ declare namespace PowerPoint {
116449
116433
  */
116450
116434
  weight?: number;
116451
116435
  }
116436
+ /** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
116437
+ interface BulletFormatUpdateData {
116438
+ /**
116439
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
116440
+ *
116441
+ * @remarks
116442
+ * [Api set: PowerPointApi 1.4]
116443
+ */
116444
+ visible?: boolean;
116445
+ }
116446
+ /** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
116447
+ interface ParagraphFormatUpdateData {
116448
+ /**
116449
+ * 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.
116450
+ *
116451
+ * @remarks
116452
+ * [Api set: PowerPointApi 1.4]
116453
+ */
116454
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
116455
+ }
116452
116456
  /** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
116453
116457
  interface ShapeFontUpdateData {
116454
116458
  /**
@@ -116628,27 +116632,14 @@ declare namespace PowerPoint {
116628
116632
  }
116629
116633
  /** An interface describing the data returned by calling `presentation.toJSON()`. */
116630
116634
  interface PresentationData {
116631
- title?: string;
116632
- }
116633
- /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
116634
- interface BulletFormatData {
116635
116635
  /**
116636
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
116636
+ * Gets the ID of the presentation.
116637
116637
  *
116638
116638
  * @remarks
116639
- * [Api set: PowerPointApi 1.4]
116640
- */
116641
- visible?: boolean;
116642
- }
116643
- /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
116644
- interface ParagraphFormatData {
116645
- /**
116646
- * 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.
116647
- *
116648
- * @remarks
116649
- * [Api set: PowerPointApi 1.4]
116639
+ * [Api set: PowerPointApi 1.5]
116650
116640
  */
116651
- horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
116641
+ id?: string;
116642
+ title?: string;
116652
116643
  }
116653
116644
  /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
116654
116645
  interface ShapeCollectionData {
@@ -116792,6 +116783,26 @@ declare namespace PowerPoint {
116792
116783
  */
116793
116784
  weight?: number;
116794
116785
  }
116786
+ /** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
116787
+ interface BulletFormatData {
116788
+ /**
116789
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
116790
+ *
116791
+ * @remarks
116792
+ * [Api set: PowerPointApi 1.4]
116793
+ */
116794
+ visible?: boolean;
116795
+ }
116796
+ /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
116797
+ interface ParagraphFormatData {
116798
+ /**
116799
+ * 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.
116800
+ *
116801
+ * @remarks
116802
+ * [Api set: PowerPointApi 1.4]
116803
+ */
116804
+ horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
116805
+ }
116795
116806
  /** An interface describing the data returned by calling `shapeFont.toJSON()`. */
116796
116807
  interface ShapeFontData {
116797
116808
  /**
@@ -116965,7 +116976,7 @@ declare namespace PowerPoint {
116965
116976
  * @remarks
116966
116977
  * [Api set: PowerPointApi 1.4]
116967
116978
  */
116968
- type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
116979
+ type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
116969
116980
  /**
116970
116981
  * Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
116971
116982
  *
@@ -116995,56 +117006,18 @@ declare namespace PowerPoint {
116995
117006
  * [Api set: PowerPointApi 1.0]
116996
117007
  */
116997
117008
  interface PresentationLoadOptions {
116998
- /**
116999
- 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`).
117000
- */
117001
- $all?: boolean;
117002
- title?: boolean;
117003
- }
117004
- /**
117005
- * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
117006
- *
117007
- * @remarks
117008
- * [Api set: PowerPointApi 1.4]
117009
- */
117010
- interface BulletFormatLoadOptions {
117011
- /**
117012
- 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`).
117013
- */
117014
- $all?: boolean;
117015
- /**
117016
- * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
117017
- *
117018
- * @remarks
117019
- * [Api set: PowerPointApi 1.4]
117020
- */
117021
- visible?: boolean;
117022
- }
117023
- /**
117024
- * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
117025
- *
117026
- * @remarks
117027
- * [Api set: PowerPointApi 1.4]
117028
- */
117029
- interface ParagraphFormatLoadOptions {
117030
117009
  /**
117031
117010
  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`).
117032
117011
  */
117033
117012
  $all?: boolean;
117034
117013
  /**
117035
- * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
117036
- *
117037
- * @remarks
117038
- * [Api set: PowerPointApi 1.4]
117039
- */
117040
- bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
117041
- /**
117042
- * 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.
117014
+ * Gets the ID of the presentation.
117043
117015
  *
117044
117016
  * @remarks
117045
- * [Api set: PowerPointApi 1.4]
117017
+ * [Api set: PowerPointApi 1.5]
117046
117018
  */
117047
- horizontalAlignment?: boolean;
117019
+ id?: boolean;
117020
+ title?: boolean;
117048
117021
  }
117049
117022
  /**
117050
117023
  * Represents the collection of shapes.
@@ -117378,6 +117351,51 @@ declare namespace PowerPoint {
117378
117351
  */
117379
117352
  weight?: boolean;
117380
117353
  }
117354
+ /**
117355
+ * Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
117356
+ *
117357
+ * @remarks
117358
+ * [Api set: PowerPointApi 1.4]
117359
+ */
117360
+ interface BulletFormatLoadOptions {
117361
+ /**
117362
+ 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`).
117363
+ */
117364
+ $all?: boolean;
117365
+ /**
117366
+ * Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
117367
+ *
117368
+ * @remarks
117369
+ * [Api set: PowerPointApi 1.4]
117370
+ */
117371
+ visible?: boolean;
117372
+ }
117373
+ /**
117374
+ * Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
117375
+ *
117376
+ * @remarks
117377
+ * [Api set: PowerPointApi 1.4]
117378
+ */
117379
+ interface ParagraphFormatLoadOptions {
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
+ * Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
117386
+ *
117387
+ * @remarks
117388
+ * [Api set: PowerPointApi 1.4]
117389
+ */
117390
+ bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
117391
+ /**
117392
+ * 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.
117393
+ *
117394
+ * @remarks
117395
+ * [Api set: PowerPointApi 1.4]
117396
+ */
117397
+ horizontalAlignment?: boolean;
117398
+ }
117381
117399
  /**
117382
117400
  * Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
117383
117401
  *
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.377",
3
+ "version": "1.0.379",
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": "d4ca4a143f1f94458fcecd060a53156e8ee158865e94438c0da7680cf5f4ab72",
48
+ "typesPublisherContentHash": "5b0b65f0c0486d834f60da0e572ddbf3dbd627bfaa42badc0293ee8a8feacaf3",
49
49
  "typeScriptVersion": "4.7"
50
50
  }