@types/office-js 1.0.298 → 1.0.299
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 -0
- 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:
|
|
11
|
+
* Last updated: Fri, 11 Nov 2022 19:32:52 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js/index.d.ts
CHANGED
|
@@ -107352,6 +107352,39 @@ declare namespace PowerPoint {
|
|
|
107352
107352
|
*/
|
|
107353
107353
|
readonly tags: PowerPoint.TagCollection;
|
|
107354
107354
|
readonly title: string;
|
|
107355
|
+
/**
|
|
107356
|
+
* Returns the selected shapes in the current slide of the presentation.
|
|
107357
|
+
If no shapes are selected, an empty collection is returned.
|
|
107358
|
+
*
|
|
107359
|
+
* @remarks
|
|
107360
|
+
* [Api set: PowerPointApi 1.5]
|
|
107361
|
+
*/
|
|
107362
|
+
getSelectedShapes(): PowerPoint.ShapeScopedCollection;
|
|
107363
|
+
/**
|
|
107364
|
+
* Returns the selected slides in the current view of the presentation.
|
|
107365
|
+
The first item in the collection is the active slide that is visible in the editing area.
|
|
107366
|
+
If no slides are selected, an empty collection is returned.
|
|
107367
|
+
*
|
|
107368
|
+
* @remarks
|
|
107369
|
+
* [Api set: PowerPointApi 1.5]
|
|
107370
|
+
*/
|
|
107371
|
+
getSelectedSlides(): PowerPoint.SlideScopedCollection;
|
|
107372
|
+
/**
|
|
107373
|
+
* Returns the selected {@link PowerPoint.TextRange} in the current view of the presentation.
|
|
107374
|
+
Throws an exception if no text is selected.
|
|
107375
|
+
*
|
|
107376
|
+
* @remarks
|
|
107377
|
+
* [Api set: PowerPointApi 1.5]
|
|
107378
|
+
*/
|
|
107379
|
+
getSelectedTextRange(): PowerPoint.TextRange;
|
|
107380
|
+
/**
|
|
107381
|
+
* Returns the selected {@link PowerPoint.TextRange} in the current view of the presentation.
|
|
107382
|
+
If no text is selected, an object with an `isNullObject` property set to `true` is returned.
|
|
107383
|
+
*
|
|
107384
|
+
* @remarks
|
|
107385
|
+
* [Api set: PowerPointApi 1.5]
|
|
107386
|
+
*/
|
|
107387
|
+
getSelectedTextRangeOrNullObject(): PowerPoint.TextRange;
|
|
107355
107388
|
/**
|
|
107356
107389
|
* Inserts the specified slides from a presentation into the current presentation.
|
|
107357
107390
|
*
|
|
@@ -107362,6 +107395,15 @@ declare namespace PowerPoint {
|
|
|
107362
107395
|
* @param options The options that define which slides will be inserted, where the new slides will go, and which presentation's formatting will be used.
|
|
107363
107396
|
*/
|
|
107364
107397
|
insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions): void;
|
|
107398
|
+
/**
|
|
107399
|
+
* Selects the slides in the current view of the presentation. Existing slide selection is replaced with the new selection.
|
|
107400
|
+
*
|
|
107401
|
+
* @remarks
|
|
107402
|
+
* [Api set: PowerPointApi 1.5]
|
|
107403
|
+
*
|
|
107404
|
+
* @param slideIds List of slide IDs to select in the presentation. If the list is empty, selection is cleared.
|
|
107405
|
+
*/
|
|
107406
|
+
setSelectedSlides(slideIds: string[]): void;
|
|
107365
107407
|
/**
|
|
107366
107408
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
107367
107409
|
*
|
|
@@ -109268,6 +109310,15 @@ declare namespace PowerPoint {
|
|
|
109268
109310
|
* [Api set: PowerPointApi 1.2]
|
|
109269
109311
|
*/
|
|
109270
109312
|
delete(): void;
|
|
109313
|
+
/**
|
|
109314
|
+
* Selects the specified shapes. Existing shape selection is replaced with the new selection.
|
|
109315
|
+
*
|
|
109316
|
+
* @remarks
|
|
109317
|
+
* [Api set: PowerPointApi 1.5]
|
|
109318
|
+
*
|
|
109319
|
+
* @param shapeIds List of shape IDs to select in the slide. If the list is empty, the selection is cleared.
|
|
109320
|
+
*/
|
|
109321
|
+
setSelectedShapes(shapeIds: string[]): void;
|
|
109271
109322
|
/**
|
|
109272
109323
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
109273
109324
|
*
|
|
@@ -109935,6 +109986,22 @@ declare namespace PowerPoint {
|
|
|
109935
109986
|
* [Api set: PowerPointApi 1.4]
|
|
109936
109987
|
*/
|
|
109937
109988
|
readonly paragraphFormat: PowerPoint.ParagraphFormat;
|
|
109989
|
+
/**
|
|
109990
|
+
* Gets or sets the length of the range that this `TextRange` represents.
|
|
109991
|
+
Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
|
|
109992
|
+
*
|
|
109993
|
+
* @remarks
|
|
109994
|
+
* [Api set: PowerPointApi 1.5]
|
|
109995
|
+
*/
|
|
109996
|
+
length: number;
|
|
109997
|
+
/**
|
|
109998
|
+
* Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.
|
|
109999
|
+
Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
|
|
110000
|
+
*
|
|
110001
|
+
* @remarks
|
|
110002
|
+
* [Api set: PowerPointApi 1.5]
|
|
110003
|
+
*/
|
|
110004
|
+
start: number;
|
|
109938
110005
|
/**
|
|
109939
110006
|
* Represents the plain text content of the text range.
|
|
109940
110007
|
*
|
|
@@ -109942,6 +110009,13 @@ declare namespace PowerPoint {
|
|
|
109942
110009
|
* [Api set: PowerPointApi 1.4]
|
|
109943
110010
|
*/
|
|
109944
110011
|
text: string;
|
|
110012
|
+
/**
|
|
110013
|
+
* Returns the parent {@link PowerPoint.TextFrame} object that holds this `TextRange`.
|
|
110014
|
+
*
|
|
110015
|
+
* @remarks
|
|
110016
|
+
* [Api set: PowerPointApi 1.5]
|
|
110017
|
+
*/
|
|
110018
|
+
getParentTextFrame(): PowerPoint.TextFrame;
|
|
109945
110019
|
/**
|
|
109946
110020
|
* Returns a `TextRange` object for the substring in the given range.
|
|
109947
110021
|
*
|
|
@@ -109952,6 +110026,13 @@ declare namespace PowerPoint {
|
|
|
109952
110026
|
* @param length Optional. The number of characters to be returned in the new text range. If length is omitted, all the characters from start to the end of the text range's last paragraph will be returned.
|
|
109953
110027
|
*/
|
|
109954
110028
|
getSubstring(start: number, length?: number): PowerPoint.TextRange;
|
|
110029
|
+
/**
|
|
110030
|
+
* Selects this `TextRange` in the current view.
|
|
110031
|
+
*
|
|
110032
|
+
* @remarks
|
|
110033
|
+
* [Api set: PowerPointApi 1.5]
|
|
110034
|
+
*/
|
|
110035
|
+
setSelected(): void;
|
|
109955
110036
|
/**
|
|
109956
110037
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
109957
110038
|
*
|
|
@@ -110058,6 +110139,13 @@ declare namespace PowerPoint {
|
|
|
110058
110139
|
* [Api set: PowerPointApi 1.4]
|
|
110059
110140
|
*/
|
|
110060
110141
|
deleteText(): void;
|
|
110142
|
+
/**
|
|
110143
|
+
* Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`.
|
|
110144
|
+
*
|
|
110145
|
+
* @remarks
|
|
110146
|
+
* [Api set: PowerPointApi 1.5]
|
|
110147
|
+
*/
|
|
110148
|
+
getParentShape(): PowerPoint.Shape;
|
|
110061
110149
|
/**
|
|
110062
110150
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110063
110151
|
*
|
|
@@ -110178,6 +110266,48 @@ declare namespace PowerPoint {
|
|
|
110178
110266
|
* [Api set: PowerPointApi 1.3]
|
|
110179
110267
|
*/
|
|
110180
110268
|
delete(): void;
|
|
110269
|
+
/**
|
|
110270
|
+
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`.
|
|
110271
|
+
*
|
|
110272
|
+
* @remarks
|
|
110273
|
+
* [Api set: PowerPointApi 1.5]
|
|
110274
|
+
*/
|
|
110275
|
+
getParentSlide(): PowerPoint.Slide;
|
|
110276
|
+
/**
|
|
110277
|
+
* Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`.
|
|
110278
|
+
*
|
|
110279
|
+
* @remarks
|
|
110280
|
+
* [Api set: PowerPointApi 1.5]
|
|
110281
|
+
*/
|
|
110282
|
+
getParentSlideLayout(): PowerPoint.SlideLayout;
|
|
110283
|
+
/**
|
|
110284
|
+
* Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape does not belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned.
|
|
110285
|
+
*
|
|
110286
|
+
* @remarks
|
|
110287
|
+
* [Api set: PowerPointApi 1.5]
|
|
110288
|
+
*/
|
|
110289
|
+
getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;
|
|
110290
|
+
/**
|
|
110291
|
+
* Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`.
|
|
110292
|
+
*
|
|
110293
|
+
* @remarks
|
|
110294
|
+
* [Api set: PowerPointApi 1.5]
|
|
110295
|
+
*/
|
|
110296
|
+
getParentSlideMaster(): PowerPoint.SlideMaster;
|
|
110297
|
+
/**
|
|
110298
|
+
* Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape does not belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned.
|
|
110299
|
+
*
|
|
110300
|
+
* @remarks
|
|
110301
|
+
* [Api set: PowerPointApi 1.5]
|
|
110302
|
+
*/
|
|
110303
|
+
getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;
|
|
110304
|
+
/**
|
|
110305
|
+
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape does not belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned.
|
|
110306
|
+
*
|
|
110307
|
+
* @remarks
|
|
110308
|
+
* [Api set: PowerPointApi 1.5]
|
|
110309
|
+
*/
|
|
110310
|
+
getParentSlideOrNullObject(): PowerPoint.Slide;
|
|
110181
110311
|
/**
|
|
110182
110312
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110183
110313
|
*
|
|
@@ -110205,6 +110335,79 @@ declare namespace PowerPoint {
|
|
|
110205
110335
|
*/
|
|
110206
110336
|
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
110207
110337
|
}
|
|
110338
|
+
/**
|
|
110339
|
+
* Represents a collection of shapes.
|
|
110340
|
+
*
|
|
110341
|
+
* @remarks
|
|
110342
|
+
* [Api set: PowerPointApi 1.5]
|
|
110343
|
+
*/
|
|
110344
|
+
class ShapeScopedCollection extends OfficeExtension.ClientObject {
|
|
110345
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110346
|
+
context: RequestContext;
|
|
110347
|
+
/** Gets the loaded child items in this collection. */
|
|
110348
|
+
readonly items: PowerPoint.Shape[];
|
|
110349
|
+
/**
|
|
110350
|
+
* Gets the number of shapes in the collection.
|
|
110351
|
+
*
|
|
110352
|
+
* @remarks
|
|
110353
|
+
* [Api set: PowerPointApi 1.5]
|
|
110354
|
+
* @returns The number of shapes in the collection.
|
|
110355
|
+
*/
|
|
110356
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
110357
|
+
/**
|
|
110358
|
+
* Gets a shape using its unique ID. An error is thrown if the shape does not exist.
|
|
110359
|
+
*
|
|
110360
|
+
* @remarks
|
|
110361
|
+
* [Api set: PowerPointApi 1.5]
|
|
110362
|
+
*
|
|
110363
|
+
* @param key The ID of the shape.
|
|
110364
|
+
* @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
|
|
110365
|
+
*/
|
|
110366
|
+
getItem(key: string): PowerPoint.Shape;
|
|
110367
|
+
/**
|
|
110368
|
+
* Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
|
|
110369
|
+
*
|
|
110370
|
+
* @remarks
|
|
110371
|
+
* [Api set: PowerPointApi 1.5]
|
|
110372
|
+
*
|
|
110373
|
+
* @param index The index of the shape in the collection.
|
|
110374
|
+
* @returns The shape at the given index. An error is thrown if index is out of range.
|
|
110375
|
+
*/
|
|
110376
|
+
getItemAt(index: number): PowerPoint.Shape;
|
|
110377
|
+
/**
|
|
110378
|
+
* Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
|
|
110379
|
+
*
|
|
110380
|
+
* @remarks
|
|
110381
|
+
* [Api set: PowerPointApi 1.5]
|
|
110382
|
+
*
|
|
110383
|
+
* @param id The ID of the shape.
|
|
110384
|
+
* @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
|
|
110385
|
+
*/
|
|
110386
|
+
getItemOrNullObject(id: string): PowerPoint.Shape;
|
|
110387
|
+
/**
|
|
110388
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110389
|
+
*
|
|
110390
|
+
* @param options Provides options for which properties of the object to load.
|
|
110391
|
+
*/
|
|
110392
|
+
load(options?: PowerPoint.Interfaces.ShapeScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeScopedCollection;
|
|
110393
|
+
/**
|
|
110394
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110395
|
+
*
|
|
110396
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
110397
|
+
*/
|
|
110398
|
+
load(propertyNames?: string | string[]): PowerPoint.ShapeScopedCollection;
|
|
110399
|
+
/**
|
|
110400
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110401
|
+
*
|
|
110402
|
+
* @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.
|
|
110403
|
+
*/
|
|
110404
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeScopedCollection;
|
|
110405
|
+
/**
|
|
110406
|
+
* 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.)
|
|
110407
|
+
* Whereas the original `PowerPoint.ShapeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
110408
|
+
*/
|
|
110409
|
+
toJSON(): PowerPoint.Interfaces.ShapeScopedCollectionData;
|
|
110410
|
+
}
|
|
110208
110411
|
/**
|
|
110209
110412
|
* Represents the collection of slides in the presentation.
|
|
110210
110413
|
*
|
|
@@ -110290,6 +110493,81 @@ declare namespace PowerPoint {
|
|
|
110290
110493
|
*/
|
|
110291
110494
|
toJSON(): PowerPoint.Interfaces.SlideCollectionData;
|
|
110292
110495
|
}
|
|
110496
|
+
/**
|
|
110497
|
+
* Represents a collection of slides in the presentation.
|
|
110498
|
+
*
|
|
110499
|
+
* @remarks
|
|
110500
|
+
* [Api set: PowerPointApi 1.5]
|
|
110501
|
+
*/
|
|
110502
|
+
class SlideScopedCollection extends OfficeExtension.ClientObject {
|
|
110503
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
110504
|
+
context: RequestContext;
|
|
110505
|
+
/** Gets the loaded child items in this collection. */
|
|
110506
|
+
readonly items: PowerPoint.Slide[];
|
|
110507
|
+
/**
|
|
110508
|
+
* Gets the number of slides in the collection.
|
|
110509
|
+
*
|
|
110510
|
+
* @remarks
|
|
110511
|
+
* [Api set: PowerPointApi 1.5]
|
|
110512
|
+
* @returns The number of slides in the collection.
|
|
110513
|
+
*/
|
|
110514
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
110515
|
+
/**
|
|
110516
|
+
* Gets a slide using its unique ID.
|
|
110517
|
+
*
|
|
110518
|
+
* @remarks
|
|
110519
|
+
* [Api set: PowerPointApi 1.5]
|
|
110520
|
+
*
|
|
110521
|
+
* @param key The ID of the slide.
|
|
110522
|
+
* @returns The slide with the unique ID. If such a slide does not exist, an error is thrown.
|
|
110523
|
+
*/
|
|
110524
|
+
getItem(key: string): PowerPoint.Slide;
|
|
110525
|
+
/**
|
|
110526
|
+
* Gets a slide using its zero-based index in the collection.
|
|
110527
|
+
*
|
|
110528
|
+
* @remarks
|
|
110529
|
+
* [Api set: PowerPointApi 1.5]
|
|
110530
|
+
*
|
|
110531
|
+
* @param index The index of the slide in the collection.
|
|
110532
|
+
* @returns The slide at the given index. An error is thrown if index is out of range.
|
|
110533
|
+
*/
|
|
110534
|
+
getItemAt(index: number): PowerPoint.Slide;
|
|
110535
|
+
/**
|
|
110536
|
+
* Gets a slide using its unique ID. If such a slide does not exist, an object with an `isNullObject` property set to true is returned. For further information,
|
|
110537
|
+
see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods
|
|
110538
|
+
and properties}.
|
|
110539
|
+
*
|
|
110540
|
+
* @remarks
|
|
110541
|
+
* [Api set: PowerPointApi 1.5]
|
|
110542
|
+
*
|
|
110543
|
+
* @param id The ID of the slide.
|
|
110544
|
+
* @returns The slide with the unique ID.
|
|
110545
|
+
*/
|
|
110546
|
+
getItemOrNullObject(id: string): PowerPoint.Slide;
|
|
110547
|
+
/**
|
|
110548
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110549
|
+
*
|
|
110550
|
+
* @param options Provides options for which properties of the object to load.
|
|
110551
|
+
*/
|
|
110552
|
+
load(options?: PowerPoint.Interfaces.SlideScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideScopedCollection;
|
|
110553
|
+
/**
|
|
110554
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110555
|
+
*
|
|
110556
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
110557
|
+
*/
|
|
110558
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideScopedCollection;
|
|
110559
|
+
/**
|
|
110560
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
110561
|
+
*
|
|
110562
|
+
* @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.
|
|
110563
|
+
*/
|
|
110564
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideScopedCollection;
|
|
110565
|
+
/**
|
|
110566
|
+
* 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.)
|
|
110567
|
+
* Whereas the original `PowerPoint.SlideScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
110568
|
+
*/
|
|
110569
|
+
toJSON(): PowerPoint.Interfaces.SlideScopedCollectionData;
|
|
110570
|
+
}
|
|
110293
110571
|
/**
|
|
110294
110572
|
* Represents the collection of Slide Masters in the presentation.
|
|
110295
110573
|
*
|
|
@@ -110532,6 +110810,22 @@ declare namespace PowerPoint {
|
|
|
110532
110810
|
}
|
|
110533
110811
|
/** An interface for updating data on the TextRange object, for use in `textRange.set({ ... })`. */
|
|
110534
110812
|
interface TextRangeUpdateData {
|
|
110813
|
+
/**
|
|
110814
|
+
* Gets or sets the length of the range that this `TextRange` represents.
|
|
110815
|
+
Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
|
|
110816
|
+
*
|
|
110817
|
+
* @remarks
|
|
110818
|
+
* [Api set: PowerPointApi 1.5]
|
|
110819
|
+
*/
|
|
110820
|
+
length?: number;
|
|
110821
|
+
/**
|
|
110822
|
+
* Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.
|
|
110823
|
+
Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
|
|
110824
|
+
*
|
|
110825
|
+
* @remarks
|
|
110826
|
+
* [Api set: PowerPointApi 1.5]
|
|
110827
|
+
*/
|
|
110828
|
+
start?: number;
|
|
110535
110829
|
/**
|
|
110536
110830
|
* Represents the plain text content of the text range.
|
|
110537
110831
|
*
|
|
@@ -110630,10 +110924,18 @@ declare namespace PowerPoint {
|
|
|
110630
110924
|
*/
|
|
110631
110925
|
width?: number;
|
|
110632
110926
|
}
|
|
110927
|
+
/** An interface for updating data on the ShapeScopedCollection object, for use in `shapeScopedCollection.set({ ... })`. */
|
|
110928
|
+
interface ShapeScopedCollectionUpdateData {
|
|
110929
|
+
items?: PowerPoint.Interfaces.ShapeData[];
|
|
110930
|
+
}
|
|
110633
110931
|
/** An interface for updating data on the SlideCollection object, for use in `slideCollection.set({ ... })`. */
|
|
110634
110932
|
interface SlideCollectionUpdateData {
|
|
110635
110933
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
110636
110934
|
}
|
|
110935
|
+
/** An interface for updating data on the SlideScopedCollection object, for use in `slideScopedCollection.set({ ... })`. */
|
|
110936
|
+
interface SlideScopedCollectionUpdateData {
|
|
110937
|
+
items?: PowerPoint.Interfaces.SlideData[];
|
|
110938
|
+
}
|
|
110637
110939
|
/** An interface for updating data on the SlideMasterCollection object, for use in `slideMasterCollection.set({ ... })`. */
|
|
110638
110940
|
interface SlideMasterCollectionUpdateData {
|
|
110639
110941
|
items?: PowerPoint.Interfaces.SlideMasterData[];
|
|
@@ -110851,6 +111153,22 @@ declare namespace PowerPoint {
|
|
|
110851
111153
|
}
|
|
110852
111154
|
/** An interface describing the data returned by calling `textRange.toJSON()`. */
|
|
110853
111155
|
interface TextRangeData {
|
|
111156
|
+
/**
|
|
111157
|
+
* Gets or sets the length of the range that this `TextRange` represents.
|
|
111158
|
+
Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
|
|
111159
|
+
*
|
|
111160
|
+
* @remarks
|
|
111161
|
+
* [Api set: PowerPointApi 1.5]
|
|
111162
|
+
*/
|
|
111163
|
+
length?: number;
|
|
111164
|
+
/**
|
|
111165
|
+
* Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.
|
|
111166
|
+
Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
|
|
111167
|
+
*
|
|
111168
|
+
* @remarks
|
|
111169
|
+
* [Api set: PowerPointApi 1.5]
|
|
111170
|
+
*/
|
|
111171
|
+
start?: number;
|
|
110854
111172
|
/**
|
|
110855
111173
|
* Represents the plain text content of the text range.
|
|
110856
111174
|
*
|
|
@@ -110970,10 +111288,18 @@ declare namespace PowerPoint {
|
|
|
110970
111288
|
*/
|
|
110971
111289
|
width?: number;
|
|
110972
111290
|
}
|
|
111291
|
+
/** An interface describing the data returned by calling `shapeScopedCollection.toJSON()`. */
|
|
111292
|
+
interface ShapeScopedCollectionData {
|
|
111293
|
+
items?: PowerPoint.Interfaces.ShapeData[];
|
|
111294
|
+
}
|
|
110973
111295
|
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
|
|
110974
111296
|
interface SlideCollectionData {
|
|
110975
111297
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
110976
111298
|
}
|
|
111299
|
+
/** An interface describing the data returned by calling `slideScopedCollection.toJSON()`. */
|
|
111300
|
+
interface SlideScopedCollectionData {
|
|
111301
|
+
items?: PowerPoint.Interfaces.SlideData[];
|
|
111302
|
+
}
|
|
110977
111303
|
/** An interface describing the data returned by calling `slideMasterCollection.toJSON()`. */
|
|
110978
111304
|
interface SlideMasterCollectionData {
|
|
110979
111305
|
items?: PowerPoint.Interfaces.SlideMasterData[];
|
|
@@ -111445,6 +111771,22 @@ declare namespace PowerPoint {
|
|
|
111445
111771
|
* [Api set: PowerPointApi 1.4]
|
|
111446
111772
|
*/
|
|
111447
111773
|
paragraphFormat?: PowerPoint.Interfaces.ParagraphFormatLoadOptions;
|
|
111774
|
+
/**
|
|
111775
|
+
* Gets or sets the length of the range that this `TextRange` represents.
|
|
111776
|
+
Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
|
|
111777
|
+
*
|
|
111778
|
+
* @remarks
|
|
111779
|
+
* [Api set: PowerPointApi 1.5]
|
|
111780
|
+
*/
|
|
111781
|
+
length?: boolean;
|
|
111782
|
+
/**
|
|
111783
|
+
* Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.
|
|
111784
|
+
Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
|
|
111785
|
+
*
|
|
111786
|
+
* @remarks
|
|
111787
|
+
* [Api set: PowerPointApi 1.5]
|
|
111788
|
+
*/
|
|
111789
|
+
start?: boolean;
|
|
111448
111790
|
/**
|
|
111449
111791
|
* Represents the plain text content of the text range.
|
|
111450
111792
|
*
|
|
@@ -111610,6 +111952,88 @@ declare namespace PowerPoint {
|
|
|
111610
111952
|
*/
|
|
111611
111953
|
width?: boolean;
|
|
111612
111954
|
}
|
|
111955
|
+
/**
|
|
111956
|
+
* Represents a collection of shapes.
|
|
111957
|
+
*
|
|
111958
|
+
* @remarks
|
|
111959
|
+
* [Api set: PowerPointApi 1.3]
|
|
111960
|
+
*/
|
|
111961
|
+
interface ShapeScopedCollectionLoadOptions {
|
|
111962
|
+
/**
|
|
111963
|
+
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`).
|
|
111964
|
+
*/
|
|
111965
|
+
$all?: boolean;
|
|
111966
|
+
/**
|
|
111967
|
+
* For EACH ITEM in the collection: Returns the fill formatting of this shape.
|
|
111968
|
+
*
|
|
111969
|
+
* @remarks
|
|
111970
|
+
* [Api set: PowerPointApi 1.4]
|
|
111971
|
+
*/
|
|
111972
|
+
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
111973
|
+
/**
|
|
111974
|
+
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
111975
|
+
*
|
|
111976
|
+
* @remarks
|
|
111977
|
+
* [Api set: PowerPointApi 1.4]
|
|
111978
|
+
*/
|
|
111979
|
+
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
111980
|
+
/**
|
|
111981
|
+
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
111982
|
+
*
|
|
111983
|
+
* @remarks
|
|
111984
|
+
* [Api set: PowerPointApi 1.4]
|
|
111985
|
+
*/
|
|
111986
|
+
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
111987
|
+
/**
|
|
111988
|
+
* For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
111989
|
+
*
|
|
111990
|
+
* @remarks
|
|
111991
|
+
* [Api set: PowerPointApi 1.4]
|
|
111992
|
+
*/
|
|
111993
|
+
height?: boolean;
|
|
111994
|
+
/**
|
|
111995
|
+
* For EACH ITEM in the collection: Gets the unique ID of the shape.
|
|
111996
|
+
*
|
|
111997
|
+
* @remarks
|
|
111998
|
+
* [Api set: PowerPointApi 1.3]
|
|
111999
|
+
*/
|
|
112000
|
+
id?: boolean;
|
|
112001
|
+
/**
|
|
112002
|
+
* For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
|
|
112003
|
+
*
|
|
112004
|
+
* @remarks
|
|
112005
|
+
* [Api set: PowerPointApi 1.4]
|
|
112006
|
+
*/
|
|
112007
|
+
left?: boolean;
|
|
112008
|
+
/**
|
|
112009
|
+
* For EACH ITEM in the collection: Specifies the name of this shape.
|
|
112010
|
+
*
|
|
112011
|
+
* @remarks
|
|
112012
|
+
* [Api set: PowerPointApi 1.4]
|
|
112013
|
+
*/
|
|
112014
|
+
name?: boolean;
|
|
112015
|
+
/**
|
|
112016
|
+
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
112017
|
+
*
|
|
112018
|
+
* @remarks
|
|
112019
|
+
* [Api set: PowerPointApi 1.4]
|
|
112020
|
+
*/
|
|
112021
|
+
top?: boolean;
|
|
112022
|
+
/**
|
|
112023
|
+
* For EACH ITEM in the collection: Returns the type of this shape. See {@link PowerPoint.ShapeType} for details.
|
|
112024
|
+
*
|
|
112025
|
+
* @remarks
|
|
112026
|
+
* [Api set: PowerPointApi 1.4]
|
|
112027
|
+
*/
|
|
112028
|
+
type?: boolean;
|
|
112029
|
+
/**
|
|
112030
|
+
* For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
112031
|
+
*
|
|
112032
|
+
* @remarks
|
|
112033
|
+
* [Api set: PowerPointApi 1.4]
|
|
112034
|
+
*/
|
|
112035
|
+
width?: boolean;
|
|
112036
|
+
}
|
|
111613
112037
|
/**
|
|
111614
112038
|
* Represents the collection of slides in the presentation.
|
|
111615
112039
|
*
|
|
@@ -111643,6 +112067,39 @@ declare namespace PowerPoint {
|
|
|
111643
112067
|
*/
|
|
111644
112068
|
id?: boolean;
|
|
111645
112069
|
}
|
|
112070
|
+
/**
|
|
112071
|
+
* Represents a collection of slides in the presentation.
|
|
112072
|
+
*
|
|
112073
|
+
* @remarks
|
|
112074
|
+
* [Api set: PowerPointApi 1.2]
|
|
112075
|
+
*/
|
|
112076
|
+
interface SlideScopedCollectionLoadOptions {
|
|
112077
|
+
/**
|
|
112078
|
+
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`).
|
|
112079
|
+
*/
|
|
112080
|
+
$all?: boolean;
|
|
112081
|
+
/**
|
|
112082
|
+
* For EACH ITEM in the collection: Gets the layout of the slide.
|
|
112083
|
+
*
|
|
112084
|
+
* @remarks
|
|
112085
|
+
* [Api set: PowerPointApi 1.3]
|
|
112086
|
+
*/
|
|
112087
|
+
layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
|
|
112088
|
+
/**
|
|
112089
|
+
* For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
|
|
112090
|
+
*
|
|
112091
|
+
* @remarks
|
|
112092
|
+
* [Api set: PowerPointApi 1.3]
|
|
112093
|
+
*/
|
|
112094
|
+
slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
|
|
112095
|
+
/**
|
|
112096
|
+
* For EACH ITEM in the collection: Gets the unique ID of the slide.
|
|
112097
|
+
*
|
|
112098
|
+
* @remarks
|
|
112099
|
+
* [Api set: PowerPointApi 1.2]
|
|
112100
|
+
*/
|
|
112101
|
+
id?: boolean;
|
|
112102
|
+
}
|
|
111646
112103
|
/**
|
|
111647
112104
|
* Represents the collection of Slide Masters in the presentation.
|
|
111648
112105
|
*
|
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.299",
|
|
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": "af35f7fe51ae4ef1c1948f5d44cc584c5305712568ce41bd7eebf1be30b2a158",
|
|
49
49
|
"typeScriptVersion": "4.1"
|
|
50
50
|
}
|