@types/office-js 1.0.377 → 1.0.378
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +457 -420
- 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,
|
|
11
|
+
* Last updated: Thu, 28 Mar 2024 20:35:30 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -37639,6 +37639,7 @@ declare namespace Excel {
|
|
|
37639
37639
|
markerForegroundColor: string;
|
|
37640
37640
|
/**
|
|
37641
37641
|
* Specifies the marker size of a chart series.
|
|
37642
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
37642
37643
|
*
|
|
37643
37644
|
* @remarks
|
|
37644
37645
|
* [Api set: ExcelApi 1.7]
|
|
@@ -38020,6 +38021,7 @@ declare namespace Excel {
|
|
|
38020
38021
|
markerForegroundColor: string;
|
|
38021
38022
|
/**
|
|
38022
38023
|
* Represents marker size of a data point.
|
|
38024
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
38023
38025
|
*
|
|
38024
38026
|
* @remarks
|
|
38025
38027
|
* [Api set: ExcelApi 1.7]
|
|
@@ -62748,6 +62750,7 @@ declare namespace Excel {
|
|
|
62748
62750
|
markerForegroundColor?: string;
|
|
62749
62751
|
/**
|
|
62750
62752
|
* Specifies the marker size of a chart series.
|
|
62753
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
62751
62754
|
*
|
|
62752
62755
|
* @remarks
|
|
62753
62756
|
* [Api set: ExcelApi 1.7]
|
|
@@ -62898,6 +62901,7 @@ declare namespace Excel {
|
|
|
62898
62901
|
markerForegroundColor?: string;
|
|
62899
62902
|
/**
|
|
62900
62903
|
* Represents marker size of a data point.
|
|
62904
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
62901
62905
|
*
|
|
62902
62906
|
* @remarks
|
|
62903
62907
|
* [Api set: ExcelApi 1.7]
|
|
@@ -68555,6 +68559,7 @@ declare namespace Excel {
|
|
|
68555
68559
|
markerForegroundColor?: string;
|
|
68556
68560
|
/**
|
|
68557
68561
|
* Specifies the marker size of a chart series.
|
|
68562
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
68558
68563
|
*
|
|
68559
68564
|
* @remarks
|
|
68560
68565
|
* [Api set: ExcelApi 1.7]
|
|
@@ -68705,6 +68710,7 @@ declare namespace Excel {
|
|
|
68705
68710
|
markerForegroundColor?: string;
|
|
68706
68711
|
/**
|
|
68707
68712
|
* Represents marker size of a data point.
|
|
68713
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
68708
68714
|
*
|
|
68709
68715
|
* @remarks
|
|
68710
68716
|
* [Api set: ExcelApi 1.7]
|
|
@@ -76392,6 +76398,7 @@ declare namespace Excel {
|
|
|
76392
76398
|
markerForegroundColor?: boolean;
|
|
76393
76399
|
/**
|
|
76394
76400
|
* For EACH ITEM in the collection: Specifies the marker size of a chart series.
|
|
76401
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
76395
76402
|
*
|
|
76396
76403
|
* @remarks
|
|
76397
76404
|
* [Api set: ExcelApi 1.7]
|
|
@@ -76721,6 +76728,7 @@ declare namespace Excel {
|
|
|
76721
76728
|
markerForegroundColor?: boolean;
|
|
76722
76729
|
/**
|
|
76723
76730
|
* Specifies the marker size of a chart series.
|
|
76731
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
76724
76732
|
*
|
|
76725
76733
|
* @remarks
|
|
76726
76734
|
* [Api set: ExcelApi 1.7]
|
|
@@ -76885,6 +76893,7 @@ declare namespace Excel {
|
|
|
76885
76893
|
markerForegroundColor?: boolean;
|
|
76886
76894
|
/**
|
|
76887
76895
|
* For EACH ITEM in the collection: Represents marker size of a data point.
|
|
76896
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
76888
76897
|
*
|
|
76889
76898
|
* @remarks
|
|
76890
76899
|
* [Api set: ExcelApi 1.7]
|
|
@@ -76953,6 +76962,7 @@ declare namespace Excel {
|
|
|
76953
76962
|
markerForegroundColor?: boolean;
|
|
76954
76963
|
/**
|
|
76955
76964
|
* Represents marker size of a data point.
|
|
76965
|
+
The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
|
|
76956
76966
|
*
|
|
76957
76967
|
* @remarks
|
|
76958
76968
|
* [Api set: ExcelApi 1.7]
|
|
@@ -113037,6 +113047,13 @@ declare namespace PowerPoint {
|
|
|
113037
113047
|
* [Api set: PowerPointApi 1.3]
|
|
113038
113048
|
*/
|
|
113039
113049
|
readonly tags: PowerPoint.TagCollection;
|
|
113050
|
+
/**
|
|
113051
|
+
* Gets the ID of the presentation.
|
|
113052
|
+
*
|
|
113053
|
+
* @remarks
|
|
113054
|
+
* [Api set: PowerPointApi 1.5]
|
|
113055
|
+
*/
|
|
113056
|
+
readonly id: string;
|
|
113040
113057
|
readonly title: string;
|
|
113041
113058
|
/**
|
|
113042
113059
|
* Returns the selected shapes in the current slide of the presentation.
|
|
@@ -113144,49 +113161,6 @@ declare namespace PowerPoint {
|
|
|
113144
113161
|
*/
|
|
113145
113162
|
slideMasterId?: string;
|
|
113146
113163
|
}
|
|
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
113164
|
/**
|
|
113191
113165
|
* Specifies the connector type for line shapes.
|
|
113192
113166
|
*
|
|
@@ -114284,59 +114258,236 @@ declare namespace PowerPoint {
|
|
|
114284
114258
|
chartPlus = "ChartPlus",
|
|
114285
114259
|
}
|
|
114286
114260
|
/**
|
|
114287
|
-
*
|
|
114261
|
+
* Represents the available options when adding shapes.
|
|
114288
114262
|
*
|
|
114289
114263
|
* @remarks
|
|
114290
|
-
* [Api set: PowerPointApi 1.
|
|
114264
|
+
* [Api set: PowerPointApi 1.4]
|
|
114291
114265
|
*/
|
|
114292
|
-
|
|
114266
|
+
interface ShapeAddOptions {
|
|
114293
114267
|
/**
|
|
114294
|
-
*
|
|
114268
|
+
* Specifies the height, in points, of the shape.
|
|
114269
|
+
When not provided, a default value will be used.
|
|
114270
|
+
Throws an `InvalidArgument` exception when set with a negative value.
|
|
114271
|
+
*
|
|
114295
114272
|
* @remarks
|
|
114296
|
-
* [Api set: PowerPointApi 1.
|
|
114273
|
+
* [Api set: PowerPointApi 1.4]
|
|
114297
114274
|
*/
|
|
114298
|
-
|
|
114275
|
+
height?: number;
|
|
114299
114276
|
/**
|
|
114300
|
-
*
|
|
114277
|
+
* Specifies the distance, in points, from the left side of the shape to the left side of the slide.
|
|
114278
|
+
When not provided, a default value will be used.
|
|
114279
|
+
*
|
|
114301
114280
|
* @remarks
|
|
114302
|
-
* [Api set: PowerPointApi 1.
|
|
114281
|
+
* [Api set: PowerPointApi 1.4]
|
|
114303
114282
|
*/
|
|
114304
|
-
|
|
114283
|
+
left?: number;
|
|
114284
|
+
/**
|
|
114285
|
+
* Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
114286
|
+
When not provided, a default value will be used.
|
|
114287
|
+
*
|
|
114288
|
+
* @remarks
|
|
114289
|
+
* [Api set: PowerPointApi 1.4]
|
|
114290
|
+
*/
|
|
114291
|
+
top?: number;
|
|
114292
|
+
/**
|
|
114293
|
+
* Specifies the width, in points, of the shape.
|
|
114294
|
+
When not provided, a default value will be used.
|
|
114295
|
+
Throws an `InvalidArgument` exception when set with a negative value.
|
|
114296
|
+
*
|
|
114297
|
+
* @remarks
|
|
114298
|
+
* [Api set: PowerPointApi 1.4]
|
|
114299
|
+
*/
|
|
114300
|
+
width?: number;
|
|
114305
114301
|
}
|
|
114306
114302
|
/**
|
|
114307
|
-
*
|
|
114303
|
+
* Specifies the dash style for a line.
|
|
114308
114304
|
*
|
|
114309
114305
|
* @remarks
|
|
114310
|
-
* [Api set: PowerPointApi 1.
|
|
114306
|
+
* [Api set: PowerPointApi 1.4]
|
|
114311
114307
|
*/
|
|
114312
|
-
|
|
114308
|
+
enum ShapeLineDashStyle {
|
|
114313
114309
|
/**
|
|
114314
|
-
*
|
|
114315
|
-
The default option is to use "KeepSourceFormatting".
|
|
114316
|
-
*
|
|
114310
|
+
* The dash line pattern
|
|
114317
114311
|
* @remarks
|
|
114318
|
-
* [Api set: PowerPointApi 1.
|
|
114312
|
+
* [Api set: PowerPointApi 1.4]
|
|
114319
114313
|
*/
|
|
114320
|
-
|
|
114314
|
+
dash = "Dash",
|
|
114321
114315
|
/**
|
|
114322
|
-
*
|
|
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
|
-
*
|
|
114316
|
+
* The dash-dot line pattern
|
|
114327
114317
|
* @remarks
|
|
114328
|
-
* [Api set: PowerPointApi 1.
|
|
114318
|
+
* [Api set: PowerPointApi 1.4]
|
|
114329
114319
|
*/
|
|
114330
|
-
|
|
114320
|
+
dashDot = "DashDot",
|
|
114331
114321
|
/**
|
|
114332
|
-
*
|
|
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
|
-
*
|
|
114322
|
+
* The dash-dot-dot line pattern
|
|
114336
114323
|
* @remarks
|
|
114337
|
-
* [Api set: PowerPointApi 1.
|
|
114324
|
+
* [Api set: PowerPointApi 1.4]
|
|
114338
114325
|
*/
|
|
114339
|
-
|
|
114326
|
+
dashDotDot = "DashDotDot",
|
|
114327
|
+
/**
|
|
114328
|
+
* The long dash line pattern
|
|
114329
|
+
* @remarks
|
|
114330
|
+
* [Api set: PowerPointApi 1.4]
|
|
114331
|
+
*/
|
|
114332
|
+
longDash = "LongDash",
|
|
114333
|
+
/**
|
|
114334
|
+
* The long dash-dot line pattern
|
|
114335
|
+
* @remarks
|
|
114336
|
+
* [Api set: PowerPointApi 1.4]
|
|
114337
|
+
*/
|
|
114338
|
+
longDashDot = "LongDashDot",
|
|
114339
|
+
/**
|
|
114340
|
+
* The round dot line pattern
|
|
114341
|
+
* @remarks
|
|
114342
|
+
* [Api set: PowerPointApi 1.4]
|
|
114343
|
+
*/
|
|
114344
|
+
roundDot = "RoundDot",
|
|
114345
|
+
/**
|
|
114346
|
+
* The solid line pattern
|
|
114347
|
+
* @remarks
|
|
114348
|
+
* [Api set: PowerPointApi 1.4]
|
|
114349
|
+
*/
|
|
114350
|
+
solid = "Solid",
|
|
114351
|
+
/**
|
|
114352
|
+
* The square dot line pattern
|
|
114353
|
+
* @remarks
|
|
114354
|
+
* [Api set: PowerPointApi 1.4]
|
|
114355
|
+
*/
|
|
114356
|
+
squareDot = "SquareDot",
|
|
114357
|
+
/**
|
|
114358
|
+
* The long dash-dot-dot line pattern
|
|
114359
|
+
* @remarks
|
|
114360
|
+
* [Api set: PowerPointApi 1.4]
|
|
114361
|
+
*/
|
|
114362
|
+
longDashDotDot = "LongDashDotDot",
|
|
114363
|
+
/**
|
|
114364
|
+
* The system dash line pattern
|
|
114365
|
+
* @remarks
|
|
114366
|
+
* [Api set: PowerPointApi 1.4]
|
|
114367
|
+
*/
|
|
114368
|
+
systemDash = "SystemDash",
|
|
114369
|
+
/**
|
|
114370
|
+
* The system dot line pattern
|
|
114371
|
+
* @remarks
|
|
114372
|
+
* [Api set: PowerPointApi 1.4]
|
|
114373
|
+
*/
|
|
114374
|
+
systemDot = "SystemDot",
|
|
114375
|
+
/**
|
|
114376
|
+
* The system dash-dot line pattern
|
|
114377
|
+
* @remarks
|
|
114378
|
+
* [Api set: PowerPointApi 1.4]
|
|
114379
|
+
*/
|
|
114380
|
+
systemDashDot = "SystemDashDot",
|
|
114381
|
+
}
|
|
114382
|
+
/**
|
|
114383
|
+
* The type of underline applied to a font.
|
|
114384
|
+
*
|
|
114385
|
+
* @remarks
|
|
114386
|
+
* [Api set: PowerPointApi 1.4]
|
|
114387
|
+
*/
|
|
114388
|
+
enum ShapeFontUnderlineStyle {
|
|
114389
|
+
/**
|
|
114390
|
+
* No underlining.
|
|
114391
|
+
* @remarks
|
|
114392
|
+
* [Api set: PowerPointApi 1.4]
|
|
114393
|
+
*/
|
|
114394
|
+
none = "None",
|
|
114395
|
+
/**
|
|
114396
|
+
* Regular single line underlining.
|
|
114397
|
+
* @remarks
|
|
114398
|
+
* [Api set: PowerPointApi 1.4]
|
|
114399
|
+
*/
|
|
114400
|
+
single = "Single",
|
|
114401
|
+
/**
|
|
114402
|
+
* Underlining of text with double lines.
|
|
114403
|
+
* @remarks
|
|
114404
|
+
* [Api set: PowerPointApi 1.4]
|
|
114405
|
+
*/
|
|
114406
|
+
double = "Double",
|
|
114407
|
+
/**
|
|
114408
|
+
* Underlining of text with a thick line.
|
|
114409
|
+
* @remarks
|
|
114410
|
+
* [Api set: PowerPointApi 1.4]
|
|
114411
|
+
*/
|
|
114412
|
+
heavy = "Heavy",
|
|
114413
|
+
/**
|
|
114414
|
+
* Underlining of text with a dotted line.
|
|
114415
|
+
* @remarks
|
|
114416
|
+
* [Api set: PowerPointApi 1.4]
|
|
114417
|
+
*/
|
|
114418
|
+
dotted = "Dotted",
|
|
114419
|
+
/**
|
|
114420
|
+
* Underlining of text with a thick, dotted line.
|
|
114421
|
+
* @remarks
|
|
114422
|
+
* [Api set: PowerPointApi 1.4]
|
|
114423
|
+
*/
|
|
114424
|
+
dottedHeavy = "DottedHeavy",
|
|
114425
|
+
/**
|
|
114426
|
+
* Underlining of text with a line containing dashes.
|
|
114427
|
+
* @remarks
|
|
114428
|
+
* [Api set: PowerPointApi 1.4]
|
|
114429
|
+
*/
|
|
114430
|
+
dash = "Dash",
|
|
114431
|
+
/**
|
|
114432
|
+
* Underlining of text with a thick line containing dashes.
|
|
114433
|
+
* @remarks
|
|
114434
|
+
* [Api set: PowerPointApi 1.4]
|
|
114435
|
+
*/
|
|
114436
|
+
dashHeavy = "DashHeavy",
|
|
114437
|
+
/**
|
|
114438
|
+
* Underlining of text with a line containing long dashes.
|
|
114439
|
+
* @remarks
|
|
114440
|
+
* [Api set: PowerPointApi 1.4]
|
|
114441
|
+
*/
|
|
114442
|
+
dashLong = "DashLong",
|
|
114443
|
+
/**
|
|
114444
|
+
* Underlining of text with a thick line containing long dashes.
|
|
114445
|
+
* @remarks
|
|
114446
|
+
* [Api set: PowerPointApi 1.4]
|
|
114447
|
+
*/
|
|
114448
|
+
dashLongHeavy = "DashLongHeavy",
|
|
114449
|
+
/**
|
|
114450
|
+
* Underlining of text with a line containing dots and dashes.
|
|
114451
|
+
* @remarks
|
|
114452
|
+
* [Api set: PowerPointApi 1.4]
|
|
114453
|
+
*/
|
|
114454
|
+
dotDash = "DotDash",
|
|
114455
|
+
/**
|
|
114456
|
+
* Underlining of text with a thick line containing dots and dashes.
|
|
114457
|
+
* @remarks
|
|
114458
|
+
* [Api set: PowerPointApi 1.4]
|
|
114459
|
+
*/
|
|
114460
|
+
dotDashHeavy = "DotDashHeavy",
|
|
114461
|
+
/**
|
|
114462
|
+
* Underlining of text with a line containing double dots and dashes.
|
|
114463
|
+
* @remarks
|
|
114464
|
+
* [Api set: PowerPointApi 1.4]
|
|
114465
|
+
*/
|
|
114466
|
+
dotDotDash = "DotDotDash",
|
|
114467
|
+
/**
|
|
114468
|
+
* Underlining of text with a thick line containing double dots and dashes.
|
|
114469
|
+
* @remarks
|
|
114470
|
+
* [Api set: PowerPointApi 1.4]
|
|
114471
|
+
*/
|
|
114472
|
+
dotDotDashHeavy = "DotDotDashHeavy",
|
|
114473
|
+
/**
|
|
114474
|
+
* Underlining of text with a wavy line.
|
|
114475
|
+
* @remarks
|
|
114476
|
+
* [Api set: PowerPointApi 1.4]
|
|
114477
|
+
*/
|
|
114478
|
+
wavy = "Wavy",
|
|
114479
|
+
/**
|
|
114480
|
+
* Underlining of text with a thick, wavy line.
|
|
114481
|
+
* @remarks
|
|
114482
|
+
* [Api set: PowerPointApi 1.4]
|
|
114483
|
+
*/
|
|
114484
|
+
wavyHeavy = "WavyHeavy",
|
|
114485
|
+
/**
|
|
114486
|
+
* Underlining of text with double wavy lines.
|
|
114487
|
+
* @remarks
|
|
114488
|
+
* [Api set: PowerPointApi 1.4]
|
|
114489
|
+
*/
|
|
114490
|
+
wavyDouble = "WavyDouble",
|
|
114340
114491
|
}
|
|
114341
114492
|
/**
|
|
114342
114493
|
* Represents the horizontal alignment of the {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
|
|
@@ -114389,96 +114540,50 @@ declare namespace PowerPoint {
|
|
|
114389
114540
|
thaiDistributed = "ThaiDistributed",
|
|
114390
114541
|
}
|
|
114391
114542
|
/**
|
|
114392
|
-
* Represents the
|
|
114543
|
+
* Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
|
|
114544
|
+
If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
|
|
114545
|
+
To change the horizontal alignment of a text, see {@link PowerPoint.ParagraphFormat} and {@link PowerPoint.ParagraphHorizontalAlignment }.
|
|
114393
114546
|
*
|
|
114394
114547
|
* @remarks
|
|
114395
114548
|
* [Api set: PowerPointApi 1.4]
|
|
114396
114549
|
*/
|
|
114397
|
-
|
|
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;
|
|
114550
|
+
enum TextVerticalAlignment {
|
|
114400
114551
|
/**
|
|
114401
|
-
*
|
|
114402
|
-
*
|
|
114552
|
+
* Specifies that the `TextFrame` should be top aligned to the `Shape`.
|
|
114403
114553
|
* @remarks
|
|
114404
114554
|
* [Api set: PowerPointApi 1.4]
|
|
114405
114555
|
*/
|
|
114406
|
-
|
|
114556
|
+
top = "Top",
|
|
114407
114557
|
/**
|
|
114408
|
-
*
|
|
114409
|
-
*
|
|
114558
|
+
* Specifies that the `TextFrame` should be center aligned to the `Shape`.
|
|
114410
114559
|
* @remarks
|
|
114411
114560
|
* [Api set: PowerPointApi 1.4]
|
|
114412
114561
|
*/
|
|
114413
|
-
|
|
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 {
|
|
114562
|
+
middle = "Middle",
|
|
114448
114563
|
/**
|
|
114449
|
-
* Specifies the
|
|
114450
|
-
When not provided, a default value will be used.
|
|
114451
|
-
Throws an `InvalidArgument` exception when set with a negative value.
|
|
114452
|
-
*
|
|
114564
|
+
* Specifies that the `TextFrame` should be bottom aligned to the `Shape`.
|
|
114453
114565
|
* @remarks
|
|
114454
114566
|
* [Api set: PowerPointApi 1.4]
|
|
114455
114567
|
*/
|
|
114456
|
-
|
|
114568
|
+
bottom = "Bottom",
|
|
114457
114569
|
/**
|
|
114458
|
-
* Specifies the
|
|
114459
|
-
When not provided, a default value will be used.
|
|
114460
|
-
*
|
|
114570
|
+
* Specifies that the `TextFrame` should be top aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
|
|
114461
114571
|
* @remarks
|
|
114462
114572
|
* [Api set: PowerPointApi 1.4]
|
|
114463
114573
|
*/
|
|
114464
|
-
|
|
114574
|
+
topCentered = "TopCentered",
|
|
114465
114575
|
/**
|
|
114466
|
-
* Specifies the
|
|
114467
|
-
When not provided, a default value will be used.
|
|
114468
|
-
*
|
|
114576
|
+
* Specifies that the `TextFrame` should be center aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
|
|
114469
114577
|
* @remarks
|
|
114470
114578
|
* [Api set: PowerPointApi 1.4]
|
|
114471
114579
|
*/
|
|
114472
|
-
|
|
114580
|
+
middleCentered = "MiddleCentered",
|
|
114473
114581
|
/**
|
|
114474
|
-
* Specifies the
|
|
114475
|
-
When not provided, a default value will be used.
|
|
114476
|
-
Throws an `InvalidArgument` exception when set with a negative value.
|
|
114477
|
-
*
|
|
114582
|
+
* Specifies that the `TextFrame` should be bottom aligned vertically to the `Shape`. Contents of the `TextFrame` will be centered horizontally within the `Shape`.
|
|
114478
114583
|
* @remarks
|
|
114479
114584
|
* [Api set: PowerPointApi 1.4]
|
|
114480
114585
|
*/
|
|
114481
|
-
|
|
114586
|
+
bottomCentered = "BottomCentered",
|
|
114482
114587
|
}
|
|
114483
114588
|
/**
|
|
114484
114589
|
* Represents the collection of shapes.
|
|
@@ -114865,22 +114970,22 @@ declare namespace PowerPoint {
|
|
|
114865
114970
|
/** Gets the loaded child items in this collection. */
|
|
114866
114971
|
readonly items: PowerPoint.Tag[];
|
|
114867
114972
|
/**
|
|
114868
|
-
* Adds a new tag at the end of the collection. If the
|
|
114973
|
+
* Adds a new tag at the end of the collection. If the key already exists in the collection, the value of the existing tag will be replaced with the given `value`.
|
|
114869
114974
|
*
|
|
114870
114975
|
* @remarks
|
|
114871
114976
|
* [Api set: PowerPointApi 1.3]
|
|
114872
114977
|
*
|
|
114873
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`.
|
|
114978
|
+
* @param key The unique ID of a tag, which is unique within this `TagCollection`. The key string is capitalized when saved in the document.
|
|
114874
114979
|
* @param value The value of the tag.
|
|
114875
114980
|
*/
|
|
114876
114981
|
add(key: string, value: string): void;
|
|
114877
114982
|
/**
|
|
114878
|
-
* Deletes the tag with the given
|
|
114983
|
+
* Deletes the tag with the given key in this collection. Does nothing if the key does not exist.
|
|
114879
114984
|
*
|
|
114880
114985
|
* @remarks
|
|
114881
114986
|
* [Api set: PowerPointApi 1.3]
|
|
114882
114987
|
*
|
|
114883
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`.
|
|
114988
|
+
* @param key The unique ID of a tag, which is unique within this `TagCollection`. This parameter is case-insensitive.
|
|
114884
114989
|
*/
|
|
114885
114990
|
delete(key: string): void;
|
|
114886
114991
|
/**
|
|
@@ -114897,7 +115002,7 @@ declare namespace PowerPoint {
|
|
|
114897
115002
|
* @remarks
|
|
114898
115003
|
* [Api set: PowerPointApi 1.3]
|
|
114899
115004
|
*
|
|
114900
|
-
* @param key The ID of the tag. The
|
|
115005
|
+
* @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
|
|
114901
115006
|
* @returns The tag with the unique ID. If such a tag does not exist, an error is thrown.
|
|
114902
115007
|
*/
|
|
114903
115008
|
getItem(key: string): PowerPoint.Tag;
|
|
@@ -114917,7 +115022,7 @@ declare namespace PowerPoint {
|
|
|
114917
115022
|
* @remarks
|
|
114918
115023
|
* [Api set: PowerPointApi 1.3]
|
|
114919
115024
|
*
|
|
114920
|
-
* @param key The ID of the tag. The
|
|
115025
|
+
* @param key The ID of the tag. The ID is case-sensitive and must be capitalized.
|
|
114921
115026
|
* @returns The tag with the unique ID. If such a tag does not exist, an object with an `isNullObject` property set to true is returned.
|
|
114922
115027
|
*/
|
|
114923
115028
|
getItemOrNullObject(key: string): PowerPoint.Tag;
|
|
@@ -115187,86 +115292,6 @@ declare namespace PowerPoint {
|
|
|
115187
115292
|
*/
|
|
115188
115293
|
thinThin = "ThinThin",
|
|
115189
115294
|
}
|
|
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
115295
|
/**
|
|
115271
115296
|
* Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
|
|
115272
115297
|
*
|
|
@@ -115382,6 +115407,12 @@ declare namespace PowerPoint {
|
|
|
115382
115407
|
* [Api set: PowerPointApi 1.4]
|
|
115383
115408
|
*/
|
|
115384
115409
|
line = "Line",
|
|
115410
|
+
/**
|
|
115411
|
+
* The shape is a table
|
|
115412
|
+
* @remarks
|
|
115413
|
+
* [Api set: PowerPointApi 1.4]
|
|
115414
|
+
*/
|
|
115415
|
+
table = "Table",
|
|
115385
115416
|
}
|
|
115386
115417
|
/**
|
|
115387
115418
|
* Determines the type of automatic sizing allowed.
|
|
@@ -115416,160 +115447,97 @@ declare namespace PowerPoint {
|
|
|
115416
115447
|
autoSizeMixed = "AutoSizeMixed",
|
|
115417
115448
|
}
|
|
115418
115449
|
/**
|
|
115419
|
-
* Represents the
|
|
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 }.
|
|
115450
|
+
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
|
|
115422
115451
|
*
|
|
115423
115452
|
* @remarks
|
|
115424
115453
|
* [Api set: PowerPointApi 1.4]
|
|
115425
115454
|
*/
|
|
115426
|
-
|
|
115427
|
-
/**
|
|
115428
|
-
|
|
115429
|
-
* @remarks
|
|
115430
|
-
* [Api set: PowerPointApi 1.4]
|
|
115431
|
-
*/
|
|
115432
|
-
top = "Top",
|
|
115455
|
+
class BulletFormat extends OfficeExtension.ClientObject {
|
|
115456
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
115457
|
+
context: RequestContext;
|
|
115433
115458
|
/**
|
|
115434
|
-
* Specifies
|
|
115459
|
+
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
115460
|
+
*
|
|
115435
115461
|
* @remarks
|
|
115436
115462
|
* [Api set: PowerPointApi 1.4]
|
|
115437
115463
|
*/
|
|
115438
|
-
|
|
115464
|
+
visible: boolean;
|
|
115439
115465
|
/**
|
|
115440
|
-
*
|
|
115441
|
-
*
|
|
115442
|
-
*
|
|
115466
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
115467
|
+
*
|
|
115468
|
+
* @param options Provides options for which properties of the object to load.
|
|
115443
115469
|
*/
|
|
115444
|
-
|
|
115470
|
+
load(options?: PowerPoint.Interfaces.BulletFormatLoadOptions): PowerPoint.BulletFormat;
|
|
115445
115471
|
/**
|
|
115446
|
-
*
|
|
115447
|
-
*
|
|
115448
|
-
*
|
|
115472
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
115473
|
+
*
|
|
115474
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
115449
115475
|
*/
|
|
115450
|
-
|
|
115476
|
+
load(propertyNames?: string | string[]): PowerPoint.BulletFormat;
|
|
115451
115477
|
/**
|
|
115452
|
-
*
|
|
115453
|
-
*
|
|
115454
|
-
*
|
|
115478
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
115479
|
+
*
|
|
115480
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
115455
115481
|
*/
|
|
115456
|
-
|
|
115482
|
+
load(propertyNamesAndPaths?: {
|
|
115483
|
+
select?: string;
|
|
115484
|
+
expand?: string;
|
|
115485
|
+
}): PowerPoint.BulletFormat;
|
|
115457
115486
|
/**
|
|
115458
|
-
|
|
115459
|
-
|
|
115460
|
-
|
|
115461
|
-
|
|
115462
|
-
bottomCentered = "BottomCentered",
|
|
115487
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
115488
|
+
* Whereas the original PowerPoint.BulletFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BulletFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
115489
|
+
*/
|
|
115490
|
+
toJSON(): PowerPoint.Interfaces.BulletFormatData;
|
|
115463
115491
|
}
|
|
115464
115492
|
/**
|
|
115465
|
-
*
|
|
115493
|
+
* Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
|
|
115466
115494
|
*
|
|
115467
115495
|
* @remarks
|
|
115468
115496
|
* [Api set: PowerPointApi 1.4]
|
|
115469
115497
|
*/
|
|
115470
|
-
|
|
115471
|
-
/**
|
|
115472
|
-
|
|
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",
|
|
115498
|
+
class ParagraphFormat extends OfficeExtension.ClientObject {
|
|
115499
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
115500
|
+
context: RequestContext;
|
|
115537
115501
|
/**
|
|
115538
|
-
*
|
|
115502
|
+
* Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
|
|
115503
|
+
*
|
|
115539
115504
|
* @remarks
|
|
115540
115505
|
* [Api set: PowerPointApi 1.4]
|
|
115541
115506
|
*/
|
|
115542
|
-
|
|
115507
|
+
readonly bulletFormat: PowerPoint.BulletFormat;
|
|
115543
115508
|
/**
|
|
115544
|
-
*
|
|
115509
|
+
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
115510
|
+
*
|
|
115545
115511
|
* @remarks
|
|
115546
115512
|
* [Api set: PowerPointApi 1.4]
|
|
115547
115513
|
*/
|
|
115548
|
-
|
|
115514
|
+
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
|
|
115549
115515
|
/**
|
|
115550
|
-
*
|
|
115551
|
-
*
|
|
115552
|
-
*
|
|
115516
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
115517
|
+
*
|
|
115518
|
+
* @param options Provides options for which properties of the object to load.
|
|
115553
115519
|
*/
|
|
115554
|
-
|
|
115520
|
+
load(options?: PowerPoint.Interfaces.ParagraphFormatLoadOptions): PowerPoint.ParagraphFormat;
|
|
115555
115521
|
/**
|
|
115556
|
-
*
|
|
115557
|
-
*
|
|
115558
|
-
*
|
|
115522
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
115523
|
+
*
|
|
115524
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
115559
115525
|
*/
|
|
115560
|
-
|
|
115526
|
+
load(propertyNames?: string | string[]): PowerPoint.ParagraphFormat;
|
|
115561
115527
|
/**
|
|
115562
|
-
*
|
|
115563
|
-
*
|
|
115564
|
-
*
|
|
115528
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
115529
|
+
*
|
|
115530
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
115565
115531
|
*/
|
|
115566
|
-
|
|
115532
|
+
load(propertyNamesAndPaths?: {
|
|
115533
|
+
select?: string;
|
|
115534
|
+
expand?: string;
|
|
115535
|
+
}): PowerPoint.ParagraphFormat;
|
|
115567
115536
|
/**
|
|
115568
|
-
|
|
115569
|
-
|
|
115570
|
-
|
|
115571
|
-
|
|
115572
|
-
wavyDouble = "WavyDouble",
|
|
115537
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that is passed to it.)
|
|
115538
|
+
* Whereas the original PowerPoint.ParagraphFormat object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ParagraphFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
115539
|
+
*/
|
|
115540
|
+
toJSON(): PowerPoint.Interfaces.ParagraphFormatData;
|
|
115573
115541
|
}
|
|
115574
115542
|
/**
|
|
115575
115543
|
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
|
|
@@ -115937,7 +115905,7 @@ declare namespace PowerPoint {
|
|
|
115937
115905
|
* @remarks
|
|
115938
115906
|
* [Api set: PowerPointApi 1.4]
|
|
115939
115907
|
*/
|
|
115940
|
-
readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
|
|
115908
|
+
readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
|
|
115941
115909
|
/**
|
|
115942
115910
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
115943
115911
|
*
|
|
@@ -116021,6 +115989,61 @@ declare namespace PowerPoint {
|
|
|
116021
115989
|
*/
|
|
116022
115990
|
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
116023
115991
|
}
|
|
115992
|
+
/**
|
|
115993
|
+
* Specifies the formatting options for when slides are inserted.
|
|
115994
|
+
*
|
|
115995
|
+
* @remarks
|
|
115996
|
+
* [Api set: PowerPointApi 1.2]
|
|
115997
|
+
*/
|
|
115998
|
+
enum InsertSlideFormatting {
|
|
115999
|
+
/**
|
|
116000
|
+
* Copy the source theme into the target presentation and use that theme.
|
|
116001
|
+
* @remarks
|
|
116002
|
+
* [Api set: PowerPointApi 1.2]
|
|
116003
|
+
*/
|
|
116004
|
+
keepSourceFormatting = "KeepSourceFormatting",
|
|
116005
|
+
/**
|
|
116006
|
+
* Use the existing theme in the target presentation.
|
|
116007
|
+
* @remarks
|
|
116008
|
+
* [Api set: PowerPointApi 1.2]
|
|
116009
|
+
*/
|
|
116010
|
+
useDestinationTheme = "UseDestinationTheme",
|
|
116011
|
+
}
|
|
116012
|
+
/**
|
|
116013
|
+
* Represents the available options when inserting slides.
|
|
116014
|
+
*
|
|
116015
|
+
* @remarks
|
|
116016
|
+
* [Api set: PowerPointApi 1.2]
|
|
116017
|
+
*/
|
|
116018
|
+
interface InsertSlideOptions {
|
|
116019
|
+
/**
|
|
116020
|
+
* Specifies which formatting to use during slide insertion.
|
|
116021
|
+
The default option is to use "KeepSourceFormatting".
|
|
116022
|
+
*
|
|
116023
|
+
* @remarks
|
|
116024
|
+
* [Api set: PowerPointApi 1.2]
|
|
116025
|
+
*/
|
|
116026
|
+
formatting?: PowerPoint.InsertSlideFormatting | "KeepSourceFormatting" | "UseDestinationTheme";
|
|
116027
|
+
/**
|
|
116028
|
+
* Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
|
|
116029
|
+
The order of these slides is preserved during the insertion.
|
|
116030
|
+
If any of the source slides are not found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
|
|
116031
|
+
All of the source slides will be inserted when `sourceSlideIds` is not provided (this is the default behavior).
|
|
116032
|
+
*
|
|
116033
|
+
* @remarks
|
|
116034
|
+
* [Api set: PowerPointApi 1.2]
|
|
116035
|
+
*/
|
|
116036
|
+
sourceSlideIds?: string[];
|
|
116037
|
+
/**
|
|
116038
|
+
* Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
|
|
116039
|
+
If `targetSlideId` is not provided, the slides will be inserted at the beginning of the presentation.
|
|
116040
|
+
If `targetSlideId` is invalid or if it is pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
|
|
116041
|
+
*
|
|
116042
|
+
* @remarks
|
|
116043
|
+
* [Api set: PowerPointApi 1.2]
|
|
116044
|
+
*/
|
|
116045
|
+
targetSlideId?: string;
|
|
116046
|
+
}
|
|
116024
116047
|
/**
|
|
116025
116048
|
* Represents a collection of shapes.
|
|
116026
116049
|
*
|
|
@@ -116345,26 +116368,6 @@ declare namespace PowerPoint {
|
|
|
116345
116368
|
*/
|
|
116346
116369
|
$skip?: number;
|
|
116347
116370
|
}
|
|
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
116371
|
/** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
|
|
116369
116372
|
interface ShapeCollectionUpdateData {
|
|
116370
116373
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
@@ -116449,6 +116452,26 @@ declare namespace PowerPoint {
|
|
|
116449
116452
|
*/
|
|
116450
116453
|
weight?: number;
|
|
116451
116454
|
}
|
|
116455
|
+
/** An interface for updating data on the BulletFormat object, for use in `bulletFormat.set({ ... })`. */
|
|
116456
|
+
interface BulletFormatUpdateData {
|
|
116457
|
+
/**
|
|
116458
|
+
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
116459
|
+
*
|
|
116460
|
+
* @remarks
|
|
116461
|
+
* [Api set: PowerPointApi 1.4]
|
|
116462
|
+
*/
|
|
116463
|
+
visible?: boolean;
|
|
116464
|
+
}
|
|
116465
|
+
/** An interface for updating data on the ParagraphFormat object, for use in `paragraphFormat.set({ ... })`. */
|
|
116466
|
+
interface ParagraphFormatUpdateData {
|
|
116467
|
+
/**
|
|
116468
|
+
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
116469
|
+
*
|
|
116470
|
+
* @remarks
|
|
116471
|
+
* [Api set: PowerPointApi 1.4]
|
|
116472
|
+
*/
|
|
116473
|
+
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
|
|
116474
|
+
}
|
|
116452
116475
|
/** An interface for updating data on the ShapeFont object, for use in `shapeFont.set({ ... })`. */
|
|
116453
116476
|
interface ShapeFontUpdateData {
|
|
116454
116477
|
/**
|
|
@@ -116628,27 +116651,14 @@ declare namespace PowerPoint {
|
|
|
116628
116651
|
}
|
|
116629
116652
|
/** An interface describing the data returned by calling `presentation.toJSON()`. */
|
|
116630
116653
|
interface PresentationData {
|
|
116631
|
-
title?: string;
|
|
116632
|
-
}
|
|
116633
|
-
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
|
|
116634
|
-
interface BulletFormatData {
|
|
116635
116654
|
/**
|
|
116636
|
-
*
|
|
116655
|
+
* Gets the ID of the presentation.
|
|
116637
116656
|
*
|
|
116638
116657
|
* @remarks
|
|
116639
|
-
* [Api set: PowerPointApi 1.
|
|
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]
|
|
116658
|
+
* [Api set: PowerPointApi 1.5]
|
|
116650
116659
|
*/
|
|
116651
|
-
|
|
116660
|
+
id?: string;
|
|
116661
|
+
title?: string;
|
|
116652
116662
|
}
|
|
116653
116663
|
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
|
|
116654
116664
|
interface ShapeCollectionData {
|
|
@@ -116792,6 +116802,26 @@ declare namespace PowerPoint {
|
|
|
116792
116802
|
*/
|
|
116793
116803
|
weight?: number;
|
|
116794
116804
|
}
|
|
116805
|
+
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
|
|
116806
|
+
interface BulletFormatData {
|
|
116807
|
+
/**
|
|
116808
|
+
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
116809
|
+
*
|
|
116810
|
+
* @remarks
|
|
116811
|
+
* [Api set: PowerPointApi 1.4]
|
|
116812
|
+
*/
|
|
116813
|
+
visible?: boolean;
|
|
116814
|
+
}
|
|
116815
|
+
/** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */
|
|
116816
|
+
interface ParagraphFormatData {
|
|
116817
|
+
/**
|
|
116818
|
+
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
116819
|
+
*
|
|
116820
|
+
* @remarks
|
|
116821
|
+
* [Api set: PowerPointApi 1.4]
|
|
116822
|
+
*/
|
|
116823
|
+
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
|
|
116824
|
+
}
|
|
116795
116825
|
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
|
|
116796
116826
|
interface ShapeFontData {
|
|
116797
116827
|
/**
|
|
@@ -116965,7 +116995,7 @@ declare namespace PowerPoint {
|
|
|
116965
116995
|
* @remarks
|
|
116966
116996
|
* [Api set: PowerPointApi 1.4]
|
|
116967
116997
|
*/
|
|
116968
|
-
type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line";
|
|
116998
|
+
type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table";
|
|
116969
116999
|
/**
|
|
116970
117000
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
116971
117001
|
*
|
|
@@ -116995,56 +117025,18 @@ declare namespace PowerPoint {
|
|
|
116995
117025
|
* [Api set: PowerPointApi 1.0]
|
|
116996
117026
|
*/
|
|
116997
117027
|
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
117028
|
/**
|
|
117031
117029
|
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
117032
117030
|
*/
|
|
117033
117031
|
$all?: boolean;
|
|
117034
117032
|
/**
|
|
117035
|
-
|
|
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.
|
|
117033
|
+
* Gets the ID of the presentation.
|
|
117043
117034
|
*
|
|
117044
117035
|
* @remarks
|
|
117045
|
-
* [Api set: PowerPointApi 1.
|
|
117036
|
+
* [Api set: PowerPointApi 1.5]
|
|
117046
117037
|
*/
|
|
117047
|
-
|
|
117038
|
+
id?: boolean;
|
|
117039
|
+
title?: boolean;
|
|
117048
117040
|
}
|
|
117049
117041
|
/**
|
|
117050
117042
|
* Represents the collection of shapes.
|
|
@@ -117378,6 +117370,51 @@ declare namespace PowerPoint {
|
|
|
117378
117370
|
*/
|
|
117379
117371
|
weight?: boolean;
|
|
117380
117372
|
}
|
|
117373
|
+
/**
|
|
117374
|
+
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
|
|
117375
|
+
*
|
|
117376
|
+
* @remarks
|
|
117377
|
+
* [Api set: PowerPointApi 1.4]
|
|
117378
|
+
*/
|
|
117379
|
+
interface BulletFormatLoadOptions {
|
|
117380
|
+
/**
|
|
117381
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
117382
|
+
*/
|
|
117383
|
+
$all?: boolean;
|
|
117384
|
+
/**
|
|
117385
|
+
* Specifies if the bullets in the paragraph are visible. Returns 'null' if the 'TextRange' includes text fragments with different bullet visibility values.
|
|
117386
|
+
*
|
|
117387
|
+
* @remarks
|
|
117388
|
+
* [Api set: PowerPointApi 1.4]
|
|
117389
|
+
*/
|
|
117390
|
+
visible?: boolean;
|
|
117391
|
+
}
|
|
117392
|
+
/**
|
|
117393
|
+
* Represents the paragraph formatting properties of a text that is attached to the {@link PowerPoint.TextRange}.
|
|
117394
|
+
*
|
|
117395
|
+
* @remarks
|
|
117396
|
+
* [Api set: PowerPointApi 1.4]
|
|
117397
|
+
*/
|
|
117398
|
+
interface ParagraphFormatLoadOptions {
|
|
117399
|
+
/**
|
|
117400
|
+
Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
|
|
117401
|
+
*/
|
|
117402
|
+
$all?: boolean;
|
|
117403
|
+
/**
|
|
117404
|
+
* Represents the bullet format of the paragraph. See {@link PowerPoint.BulletFormat} for details.
|
|
117405
|
+
*
|
|
117406
|
+
* @remarks
|
|
117407
|
+
* [Api set: PowerPointApi 1.4]
|
|
117408
|
+
*/
|
|
117409
|
+
bulletFormat?: PowerPoint.Interfaces.BulletFormatLoadOptions;
|
|
117410
|
+
/**
|
|
117411
|
+
* Represents the horizontal alignment of the paragraph. Returns 'null' if the 'TextRange' includes text fragments with different horizontal alignment values. See {@link PowerPoint.ParagraphHorizontalAlignment} for details.
|
|
117412
|
+
*
|
|
117413
|
+
* @remarks
|
|
117414
|
+
* [Api set: PowerPointApi 1.4]
|
|
117415
|
+
*/
|
|
117416
|
+
horizontalAlignment?: boolean;
|
|
117417
|
+
}
|
|
117381
117418
|
/**
|
|
117382
117419
|
* Represents the font attributes, such as font name, font size, and color, for a shape's TextRange object.
|
|
117383
117420
|
*
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.378",
|
|
4
4
|
"description": "TypeScript definitions for office-js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "bcc55dc00af5d598cb779a049b17524cf96d7c0ddb9b6406bab86a02222978d6",
|
|
49
49
|
"typeScriptVersion": "4.7"
|
|
50
50
|
}
|