@types/office-js-preview 1.0.574 → 1.0.576
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-preview/README.md +1 -1
- office-js-preview/index.d.ts +1494 -10
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -99061,8 +99061,7 @@ declare namespace Word {
|
|
|
99061
99061
|
* Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
|
|
99062
99062
|
*
|
|
99063
99063
|
* @remarks
|
|
99064
|
-
* [Api set:
|
|
99065
|
-
* @beta
|
|
99064
|
+
* [Api set: WordApiDesktop 1.2]
|
|
99066
99065
|
*/
|
|
99067
99066
|
hidden: boolean;
|
|
99068
99067
|
/**
|
|
@@ -111966,8 +111965,7 @@ declare namespace Word {
|
|
|
111966
111965
|
* Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
|
|
111967
111966
|
*
|
|
111968
111967
|
* @remarks
|
|
111969
|
-
* [Api set:
|
|
111970
|
-
* @beta
|
|
111968
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111971
111969
|
*/
|
|
111972
111970
|
hidden?: boolean;
|
|
111973
111971
|
/**
|
|
@@ -114251,8 +114249,7 @@ declare namespace Word {
|
|
|
114251
114249
|
* Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
|
|
114252
114250
|
*
|
|
114253
114251
|
* @remarks
|
|
114254
|
-
* [Api set:
|
|
114255
|
-
* @beta
|
|
114252
|
+
* [Api set: WordApiDesktop 1.2]
|
|
114256
114253
|
*/
|
|
114257
114254
|
hidden?: boolean;
|
|
114258
114255
|
/**
|
|
@@ -117669,8 +117666,7 @@ declare namespace Word {
|
|
|
117669
117666
|
* Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false.
|
|
117670
117667
|
*
|
|
117671
117668
|
* @remarks
|
|
117672
|
-
* [Api set:
|
|
117673
|
-
* @beta
|
|
117669
|
+
* [Api set: WordApiDesktop 1.2]
|
|
117674
117670
|
*/
|
|
117675
117671
|
hidden?: boolean;
|
|
117676
117672
|
/**
|
|
@@ -131477,6 +131473,14 @@ declare namespace PowerPoint {
|
|
|
131477
131473
|
class Presentation extends OfficeExtension.ClientObject {
|
|
131478
131474
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
131479
131475
|
context: RequestContext;
|
|
131476
|
+
/**
|
|
131477
|
+
* Returns a collection of bindings that are associated with the presentation.
|
|
131478
|
+
*
|
|
131479
|
+
* @remarks
|
|
131480
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
131481
|
+
* @beta
|
|
131482
|
+
*/
|
|
131483
|
+
readonly bindings: PowerPoint.BindingCollection;
|
|
131480
131484
|
/**
|
|
131481
131485
|
* Returns a collection of custom XML parts that are associated with the presentation.
|
|
131482
131486
|
*
|
|
@@ -131626,6 +131630,22 @@ declare namespace PowerPoint {
|
|
|
131626
131630
|
*/
|
|
131627
131631
|
slideMasterId?: string;
|
|
131628
131632
|
}
|
|
131633
|
+
/**
|
|
131634
|
+
* Binding type enumeration.
|
|
131635
|
+
*
|
|
131636
|
+
* @remarks
|
|
131637
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
131638
|
+
* @beta
|
|
131639
|
+
*/
|
|
131640
|
+
enum BindingType {
|
|
131641
|
+
/**
|
|
131642
|
+
* Represents a shape binding.
|
|
131643
|
+
* @remarks
|
|
131644
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
131645
|
+
* @beta
|
|
131646
|
+
*/
|
|
131647
|
+
shape = "Shape",
|
|
131648
|
+
}
|
|
131629
131649
|
/**
|
|
131630
131650
|
* Represents a custom XML part object.
|
|
131631
131651
|
*
|
|
@@ -133638,6 +133658,16 @@ declare namespace PowerPoint {
|
|
|
133638
133658
|
* [Api set: PowerPointApi 1.4]
|
|
133639
133659
|
*/
|
|
133640
133660
|
clear(): void;
|
|
133661
|
+
/**
|
|
133662
|
+
* Sets the fill formatting of the shape to an image. This changes the fill type to `PictureAndTexture`.
|
|
133663
|
+
*
|
|
133664
|
+
* @remarks
|
|
133665
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
133666
|
+
* @beta
|
|
133667
|
+
*
|
|
133668
|
+
* @param base64EncodedImage A string that is a Base64 encoding of the image data.
|
|
133669
|
+
*/
|
|
133670
|
+
setImage(base64EncodedImage: string): void;
|
|
133641
133671
|
/**
|
|
133642
133672
|
* Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Solid`.
|
|
133643
133673
|
*
|
|
@@ -133855,7 +133885,7 @@ declare namespace PowerPoint {
|
|
|
133855
133885
|
*/
|
|
133856
133886
|
italic: boolean | null;
|
|
133857
133887
|
/**
|
|
133858
|
-
* Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it
|
|
133888
|
+
* Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
|
|
133859
133889
|
*
|
|
133860
133890
|
* @remarks
|
|
133861
133891
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -133958,6 +133988,136 @@ declare namespace PowerPoint {
|
|
|
133958
133988
|
*/
|
|
133959
133989
|
toJSON(): PowerPoint.Interfaces.ShapeFontData;
|
|
133960
133990
|
}
|
|
133991
|
+
/**
|
|
133992
|
+
* Represents the font attributes, such as font name, size, and color.
|
|
133993
|
+
*
|
|
133994
|
+
* @remarks
|
|
133995
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
133996
|
+
* @beta
|
|
133997
|
+
*/
|
|
133998
|
+
interface FontProperties {
|
|
133999
|
+
/**
|
|
134000
|
+
* Represents whether the font uses all caps, where lowercase letters are shown as capital letters.
|
|
134001
|
+
*
|
|
134002
|
+
* @remarks
|
|
134003
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134004
|
+
* @beta
|
|
134005
|
+
*/
|
|
134006
|
+
allCaps?: boolean | undefined;
|
|
134007
|
+
/**
|
|
134008
|
+
* Represents the bold status of font.
|
|
134009
|
+
*
|
|
134010
|
+
* @remarks
|
|
134011
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134012
|
+
* @beta
|
|
134013
|
+
*/
|
|
134014
|
+
bold?: boolean | undefined;
|
|
134015
|
+
/**
|
|
134016
|
+
* Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").
|
|
134017
|
+
*
|
|
134018
|
+
* @remarks
|
|
134019
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134020
|
+
* @beta
|
|
134021
|
+
*/
|
|
134022
|
+
color?: string | undefined;
|
|
134023
|
+
/**
|
|
134024
|
+
* Represents the double-strikethrough status of the font.
|
|
134025
|
+
*
|
|
134026
|
+
* @remarks
|
|
134027
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134028
|
+
* @beta
|
|
134029
|
+
*/
|
|
134030
|
+
doubleStrikethrough?: boolean | undefined;
|
|
134031
|
+
/**
|
|
134032
|
+
* Represents the italic status of font.
|
|
134033
|
+
*
|
|
134034
|
+
* @remarks
|
|
134035
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134036
|
+
* @beta
|
|
134037
|
+
*/
|
|
134038
|
+
italic?: boolean | undefined;
|
|
134039
|
+
/**
|
|
134040
|
+
* Represents the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name.
|
|
134041
|
+
*
|
|
134042
|
+
* @remarks
|
|
134043
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134044
|
+
* @beta
|
|
134045
|
+
*/
|
|
134046
|
+
name?: string | undefined;
|
|
134047
|
+
/**
|
|
134048
|
+
* Represents the font size in points (e.g., 11).
|
|
134049
|
+
*
|
|
134050
|
+
* @remarks
|
|
134051
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134052
|
+
* @beta
|
|
134053
|
+
*/
|
|
134054
|
+
size?: number | undefined;
|
|
134055
|
+
/**
|
|
134056
|
+
* Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.
|
|
134057
|
+
*
|
|
134058
|
+
* @remarks
|
|
134059
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134060
|
+
* @beta
|
|
134061
|
+
*/
|
|
134062
|
+
smallCaps?: boolean | undefined;
|
|
134063
|
+
/**
|
|
134064
|
+
* Represents the strikethrough status of the font.
|
|
134065
|
+
*
|
|
134066
|
+
* @remarks
|
|
134067
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134068
|
+
* @beta
|
|
134069
|
+
*/
|
|
134070
|
+
strikethrough?: boolean | undefined;
|
|
134071
|
+
/**
|
|
134072
|
+
* Represents the subscript status of the font.
|
|
134073
|
+
*
|
|
134074
|
+
* @remarks
|
|
134075
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134076
|
+
* @beta
|
|
134077
|
+
*/
|
|
134078
|
+
subscript?: boolean | undefined;
|
|
134079
|
+
/**
|
|
134080
|
+
* Represents the superscript status of the font.
|
|
134081
|
+
*
|
|
134082
|
+
* @remarks
|
|
134083
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134084
|
+
* @beta
|
|
134085
|
+
*/
|
|
134086
|
+
superscript?: boolean | undefined;
|
|
134087
|
+
/**
|
|
134088
|
+
* Type of underline applied to the font. See {@link PowerPoint.ShapeFontUnderlineStyle} for details.
|
|
134089
|
+
*
|
|
134090
|
+
* @remarks
|
|
134091
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134092
|
+
* @beta
|
|
134093
|
+
*/
|
|
134094
|
+
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | undefined;
|
|
134095
|
+
}
|
|
134096
|
+
/**
|
|
134097
|
+
* Represents a sequence of one or more characters with the same font attributes.
|
|
134098
|
+
*
|
|
134099
|
+
* @remarks
|
|
134100
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134101
|
+
* @beta
|
|
134102
|
+
*/
|
|
134103
|
+
interface TextRun {
|
|
134104
|
+
/**
|
|
134105
|
+
* The font attributes (such as font name, font size, and color) applied to this text run.
|
|
134106
|
+
*
|
|
134107
|
+
* @remarks
|
|
134108
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134109
|
+
* @beta
|
|
134110
|
+
*/
|
|
134111
|
+
font?: PowerPoint.FontProperties;
|
|
134112
|
+
/**
|
|
134113
|
+
* The text of this text run.
|
|
134114
|
+
*
|
|
134115
|
+
* @remarks
|
|
134116
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134117
|
+
* @beta
|
|
134118
|
+
*/
|
|
134119
|
+
text: string;
|
|
134120
|
+
}
|
|
133961
134121
|
/**
|
|
133962
134122
|
* Represents the vertical alignment of a {@link PowerPoint.TextFrame} in a {@link PowerPoint.Shape}.
|
|
133963
134123
|
If one the centered options are selected, the contents of the `TextFrame` will be centered horizontally within the `Shape` as a group.
|
|
@@ -134004,6 +134164,685 @@ declare namespace PowerPoint {
|
|
|
134004
134164
|
*/
|
|
134005
134165
|
bottomCentered = "BottomCentered",
|
|
134006
134166
|
}
|
|
134167
|
+
/**
|
|
134168
|
+
* Represents a table.
|
|
134169
|
+
*
|
|
134170
|
+
* @remarks
|
|
134171
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134172
|
+
* @beta
|
|
134173
|
+
*/
|
|
134174
|
+
class TableCell extends OfficeExtension.ClientObject {
|
|
134175
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
134176
|
+
context: RequestContext;
|
|
134177
|
+
/**
|
|
134178
|
+
* Gets the number of table columns this cell spans across.
|
|
134179
|
+
Will be greater than or equal to 1.
|
|
134180
|
+
*
|
|
134181
|
+
* @remarks
|
|
134182
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134183
|
+
* @beta
|
|
134184
|
+
*/
|
|
134185
|
+
readonly columnCount: number;
|
|
134186
|
+
/**
|
|
134187
|
+
* Gets the zero-based column index of the cell within the table.
|
|
134188
|
+
*
|
|
134189
|
+
* @remarks
|
|
134190
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134191
|
+
* @beta
|
|
134192
|
+
*/
|
|
134193
|
+
readonly columnIndex: number;
|
|
134194
|
+
/**
|
|
134195
|
+
* Gets the number of table rows this cell spans across.
|
|
134196
|
+
Will be greater than or equal to 1.
|
|
134197
|
+
*
|
|
134198
|
+
* @remarks
|
|
134199
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134200
|
+
* @beta
|
|
134201
|
+
*/
|
|
134202
|
+
readonly rowCount: number;
|
|
134203
|
+
/**
|
|
134204
|
+
* Gets the zero-based row index of the cell within the table.
|
|
134205
|
+
*
|
|
134206
|
+
* @remarks
|
|
134207
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134208
|
+
* @beta
|
|
134209
|
+
*/
|
|
134210
|
+
readonly rowIndex: number;
|
|
134211
|
+
/**
|
|
134212
|
+
* Specifies the text content of the table cell.
|
|
134213
|
+
*
|
|
134214
|
+
* @remarks
|
|
134215
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134216
|
+
* @beta
|
|
134217
|
+
*/
|
|
134218
|
+
text: string;
|
|
134219
|
+
/**
|
|
134220
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134221
|
+
*
|
|
134222
|
+
* @param options Provides options for which properties of the object to load.
|
|
134223
|
+
*/
|
|
134224
|
+
load(options?: PowerPoint.Interfaces.TableCellLoadOptions): PowerPoint.TableCell;
|
|
134225
|
+
/**
|
|
134226
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134227
|
+
*
|
|
134228
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
134229
|
+
*/
|
|
134230
|
+
load(propertyNames?: string | string[]): PowerPoint.TableCell;
|
|
134231
|
+
/**
|
|
134232
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134233
|
+
*
|
|
134234
|
+
* @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.
|
|
134235
|
+
*/
|
|
134236
|
+
load(propertyNamesAndPaths?: {
|
|
134237
|
+
select?: string;
|
|
134238
|
+
expand?: string;
|
|
134239
|
+
}): PowerPoint.TableCell;
|
|
134240
|
+
/**
|
|
134241
|
+
* 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's passed to it.)
|
|
134242
|
+
* Whereas the original `PowerPoint.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object.
|
|
134243
|
+
*/
|
|
134244
|
+
toJSON(): PowerPoint.Interfaces.TableCellData;
|
|
134245
|
+
}
|
|
134246
|
+
/**
|
|
134247
|
+
* Represents a collection of table cells.
|
|
134248
|
+
*
|
|
134249
|
+
* @remarks
|
|
134250
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134251
|
+
* @beta
|
|
134252
|
+
*/
|
|
134253
|
+
class TableCellCollection extends OfficeExtension.ClientObject {
|
|
134254
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
134255
|
+
context: RequestContext;
|
|
134256
|
+
/** Gets the loaded child items in this collection. */
|
|
134257
|
+
readonly items: PowerPoint.TableCell[];
|
|
134258
|
+
/**
|
|
134259
|
+
* Gets the number of table cells in the collection.
|
|
134260
|
+
*
|
|
134261
|
+
* @remarks
|
|
134262
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134263
|
+
* @beta
|
|
134264
|
+
* @returns The number of table cells in the collection.
|
|
134265
|
+
*/
|
|
134266
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
134267
|
+
/**
|
|
134268
|
+
* Gets the table cell using its zero-based index in the collection. If the `TableCell` does not exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties) | *OrNullObject methods and properties}.
|
|
134269
|
+
*
|
|
134270
|
+
* @remarks
|
|
134271
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134272
|
+
* @beta
|
|
134273
|
+
*
|
|
134274
|
+
* @param row Row index value of the table cell to be retrieved, as a zero-based index.
|
|
134275
|
+
* @param column Column index value of the table cell to be retrieved, as a zero-based index.
|
|
134276
|
+
* @returns The `TableCell` object.
|
|
134277
|
+
*/
|
|
134278
|
+
getItemAtOrNullObject(row: number, column: number): PowerPoint.TableCell;
|
|
134279
|
+
/**
|
|
134280
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134281
|
+
*
|
|
134282
|
+
* @param options Provides options for which properties of the object to load.
|
|
134283
|
+
*/
|
|
134284
|
+
load(options?: PowerPoint.Interfaces.TableCellCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.TableCellCollection;
|
|
134285
|
+
/**
|
|
134286
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134287
|
+
*
|
|
134288
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
134289
|
+
*/
|
|
134290
|
+
load(propertyNames?: string | string[]): PowerPoint.TableCellCollection;
|
|
134291
|
+
/**
|
|
134292
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134293
|
+
*
|
|
134294
|
+
* @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.
|
|
134295
|
+
*/
|
|
134296
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableCellCollection;
|
|
134297
|
+
/**
|
|
134298
|
+
* 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's passed to it.)
|
|
134299
|
+
* Whereas the original `PowerPoint.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
134300
|
+
*/
|
|
134301
|
+
toJSON(): PowerPoint.Interfaces.TableCellCollectionData;
|
|
134302
|
+
}
|
|
134303
|
+
/**
|
|
134304
|
+
* Represents the fill formatting of a table cell.
|
|
134305
|
+
*
|
|
134306
|
+
* @remarks
|
|
134307
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134308
|
+
* @beta
|
|
134309
|
+
*/
|
|
134310
|
+
interface FillProperties {
|
|
134311
|
+
/**
|
|
134312
|
+
* Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
|
|
134313
|
+
*
|
|
134314
|
+
* @remarks
|
|
134315
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134316
|
+
* @beta
|
|
134317
|
+
*/
|
|
134318
|
+
color?: string | undefined;
|
|
134319
|
+
/**
|
|
134320
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
134321
|
+
*
|
|
134322
|
+
* @remarks
|
|
134323
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134324
|
+
* @beta
|
|
134325
|
+
*/
|
|
134326
|
+
transparency?: number | undefined;
|
|
134327
|
+
}
|
|
134328
|
+
/**
|
|
134329
|
+
* Represents the properties for a table cell border.
|
|
134330
|
+
*
|
|
134331
|
+
* @remarks
|
|
134332
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134333
|
+
* @beta
|
|
134334
|
+
*/
|
|
134335
|
+
interface BorderProperties {
|
|
134336
|
+
/**
|
|
134337
|
+
* Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").
|
|
134338
|
+
*
|
|
134339
|
+
* @remarks
|
|
134340
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134341
|
+
* @beta
|
|
134342
|
+
*/
|
|
134343
|
+
color?: string | undefined;
|
|
134344
|
+
/**
|
|
134345
|
+
* Represents the dash style of the line.
|
|
134346
|
+
*
|
|
134347
|
+
* @remarks
|
|
134348
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134349
|
+
* @beta
|
|
134350
|
+
*/
|
|
134351
|
+
dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot" | undefined;
|
|
134352
|
+
/**
|
|
134353
|
+
* Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).
|
|
134354
|
+
*
|
|
134355
|
+
* @remarks
|
|
134356
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134357
|
+
* @beta
|
|
134358
|
+
*/
|
|
134359
|
+
transparency?: number | undefined;
|
|
134360
|
+
/**
|
|
134361
|
+
* Represents the weight of the line, in points.
|
|
134362
|
+
*
|
|
134363
|
+
* @remarks
|
|
134364
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134365
|
+
* @beta
|
|
134366
|
+
*/
|
|
134367
|
+
weight?: number | undefined;
|
|
134368
|
+
}
|
|
134369
|
+
/**
|
|
134370
|
+
* Represents the borders of a table cell.
|
|
134371
|
+
*
|
|
134372
|
+
* @remarks
|
|
134373
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134374
|
+
* @beta
|
|
134375
|
+
*/
|
|
134376
|
+
interface TableCellBorders {
|
|
134377
|
+
/**
|
|
134378
|
+
* Represents the bottom border.
|
|
134379
|
+
*
|
|
134380
|
+
* @remarks
|
|
134381
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134382
|
+
* @beta
|
|
134383
|
+
*/
|
|
134384
|
+
bottom?: PowerPoint.BorderProperties;
|
|
134385
|
+
/**
|
|
134386
|
+
* Represents the diagonal border (top-left to bottom-right).
|
|
134387
|
+
*
|
|
134388
|
+
* @remarks
|
|
134389
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134390
|
+
* @beta
|
|
134391
|
+
*/
|
|
134392
|
+
diagonalDown?: PowerPoint.BorderProperties;
|
|
134393
|
+
/**
|
|
134394
|
+
* Represents the diagonal border (bottom-left to top-right).
|
|
134395
|
+
*
|
|
134396
|
+
* @remarks
|
|
134397
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134398
|
+
* @beta
|
|
134399
|
+
*/
|
|
134400
|
+
diagonalUp?: PowerPoint.BorderProperties;
|
|
134401
|
+
/**
|
|
134402
|
+
* Represents the left border.
|
|
134403
|
+
*
|
|
134404
|
+
* @remarks
|
|
134405
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134406
|
+
* @beta
|
|
134407
|
+
*/
|
|
134408
|
+
left?: PowerPoint.BorderProperties;
|
|
134409
|
+
/**
|
|
134410
|
+
* Represents the right border.
|
|
134411
|
+
*
|
|
134412
|
+
* @remarks
|
|
134413
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134414
|
+
* @beta
|
|
134415
|
+
*/
|
|
134416
|
+
right?: PowerPoint.BorderProperties;
|
|
134417
|
+
/**
|
|
134418
|
+
* Represents the top border.
|
|
134419
|
+
*
|
|
134420
|
+
* @remarks
|
|
134421
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134422
|
+
* @beta
|
|
134423
|
+
*/
|
|
134424
|
+
top?: PowerPoint.BorderProperties;
|
|
134425
|
+
}
|
|
134426
|
+
/**
|
|
134427
|
+
* Represents the margins of a table cell.
|
|
134428
|
+
*
|
|
134429
|
+
* @remarks
|
|
134430
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134431
|
+
* @beta
|
|
134432
|
+
*/
|
|
134433
|
+
interface TableCellMargins {
|
|
134434
|
+
/**
|
|
134435
|
+
* Specifies the bottom margin in points.
|
|
134436
|
+
*
|
|
134437
|
+
* @remarks
|
|
134438
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134439
|
+
* @beta
|
|
134440
|
+
*/
|
|
134441
|
+
bottom?: number | undefined;
|
|
134442
|
+
/**
|
|
134443
|
+
* Specifies the left margin in points.
|
|
134444
|
+
*
|
|
134445
|
+
* @remarks
|
|
134446
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134447
|
+
* @beta
|
|
134448
|
+
*/
|
|
134449
|
+
left?: number | undefined;
|
|
134450
|
+
/**
|
|
134451
|
+
* Specifies the right margin in points.
|
|
134452
|
+
*
|
|
134453
|
+
* @remarks
|
|
134454
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134455
|
+
* @beta
|
|
134456
|
+
*/
|
|
134457
|
+
right?: number | undefined;
|
|
134458
|
+
/**
|
|
134459
|
+
* Specifies the top margin in points.
|
|
134460
|
+
*
|
|
134461
|
+
* @remarks
|
|
134462
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134463
|
+
* @beta
|
|
134464
|
+
*/
|
|
134465
|
+
top?: number | undefined;
|
|
134466
|
+
}
|
|
134467
|
+
/**
|
|
134468
|
+
* Represents the table cell properties to update.
|
|
134469
|
+
*
|
|
134470
|
+
* @remarks
|
|
134471
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134472
|
+
* @beta
|
|
134473
|
+
*/
|
|
134474
|
+
interface TableCellProperties {
|
|
134475
|
+
/**
|
|
134476
|
+
* Specifies the border formatting of the table cell.
|
|
134477
|
+
*
|
|
134478
|
+
* @remarks
|
|
134479
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134480
|
+
* @beta
|
|
134481
|
+
*/
|
|
134482
|
+
borders?: PowerPoint.TableCellBorders;
|
|
134483
|
+
/**
|
|
134484
|
+
* Specifies the fill formatting of the table cell.
|
|
134485
|
+
*
|
|
134486
|
+
* @remarks
|
|
134487
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134488
|
+
* @beta
|
|
134489
|
+
*/
|
|
134490
|
+
fill?: PowerPoint.FillProperties;
|
|
134491
|
+
/**
|
|
134492
|
+
* Specifies the font formatting of the table cell.
|
|
134493
|
+
*
|
|
134494
|
+
* @remarks
|
|
134495
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134496
|
+
* @beta
|
|
134497
|
+
*/
|
|
134498
|
+
font?: PowerPoint.FontProperties;
|
|
134499
|
+
/**
|
|
134500
|
+
* Represents the horizontal alignment of the table cell.
|
|
134501
|
+
*
|
|
134502
|
+
* @remarks
|
|
134503
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134504
|
+
* @beta
|
|
134505
|
+
*/
|
|
134506
|
+
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | undefined;
|
|
134507
|
+
/**
|
|
134508
|
+
* Represents the indent level of the text in the table cell.
|
|
134509
|
+
*
|
|
134510
|
+
* @remarks
|
|
134511
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134512
|
+
* @beta
|
|
134513
|
+
*/
|
|
134514
|
+
indentLevel?: number | undefined;
|
|
134515
|
+
/**
|
|
134516
|
+
* Specifies the margin settings in the table cell.
|
|
134517
|
+
*
|
|
134518
|
+
* @remarks
|
|
134519
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134520
|
+
* @beta
|
|
134521
|
+
*/
|
|
134522
|
+
margins?: PowerPoint.TableCellMargins;
|
|
134523
|
+
/**
|
|
134524
|
+
* Specifies the text content of the table cell.
|
|
134525
|
+
|
|
134526
|
+
If a portion of the text requires different formatting, use the `textRuns` property instead.
|
|
134527
|
+
*
|
|
134528
|
+
* @remarks
|
|
134529
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134530
|
+
* @beta
|
|
134531
|
+
*/
|
|
134532
|
+
text?: string;
|
|
134533
|
+
/**
|
|
134534
|
+
* Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
134535
|
+
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
134536
|
+
*
|
|
134537
|
+
* @remarks
|
|
134538
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134539
|
+
* @beta
|
|
134540
|
+
*/
|
|
134541
|
+
textRuns?: PowerPoint.TextRun[];
|
|
134542
|
+
/**
|
|
134543
|
+
* Represents the vertical alignment of the table cell.
|
|
134544
|
+
*
|
|
134545
|
+
* @remarks
|
|
134546
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134547
|
+
* @beta
|
|
134548
|
+
*/
|
|
134549
|
+
verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
|
|
134550
|
+
}
|
|
134551
|
+
/**
|
|
134552
|
+
* Represents a table.
|
|
134553
|
+
*
|
|
134554
|
+
* @remarks
|
|
134555
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134556
|
+
* @beta
|
|
134557
|
+
*/
|
|
134558
|
+
class Table extends OfficeExtension.ClientObject {
|
|
134559
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
134560
|
+
context: RequestContext;
|
|
134561
|
+
/**
|
|
134562
|
+
* Gets the number of columns in the table.
|
|
134563
|
+
*
|
|
134564
|
+
* @remarks
|
|
134565
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134566
|
+
* @beta
|
|
134567
|
+
*/
|
|
134568
|
+
readonly columnCount: number;
|
|
134569
|
+
/**
|
|
134570
|
+
* Gets the number of rows in the table.
|
|
134571
|
+
*
|
|
134572
|
+
* @remarks
|
|
134573
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134574
|
+
* @beta
|
|
134575
|
+
*/
|
|
134576
|
+
readonly rowCount: number;
|
|
134577
|
+
/**
|
|
134578
|
+
* Gets all of the values in the table.
|
|
134579
|
+
*
|
|
134580
|
+
* @remarks
|
|
134581
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134582
|
+
* @beta
|
|
134583
|
+
*/
|
|
134584
|
+
readonly values: string[][];
|
|
134585
|
+
/**
|
|
134586
|
+
* Gets the cell at the specified `rowIndex` and `columnIndex`.
|
|
134587
|
+
*
|
|
134588
|
+
* @remarks
|
|
134589
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134590
|
+
* @beta
|
|
134591
|
+
*
|
|
134592
|
+
* @param rowIndex The zero-based row index of the cell.
|
|
134593
|
+
* @param columnIndex The zero-based column index of the cell.
|
|
134594
|
+
* @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned.
|
|
134595
|
+
*/
|
|
134596
|
+
getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
|
|
134597
|
+
/**
|
|
134598
|
+
* Gets a collection of cells that represent the merged areas of the table.
|
|
134599
|
+
*
|
|
134600
|
+
* @remarks
|
|
134601
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134602
|
+
* @beta
|
|
134603
|
+
* @returns a `TableCellCollection` with cells that represent the merged areas of the table.
|
|
134604
|
+
*/
|
|
134605
|
+
getMergedAreas(): PowerPoint.TableCellCollection;
|
|
134606
|
+
/**
|
|
134607
|
+
* Gets the shape object for the table.
|
|
134608
|
+
*
|
|
134609
|
+
* @remarks
|
|
134610
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134611
|
+
* @beta
|
|
134612
|
+
*/
|
|
134613
|
+
getShape(): PowerPoint.Shape;
|
|
134614
|
+
/**
|
|
134615
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134616
|
+
*
|
|
134617
|
+
* @param options Provides options for which properties of the object to load.
|
|
134618
|
+
*/
|
|
134619
|
+
load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table;
|
|
134620
|
+
/**
|
|
134621
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134622
|
+
*
|
|
134623
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
134624
|
+
*/
|
|
134625
|
+
load(propertyNames?: string | string[]): PowerPoint.Table;
|
|
134626
|
+
/**
|
|
134627
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
134628
|
+
*
|
|
134629
|
+
* @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.
|
|
134630
|
+
*/
|
|
134631
|
+
load(propertyNamesAndPaths?: {
|
|
134632
|
+
select?: string;
|
|
134633
|
+
expand?: string;
|
|
134634
|
+
}): PowerPoint.Table;
|
|
134635
|
+
/**
|
|
134636
|
+
* 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's passed to it.)
|
|
134637
|
+
* Whereas the original `PowerPoint.Table` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableData`) that contains shallow copies of any loaded child properties from the original object.
|
|
134638
|
+
*/
|
|
134639
|
+
toJSON(): PowerPoint.Interfaces.TableData;
|
|
134640
|
+
}
|
|
134641
|
+
/**
|
|
134642
|
+
* Provides the table column properties.
|
|
134643
|
+
*
|
|
134644
|
+
* @remarks
|
|
134645
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134646
|
+
* @beta
|
|
134647
|
+
*/
|
|
134648
|
+
interface TableColumnProperties {
|
|
134649
|
+
/**
|
|
134650
|
+
* Represents the desired width of each column in points, or is undefined.
|
|
134651
|
+
|
|
134652
|
+
When a table is being added, for columns whose width is undefined,
|
|
134653
|
+
the column width will be calculated by evenly dividing the remaining width
|
|
134654
|
+
of the table amongst those columns. If the table does not have a defined width,
|
|
134655
|
+
a default column width will be used.
|
|
134656
|
+
*
|
|
134657
|
+
* @remarks
|
|
134658
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134659
|
+
* @beta
|
|
134660
|
+
*/
|
|
134661
|
+
columnWidth?: number | undefined;
|
|
134662
|
+
}
|
|
134663
|
+
/**
|
|
134664
|
+
* Represents the properties of a merged area of cells in a table.
|
|
134665
|
+
*
|
|
134666
|
+
* @remarks
|
|
134667
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134668
|
+
* @beta
|
|
134669
|
+
*/
|
|
134670
|
+
interface TableMergedAreaProperties {
|
|
134671
|
+
/**
|
|
134672
|
+
* Specifies the number of columns for the merged cells area.
|
|
134673
|
+
Must be 1 or greater.
|
|
134674
|
+
*
|
|
134675
|
+
* @remarks
|
|
134676
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134677
|
+
* @beta
|
|
134678
|
+
*/
|
|
134679
|
+
columnCount: number;
|
|
134680
|
+
/**
|
|
134681
|
+
* Specifies the zero-based index of the column of the top left cell of the merged area.
|
|
134682
|
+
*
|
|
134683
|
+
* @remarks
|
|
134684
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134685
|
+
* @beta
|
|
134686
|
+
*/
|
|
134687
|
+
columnIndex: number;
|
|
134688
|
+
/**
|
|
134689
|
+
* Specifies the number of rows for the merged cells area.
|
|
134690
|
+
Must be 1 or greater.
|
|
134691
|
+
*
|
|
134692
|
+
* @remarks
|
|
134693
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134694
|
+
* @beta
|
|
134695
|
+
*/
|
|
134696
|
+
rowCount: number;
|
|
134697
|
+
/**
|
|
134698
|
+
* Specifies the zero-based index of the row of the top left cell of the merged area.
|
|
134699
|
+
*
|
|
134700
|
+
* @remarks
|
|
134701
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134702
|
+
* @beta
|
|
134703
|
+
*/
|
|
134704
|
+
rowIndex: number;
|
|
134705
|
+
}
|
|
134706
|
+
/**
|
|
134707
|
+
* Provides the table row properties.
|
|
134708
|
+
*
|
|
134709
|
+
* @remarks
|
|
134710
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134711
|
+
* @beta
|
|
134712
|
+
*/
|
|
134713
|
+
interface TableRowProperties {
|
|
134714
|
+
/**
|
|
134715
|
+
* Represents the desired height of each row in points, or is undefined.
|
|
134716
|
+
|
|
134717
|
+
When a table is being added, for rows whose height is undefined,
|
|
134718
|
+
the row height will be calculated by evenly dividing the remaining height
|
|
134719
|
+
of the table amongst those rows. If the table does not have a defined height,
|
|
134720
|
+
a default row height will be used.
|
|
134721
|
+
*
|
|
134722
|
+
* @remarks
|
|
134723
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134724
|
+
* @beta
|
|
134725
|
+
*/
|
|
134726
|
+
rowHeight?: number | undefined;
|
|
134727
|
+
}
|
|
134728
|
+
/**
|
|
134729
|
+
* Represents the available options when adding a table.
|
|
134730
|
+
*
|
|
134731
|
+
* @remarks
|
|
134732
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134733
|
+
* @beta
|
|
134734
|
+
*/
|
|
134735
|
+
interface TableAddOptions {
|
|
134736
|
+
/**
|
|
134737
|
+
* If provided, specifies properties for each column in the table.
|
|
134738
|
+
The array length must be equal to the number of columns in the table.
|
|
134739
|
+
Specify an empty object for columns that should use the default formatting.
|
|
134740
|
+
*
|
|
134741
|
+
* @remarks
|
|
134742
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134743
|
+
* @beta
|
|
134744
|
+
*/
|
|
134745
|
+
columns?: PowerPoint.TableColumnProperties[];
|
|
134746
|
+
/**
|
|
134747
|
+
* Specifies the height, in points, of the table.
|
|
134748
|
+
A default value is used when this parameter is not provided.
|
|
134749
|
+
Throws an `InvalidArgument` exception when set with a negative value.
|
|
134750
|
+
*
|
|
134751
|
+
* @remarks
|
|
134752
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134753
|
+
* @beta
|
|
134754
|
+
*/
|
|
134755
|
+
height?: number | undefined;
|
|
134756
|
+
/**
|
|
134757
|
+
* Specifies the distance, in points, from the left side of the table to the left side of the slide.
|
|
134758
|
+
The table is centered horizontally when this parameter is not provided.
|
|
134759
|
+
*
|
|
134760
|
+
* @remarks
|
|
134761
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134762
|
+
* @beta
|
|
134763
|
+
*/
|
|
134764
|
+
left?: number | undefined;
|
|
134765
|
+
/**
|
|
134766
|
+
* If specified, represents an rectangular area where multiple cells appear as a single cell.
|
|
134767
|
+
*
|
|
134768
|
+
* @remarks
|
|
134769
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134770
|
+
* @beta
|
|
134771
|
+
*/
|
|
134772
|
+
mergedAreas?: PowerPoint.TableMergedAreaProperties[];
|
|
134773
|
+
/**
|
|
134774
|
+
* If provided, specifies properties for each row in the table.
|
|
134775
|
+
The array length must be equal to the number of rows in the table.
|
|
134776
|
+
Specify an empty object for rows that should use the default formatting.
|
|
134777
|
+
*
|
|
134778
|
+
* @remarks
|
|
134779
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134780
|
+
* @beta
|
|
134781
|
+
*/
|
|
134782
|
+
rows?: PowerPoint.TableRowProperties[];
|
|
134783
|
+
/**
|
|
134784
|
+
* If provided, specifies properties for each cell in the table.
|
|
134785
|
+
|
|
134786
|
+
This should be an 2D array with the same number of rows and columns as the table.
|
|
134787
|
+
If a cell does not require specific formatting, specify an empty object for that cell.
|
|
134788
|
+
Only the top left cell of a merged are can have properties specified, which will be applied
|
|
134789
|
+
to the entire merged area. For the other cells in the merged area, an empty object should be provided.
|
|
134790
|
+
*
|
|
134791
|
+
* @remarks
|
|
134792
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134793
|
+
* @beta
|
|
134794
|
+
*/
|
|
134795
|
+
specificCellProperties?: PowerPoint.TableCellProperties[][];
|
|
134796
|
+
/**
|
|
134797
|
+
* Specifies the distance, in points, from the top edge of the table to the top edge of the slide.
|
|
134798
|
+
A default value is used when this parameter is not provided.
|
|
134799
|
+
*
|
|
134800
|
+
* @remarks
|
|
134801
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134802
|
+
* @beta
|
|
134803
|
+
*/
|
|
134804
|
+
top?: number | undefined;
|
|
134805
|
+
/**
|
|
134806
|
+
* Specifies the formatting which applies uniformly to all of the table cells.
|
|
134807
|
+
|
|
134808
|
+
To apply specific formatting to individual cells, use specificCellProperties.
|
|
134809
|
+
|
|
134810
|
+
If both uniformCellProperties and specificCellProperties are undefined, the default formatting
|
|
134811
|
+
will be used, and the default table style will be applied. The table will have the same
|
|
134812
|
+
appearance as when the user adds a table through the PowerPoint UI.
|
|
134813
|
+
|
|
134814
|
+
To provide a plain appearance for the table, set this property to an empty object
|
|
134815
|
+
and do not specify specificCellProperties.
|
|
134816
|
+
*
|
|
134817
|
+
* @remarks
|
|
134818
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134819
|
+
* @beta
|
|
134820
|
+
*/
|
|
134821
|
+
uniformCellProperties?: PowerPoint.TableCellProperties;
|
|
134822
|
+
/**
|
|
134823
|
+
* If provided, specifies the values for the table.
|
|
134824
|
+
|
|
134825
|
+
When the table contains areas of merged cells,
|
|
134826
|
+
only the top left cell of each merged area can have a
|
|
134827
|
+
non-empty string value. The other cells
|
|
134828
|
+
in the merged area must be an empty string.
|
|
134829
|
+
*
|
|
134830
|
+
* @remarks
|
|
134831
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134832
|
+
* @beta
|
|
134833
|
+
*/
|
|
134834
|
+
values?: string[][];
|
|
134835
|
+
/**
|
|
134836
|
+
* Specifies the width, in points, of the table.
|
|
134837
|
+
A default value is used when this parameter is not provided.
|
|
134838
|
+
Throws an `InvalidArgument` exception when set with a negative value.
|
|
134839
|
+
*
|
|
134840
|
+
* @remarks
|
|
134841
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134842
|
+
* @beta
|
|
134843
|
+
*/
|
|
134844
|
+
width?: number | undefined;
|
|
134845
|
+
}
|
|
134007
134846
|
/**
|
|
134008
134847
|
* Represents the collection of shapes.
|
|
134009
134848
|
*
|
|
@@ -134070,6 +134909,20 @@ declare namespace PowerPoint {
|
|
|
134070
134909
|
* @returns The newly inserted shape.
|
|
134071
134910
|
*/
|
|
134072
134911
|
addLine(connectorType?: "Straight" | "Elbow" | "Curve", options?: PowerPoint.ShapeAddOptions): PowerPoint.Shape;
|
|
134912
|
+
/**
|
|
134913
|
+
* Adds a table to the slide. Returns a `Shape` object that represents the new table.
|
|
134914
|
+
Use the `Shape.table` property to get the `Table` object for the shape.
|
|
134915
|
+
*
|
|
134916
|
+
* @remarks
|
|
134917
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
134918
|
+
* @beta
|
|
134919
|
+
*
|
|
134920
|
+
* @param rowCount Number of rows in the table. Must be 1 or greater.
|
|
134921
|
+
* @param columnCount Number of columns in the table. Must be 1 or greater.
|
|
134922
|
+
* @param options Provides options describing the new table.
|
|
134923
|
+
* @returns The newly inserted shape.
|
|
134924
|
+
*/
|
|
134925
|
+
addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions): PowerPoint.Shape;
|
|
134073
134926
|
/**
|
|
134074
134927
|
* Adds a text box to the slide with the provided text as the content. Returns a `Shape` object that represents the new text box.
|
|
134075
134928
|
*
|
|
@@ -135548,6 +136401,43 @@ declare namespace PowerPoint {
|
|
|
135548
136401
|
*/
|
|
135549
136402
|
toJSON(): PowerPoint.Interfaces.TextFrameData;
|
|
135550
136403
|
}
|
|
136404
|
+
/**
|
|
136405
|
+
* Use with `setZOrder` to move the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
|
|
136406
|
+
*
|
|
136407
|
+
* @remarks
|
|
136408
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136409
|
+
* @beta
|
|
136410
|
+
*/
|
|
136411
|
+
enum ShapeZOrder {
|
|
136412
|
+
/**
|
|
136413
|
+
* Brings the shape forward one spot in the z-order.
|
|
136414
|
+
* @remarks
|
|
136415
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136416
|
+
* @beta
|
|
136417
|
+
*/
|
|
136418
|
+
bringForward = "BringForward",
|
|
136419
|
+
/**
|
|
136420
|
+
* Brings the shape to the front of the z-order.
|
|
136421
|
+
* @remarks
|
|
136422
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136423
|
+
* @beta
|
|
136424
|
+
*/
|
|
136425
|
+
bringToFront = "BringToFront",
|
|
136426
|
+
/**
|
|
136427
|
+
* Sends the shape backward one spot in the z-order.
|
|
136428
|
+
* @remarks
|
|
136429
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136430
|
+
* @beta
|
|
136431
|
+
*/
|
|
136432
|
+
sendBackward = "SendBackward",
|
|
136433
|
+
/**
|
|
136434
|
+
* Sends the shape to the back of the z-order.
|
|
136435
|
+
* @remarks
|
|
136436
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136437
|
+
* @beta
|
|
136438
|
+
*/
|
|
136439
|
+
sendToBack = "SendToBack",
|
|
136440
|
+
}
|
|
135551
136441
|
/**
|
|
135552
136442
|
* Represents a single shape in the slide.
|
|
135553
136443
|
*
|
|
@@ -135682,6 +136572,15 @@ declare namespace PowerPoint {
|
|
|
135682
136572
|
* [Api set: PowerPointApi 1.4]
|
|
135683
136573
|
*/
|
|
135684
136574
|
width: number;
|
|
136575
|
+
/**
|
|
136576
|
+
* Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
136577
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
136578
|
+
*
|
|
136579
|
+
* @remarks
|
|
136580
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136581
|
+
* @beta
|
|
136582
|
+
*/
|
|
136583
|
+
readonly zOrderPosition: number;
|
|
135685
136584
|
/**
|
|
135686
136585
|
* Deletes the shape from the shape collection. Does nothing if the shape does not exist.
|
|
135687
136586
|
*
|
|
@@ -135731,6 +136630,34 @@ declare namespace PowerPoint {
|
|
|
135731
136630
|
* [Api set: PowerPointApi 1.5]
|
|
135732
136631
|
*/
|
|
135733
136632
|
getParentSlideOrNullObject(): PowerPoint.Slide;
|
|
136633
|
+
/**
|
|
136634
|
+
* Returns the `Table` object if this shape is a table.
|
|
136635
|
+
*
|
|
136636
|
+
* @remarks
|
|
136637
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136638
|
+
* @beta
|
|
136639
|
+
*/
|
|
136640
|
+
getTable(): PowerPoint.Table;
|
|
136641
|
+
/**
|
|
136642
|
+
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
|
|
136643
|
+
*
|
|
136644
|
+
* @remarks
|
|
136645
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136646
|
+
* @beta
|
|
136647
|
+
*
|
|
136648
|
+
* @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
|
|
136649
|
+
*/
|
|
136650
|
+
setZOrder(position: PowerPoint.ShapeZOrder): void;
|
|
136651
|
+
/**
|
|
136652
|
+
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
|
|
136653
|
+
*
|
|
136654
|
+
* @remarks
|
|
136655
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136656
|
+
* @beta
|
|
136657
|
+
*
|
|
136658
|
+
* @param position Specifies how to move the shape within the z-order stack. Uses the `ShapeZOrder` enum.
|
|
136659
|
+
*/
|
|
136660
|
+
setZOrder(position: "BringForward" | "BringToFront" | "SendBackward" | "SendToBack"): void;
|
|
135734
136661
|
/**
|
|
135735
136662
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
135736
136663
|
*
|
|
@@ -135758,6 +136685,198 @@ declare namespace PowerPoint {
|
|
|
135758
136685
|
*/
|
|
135759
136686
|
toJSON(): PowerPoint.Interfaces.ShapeData;
|
|
135760
136687
|
}
|
|
136688
|
+
/**
|
|
136689
|
+
* Represents an Office.js binding that is defined in the presentation.
|
|
136690
|
+
*
|
|
136691
|
+
* @remarks
|
|
136692
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136693
|
+
* @beta
|
|
136694
|
+
*/
|
|
136695
|
+
class Binding extends OfficeExtension.ClientObject {
|
|
136696
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
136697
|
+
context: RequestContext;
|
|
136698
|
+
/**
|
|
136699
|
+
* Represents the binding identifier.
|
|
136700
|
+
*
|
|
136701
|
+
* @remarks
|
|
136702
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136703
|
+
* @beta
|
|
136704
|
+
*/
|
|
136705
|
+
readonly id: string;
|
|
136706
|
+
/**
|
|
136707
|
+
* Returns the type of the binding. See `BindingType` for details.
|
|
136708
|
+
*
|
|
136709
|
+
* @remarks
|
|
136710
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136711
|
+
* @beta
|
|
136712
|
+
*/
|
|
136713
|
+
readonly type: PowerPoint.BindingType | "Shape";
|
|
136714
|
+
/**
|
|
136715
|
+
* Deletes the binding.
|
|
136716
|
+
*
|
|
136717
|
+
* @remarks
|
|
136718
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136719
|
+
* @beta
|
|
136720
|
+
*/
|
|
136721
|
+
delete(): void;
|
|
136722
|
+
/**
|
|
136723
|
+
* Returns the shape represented by the binding. Will throw an error if the binding is not of the correct type.
|
|
136724
|
+
*
|
|
136725
|
+
* @remarks
|
|
136726
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136727
|
+
* @beta
|
|
136728
|
+
*/
|
|
136729
|
+
getShape(): PowerPoint.Shape;
|
|
136730
|
+
/**
|
|
136731
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
136732
|
+
*
|
|
136733
|
+
* @param options Provides options for which properties of the object to load.
|
|
136734
|
+
*/
|
|
136735
|
+
load(options?: PowerPoint.Interfaces.BindingLoadOptions): PowerPoint.Binding;
|
|
136736
|
+
/**
|
|
136737
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
136738
|
+
*
|
|
136739
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
136740
|
+
*/
|
|
136741
|
+
load(propertyNames?: string | string[]): PowerPoint.Binding;
|
|
136742
|
+
/**
|
|
136743
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
136744
|
+
*
|
|
136745
|
+
* @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.
|
|
136746
|
+
*/
|
|
136747
|
+
load(propertyNamesAndPaths?: {
|
|
136748
|
+
select?: string;
|
|
136749
|
+
expand?: string;
|
|
136750
|
+
}): PowerPoint.Binding;
|
|
136751
|
+
/**
|
|
136752
|
+
* 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's passed to it.)
|
|
136753
|
+
* Whereas the original `PowerPoint.Binding` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingData`) that contains shallow copies of any loaded child properties from the original object.
|
|
136754
|
+
*/
|
|
136755
|
+
toJSON(): PowerPoint.Interfaces.BindingData;
|
|
136756
|
+
}
|
|
136757
|
+
/**
|
|
136758
|
+
* Represents the collection of all the binding objects that are part of the presentation.
|
|
136759
|
+
*
|
|
136760
|
+
* @remarks
|
|
136761
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136762
|
+
* @beta
|
|
136763
|
+
*/
|
|
136764
|
+
class BindingCollection extends OfficeExtension.ClientObject {
|
|
136765
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
136766
|
+
context: RequestContext;
|
|
136767
|
+
/** Gets the loaded child items in this collection. */
|
|
136768
|
+
readonly items: PowerPoint.Binding[];
|
|
136769
|
+
/**
|
|
136770
|
+
* Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
|
|
136771
|
+
*
|
|
136772
|
+
* @remarks
|
|
136773
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136774
|
+
* @beta
|
|
136775
|
+
*
|
|
136776
|
+
* @param shape Shape to which the binding is added.
|
|
136777
|
+
* @param bindingType Type of binding. See `BindingType`.
|
|
136778
|
+
* @param id ID of the binding.
|
|
136779
|
+
*/
|
|
136780
|
+
add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;
|
|
136781
|
+
/**
|
|
136782
|
+
* Adds a new binding to a particular Shape. If the provided ID is already being used by a binding, the existing binding will be overwritten.
|
|
136783
|
+
*
|
|
136784
|
+
* @remarks
|
|
136785
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136786
|
+
* @beta
|
|
136787
|
+
*
|
|
136788
|
+
* @param shape Shape to which the binding is added.
|
|
136789
|
+
* @param bindingType Type of binding. See `BindingType`.
|
|
136790
|
+
* @param id ID of the binding.
|
|
136791
|
+
*/
|
|
136792
|
+
add(shape: PowerPoint.Shape, bindingType: "Shape", id: string): PowerPoint.Binding;
|
|
136793
|
+
/**
|
|
136794
|
+
* Adds a new binding based on the current selection.
|
|
136795
|
+
If the selection has multiple areas, the `InvalidReference` error will be returned.
|
|
136796
|
+
*
|
|
136797
|
+
* @remarks
|
|
136798
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136799
|
+
* @beta
|
|
136800
|
+
*
|
|
136801
|
+
* @param bindingType Type of binding. See `BindingType`.
|
|
136802
|
+
* @param id ID of the binding.
|
|
136803
|
+
*/
|
|
136804
|
+
addFromSelection(bindingType: PowerPoint.BindingType, id: string): PowerPoint.Binding;
|
|
136805
|
+
/**
|
|
136806
|
+
* Adds a new binding based on the current selection.
|
|
136807
|
+
If the selection has multiple areas, the `InvalidReference` error will be returned.
|
|
136808
|
+
*
|
|
136809
|
+
* @remarks
|
|
136810
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136811
|
+
* @beta
|
|
136812
|
+
*
|
|
136813
|
+
* @param bindingType Type of binding. See `BindingType`.
|
|
136814
|
+
* @param id ID of the binding.
|
|
136815
|
+
*/
|
|
136816
|
+
addFromSelection(bindingType: "Shape", id: string): PowerPoint.Binding;
|
|
136817
|
+
/**
|
|
136818
|
+
* Gets the number of bindings in the collection.
|
|
136819
|
+
*
|
|
136820
|
+
* @remarks
|
|
136821
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136822
|
+
* @beta
|
|
136823
|
+
*/
|
|
136824
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
136825
|
+
/**
|
|
136826
|
+
* Gets a binding object by ID. Throws an ItemNotFoundException if there's no binding with that ID.
|
|
136827
|
+
*
|
|
136828
|
+
* @remarks
|
|
136829
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136830
|
+
* @beta
|
|
136831
|
+
*
|
|
136832
|
+
* @param key ID of the binding object to be retrieved.
|
|
136833
|
+
*/
|
|
136834
|
+
getItem(key: string): PowerPoint.Binding;
|
|
136835
|
+
/**
|
|
136836
|
+
* Gets a binding object based on its position in the items array. Throws an InvalidArgumentException if the index less than 0, or greater than or equal to the count of items in the collection.
|
|
136837
|
+
*
|
|
136838
|
+
* @remarks
|
|
136839
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136840
|
+
* @beta
|
|
136841
|
+
*
|
|
136842
|
+
* @param index Index value of the object to be retrieved. Zero-indexed.
|
|
136843
|
+
*/
|
|
136844
|
+
getItemAt(index: number): PowerPoint.Binding;
|
|
136845
|
+
/**
|
|
136846
|
+
* Gets a binding object by ID. If the binding object doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
136847
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
136848
|
+
*
|
|
136849
|
+
* @remarks
|
|
136850
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
136851
|
+
* @beta
|
|
136852
|
+
*
|
|
136853
|
+
* @param id ID of the binding object to be retrieved.
|
|
136854
|
+
*/
|
|
136855
|
+
getItemOrNullObject(id: string): PowerPoint.Binding;
|
|
136856
|
+
/**
|
|
136857
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
136858
|
+
*
|
|
136859
|
+
* @param options Provides options for which properties of the object to load.
|
|
136860
|
+
*/
|
|
136861
|
+
load(options?: PowerPoint.Interfaces.BindingCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.BindingCollection;
|
|
136862
|
+
/**
|
|
136863
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
136864
|
+
*
|
|
136865
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
136866
|
+
*/
|
|
136867
|
+
load(propertyNames?: string | string[]): PowerPoint.BindingCollection;
|
|
136868
|
+
/**
|
|
136869
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
136870
|
+
*
|
|
136871
|
+
* @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.
|
|
136872
|
+
*/
|
|
136873
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.BindingCollection;
|
|
136874
|
+
/**
|
|
136875
|
+
* 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's passed to it.)
|
|
136876
|
+
* Whereas the original `PowerPoint.BindingCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BindingCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
136877
|
+
*/
|
|
136878
|
+
toJSON(): PowerPoint.Interfaces.BindingCollectionData;
|
|
136879
|
+
}
|
|
135761
136880
|
/**
|
|
135762
136881
|
* Specifies the document property type for custom properties.
|
|
135763
136882
|
*
|
|
@@ -136550,6 +137669,21 @@ declare namespace PowerPoint {
|
|
|
136550
137669
|
*/
|
|
136551
137670
|
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
|
|
136552
137671
|
}
|
|
137672
|
+
/** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */
|
|
137673
|
+
interface TableCellUpdateData {
|
|
137674
|
+
/**
|
|
137675
|
+
* Specifies the text content of the table cell.
|
|
137676
|
+
*
|
|
137677
|
+
* @remarks
|
|
137678
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
137679
|
+
* @beta
|
|
137680
|
+
*/
|
|
137681
|
+
text?: string;
|
|
137682
|
+
}
|
|
137683
|
+
/** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */
|
|
137684
|
+
interface TableCellCollectionUpdateData {
|
|
137685
|
+
items?: PowerPoint.Interfaces.TableCellData[];
|
|
137686
|
+
}
|
|
136553
137687
|
/** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */
|
|
136554
137688
|
interface ShapeCollectionUpdateData {
|
|
136555
137689
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
@@ -136757,6 +137891,10 @@ declare namespace PowerPoint {
|
|
|
136757
137891
|
*/
|
|
136758
137892
|
width?: number;
|
|
136759
137893
|
}
|
|
137894
|
+
/** An interface for updating data on the `BindingCollection` object, for use in `bindingCollection.set({ ... })`. */
|
|
137895
|
+
interface BindingCollectionUpdateData {
|
|
137896
|
+
items?: PowerPoint.Interfaces.BindingData[];
|
|
137897
|
+
}
|
|
136760
137898
|
/** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */
|
|
136761
137899
|
interface CustomPropertyUpdateData {
|
|
136762
137900
|
/**
|
|
@@ -137092,6 +138230,82 @@ declare namespace PowerPoint {
|
|
|
137092
138230
|
*/
|
|
137093
138231
|
underline?: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null;
|
|
137094
138232
|
}
|
|
138233
|
+
/** An interface describing the data returned by calling `tableCell.toJSON()`. */
|
|
138234
|
+
interface TableCellData {
|
|
138235
|
+
/**
|
|
138236
|
+
* Gets the number of table columns this cell spans across.
|
|
138237
|
+
Will be greater than or equal to 1.
|
|
138238
|
+
*
|
|
138239
|
+
* @remarks
|
|
138240
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138241
|
+
* @beta
|
|
138242
|
+
*/
|
|
138243
|
+
columnCount?: number;
|
|
138244
|
+
/**
|
|
138245
|
+
* Gets the zero-based column index of the cell within the table.
|
|
138246
|
+
*
|
|
138247
|
+
* @remarks
|
|
138248
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138249
|
+
* @beta
|
|
138250
|
+
*/
|
|
138251
|
+
columnIndex?: number;
|
|
138252
|
+
/**
|
|
138253
|
+
* Gets the number of table rows this cell spans across.
|
|
138254
|
+
Will be greater than or equal to 1.
|
|
138255
|
+
*
|
|
138256
|
+
* @remarks
|
|
138257
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138258
|
+
* @beta
|
|
138259
|
+
*/
|
|
138260
|
+
rowCount?: number;
|
|
138261
|
+
/**
|
|
138262
|
+
* Gets the zero-based row index of the cell within the table.
|
|
138263
|
+
*
|
|
138264
|
+
* @remarks
|
|
138265
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138266
|
+
* @beta
|
|
138267
|
+
*/
|
|
138268
|
+
rowIndex?: number;
|
|
138269
|
+
/**
|
|
138270
|
+
* Specifies the text content of the table cell.
|
|
138271
|
+
*
|
|
138272
|
+
* @remarks
|
|
138273
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138274
|
+
* @beta
|
|
138275
|
+
*/
|
|
138276
|
+
text?: string;
|
|
138277
|
+
}
|
|
138278
|
+
/** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */
|
|
138279
|
+
interface TableCellCollectionData {
|
|
138280
|
+
items?: PowerPoint.Interfaces.TableCellData[];
|
|
138281
|
+
}
|
|
138282
|
+
/** An interface describing the data returned by calling `table.toJSON()`. */
|
|
138283
|
+
interface TableData {
|
|
138284
|
+
/**
|
|
138285
|
+
* Gets the number of columns in the table.
|
|
138286
|
+
*
|
|
138287
|
+
* @remarks
|
|
138288
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138289
|
+
* @beta
|
|
138290
|
+
*/
|
|
138291
|
+
columnCount?: number;
|
|
138292
|
+
/**
|
|
138293
|
+
* Gets the number of rows in the table.
|
|
138294
|
+
*
|
|
138295
|
+
* @remarks
|
|
138296
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138297
|
+
* @beta
|
|
138298
|
+
*/
|
|
138299
|
+
rowCount?: number;
|
|
138300
|
+
/**
|
|
138301
|
+
* Gets all of the values in the table.
|
|
138302
|
+
*
|
|
138303
|
+
* @remarks
|
|
138304
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138305
|
+
* @beta
|
|
138306
|
+
*/
|
|
138307
|
+
values?: string[][];
|
|
138308
|
+
}
|
|
137095
138309
|
/** An interface describing the data returned by calling `shapeCollection.toJSON()`. */
|
|
137096
138310
|
interface ShapeCollectionData {
|
|
137097
138311
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
@@ -137411,6 +138625,38 @@ declare namespace PowerPoint {
|
|
|
137411
138625
|
* [Api set: PowerPointApi 1.4]
|
|
137412
138626
|
*/
|
|
137413
138627
|
width?: number;
|
|
138628
|
+
/**
|
|
138629
|
+
* Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
138630
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
138631
|
+
*
|
|
138632
|
+
* @remarks
|
|
138633
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138634
|
+
* @beta
|
|
138635
|
+
*/
|
|
138636
|
+
zOrderPosition?: number;
|
|
138637
|
+
}
|
|
138638
|
+
/** An interface describing the data returned by calling `binding.toJSON()`. */
|
|
138639
|
+
interface BindingData {
|
|
138640
|
+
/**
|
|
138641
|
+
* Represents the binding identifier.
|
|
138642
|
+
*
|
|
138643
|
+
* @remarks
|
|
138644
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138645
|
+
* @beta
|
|
138646
|
+
*/
|
|
138647
|
+
id?: string;
|
|
138648
|
+
/**
|
|
138649
|
+
* Returns the type of the binding. See `BindingType` for details.
|
|
138650
|
+
*
|
|
138651
|
+
* @remarks
|
|
138652
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
138653
|
+
* @beta
|
|
138654
|
+
*/
|
|
138655
|
+
type?: PowerPoint.BindingType | "Shape";
|
|
138656
|
+
}
|
|
138657
|
+
/** An interface describing the data returned by calling `bindingCollection.toJSON()`. */
|
|
138658
|
+
interface BindingCollectionData {
|
|
138659
|
+
items?: PowerPoint.Interfaces.BindingData[];
|
|
137414
138660
|
}
|
|
137415
138661
|
/** An interface describing the data returned by calling `customProperty.toJSON()`. */
|
|
137416
138662
|
interface CustomPropertyData {
|
|
@@ -137882,7 +139128,13 @@ declare namespace PowerPoint {
|
|
|
137882
139128
|
*/
|
|
137883
139129
|
subscript?: boolean;
|
|
137884
139130
|
/**
|
|
137885
|
-
* Specifies the
|
|
139131
|
+
* Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute. The possible values are as follows:
|
|
139132
|
+
*
|
|
139133
|
+
* - `true`: All the text has the **Superscript** attribute.
|
|
139134
|
+
*
|
|
139135
|
+
* - `false`: None of the text has the **Superscript** attribute.
|
|
139136
|
+
*
|
|
139137
|
+
* - `null`: Returned if some, but not all, of the text has the **Superscript** attribute.
|
|
137886
139138
|
*
|
|
137887
139139
|
* @remarks
|
|
137888
139140
|
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
@@ -137897,6 +139149,153 @@ declare namespace PowerPoint {
|
|
|
137897
139149
|
*/
|
|
137898
139150
|
underline?: boolean;
|
|
137899
139151
|
}
|
|
139152
|
+
/**
|
|
139153
|
+
* Represents a table.
|
|
139154
|
+
*
|
|
139155
|
+
* @remarks
|
|
139156
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139157
|
+
* @beta
|
|
139158
|
+
*/
|
|
139159
|
+
interface TableCellLoadOptions {
|
|
139160
|
+
/**
|
|
139161
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
139162
|
+
*/
|
|
139163
|
+
$all?: boolean;
|
|
139164
|
+
/**
|
|
139165
|
+
* Gets the number of table columns this cell spans across.
|
|
139166
|
+
Will be greater than or equal to 1.
|
|
139167
|
+
*
|
|
139168
|
+
* @remarks
|
|
139169
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139170
|
+
* @beta
|
|
139171
|
+
*/
|
|
139172
|
+
columnCount?: boolean;
|
|
139173
|
+
/**
|
|
139174
|
+
* Gets the zero-based column index of the cell within the table.
|
|
139175
|
+
*
|
|
139176
|
+
* @remarks
|
|
139177
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139178
|
+
* @beta
|
|
139179
|
+
*/
|
|
139180
|
+
columnIndex?: boolean;
|
|
139181
|
+
/**
|
|
139182
|
+
* Gets the number of table rows this cell spans across.
|
|
139183
|
+
Will be greater than or equal to 1.
|
|
139184
|
+
*
|
|
139185
|
+
* @remarks
|
|
139186
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139187
|
+
* @beta
|
|
139188
|
+
*/
|
|
139189
|
+
rowCount?: boolean;
|
|
139190
|
+
/**
|
|
139191
|
+
* Gets the zero-based row index of the cell within the table.
|
|
139192
|
+
*
|
|
139193
|
+
* @remarks
|
|
139194
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139195
|
+
* @beta
|
|
139196
|
+
*/
|
|
139197
|
+
rowIndex?: boolean;
|
|
139198
|
+
/**
|
|
139199
|
+
* Specifies the text content of the table cell.
|
|
139200
|
+
*
|
|
139201
|
+
* @remarks
|
|
139202
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139203
|
+
* @beta
|
|
139204
|
+
*/
|
|
139205
|
+
text?: boolean;
|
|
139206
|
+
}
|
|
139207
|
+
/**
|
|
139208
|
+
* Represents a collection of table cells.
|
|
139209
|
+
*
|
|
139210
|
+
* @remarks
|
|
139211
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139212
|
+
* @beta
|
|
139213
|
+
*/
|
|
139214
|
+
interface TableCellCollectionLoadOptions {
|
|
139215
|
+
/**
|
|
139216
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
139217
|
+
*/
|
|
139218
|
+
$all?: boolean;
|
|
139219
|
+
/**
|
|
139220
|
+
* For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
|
|
139221
|
+
Will be greater than or equal to 1.
|
|
139222
|
+
*
|
|
139223
|
+
* @remarks
|
|
139224
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139225
|
+
* @beta
|
|
139226
|
+
*/
|
|
139227
|
+
columnCount?: boolean;
|
|
139228
|
+
/**
|
|
139229
|
+
* For EACH ITEM in the collection: Gets the zero-based column index of the cell within the table.
|
|
139230
|
+
*
|
|
139231
|
+
* @remarks
|
|
139232
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139233
|
+
* @beta
|
|
139234
|
+
*/
|
|
139235
|
+
columnIndex?: boolean;
|
|
139236
|
+
/**
|
|
139237
|
+
* For EACH ITEM in the collection: Gets the number of table rows this cell spans across.
|
|
139238
|
+
Will be greater than or equal to 1.
|
|
139239
|
+
*
|
|
139240
|
+
* @remarks
|
|
139241
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139242
|
+
* @beta
|
|
139243
|
+
*/
|
|
139244
|
+
rowCount?: boolean;
|
|
139245
|
+
/**
|
|
139246
|
+
* For EACH ITEM in the collection: Gets the zero-based row index of the cell within the table.
|
|
139247
|
+
*
|
|
139248
|
+
* @remarks
|
|
139249
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139250
|
+
* @beta
|
|
139251
|
+
*/
|
|
139252
|
+
rowIndex?: boolean;
|
|
139253
|
+
/**
|
|
139254
|
+
* For EACH ITEM in the collection: Specifies the text content of the table cell.
|
|
139255
|
+
*
|
|
139256
|
+
* @remarks
|
|
139257
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139258
|
+
* @beta
|
|
139259
|
+
*/
|
|
139260
|
+
text?: boolean;
|
|
139261
|
+
}
|
|
139262
|
+
/**
|
|
139263
|
+
* Represents a table.
|
|
139264
|
+
*
|
|
139265
|
+
* @remarks
|
|
139266
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139267
|
+
* @beta
|
|
139268
|
+
*/
|
|
139269
|
+
interface TableLoadOptions {
|
|
139270
|
+
/**
|
|
139271
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
139272
|
+
*/
|
|
139273
|
+
$all?: boolean;
|
|
139274
|
+
/**
|
|
139275
|
+
* Gets the number of columns in the table.
|
|
139276
|
+
*
|
|
139277
|
+
* @remarks
|
|
139278
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139279
|
+
* @beta
|
|
139280
|
+
*/
|
|
139281
|
+
columnCount?: boolean;
|
|
139282
|
+
/**
|
|
139283
|
+
* Gets the number of rows in the table.
|
|
139284
|
+
*
|
|
139285
|
+
* @remarks
|
|
139286
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139287
|
+
* @beta
|
|
139288
|
+
*/
|
|
139289
|
+
rowCount?: boolean;
|
|
139290
|
+
/**
|
|
139291
|
+
* Gets all of the values in the table.
|
|
139292
|
+
*
|
|
139293
|
+
* @remarks
|
|
139294
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139295
|
+
* @beta
|
|
139296
|
+
*/
|
|
139297
|
+
values?: boolean;
|
|
139298
|
+
}
|
|
137900
139299
|
/**
|
|
137901
139300
|
* Represents the collection of shapes.
|
|
137902
139301
|
*
|
|
@@ -138019,6 +139418,15 @@ declare namespace PowerPoint {
|
|
|
138019
139418
|
* [Api set: PowerPointApi 1.4]
|
|
138020
139419
|
*/
|
|
138021
139420
|
width?: boolean;
|
|
139421
|
+
/**
|
|
139422
|
+
* For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
139423
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
139424
|
+
*
|
|
139425
|
+
* @remarks
|
|
139426
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139427
|
+
* @beta
|
|
139428
|
+
*/
|
|
139429
|
+
zOrderPosition?: boolean;
|
|
138022
139430
|
}
|
|
138023
139431
|
/**
|
|
138024
139432
|
* Represents the layout of a slide.
|
|
@@ -138329,6 +139737,15 @@ declare namespace PowerPoint {
|
|
|
138329
139737
|
* [Api set: PowerPointApi 1.4]
|
|
138330
139738
|
*/
|
|
138331
139739
|
width?: boolean;
|
|
139740
|
+
/**
|
|
139741
|
+
* For EACH ITEM in the collection: Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
139742
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
139743
|
+
*
|
|
139744
|
+
* @remarks
|
|
139745
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
139746
|
+
* @beta
|
|
139747
|
+
*/
|
|
139748
|
+
zOrderPosition?: boolean;
|
|
138332
139749
|
}
|
|
138333
139750
|
/**
|
|
138334
139751
|
* Represents a shape group inside a presentation. To get the corresponding Shape object, use `ShapeGroup.shape`.
|
|
@@ -138704,6 +140121,73 @@ declare namespace PowerPoint {
|
|
|
138704
140121
|
* [Api set: PowerPointApi 1.4]
|
|
138705
140122
|
*/
|
|
138706
140123
|
width?: boolean;
|
|
140124
|
+
/**
|
|
140125
|
+
* Returns the z-order position of the shape, with 0 representing the bottom of the order stack. Every shape on a slide has a unique z-order, but
|
|
140126
|
+
each slide also has a unique z-order stack, so two shapes on separate slides could have the same z-order number.
|
|
140127
|
+
*
|
|
140128
|
+
* @remarks
|
|
140129
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
140130
|
+
* @beta
|
|
140131
|
+
*/
|
|
140132
|
+
zOrderPosition?: boolean;
|
|
140133
|
+
}
|
|
140134
|
+
/**
|
|
140135
|
+
* Represents an Office.js binding that is defined in the presentation.
|
|
140136
|
+
*
|
|
140137
|
+
* @remarks
|
|
140138
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
140139
|
+
* @beta
|
|
140140
|
+
*/
|
|
140141
|
+
interface BindingLoadOptions {
|
|
140142
|
+
/**
|
|
140143
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
140144
|
+
*/
|
|
140145
|
+
$all?: boolean;
|
|
140146
|
+
/**
|
|
140147
|
+
* Represents the binding identifier.
|
|
140148
|
+
*
|
|
140149
|
+
* @remarks
|
|
140150
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
140151
|
+
* @beta
|
|
140152
|
+
*/
|
|
140153
|
+
id?: boolean;
|
|
140154
|
+
/**
|
|
140155
|
+
* Returns the type of the binding. See `BindingType` for details.
|
|
140156
|
+
*
|
|
140157
|
+
* @remarks
|
|
140158
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
140159
|
+
* @beta
|
|
140160
|
+
*/
|
|
140161
|
+
type?: boolean;
|
|
140162
|
+
}
|
|
140163
|
+
/**
|
|
140164
|
+
* Represents the collection of all the binding objects that are part of the presentation.
|
|
140165
|
+
*
|
|
140166
|
+
* @remarks
|
|
140167
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
140168
|
+
* @beta
|
|
140169
|
+
*/
|
|
140170
|
+
interface BindingCollectionLoadOptions {
|
|
140171
|
+
/**
|
|
140172
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
140173
|
+
*/
|
|
140174
|
+
$all?: boolean;
|
|
140175
|
+
/**
|
|
140176
|
+
* For EACH ITEM in the collection: Represents the binding identifier.
|
|
140177
|
+
*
|
|
140178
|
+
* @remarks
|
|
140179
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
140180
|
+
* @beta
|
|
140181
|
+
*/
|
|
140182
|
+
id?: boolean;
|
|
140183
|
+
/**
|
|
140184
|
+
* For EACH ITEM in the collection: Returns the type of the binding. See `BindingType` for details.
|
|
140185
|
+
*
|
|
140186
|
+
* @remarks
|
|
140187
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
140188
|
+
* @beta
|
|
140189
|
+
*/
|
|
140190
|
+
type?: boolean;
|
|
138707
140191
|
}
|
|
138708
140192
|
/**
|
|
138709
140193
|
* Represents a custom property.
|