@types/office-js 1.0.249 → 1.0.252
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 +393 -393
- 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: Wed, 04 May 2022 22:31:37 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
|
@@ -543,16 +543,16 @@ declare namespace Office {
|
|
|
543
543
|
*/
|
|
544
544
|
interface Actions {
|
|
545
545
|
/**
|
|
546
|
-
* Associates the ID of an action with a function.
|
|
546
|
+
* Associates the ID or name of an action with a function.
|
|
547
547
|
*
|
|
548
|
-
* @param actionId The ID of an action that is defined in an extended manifest.
|
|
548
|
+
* @param actionId The ID of an action that is defined in an extended manifest or the name of the function as specified in a **FunctionName** element in the manifest.
|
|
549
549
|
* @param actionFunction The function that is run when the action is invoked.
|
|
550
550
|
*
|
|
551
551
|
* @remarks
|
|
552
552
|
* **Requirement set**: {@link https://docs.microsoft.com/javascript/api/requirement-sets/common/shared-runtime-requirement-sets | SharedRuntime 1.1}
|
|
553
553
|
*/
|
|
554
554
|
associate: (actionId: string, actionFunction: (arg?: any) => void) => void;
|
|
555
|
-
}
|
|
555
|
+
}
|
|
556
556
|
/**
|
|
557
557
|
* Message used in the `onVisibilityModeChanged` invocation.
|
|
558
558
|
*/
|
|
@@ -1850,7 +1850,7 @@ declare namespace Office {
|
|
|
1850
1850
|
*
|
|
1851
1851
|
* **Hosts**: Excel, Outlook (in preview), PowerPoint, Word
|
|
1852
1852
|
*
|
|
1853
|
-
* `OfficeTheme` is only supported in Office on Windows.
|
|
1853
|
+
* `OfficeTheme` is only supported in Office on Windows, Mac, and the web.
|
|
1854
1854
|
*/
|
|
1855
1855
|
interface OfficeTheme {
|
|
1856
1856
|
/**
|
|
@@ -96989,6 +96989,274 @@ declare namespace PowerPoint {
|
|
|
96989
96989
|
*/
|
|
96990
96990
|
targetSlideId?: string;
|
|
96991
96991
|
}
|
|
96992
|
+
/**
|
|
96993
|
+
* Represents the collection of shapes.
|
|
96994
|
+
*
|
|
96995
|
+
* @remarks
|
|
96996
|
+
* [Api set: PowerPointApi 1.3]
|
|
96997
|
+
*/
|
|
96998
|
+
class ShapeCollection extends OfficeExtension.ClientObject {
|
|
96999
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97000
|
+
context: RequestContext;
|
|
97001
|
+
/** Gets the loaded child items in this collection. */
|
|
97002
|
+
readonly items: PowerPoint.Shape[];
|
|
97003
|
+
/**
|
|
97004
|
+
* Gets the number of shapes in the collection.
|
|
97005
|
+
*
|
|
97006
|
+
* @remarks
|
|
97007
|
+
* [Api set: PowerPointApi 1.3]
|
|
97008
|
+
* @returns The number of shapes in the collection.
|
|
97009
|
+
*/
|
|
97010
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
97011
|
+
/**
|
|
97012
|
+
* Gets a shape using its unique ID. An error is thrown if the shape does not exist.
|
|
97013
|
+
*
|
|
97014
|
+
* @remarks
|
|
97015
|
+
* [Api set: PowerPointApi 1.3]
|
|
97016
|
+
*
|
|
97017
|
+
* @param key The ID of the shape.
|
|
97018
|
+
* @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
|
|
97019
|
+
*/
|
|
97020
|
+
getItem(key: string): PowerPoint.Shape;
|
|
97021
|
+
/**
|
|
97022
|
+
* Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
|
|
97023
|
+
*
|
|
97024
|
+
* @remarks
|
|
97025
|
+
* [Api set: PowerPointApi 1.3]
|
|
97026
|
+
*
|
|
97027
|
+
* @param index The index of the shape in the collection.
|
|
97028
|
+
* @returns The shape at the given index. An error is thrown if index is out of range.
|
|
97029
|
+
*/
|
|
97030
|
+
getItemAt(index: number): PowerPoint.Shape;
|
|
97031
|
+
/**
|
|
97032
|
+
* 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.
|
|
97033
|
+
*
|
|
97034
|
+
* @remarks
|
|
97035
|
+
* [Api set: PowerPointApi 1.3]
|
|
97036
|
+
*
|
|
97037
|
+
* @param id The ID of the shape.
|
|
97038
|
+
* @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.
|
|
97039
|
+
*/
|
|
97040
|
+
getItemOrNullObject(id: string): PowerPoint.Shape;
|
|
97041
|
+
/**
|
|
97042
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97043
|
+
*
|
|
97044
|
+
* @param options Provides options for which properties of the object to load.
|
|
97045
|
+
*/
|
|
97046
|
+
load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
|
|
97047
|
+
/**
|
|
97048
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97049
|
+
*
|
|
97050
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97051
|
+
*/
|
|
97052
|
+
load(propertyNames?: string | string[]): PowerPoint.ShapeCollection;
|
|
97053
|
+
/**
|
|
97054
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97055
|
+
*
|
|
97056
|
+
* @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.
|
|
97057
|
+
*/
|
|
97058
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
|
|
97059
|
+
/**
|
|
97060
|
+
* 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.)
|
|
97061
|
+
* Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
97062
|
+
*/
|
|
97063
|
+
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
|
|
97064
|
+
}
|
|
97065
|
+
/**
|
|
97066
|
+
* Represents the layout of a slide.
|
|
97067
|
+
*
|
|
97068
|
+
* @remarks
|
|
97069
|
+
* [Api set: PowerPointApi 1.3]
|
|
97070
|
+
*/
|
|
97071
|
+
class SlideLayout extends OfficeExtension.ClientObject {
|
|
97072
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97073
|
+
context: RequestContext;
|
|
97074
|
+
/**
|
|
97075
|
+
* Returns a collection of shapes in the slide layout.
|
|
97076
|
+
*
|
|
97077
|
+
* @remarks
|
|
97078
|
+
* [Api set: PowerPointApi 1.3]
|
|
97079
|
+
*/
|
|
97080
|
+
readonly shapes: PowerPoint.ShapeCollection;
|
|
97081
|
+
/**
|
|
97082
|
+
* Gets the unique ID of the slide layout.
|
|
97083
|
+
*
|
|
97084
|
+
* @remarks
|
|
97085
|
+
* [Api set: PowerPointApi 1.3]
|
|
97086
|
+
*/
|
|
97087
|
+
readonly id: string;
|
|
97088
|
+
/**
|
|
97089
|
+
* Gets the name of the slide layout.
|
|
97090
|
+
*
|
|
97091
|
+
* @remarks
|
|
97092
|
+
* [Api set: PowerPointApi 1.3]
|
|
97093
|
+
*/
|
|
97094
|
+
readonly name: string;
|
|
97095
|
+
/**
|
|
97096
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97097
|
+
*
|
|
97098
|
+
* @param options Provides options for which properties of the object to load.
|
|
97099
|
+
*/
|
|
97100
|
+
load(options?: PowerPoint.Interfaces.SlideLayoutLoadOptions): PowerPoint.SlideLayout;
|
|
97101
|
+
/**
|
|
97102
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97103
|
+
*
|
|
97104
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97105
|
+
*/
|
|
97106
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideLayout;
|
|
97107
|
+
/**
|
|
97108
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97109
|
+
*
|
|
97110
|
+
* @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.
|
|
97111
|
+
*/
|
|
97112
|
+
load(propertyNamesAndPaths?: {
|
|
97113
|
+
select?: string;
|
|
97114
|
+
expand?: string;
|
|
97115
|
+
}): PowerPoint.SlideLayout;
|
|
97116
|
+
/**
|
|
97117
|
+
* 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.)
|
|
97118
|
+
* Whereas the original PowerPoint.SlideLayout object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
|
|
97119
|
+
*/
|
|
97120
|
+
toJSON(): PowerPoint.Interfaces.SlideLayoutData;
|
|
97121
|
+
}
|
|
97122
|
+
/**
|
|
97123
|
+
* Represents the collection of layouts provided by the Slide Master for slides.
|
|
97124
|
+
*
|
|
97125
|
+
* @remarks
|
|
97126
|
+
* [Api set: PowerPointApi 1.3]
|
|
97127
|
+
*/
|
|
97128
|
+
class SlideLayoutCollection extends OfficeExtension.ClientObject {
|
|
97129
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97130
|
+
context: RequestContext;
|
|
97131
|
+
/** Gets the loaded child items in this collection. */
|
|
97132
|
+
readonly items: PowerPoint.SlideLayout[];
|
|
97133
|
+
/**
|
|
97134
|
+
* Gets the number of layouts in the collection.
|
|
97135
|
+
*
|
|
97136
|
+
* @remarks
|
|
97137
|
+
* [Api set: PowerPointApi 1.3]
|
|
97138
|
+
* @returns The number of layouts in the collection.
|
|
97139
|
+
*/
|
|
97140
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
97141
|
+
/**
|
|
97142
|
+
* Gets a layout using its unique ID.
|
|
97143
|
+
*
|
|
97144
|
+
* @remarks
|
|
97145
|
+
* [Api set: PowerPointApi 1.3]
|
|
97146
|
+
*
|
|
97147
|
+
* @param key The ID of the layout.
|
|
97148
|
+
* @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
|
|
97149
|
+
*/
|
|
97150
|
+
getItem(key: string): PowerPoint.SlideLayout;
|
|
97151
|
+
/**
|
|
97152
|
+
* Gets a layout using its zero-based index in the collection.
|
|
97153
|
+
*
|
|
97154
|
+
* @remarks
|
|
97155
|
+
* [Api set: PowerPointApi 1.3]
|
|
97156
|
+
*
|
|
97157
|
+
* @param index The index of the layout in the collection.
|
|
97158
|
+
* @returns The layout at the given index. An error is thrown if index is out of range.
|
|
97159
|
+
*/
|
|
97160
|
+
getItemAt(index: number): PowerPoint.SlideLayout;
|
|
97161
|
+
/**
|
|
97162
|
+
* Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information,
|
|
97163
|
+
see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
97164
|
+
*
|
|
97165
|
+
* @remarks
|
|
97166
|
+
* [Api set: PowerPointApi 1.3]
|
|
97167
|
+
*
|
|
97168
|
+
* @param id The ID of the layout.
|
|
97169
|
+
* @returns The layout with the unique ID.
|
|
97170
|
+
*/
|
|
97171
|
+
getItemOrNullObject(id: string): PowerPoint.SlideLayout;
|
|
97172
|
+
/**
|
|
97173
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97174
|
+
*
|
|
97175
|
+
* @param options Provides options for which properties of the object to load.
|
|
97176
|
+
*/
|
|
97177
|
+
load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
|
|
97178
|
+
/**
|
|
97179
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97180
|
+
*
|
|
97181
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97182
|
+
*/
|
|
97183
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
|
|
97184
|
+
/**
|
|
97185
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97186
|
+
*
|
|
97187
|
+
* @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.
|
|
97188
|
+
*/
|
|
97189
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
|
|
97190
|
+
/**
|
|
97191
|
+
* 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.)
|
|
97192
|
+
* Whereas the original `PowerPoint.SlideLayoutCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
97193
|
+
*/
|
|
97194
|
+
toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
|
|
97195
|
+
}
|
|
97196
|
+
/**
|
|
97197
|
+
* Represents the Slide Master of a slide.
|
|
97198
|
+
*
|
|
97199
|
+
* @remarks
|
|
97200
|
+
* [Api set: PowerPointApi 1.3]
|
|
97201
|
+
*/
|
|
97202
|
+
class SlideMaster extends OfficeExtension.ClientObject {
|
|
97203
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97204
|
+
context: RequestContext;
|
|
97205
|
+
/**
|
|
97206
|
+
* Gets the collection of layouts provided by the Slide Master for slides.
|
|
97207
|
+
*
|
|
97208
|
+
* @remarks
|
|
97209
|
+
* [Api set: PowerPointApi 1.3]
|
|
97210
|
+
*/
|
|
97211
|
+
readonly layouts: PowerPoint.SlideLayoutCollection;
|
|
97212
|
+
/**
|
|
97213
|
+
* Returns a collection of shapes in the Slide Master.
|
|
97214
|
+
*
|
|
97215
|
+
* @remarks
|
|
97216
|
+
* [Api set: PowerPointApi 1.3]
|
|
97217
|
+
*/
|
|
97218
|
+
readonly shapes: PowerPoint.ShapeCollection;
|
|
97219
|
+
/**
|
|
97220
|
+
* Gets the unique ID of the Slide Master.
|
|
97221
|
+
*
|
|
97222
|
+
* @remarks
|
|
97223
|
+
* [Api set: PowerPointApi 1.3]
|
|
97224
|
+
*/
|
|
97225
|
+
readonly id: string;
|
|
97226
|
+
/**
|
|
97227
|
+
* Gets the unique name of the Slide Master.
|
|
97228
|
+
*
|
|
97229
|
+
* @remarks
|
|
97230
|
+
* [Api set: PowerPointApi 1.3]
|
|
97231
|
+
*/
|
|
97232
|
+
readonly name: string;
|
|
97233
|
+
/**
|
|
97234
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97235
|
+
*
|
|
97236
|
+
* @param options Provides options for which properties of the object to load.
|
|
97237
|
+
*/
|
|
97238
|
+
load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
|
|
97239
|
+
/**
|
|
97240
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97241
|
+
*
|
|
97242
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97243
|
+
*/
|
|
97244
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
|
|
97245
|
+
/**
|
|
97246
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97247
|
+
*
|
|
97248
|
+
* @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.
|
|
97249
|
+
*/
|
|
97250
|
+
load(propertyNamesAndPaths?: {
|
|
97251
|
+
select?: string;
|
|
97252
|
+
expand?: string;
|
|
97253
|
+
}): PowerPoint.SlideMaster;
|
|
97254
|
+
/**
|
|
97255
|
+
* 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.)
|
|
97256
|
+
* Whereas the original PowerPoint.SlideMaster object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
|
|
97257
|
+
*/
|
|
97258
|
+
toJSON(): PowerPoint.Interfaces.SlideMasterData;
|
|
97259
|
+
}
|
|
96992
97260
|
/**
|
|
96993
97261
|
* Represents a single tag in the slide.
|
|
96994
97262
|
*
|
|
@@ -97132,177 +97400,68 @@ declare namespace PowerPoint {
|
|
|
97132
97400
|
toJSON(): PowerPoint.Interfaces.TagCollectionData;
|
|
97133
97401
|
}
|
|
97134
97402
|
/**
|
|
97135
|
-
* Represents a single
|
|
97136
|
-
*
|
|
97137
|
-
* @remarks
|
|
97138
|
-
* [Api set: PowerPointApi 1.3]
|
|
97139
|
-
*/
|
|
97140
|
-
class Shape extends OfficeExtension.ClientObject {
|
|
97141
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97142
|
-
context: RequestContext;
|
|
97143
|
-
/**
|
|
97144
|
-
* Returns a collection of tags in the shape.
|
|
97145
|
-
*
|
|
97146
|
-
* @remarks
|
|
97147
|
-
* [Api set: PowerPointApi 1.3]
|
|
97148
|
-
*/
|
|
97149
|
-
readonly tags: PowerPoint.TagCollection;
|
|
97150
|
-
/**
|
|
97151
|
-
* Gets the unique ID of the shape.
|
|
97152
|
-
*
|
|
97153
|
-
* @remarks
|
|
97154
|
-
* [Api set: PowerPointApi 1.3]
|
|
97155
|
-
*/
|
|
97156
|
-
readonly id: string;
|
|
97157
|
-
/**
|
|
97158
|
-
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
|
|
97159
|
-
*
|
|
97160
|
-
* @remarks
|
|
97161
|
-
* [Api set: PowerPointApi 1.3]
|
|
97162
|
-
*/
|
|
97163
|
-
delete(): void;
|
|
97164
|
-
/**
|
|
97165
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97166
|
-
*
|
|
97167
|
-
* @param options Provides options for which properties of the object to load.
|
|
97168
|
-
*/
|
|
97169
|
-
load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;
|
|
97170
|
-
/**
|
|
97171
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97172
|
-
*
|
|
97173
|
-
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97174
|
-
*/
|
|
97175
|
-
load(propertyNames?: string | string[]): PowerPoint.Shape;
|
|
97176
|
-
/**
|
|
97177
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97178
|
-
*
|
|
97179
|
-
* @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.
|
|
97180
|
-
*/
|
|
97181
|
-
load(propertyNamesAndPaths?: {
|
|
97182
|
-
select?: string;
|
|
97183
|
-
expand?: string;
|
|
97184
|
-
}): PowerPoint.Shape;
|
|
97185
|
-
/**
|
|
97186
|
-
* 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.)
|
|
97187
|
-
* Whereas the original PowerPoint.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
97188
|
-
*/
|
|
97189
|
-
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
97190
|
-
}
|
|
97191
|
-
/**
|
|
97192
|
-
* Represents the collection of shapes.
|
|
97403
|
+
* Represents a single slide of a presentation.
|
|
97193
97404
|
*
|
|
97194
97405
|
* @remarks
|
|
97195
|
-
* [Api set: PowerPointApi 1.
|
|
97406
|
+
* [Api set: PowerPointApi 1.2]
|
|
97196
97407
|
*/
|
|
97197
|
-
class
|
|
97408
|
+
class Slide extends OfficeExtension.ClientObject {
|
|
97198
97409
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97199
97410
|
context: RequestContext;
|
|
97200
|
-
/** Gets the loaded child items in this collection. */
|
|
97201
|
-
readonly items: PowerPoint.Shape[];
|
|
97202
|
-
/**
|
|
97203
|
-
* Gets the number of shapes in the collection.
|
|
97204
|
-
*
|
|
97205
|
-
* @remarks
|
|
97206
|
-
* [Api set: PowerPointApi 1.3]
|
|
97207
|
-
* @returns The number of shapes in the collection.
|
|
97208
|
-
*/
|
|
97209
|
-
getCount(): OfficeExtension.ClientResult<number>;
|
|
97210
97411
|
/**
|
|
97211
|
-
* Gets
|
|
97412
|
+
* Gets the layout of the slide.
|
|
97212
97413
|
*
|
|
97213
97414
|
* @remarks
|
|
97214
97415
|
* [Api set: PowerPointApi 1.3]
|
|
97215
|
-
*
|
|
97216
|
-
* @param key The ID of the shape.
|
|
97217
|
-
* @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
|
|
97218
97416
|
*/
|
|
97219
|
-
|
|
97417
|
+
readonly layout: PowerPoint.SlideLayout;
|
|
97220
97418
|
/**
|
|
97221
|
-
*
|
|
97419
|
+
* Returns a collection of shapes in the slide.
|
|
97222
97420
|
*
|
|
97223
97421
|
* @remarks
|
|
97224
97422
|
* [Api set: PowerPointApi 1.3]
|
|
97225
|
-
*
|
|
97226
|
-
* @param index The index of the shape in the collection.
|
|
97227
|
-
* @returns The shape at the given index. An error is thrown if index is out of range.
|
|
97228
97423
|
*/
|
|
97229
|
-
|
|
97424
|
+
readonly shapes: PowerPoint.ShapeCollection;
|
|
97230
97425
|
/**
|
|
97231
|
-
* Gets
|
|
97426
|
+
* Gets the `SlideMaster` object that represents the slide's default content.
|
|
97232
97427
|
*
|
|
97233
97428
|
* @remarks
|
|
97234
97429
|
* [Api set: PowerPointApi 1.3]
|
|
97235
|
-
*
|
|
97236
|
-
* @param id The ID of the shape.
|
|
97237
|
-
* @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.
|
|
97238
|
-
*/
|
|
97239
|
-
getItemOrNullObject(id: string): PowerPoint.Shape;
|
|
97240
|
-
/**
|
|
97241
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97242
|
-
*
|
|
97243
|
-
* @param options Provides options for which properties of the object to load.
|
|
97244
|
-
*/
|
|
97245
|
-
load(options?: PowerPoint.Interfaces.ShapeCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.ShapeCollection;
|
|
97246
|
-
/**
|
|
97247
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97248
|
-
*
|
|
97249
|
-
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97250
97430
|
*/
|
|
97251
|
-
|
|
97252
|
-
/**
|
|
97253
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97254
|
-
*
|
|
97255
|
-
* @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.
|
|
97256
|
-
*/
|
|
97257
|
-
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.ShapeCollection;
|
|
97258
|
-
/**
|
|
97259
|
-
* 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.)
|
|
97260
|
-
* Whereas the original `PowerPoint.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
97261
|
-
*/
|
|
97262
|
-
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
|
|
97263
|
-
}
|
|
97264
|
-
/**
|
|
97265
|
-
* Represents the layout of a slide.
|
|
97266
|
-
*
|
|
97267
|
-
* @remarks
|
|
97268
|
-
* [Api set: PowerPointApi 1.3]
|
|
97269
|
-
*/
|
|
97270
|
-
class SlideLayout extends OfficeExtension.ClientObject {
|
|
97271
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97272
|
-
context: RequestContext;
|
|
97431
|
+
readonly slideMaster: PowerPoint.SlideMaster;
|
|
97273
97432
|
/**
|
|
97274
|
-
* Returns a collection of
|
|
97433
|
+
* Returns a collection of tags in the slide.
|
|
97275
97434
|
*
|
|
97276
97435
|
* @remarks
|
|
97277
97436
|
* [Api set: PowerPointApi 1.3]
|
|
97278
97437
|
*/
|
|
97279
|
-
readonly
|
|
97438
|
+
readonly tags: PowerPoint.TagCollection;
|
|
97280
97439
|
/**
|
|
97281
|
-
* Gets the unique ID of the slide
|
|
97440
|
+
* Gets the unique ID of the slide.
|
|
97282
97441
|
*
|
|
97283
97442
|
* @remarks
|
|
97284
|
-
* [Api set: PowerPointApi 1.
|
|
97443
|
+
* [Api set: PowerPointApi 1.2]
|
|
97285
97444
|
*/
|
|
97286
97445
|
readonly id: string;
|
|
97287
97446
|
/**
|
|
97288
|
-
*
|
|
97447
|
+
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
|
|
97289
97448
|
*
|
|
97290
97449
|
* @remarks
|
|
97291
|
-
* [Api set: PowerPointApi 1.
|
|
97450
|
+
* [Api set: PowerPointApi 1.2]
|
|
97292
97451
|
*/
|
|
97293
|
-
|
|
97452
|
+
delete(): void;
|
|
97294
97453
|
/**
|
|
97295
97454
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97296
97455
|
*
|
|
97297
97456
|
* @param options Provides options for which properties of the object to load.
|
|
97298
97457
|
*/
|
|
97299
|
-
load(options?: PowerPoint.Interfaces.
|
|
97458
|
+
load(options?: PowerPoint.Interfaces.SlideLoadOptions): PowerPoint.Slide;
|
|
97300
97459
|
/**
|
|
97301
97460
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97302
97461
|
*
|
|
97303
97462
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97304
97463
|
*/
|
|
97305
|
-
load(propertyNames?: string | string[]): PowerPoint.
|
|
97464
|
+
load(propertyNames?: string | string[]): PowerPoint.Slide;
|
|
97306
97465
|
/**
|
|
97307
97466
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97308
97467
|
*
|
|
@@ -97311,214 +97470,55 @@ declare namespace PowerPoint {
|
|
|
97311
97470
|
load(propertyNamesAndPaths?: {
|
|
97312
97471
|
select?: string;
|
|
97313
97472
|
expand?: string;
|
|
97314
|
-
}): PowerPoint.
|
|
97315
|
-
/**
|
|
97316
|
-
* 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.)
|
|
97317
|
-
* Whereas the original PowerPoint.SlideLayout object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutData`) that contains shallow copies of any loaded child properties from the original object.
|
|
97318
|
-
*/
|
|
97319
|
-
toJSON(): PowerPoint.Interfaces.SlideLayoutData;
|
|
97320
|
-
}
|
|
97321
|
-
/**
|
|
97322
|
-
* Represents the collection of layouts provided by the Slide Master for slides.
|
|
97323
|
-
*
|
|
97324
|
-
* @remarks
|
|
97325
|
-
* [Api set: PowerPointApi 1.3]
|
|
97326
|
-
*/
|
|
97327
|
-
class SlideLayoutCollection extends OfficeExtension.ClientObject {
|
|
97328
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97329
|
-
context: RequestContext;
|
|
97330
|
-
/** Gets the loaded child items in this collection. */
|
|
97331
|
-
readonly items: PowerPoint.SlideLayout[];
|
|
97332
|
-
/**
|
|
97333
|
-
* Gets the number of layouts in the collection.
|
|
97334
|
-
*
|
|
97335
|
-
* @remarks
|
|
97336
|
-
* [Api set: PowerPointApi 1.3]
|
|
97337
|
-
* @returns The number of layouts in the collection.
|
|
97338
|
-
*/
|
|
97339
|
-
getCount(): OfficeExtension.ClientResult<number>;
|
|
97340
|
-
/**
|
|
97341
|
-
* Gets a layout using its unique ID.
|
|
97342
|
-
*
|
|
97343
|
-
* @remarks
|
|
97344
|
-
* [Api set: PowerPointApi 1.3]
|
|
97345
|
-
*
|
|
97346
|
-
* @param key The ID of the layout.
|
|
97347
|
-
* @returns The layout with the unique ID. If such a layout does not exist, an error is thrown.
|
|
97348
|
-
*/
|
|
97349
|
-
getItem(key: string): PowerPoint.SlideLayout;
|
|
97350
|
-
/**
|
|
97351
|
-
* Gets a layout using its zero-based index in the collection.
|
|
97352
|
-
*
|
|
97353
|
-
* @remarks
|
|
97354
|
-
* [Api set: PowerPointApi 1.3]
|
|
97355
|
-
*
|
|
97356
|
-
* @param index The index of the layout in the collection.
|
|
97357
|
-
* @returns The layout at the given index. An error is thrown if index is out of range.
|
|
97358
|
-
*/
|
|
97359
|
-
getItemAt(index: number): PowerPoint.SlideLayout;
|
|
97360
|
-
/**
|
|
97361
|
-
* Gets a layout using its unique ID. If such a layout does not exist, an object with an `isNullObject` property set to true is returned. For further information,
|
|
97362
|
-
see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
97363
|
-
*
|
|
97364
|
-
* @remarks
|
|
97365
|
-
* [Api set: PowerPointApi 1.3]
|
|
97366
|
-
*
|
|
97367
|
-
* @param id The ID of the layout.
|
|
97368
|
-
* @returns The layout with the unique ID.
|
|
97369
|
-
*/
|
|
97370
|
-
getItemOrNullObject(id: string): PowerPoint.SlideLayout;
|
|
97371
|
-
/**
|
|
97372
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97373
|
-
*
|
|
97374
|
-
* @param options Provides options for which properties of the object to load.
|
|
97375
|
-
*/
|
|
97376
|
-
load(options?: PowerPoint.Interfaces.SlideLayoutCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SlideLayoutCollection;
|
|
97377
|
-
/**
|
|
97378
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97379
|
-
*
|
|
97380
|
-
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97381
|
-
*/
|
|
97382
|
-
load(propertyNames?: string | string[]): PowerPoint.SlideLayoutCollection;
|
|
97383
|
-
/**
|
|
97384
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97385
|
-
*
|
|
97386
|
-
* @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.
|
|
97387
|
-
*/
|
|
97388
|
-
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SlideLayoutCollection;
|
|
97473
|
+
}): PowerPoint.Slide;
|
|
97389
97474
|
/**
|
|
97390
97475
|
* 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.)
|
|
97391
|
-
* Whereas the original
|
|
97476
|
+
* Whereas the original PowerPoint.Slide object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideData`) that contains shallow copies of any loaded child properties from the original object.
|
|
97392
97477
|
*/
|
|
97393
|
-
toJSON(): PowerPoint.Interfaces.
|
|
97478
|
+
toJSON(): PowerPoint.Interfaces.SlideData;
|
|
97394
97479
|
}
|
|
97395
97480
|
/**
|
|
97396
|
-
* Represents
|
|
97481
|
+
* Represents a single shape in the slide.
|
|
97397
97482
|
*
|
|
97398
97483
|
* @remarks
|
|
97399
97484
|
* [Api set: PowerPointApi 1.3]
|
|
97400
97485
|
*/
|
|
97401
|
-
class
|
|
97486
|
+
class Shape extends OfficeExtension.ClientObject {
|
|
97402
97487
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97403
97488
|
context: RequestContext;
|
|
97404
97489
|
/**
|
|
97405
|
-
*
|
|
97406
|
-
*
|
|
97407
|
-
* @remarks
|
|
97408
|
-
* [Api set: PowerPointApi 1.3]
|
|
97409
|
-
*/
|
|
97410
|
-
readonly layouts: PowerPoint.SlideLayoutCollection;
|
|
97411
|
-
/**
|
|
97412
|
-
* Returns a collection of shapes in the Slide Master.
|
|
97490
|
+
* Returns a collection of tags in the shape.
|
|
97413
97491
|
*
|
|
97414
97492
|
* @remarks
|
|
97415
97493
|
* [Api set: PowerPointApi 1.3]
|
|
97416
97494
|
*/
|
|
97417
|
-
readonly
|
|
97495
|
+
readonly tags: PowerPoint.TagCollection;
|
|
97418
97496
|
/**
|
|
97419
|
-
* Gets the unique ID of the
|
|
97497
|
+
* Gets the unique ID of the shape.
|
|
97420
97498
|
*
|
|
97421
97499
|
* @remarks
|
|
97422
97500
|
* [Api set: PowerPointApi 1.3]
|
|
97423
97501
|
*/
|
|
97424
97502
|
readonly id: string;
|
|
97425
97503
|
/**
|
|
97426
|
-
*
|
|
97427
|
-
*
|
|
97428
|
-
* @remarks
|
|
97429
|
-
* [Api set: PowerPointApi 1.3]
|
|
97430
|
-
*/
|
|
97431
|
-
readonly name: string;
|
|
97432
|
-
/**
|
|
97433
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97434
|
-
*
|
|
97435
|
-
* @param options Provides options for which properties of the object to load.
|
|
97436
|
-
*/
|
|
97437
|
-
load(options?: PowerPoint.Interfaces.SlideMasterLoadOptions): PowerPoint.SlideMaster;
|
|
97438
|
-
/**
|
|
97439
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97440
|
-
*
|
|
97441
|
-
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97442
|
-
*/
|
|
97443
|
-
load(propertyNames?: string | string[]): PowerPoint.SlideMaster;
|
|
97444
|
-
/**
|
|
97445
|
-
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97446
|
-
*
|
|
97447
|
-
* @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.
|
|
97448
|
-
*/
|
|
97449
|
-
load(propertyNamesAndPaths?: {
|
|
97450
|
-
select?: string;
|
|
97451
|
-
expand?: string;
|
|
97452
|
-
}): PowerPoint.SlideMaster;
|
|
97453
|
-
/**
|
|
97454
|
-
* 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.)
|
|
97455
|
-
* Whereas the original PowerPoint.SlideMaster object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterData`) that contains shallow copies of any loaded child properties from the original object.
|
|
97456
|
-
*/
|
|
97457
|
-
toJSON(): PowerPoint.Interfaces.SlideMasterData;
|
|
97458
|
-
}
|
|
97459
|
-
/**
|
|
97460
|
-
* Represents a single slide of a presentation.
|
|
97461
|
-
*
|
|
97462
|
-
* @remarks
|
|
97463
|
-
* [Api set: PowerPointApi 1.2]
|
|
97464
|
-
*/
|
|
97465
|
-
class Slide extends OfficeExtension.ClientObject {
|
|
97466
|
-
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
97467
|
-
context: RequestContext;
|
|
97468
|
-
/**
|
|
97469
|
-
* Gets the layout of the slide.
|
|
97470
|
-
*
|
|
97471
|
-
* @remarks
|
|
97472
|
-
* [Api set: PowerPointApi 1.3]
|
|
97473
|
-
*/
|
|
97474
|
-
readonly layout: PowerPoint.SlideLayout;
|
|
97475
|
-
/**
|
|
97476
|
-
* Returns a collection of shapes in the slide.
|
|
97477
|
-
*
|
|
97478
|
-
* @remarks
|
|
97479
|
-
* [Api set: PowerPointApi 1.3]
|
|
97480
|
-
*/
|
|
97481
|
-
readonly shapes: PowerPoint.ShapeCollection;
|
|
97482
|
-
/**
|
|
97483
|
-
* Gets the `SlideMaster` object that represents the slide's default content.
|
|
97484
|
-
*
|
|
97485
|
-
* @remarks
|
|
97486
|
-
* [Api set: PowerPointApi 1.3]
|
|
97487
|
-
*/
|
|
97488
|
-
readonly slideMaster: PowerPoint.SlideMaster;
|
|
97489
|
-
/**
|
|
97490
|
-
* Returns a collection of tags in the slide.
|
|
97504
|
+
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
|
|
97491
97505
|
*
|
|
97492
97506
|
* @remarks
|
|
97493
97507
|
* [Api set: PowerPointApi 1.3]
|
|
97494
97508
|
*/
|
|
97495
|
-
readonly tags: PowerPoint.TagCollection;
|
|
97496
|
-
/**
|
|
97497
|
-
* Gets the unique ID of the slide.
|
|
97498
|
-
*
|
|
97499
|
-
* @remarks
|
|
97500
|
-
* [Api set: PowerPointApi 1.2]
|
|
97501
|
-
*/
|
|
97502
|
-
readonly id: string;
|
|
97503
|
-
/**
|
|
97504
|
-
* Deletes the slide from the presentation. Does nothing if the slide does not exist.
|
|
97505
|
-
*
|
|
97506
|
-
* @remarks
|
|
97507
|
-
* [Api set: PowerPointApi 1.2]
|
|
97508
|
-
*/
|
|
97509
97509
|
delete(): void;
|
|
97510
97510
|
/**
|
|
97511
97511
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97512
97512
|
*
|
|
97513
97513
|
* @param options Provides options for which properties of the object to load.
|
|
97514
97514
|
*/
|
|
97515
|
-
load(options?: PowerPoint.Interfaces.
|
|
97515
|
+
load(options?: PowerPoint.Interfaces.ShapeLoadOptions): PowerPoint.Shape;
|
|
97516
97516
|
/**
|
|
97517
97517
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97518
97518
|
*
|
|
97519
97519
|
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
97520
97520
|
*/
|
|
97521
|
-
load(propertyNames?: string | string[]): PowerPoint.
|
|
97521
|
+
load(propertyNames?: string | string[]): PowerPoint.Shape;
|
|
97522
97522
|
/**
|
|
97523
97523
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
97524
97524
|
*
|
|
@@ -97527,12 +97527,12 @@ declare namespace PowerPoint {
|
|
|
97527
97527
|
load(propertyNamesAndPaths?: {
|
|
97528
97528
|
select?: string;
|
|
97529
97529
|
expand?: string;
|
|
97530
|
-
}): PowerPoint.
|
|
97530
|
+
}): PowerPoint.Shape;
|
|
97531
97531
|
/**
|
|
97532
97532
|
* 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.)
|
|
97533
|
-
* Whereas the original PowerPoint.
|
|
97533
|
+
* Whereas the original PowerPoint.Shape object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
97534
97534
|
*/
|
|
97535
|
-
toJSON(): PowerPoint.Interfaces.
|
|
97535
|
+
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
97536
97536
|
}
|
|
97537
97537
|
/**
|
|
97538
97538
|
* Represents the collection of slides in the presentation.
|
|
@@ -97710,6 +97710,14 @@ declare namespace PowerPoint {
|
|
|
97710
97710
|
*/
|
|
97711
97711
|
$skip?: number;
|
|
97712
97712
|
}
|
|
97713
|
+
/** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
|
|
97714
|
+
interface ShapeCollectionUpdateData {
|
|
97715
|
+
items?: PowerPoint.Interfaces.ShapeData[];
|
|
97716
|
+
}
|
|
97717
|
+
/** An interface for updating data on the SlideLayoutCollection object, for use in `slideLayoutCollection.set({ ... })`. */
|
|
97718
|
+
interface SlideLayoutCollectionUpdateData {
|
|
97719
|
+
items?: PowerPoint.Interfaces.SlideLayoutData[];
|
|
97720
|
+
}
|
|
97713
97721
|
/** An interface for updating data on the Tag object, for use in `tag.set({ ... })`. */
|
|
97714
97722
|
interface TagUpdateData {
|
|
97715
97723
|
/**
|
|
@@ -97724,14 +97732,6 @@ declare namespace PowerPoint {
|
|
|
97724
97732
|
interface TagCollectionUpdateData {
|
|
97725
97733
|
items?: PowerPoint.Interfaces.TagData[];
|
|
97726
97734
|
}
|
|
97727
|
-
/** An interface for updating data on the ShapeCollection object, for use in `shapeCollection.set({ ... })`. */
|
|
97728
|
-
interface ShapeCollectionUpdateData {
|
|
97729
|
-
items?: PowerPoint.Interfaces.ShapeData[];
|
|
97730
|
-
}
|
|
97731
|
-
/** An interface for updating data on the SlideLayoutCollection object, for use in `slideLayoutCollection.set({ ... })`. */
|
|
97732
|
-
interface SlideLayoutCollectionUpdateData {
|
|
97733
|
-
items?: PowerPoint.Interfaces.SlideLayoutData[];
|
|
97734
|
-
}
|
|
97735
97735
|
/** An interface for updating data on the SlideCollection object, for use in `slideCollection.set({ ... })`. */
|
|
97736
97736
|
interface SlideCollectionUpdateData {
|
|
97737
97737
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -97744,37 +97744,6 @@ declare namespace PowerPoint {
|
|
|
97744
97744
|
interface PresentationData {
|
|
97745
97745
|
title?: string;
|
|
97746
97746
|
}
|
|
97747
|
-
/** An interface describing the data returned by calling `tag.toJSON()`. */
|
|
97748
|
-
interface TagData {
|
|
97749
|
-
/**
|
|
97750
|
-
* Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
|
|
97751
|
-
*
|
|
97752
|
-
* @remarks
|
|
97753
|
-
* [Api set: PowerPointApi 1.3]
|
|
97754
|
-
*/
|
|
97755
|
-
key?: string;
|
|
97756
|
-
/**
|
|
97757
|
-
* Gets the value of the tag.
|
|
97758
|
-
*
|
|
97759
|
-
* @remarks
|
|
97760
|
-
* [Api set: PowerPointApi 1.3]
|
|
97761
|
-
*/
|
|
97762
|
-
value?: string;
|
|
97763
|
-
}
|
|
97764
|
-
/** An interface describing the data returned by calling `tagCollection.toJSON()`. */
|
|
97765
|
-
interface TagCollectionData {
|
|
97766
|
-
items?: PowerPoint.Interfaces.TagData[];
|
|
97767
|
-
}
|
|
97768
|
-
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
97769
|
-
interface ShapeData {
|
|
97770
|
-
/**
|
|
97771
|
-
* Gets the unique ID of the shape.
|
|
97772
|
-
*
|
|
97773
|
-
* @remarks
|
|
97774
|
-
* [Api set: PowerPointApi 1.3]
|
|
97775
|
-
*/
|
|
97776
|
-
id?: string;
|
|
97777
|
-
}
|
|
97778
97747
|
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
|
|
97779
97748
|
interface ShapeCollectionData {
|
|
97780
97749
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
@@ -97817,6 +97786,27 @@ declare namespace PowerPoint {
|
|
|
97817
97786
|
*/
|
|
97818
97787
|
name?: string;
|
|
97819
97788
|
}
|
|
97789
|
+
/** An interface describing the data returned by calling `tag.toJSON()`. */
|
|
97790
|
+
interface TagData {
|
|
97791
|
+
/**
|
|
97792
|
+
* Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
|
|
97793
|
+
*
|
|
97794
|
+
* @remarks
|
|
97795
|
+
* [Api set: PowerPointApi 1.3]
|
|
97796
|
+
*/
|
|
97797
|
+
key?: string;
|
|
97798
|
+
/**
|
|
97799
|
+
* Gets the value of the tag.
|
|
97800
|
+
*
|
|
97801
|
+
* @remarks
|
|
97802
|
+
* [Api set: PowerPointApi 1.3]
|
|
97803
|
+
*/
|
|
97804
|
+
value?: string;
|
|
97805
|
+
}
|
|
97806
|
+
/** An interface describing the data returned by calling `tagCollection.toJSON()`. */
|
|
97807
|
+
interface TagCollectionData {
|
|
97808
|
+
items?: PowerPoint.Interfaces.TagData[];
|
|
97809
|
+
}
|
|
97820
97810
|
/** An interface describing the data returned by calling `slide.toJSON()`. */
|
|
97821
97811
|
interface SlideData {
|
|
97822
97812
|
/**
|
|
@@ -97827,6 +97817,16 @@ declare namespace PowerPoint {
|
|
|
97827
97817
|
*/
|
|
97828
97818
|
id?: string;
|
|
97829
97819
|
}
|
|
97820
|
+
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
97821
|
+
interface ShapeData {
|
|
97822
|
+
/**
|
|
97823
|
+
* Gets the unique ID of the shape.
|
|
97824
|
+
*
|
|
97825
|
+
* @remarks
|
|
97826
|
+
* [Api set: PowerPointApi 1.3]
|
|
97827
|
+
*/
|
|
97828
|
+
id?: string;
|
|
97829
|
+
}
|
|
97830
97830
|
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
|
|
97831
97831
|
interface SlideCollectionData {
|
|
97832
97832
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -97847,115 +97847,96 @@ declare namespace PowerPoint {
|
|
|
97847
97847
|
title?: boolean;
|
|
97848
97848
|
}
|
|
97849
97849
|
/**
|
|
97850
|
-
* Represents
|
|
97850
|
+
* Represents the collection of shapes.
|
|
97851
97851
|
*
|
|
97852
97852
|
* @remarks
|
|
97853
97853
|
* [Api set: PowerPointApi 1.3]
|
|
97854
97854
|
*/
|
|
97855
|
-
interface
|
|
97855
|
+
interface ShapeCollectionLoadOptions {
|
|
97856
97856
|
/**
|
|
97857
97857
|
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`).
|
|
97858
97858
|
*/
|
|
97859
97859
|
$all?: boolean;
|
|
97860
97860
|
/**
|
|
97861
|
-
*
|
|
97862
|
-
*
|
|
97863
|
-
* @remarks
|
|
97864
|
-
* [Api set: PowerPointApi 1.3]
|
|
97865
|
-
*/
|
|
97866
|
-
key?: boolean;
|
|
97867
|
-
/**
|
|
97868
|
-
* Gets the value of the tag.
|
|
97861
|
+
* For EACH ITEM in the collection: Gets the unique ID of the shape.
|
|
97869
97862
|
*
|
|
97870
97863
|
* @remarks
|
|
97871
97864
|
* [Api set: PowerPointApi 1.3]
|
|
97872
97865
|
*/
|
|
97873
|
-
|
|
97866
|
+
id?: boolean;
|
|
97874
97867
|
}
|
|
97875
97868
|
/**
|
|
97876
|
-
* Represents the
|
|
97869
|
+
* Represents the layout of a slide.
|
|
97877
97870
|
*
|
|
97878
97871
|
* @remarks
|
|
97879
97872
|
* [Api set: PowerPointApi 1.3]
|
|
97880
97873
|
*/
|
|
97881
|
-
interface
|
|
97874
|
+
interface SlideLayoutLoadOptions {
|
|
97882
97875
|
/**
|
|
97883
97876
|
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`).
|
|
97884
97877
|
*/
|
|
97885
97878
|
$all?: boolean;
|
|
97886
97879
|
/**
|
|
97887
|
-
*
|
|
97880
|
+
* Gets the unique ID of the slide layout.
|
|
97888
97881
|
*
|
|
97889
97882
|
* @remarks
|
|
97890
97883
|
* [Api set: PowerPointApi 1.3]
|
|
97891
97884
|
*/
|
|
97892
|
-
|
|
97885
|
+
id?: boolean;
|
|
97893
97886
|
/**
|
|
97894
|
-
*
|
|
97887
|
+
* Gets the name of the slide layout.
|
|
97895
97888
|
*
|
|
97896
97889
|
* @remarks
|
|
97897
97890
|
* [Api set: PowerPointApi 1.3]
|
|
97898
97891
|
*/
|
|
97899
|
-
|
|
97892
|
+
name?: boolean;
|
|
97900
97893
|
}
|
|
97901
97894
|
/**
|
|
97902
|
-
* Represents
|
|
97895
|
+
* Represents the collection of layouts provided by the Slide Master for slides.
|
|
97903
97896
|
*
|
|
97904
97897
|
* @remarks
|
|
97905
97898
|
* [Api set: PowerPointApi 1.3]
|
|
97906
97899
|
*/
|
|
97907
|
-
interface
|
|
97900
|
+
interface SlideLayoutCollectionLoadOptions {
|
|
97908
97901
|
/**
|
|
97909
97902
|
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`).
|
|
97910
97903
|
*/
|
|
97911
97904
|
$all?: boolean;
|
|
97912
97905
|
/**
|
|
97913
|
-
* Gets the unique ID of the
|
|
97906
|
+
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
|
|
97914
97907
|
*
|
|
97915
97908
|
* @remarks
|
|
97916
97909
|
* [Api set: PowerPointApi 1.3]
|
|
97917
97910
|
*/
|
|
97918
97911
|
id?: boolean;
|
|
97919
|
-
}
|
|
97920
|
-
/**
|
|
97921
|
-
* Represents the collection of shapes.
|
|
97922
|
-
*
|
|
97923
|
-
* @remarks
|
|
97924
|
-
* [Api set: PowerPointApi 1.3]
|
|
97925
|
-
*/
|
|
97926
|
-
interface ShapeCollectionLoadOptions {
|
|
97927
|
-
/**
|
|
97928
|
-
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`).
|
|
97929
|
-
*/
|
|
97930
|
-
$all?: boolean;
|
|
97931
97912
|
/**
|
|
97932
|
-
* For EACH ITEM in the collection: Gets the
|
|
97913
|
+
* For EACH ITEM in the collection: Gets the name of the slide layout.
|
|
97933
97914
|
*
|
|
97934
97915
|
* @remarks
|
|
97935
97916
|
* [Api set: PowerPointApi 1.3]
|
|
97936
97917
|
*/
|
|
97937
|
-
|
|
97918
|
+
name?: boolean;
|
|
97938
97919
|
}
|
|
97939
97920
|
/**
|
|
97940
|
-
* Represents the
|
|
97921
|
+
* Represents the Slide Master of a slide.
|
|
97941
97922
|
*
|
|
97942
97923
|
* @remarks
|
|
97943
97924
|
* [Api set: PowerPointApi 1.3]
|
|
97944
97925
|
*/
|
|
97945
|
-
interface
|
|
97926
|
+
interface SlideMasterLoadOptions {
|
|
97946
97927
|
/**
|
|
97947
97928
|
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`).
|
|
97948
97929
|
*/
|
|
97949
97930
|
$all?: boolean;
|
|
97950
97931
|
/**
|
|
97951
|
-
* Gets the unique ID of the
|
|
97932
|
+
* Gets the unique ID of the Slide Master.
|
|
97952
97933
|
*
|
|
97953
97934
|
* @remarks
|
|
97954
97935
|
* [Api set: PowerPointApi 1.3]
|
|
97955
97936
|
*/
|
|
97956
97937
|
id?: boolean;
|
|
97957
97938
|
/**
|
|
97958
|
-
* Gets the name of the
|
|
97939
|
+
* Gets the unique name of the Slide Master.
|
|
97959
97940
|
*
|
|
97960
97941
|
* @remarks
|
|
97961
97942
|
* [Api set: PowerPointApi 1.3]
|
|
@@ -97963,56 +97944,56 @@ declare namespace PowerPoint {
|
|
|
97963
97944
|
name?: boolean;
|
|
97964
97945
|
}
|
|
97965
97946
|
/**
|
|
97966
|
-
* Represents
|
|
97947
|
+
* Represents a single tag in the slide.
|
|
97967
97948
|
*
|
|
97968
97949
|
* @remarks
|
|
97969
97950
|
* [Api set: PowerPointApi 1.3]
|
|
97970
97951
|
*/
|
|
97971
|
-
interface
|
|
97952
|
+
interface TagLoadOptions {
|
|
97972
97953
|
/**
|
|
97973
97954
|
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`).
|
|
97974
97955
|
*/
|
|
97975
97956
|
$all?: boolean;
|
|
97976
97957
|
/**
|
|
97977
|
-
*
|
|
97958
|
+
* Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
|
|
97978
97959
|
*
|
|
97979
97960
|
* @remarks
|
|
97980
97961
|
* [Api set: PowerPointApi 1.3]
|
|
97981
97962
|
*/
|
|
97982
|
-
|
|
97963
|
+
key?: boolean;
|
|
97983
97964
|
/**
|
|
97984
|
-
*
|
|
97965
|
+
* Gets the value of the tag.
|
|
97985
97966
|
*
|
|
97986
97967
|
* @remarks
|
|
97987
97968
|
* [Api set: PowerPointApi 1.3]
|
|
97988
97969
|
*/
|
|
97989
|
-
|
|
97970
|
+
value?: boolean;
|
|
97990
97971
|
}
|
|
97991
97972
|
/**
|
|
97992
|
-
* Represents the
|
|
97973
|
+
* Represents the collection of tags.
|
|
97993
97974
|
*
|
|
97994
97975
|
* @remarks
|
|
97995
97976
|
* [Api set: PowerPointApi 1.3]
|
|
97996
97977
|
*/
|
|
97997
|
-
interface
|
|
97978
|
+
interface TagCollectionLoadOptions {
|
|
97998
97979
|
/**
|
|
97999
97980
|
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`).
|
|
98000
97981
|
*/
|
|
98001
97982
|
$all?: boolean;
|
|
98002
97983
|
/**
|
|
98003
|
-
* Gets the unique ID of the
|
|
97984
|
+
* For EACH ITEM in the collection: Gets the unique ID of the tag. The `key` is unique within the owning `TagCollection` and always stored as uppercase letters within the document.
|
|
98004
97985
|
*
|
|
98005
97986
|
* @remarks
|
|
98006
97987
|
* [Api set: PowerPointApi 1.3]
|
|
98007
97988
|
*/
|
|
98008
|
-
|
|
97989
|
+
key?: boolean;
|
|
98009
97990
|
/**
|
|
98010
|
-
* Gets the
|
|
97991
|
+
* For EACH ITEM in the collection: Gets the value of the tag.
|
|
98011
97992
|
*
|
|
98012
97993
|
* @remarks
|
|
98013
97994
|
* [Api set: PowerPointApi 1.3]
|
|
98014
97995
|
*/
|
|
98015
|
-
|
|
97996
|
+
value?: boolean;
|
|
98016
97997
|
}
|
|
98017
97998
|
/**
|
|
98018
97999
|
* Represents a single slide of a presentation.
|
|
@@ -98047,6 +98028,25 @@ declare namespace PowerPoint {
|
|
|
98047
98028
|
*/
|
|
98048
98029
|
id?: boolean;
|
|
98049
98030
|
}
|
|
98031
|
+
/**
|
|
98032
|
+
* Represents a single shape in the slide.
|
|
98033
|
+
*
|
|
98034
|
+
* @remarks
|
|
98035
|
+
* [Api set: PowerPointApi 1.3]
|
|
98036
|
+
*/
|
|
98037
|
+
interface ShapeLoadOptions {
|
|
98038
|
+
/**
|
|
98039
|
+
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`).
|
|
98040
|
+
*/
|
|
98041
|
+
$all?: boolean;
|
|
98042
|
+
/**
|
|
98043
|
+
* Gets the unique ID of the shape.
|
|
98044
|
+
*
|
|
98045
|
+
* @remarks
|
|
98046
|
+
* [Api set: PowerPointApi 1.3]
|
|
98047
|
+
*/
|
|
98048
|
+
id?: boolean;
|
|
98049
|
+
}
|
|
98050
98050
|
/**
|
|
98051
98051
|
* Represents the collection of slides in the presentation.
|
|
98052
98052
|
*
|
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.252",
|
|
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": "f763b7c2e39bc3413d2d9edcf908075d89595659e0179bd47858516862405d8a",
|
|
49
49
|
"typeScriptVersion": "3.9"
|
|
50
50
|
}
|