@types/office-js-preview 1.0.626 → 1.0.628
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 +2751 -196
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -114731,7 +114731,7 @@ declare namespace Word {
|
|
|
114731
114731
|
toJSON(): Word.Interfaces.RevisionsFilterData;
|
|
114732
114732
|
}
|
|
114733
114733
|
/**
|
|
114734
|
-
* Represents a single item in a {@link Word.
|
|
114734
|
+
* Represents a single item in a {@link Word.RepeatingSectionContentControl}.
|
|
114735
114735
|
*
|
|
114736
114736
|
* @remarks
|
|
114737
114737
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -157240,7 +157240,7 @@ declare namespace Word {
|
|
|
157240
157240
|
view?: boolean;
|
|
157241
157241
|
}
|
|
157242
157242
|
/**
|
|
157243
|
-
* Represents a single item in a {@link Word.
|
|
157243
|
+
* Represents a single item in a {@link Word.RepeatingSectionContentControl}.
|
|
157244
157244
|
*
|
|
157245
157245
|
* @remarks
|
|
157246
157246
|
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
@@ -170276,6 +170276,14 @@ declare namespace PowerPoint {
|
|
|
170276
170276
|
* [Api set: PowerPointApi 1.7]
|
|
170277
170277
|
*/
|
|
170278
170278
|
readonly customXmlParts: PowerPoint.CustomXmlPartCollection;
|
|
170279
|
+
/**
|
|
170280
|
+
* Returns the page setup information whose properties control slide setup attributes for the presentation.
|
|
170281
|
+
*
|
|
170282
|
+
* @remarks
|
|
170283
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
170284
|
+
* @beta
|
|
170285
|
+
*/
|
|
170286
|
+
readonly pageSetup: PowerPoint.PageSetup;
|
|
170279
170287
|
/**
|
|
170280
170288
|
* Gets the properties of the presentation.
|
|
170281
170289
|
*
|
|
@@ -172439,9 +172447,9 @@ declare namespace PowerPoint {
|
|
|
172439
172447
|
expand?: string;
|
|
172440
172448
|
}): PowerPoint.Borders;
|
|
172441
172449
|
/**
|
|
172442
|
-
|
|
172443
|
-
|
|
172444
|
-
|
|
172450
|
+
* 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.)
|
|
172451
|
+
* Whereas the original `PowerPoint.Borders` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.BordersData`) that contains shallow copies of any loaded child properties from the original object.
|
|
172452
|
+
*/
|
|
172445
172453
|
toJSON(): PowerPoint.Interfaces.BordersData;
|
|
172446
172454
|
}
|
|
172447
172455
|
/**
|
|
@@ -172508,9 +172516,9 @@ declare namespace PowerPoint {
|
|
|
172508
172516
|
expand?: string;
|
|
172509
172517
|
}): PowerPoint.Margins;
|
|
172510
172518
|
/**
|
|
172511
|
-
|
|
172512
|
-
|
|
172513
|
-
|
|
172519
|
+
* 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.)
|
|
172520
|
+
* Whereas the original `PowerPoint.Margins` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.MarginsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
172521
|
+
*/
|
|
172514
172522
|
toJSON(): PowerPoint.Interfaces.MarginsData;
|
|
172515
172523
|
}
|
|
172516
172524
|
/**
|
|
@@ -173222,7 +173230,7 @@ declare namespace PowerPoint {
|
|
|
173222
173230
|
*/
|
|
173223
173231
|
text: string;
|
|
173224
173232
|
/**
|
|
173225
|
-
* Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
173233
|
+
* Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
|
|
173226
173234
|
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
173227
173235
|
*
|
|
173228
173236
|
* @remarks
|
|
@@ -173400,9 +173408,9 @@ declare namespace PowerPoint {
|
|
|
173400
173408
|
expand?: string;
|
|
173401
173409
|
}): PowerPoint.TableColumn;
|
|
173402
173410
|
/**
|
|
173403
|
-
|
|
173404
|
-
|
|
173405
|
-
|
|
173411
|
+
* 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.)
|
|
173412
|
+
* Whereas the original `PowerPoint.TableColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnData`) that contains shallow copies of any loaded child properties from the original object.
|
|
173413
|
+
*/
|
|
173406
173414
|
toJSON(): PowerPoint.Interfaces.TableColumnData;
|
|
173407
173415
|
}
|
|
173408
173416
|
/**
|
|
@@ -173608,7 +173616,7 @@ declare namespace PowerPoint {
|
|
|
173608
173616
|
*/
|
|
173609
173617
|
text?: string;
|
|
173610
173618
|
/**
|
|
173611
|
-
* Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
173619
|
+
* Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
|
|
173612
173620
|
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
173613
173621
|
*
|
|
173614
173622
|
* @remarks
|
|
@@ -173623,32 +173631,6 @@ declare namespace PowerPoint {
|
|
|
173623
173631
|
*/
|
|
173624
173632
|
verticalAlignment?: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered" | undefined;
|
|
173625
173633
|
}
|
|
173626
|
-
/**
|
|
173627
|
-
* Represents the available options when adding a table column.
|
|
173628
|
-
*
|
|
173629
|
-
* @remarks
|
|
173630
|
-
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
173631
|
-
* @beta
|
|
173632
|
-
*/
|
|
173633
|
-
interface TableColumnAddOptions {
|
|
173634
|
-
/**
|
|
173635
|
-
* If provided, specifies properties for each cell in the table column.
|
|
173636
|
-
If a cell doesn't require specific formatting, specify an empty object for that cell.
|
|
173637
|
-
*
|
|
173638
|
-
* @remarks
|
|
173639
|
-
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
173640
|
-
* @beta
|
|
173641
|
-
*/
|
|
173642
|
-
specificCellProperties?: PowerPoint.TableCellProperties[][];
|
|
173643
|
-
/**
|
|
173644
|
-
* Specifies the formatting which applies uniformly to all of the table column cells.
|
|
173645
|
-
*
|
|
173646
|
-
* @remarks
|
|
173647
|
-
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
173648
|
-
* @beta
|
|
173649
|
-
*/
|
|
173650
|
-
uniformCellProperties?: PowerPoint.TableCellProperties;
|
|
173651
|
-
}
|
|
173652
173634
|
/**
|
|
173653
173635
|
* Represents a collection of table columns.
|
|
173654
173636
|
*
|
|
@@ -173722,9 +173704,9 @@ declare namespace PowerPoint {
|
|
|
173722
173704
|
*/
|
|
173723
173705
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableColumnCollection;
|
|
173724
173706
|
/**
|
|
173725
|
-
|
|
173726
|
-
|
|
173727
|
-
|
|
173707
|
+
* 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.)
|
|
173708
|
+
* Whereas the original `PowerPoint.TableColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
173709
|
+
*/
|
|
173728
173710
|
toJSON(): PowerPoint.Interfaces.TableColumnCollectionData;
|
|
173729
173711
|
}
|
|
173730
173712
|
/**
|
|
@@ -173824,36 +173806,10 @@ declare namespace PowerPoint {
|
|
|
173824
173806
|
expand?: string;
|
|
173825
173807
|
}): PowerPoint.TableRow;
|
|
173826
173808
|
/**
|
|
173827
|
-
|
|
173828
|
-
|
|
173829
|
-
*/
|
|
173830
|
-
toJSON(): PowerPoint.Interfaces.TableRowData;
|
|
173831
|
-
}
|
|
173832
|
-
/**
|
|
173833
|
-
* Represents the available options when adding a table row.
|
|
173834
|
-
*
|
|
173835
|
-
* @remarks
|
|
173836
|
-
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
173837
|
-
* @beta
|
|
173838
|
-
*/
|
|
173839
|
-
interface TableRowAddOptions {
|
|
173840
|
-
/**
|
|
173841
|
-
* If provided, specifies properties for each cell in the table row.
|
|
173842
|
-
If a cell doesn't require specific formatting, specify an empty object for that cell.
|
|
173843
|
-
*
|
|
173844
|
-
* @remarks
|
|
173845
|
-
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
173846
|
-
* @beta
|
|
173847
|
-
*/
|
|
173848
|
-
specificCellProperties?: PowerPoint.TableCellProperties[][];
|
|
173849
|
-
/**
|
|
173850
|
-
* Specifies the formatting which applies uniformly to all of the table row cells.
|
|
173851
|
-
*
|
|
173852
|
-
* @remarks
|
|
173853
|
-
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
173854
|
-
* @beta
|
|
173809
|
+
* 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.)
|
|
173810
|
+
* Whereas the original `PowerPoint.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object.
|
|
173855
173811
|
*/
|
|
173856
|
-
|
|
173812
|
+
toJSON(): PowerPoint.Interfaces.TableRowData;
|
|
173857
173813
|
}
|
|
173858
173814
|
/**
|
|
173859
173815
|
* Represents a collection of table rows.
|
|
@@ -173928,9 +173884,9 @@ declare namespace PowerPoint {
|
|
|
173928
173884
|
*/
|
|
173929
173885
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.TableRowCollection;
|
|
173930
173886
|
/**
|
|
173931
|
-
|
|
173932
|
-
|
|
173933
|
-
|
|
173887
|
+
* 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.)
|
|
173888
|
+
* Whereas the original `PowerPoint.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
173889
|
+
*/
|
|
173934
173890
|
toJSON(): PowerPoint.Interfaces.TableRowCollectionData;
|
|
173935
173891
|
}
|
|
173936
173892
|
/**
|
|
@@ -174548,9 +174504,9 @@ declare namespace PowerPoint {
|
|
|
174548
174504
|
expand?: string;
|
|
174549
174505
|
}): PowerPoint.TableStyleOptions;
|
|
174550
174506
|
/**
|
|
174551
|
-
|
|
174552
|
-
|
|
174553
|
-
|
|
174507
|
+
* 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.)
|
|
174508
|
+
* Whereas the original `PowerPoint.TableStyleOptions` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.TableStyleOptionsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
174509
|
+
*/
|
|
174554
174510
|
toJSON(): PowerPoint.Interfaces.TableStyleOptionsData;
|
|
174555
174511
|
}
|
|
174556
174512
|
/**
|
|
@@ -174678,9 +174634,9 @@ declare namespace PowerPoint {
|
|
|
174678
174634
|
expand?: string;
|
|
174679
174635
|
}): PowerPoint.Table;
|
|
174680
174636
|
/**
|
|
174681
|
-
|
|
174682
|
-
|
|
174683
|
-
|
|
174637
|
+
* 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.)
|
|
174638
|
+
* 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.
|
|
174639
|
+
*/
|
|
174684
174640
|
toJSON(): PowerPoint.Interfaces.TableData;
|
|
174685
174641
|
}
|
|
174686
174642
|
/**
|
|
@@ -175027,6 +174983,999 @@ declare namespace PowerPoint {
|
|
|
175027
174983
|
*/
|
|
175028
174984
|
toJSON(): PowerPoint.Interfaces.ShapeCollectionData;
|
|
175029
174985
|
}
|
|
174986
|
+
/**
|
|
174987
|
+
* Specifies the gradient fill type for a {@link PowerPoint.SlideBackgroundGradientFill}.
|
|
174988
|
+
*
|
|
174989
|
+
* @remarks
|
|
174990
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
174991
|
+
* @beta
|
|
174992
|
+
*/
|
|
174993
|
+
enum SlideBackgroundGradientFillType {
|
|
174994
|
+
/**
|
|
174995
|
+
* Unsupported gradient fill.
|
|
174996
|
+
* @remarks
|
|
174997
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
174998
|
+
* @beta
|
|
174999
|
+
*/
|
|
175000
|
+
unsupported = "Unsupported",
|
|
175001
|
+
/**
|
|
175002
|
+
* Linear gradient fill.
|
|
175003
|
+
* @remarks
|
|
175004
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175005
|
+
* @beta
|
|
175006
|
+
*/
|
|
175007
|
+
linear = "Linear",
|
|
175008
|
+
/**
|
|
175009
|
+
* Radial gradient fill.
|
|
175010
|
+
* @remarks
|
|
175011
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175012
|
+
* @beta
|
|
175013
|
+
*/
|
|
175014
|
+
radial = "Radial",
|
|
175015
|
+
/**
|
|
175016
|
+
* Rectangular gradient fill.
|
|
175017
|
+
* @remarks
|
|
175018
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175019
|
+
* @beta
|
|
175020
|
+
*/
|
|
175021
|
+
rectangular = "Rectangular",
|
|
175022
|
+
/**
|
|
175023
|
+
* Path gradient fill.
|
|
175024
|
+
* @remarks
|
|
175025
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175026
|
+
* @beta
|
|
175027
|
+
*/
|
|
175028
|
+
path = "Path",
|
|
175029
|
+
/**
|
|
175030
|
+
* Shade from title gradient fill.
|
|
175031
|
+
* @remarks
|
|
175032
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175033
|
+
* @beta
|
|
175034
|
+
*/
|
|
175035
|
+
shadeFromTitle = "ShadeFromTitle",
|
|
175036
|
+
}
|
|
175037
|
+
/**
|
|
175038
|
+
* Represents {@link PowerPoint.SlideBackground} gradient fill properties.
|
|
175039
|
+
*
|
|
175040
|
+
* @remarks
|
|
175041
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175042
|
+
* @beta
|
|
175043
|
+
*/
|
|
175044
|
+
class SlideBackgroundGradientFill extends OfficeExtension.ClientObject {
|
|
175045
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175046
|
+
context: RequestContext;
|
|
175047
|
+
/**
|
|
175048
|
+
* Specifies the type of gradient fill.
|
|
175049
|
+
*
|
|
175050
|
+
* @remarks
|
|
175051
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175052
|
+
* @beta
|
|
175053
|
+
*/
|
|
175054
|
+
type: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
|
|
175055
|
+
/**
|
|
175056
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175057
|
+
*
|
|
175058
|
+
* @param options Provides options for which properties of the object to load.
|
|
175059
|
+
*/
|
|
175060
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundGradientFillLoadOptions): PowerPoint.SlideBackgroundGradientFill;
|
|
175061
|
+
/**
|
|
175062
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175063
|
+
*
|
|
175064
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
175065
|
+
*/
|
|
175066
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundGradientFill;
|
|
175067
|
+
/**
|
|
175068
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175069
|
+
*
|
|
175070
|
+
* @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.
|
|
175071
|
+
*/
|
|
175072
|
+
load(propertyNamesAndPaths?: {
|
|
175073
|
+
select?: string;
|
|
175074
|
+
expand?: string;
|
|
175075
|
+
}): PowerPoint.SlideBackgroundGradientFill;
|
|
175076
|
+
/**
|
|
175077
|
+
* 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.)
|
|
175078
|
+
* Whereas the original `PowerPoint.SlideBackgroundGradientFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundGradientFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
175079
|
+
*/
|
|
175080
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundGradientFillData;
|
|
175081
|
+
}
|
|
175082
|
+
/**
|
|
175083
|
+
* Represents the available options for setting a {@link PowerPoint.SlideBackground} gradient fill.
|
|
175084
|
+
*
|
|
175085
|
+
* @remarks
|
|
175086
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175087
|
+
* @beta
|
|
175088
|
+
*/
|
|
175089
|
+
interface SlideBackgroundGradientFillOptions {
|
|
175090
|
+
/**
|
|
175091
|
+
* If provided, specifies the type of gradient fill.
|
|
175092
|
+
*
|
|
175093
|
+
* @remarks
|
|
175094
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175095
|
+
* @beta
|
|
175096
|
+
*/
|
|
175097
|
+
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
|
|
175098
|
+
}
|
|
175099
|
+
/**
|
|
175100
|
+
* Specifies the pattern fill type for a {@link PowerPoint.SlideBackgroundPatternFill}.
|
|
175101
|
+
*
|
|
175102
|
+
* @remarks
|
|
175103
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175104
|
+
* @beta
|
|
175105
|
+
*/
|
|
175106
|
+
enum SlideBackgroundPatternFillType {
|
|
175107
|
+
/**
|
|
175108
|
+
* Unsupported pattern fill.
|
|
175109
|
+
* @remarks
|
|
175110
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175111
|
+
* @beta
|
|
175112
|
+
*/
|
|
175113
|
+
unsupported = "Unsupported",
|
|
175114
|
+
/**
|
|
175115
|
+
* 5 percent pattern fill.
|
|
175116
|
+
* @remarks
|
|
175117
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175118
|
+
* @beta
|
|
175119
|
+
*/
|
|
175120
|
+
percent5 = "Percent5",
|
|
175121
|
+
/**
|
|
175122
|
+
* 10 percent pattern fill.
|
|
175123
|
+
* @remarks
|
|
175124
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175125
|
+
* @beta
|
|
175126
|
+
*/
|
|
175127
|
+
percent10 = "Percent10",
|
|
175128
|
+
/**
|
|
175129
|
+
* 20 percent pattern fill.
|
|
175130
|
+
* @remarks
|
|
175131
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175132
|
+
* @beta
|
|
175133
|
+
*/
|
|
175134
|
+
percent20 = "Percent20",
|
|
175135
|
+
/**
|
|
175136
|
+
* 25 percent pattern fill.
|
|
175137
|
+
* @remarks
|
|
175138
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175139
|
+
* @beta
|
|
175140
|
+
*/
|
|
175141
|
+
percent25 = "Percent25",
|
|
175142
|
+
/**
|
|
175143
|
+
* 30 percent pattern fill.
|
|
175144
|
+
* @remarks
|
|
175145
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175146
|
+
* @beta
|
|
175147
|
+
*/
|
|
175148
|
+
percent30 = "Percent30",
|
|
175149
|
+
/**
|
|
175150
|
+
* 40 percent pattern fill.
|
|
175151
|
+
* @remarks
|
|
175152
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175153
|
+
* @beta
|
|
175154
|
+
*/
|
|
175155
|
+
percent40 = "Percent40",
|
|
175156
|
+
/**
|
|
175157
|
+
* 50 percent pattern fill.
|
|
175158
|
+
* @remarks
|
|
175159
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175160
|
+
* @beta
|
|
175161
|
+
*/
|
|
175162
|
+
percent50 = "Percent50",
|
|
175163
|
+
/**
|
|
175164
|
+
* 60 percent pattern fill.
|
|
175165
|
+
* @remarks
|
|
175166
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175167
|
+
* @beta
|
|
175168
|
+
*/
|
|
175169
|
+
percent60 = "Percent60",
|
|
175170
|
+
/**
|
|
175171
|
+
* 70 percent pattern fill.
|
|
175172
|
+
* @remarks
|
|
175173
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175174
|
+
* @beta
|
|
175175
|
+
*/
|
|
175176
|
+
percent70 = "Percent70",
|
|
175177
|
+
/**
|
|
175178
|
+
* 75 percent pattern fill.
|
|
175179
|
+
* @remarks
|
|
175180
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175181
|
+
* @beta
|
|
175182
|
+
*/
|
|
175183
|
+
percent75 = "Percent75",
|
|
175184
|
+
/**
|
|
175185
|
+
* 80 percent pattern fill.
|
|
175186
|
+
* @remarks
|
|
175187
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175188
|
+
* @beta
|
|
175189
|
+
*/
|
|
175190
|
+
percent80 = "Percent80",
|
|
175191
|
+
/**
|
|
175192
|
+
* 90 percent pattern fill.
|
|
175193
|
+
* @remarks
|
|
175194
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175195
|
+
* @beta
|
|
175196
|
+
*/
|
|
175197
|
+
percent90 = "Percent90",
|
|
175198
|
+
/**
|
|
175199
|
+
* Horizontal pattern fill.
|
|
175200
|
+
* @remarks
|
|
175201
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175202
|
+
* @beta
|
|
175203
|
+
*/
|
|
175204
|
+
horizontal = "Horizontal",
|
|
175205
|
+
/**
|
|
175206
|
+
* Vertical pattern fill.
|
|
175207
|
+
* @remarks
|
|
175208
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175209
|
+
* @beta
|
|
175210
|
+
*/
|
|
175211
|
+
vertical = "Vertical",
|
|
175212
|
+
/**
|
|
175213
|
+
* Light horizontal pattern fill.
|
|
175214
|
+
* @remarks
|
|
175215
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175216
|
+
* @beta
|
|
175217
|
+
*/
|
|
175218
|
+
lightHorizontal = "LightHorizontal",
|
|
175219
|
+
/**
|
|
175220
|
+
* Light vertical pattern fill.
|
|
175221
|
+
* @remarks
|
|
175222
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175223
|
+
* @beta
|
|
175224
|
+
*/
|
|
175225
|
+
lightVertical = "LightVertical",
|
|
175226
|
+
/**
|
|
175227
|
+
* Dark horizontal pattern fill.
|
|
175228
|
+
* @remarks
|
|
175229
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175230
|
+
* @beta
|
|
175231
|
+
*/
|
|
175232
|
+
darkHorizontal = "DarkHorizontal",
|
|
175233
|
+
/**
|
|
175234
|
+
* Dark vertical pattern fill.
|
|
175235
|
+
* @remarks
|
|
175236
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175237
|
+
* @beta
|
|
175238
|
+
*/
|
|
175239
|
+
darkVertical = "DarkVertical",
|
|
175240
|
+
/**
|
|
175241
|
+
* Narrow horizontal pattern fill.
|
|
175242
|
+
* @remarks
|
|
175243
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175244
|
+
* @beta
|
|
175245
|
+
*/
|
|
175246
|
+
narrowHorizontal = "NarrowHorizontal",
|
|
175247
|
+
/**
|
|
175248
|
+
* Narrow vertical pattern fill.
|
|
175249
|
+
* @remarks
|
|
175250
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175251
|
+
* @beta
|
|
175252
|
+
*/
|
|
175253
|
+
narrowVertical = "NarrowVertical",
|
|
175254
|
+
/**
|
|
175255
|
+
* Dashed horizontal pattern fill.
|
|
175256
|
+
* @remarks
|
|
175257
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175258
|
+
* @beta
|
|
175259
|
+
*/
|
|
175260
|
+
dashedHorizontal = "DashedHorizontal",
|
|
175261
|
+
/**
|
|
175262
|
+
* Dashed vertical pattern fill.
|
|
175263
|
+
* @remarks
|
|
175264
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175265
|
+
* @beta
|
|
175266
|
+
*/
|
|
175267
|
+
dashedVertical = "DashedVertical",
|
|
175268
|
+
/**
|
|
175269
|
+
* Cross pattern fill.
|
|
175270
|
+
* @remarks
|
|
175271
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175272
|
+
* @beta
|
|
175273
|
+
*/
|
|
175274
|
+
cross = "Cross",
|
|
175275
|
+
/**
|
|
175276
|
+
* Downward diagonal pattern fill.
|
|
175277
|
+
* @remarks
|
|
175278
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175279
|
+
* @beta
|
|
175280
|
+
*/
|
|
175281
|
+
downwardDiagonal = "DownwardDiagonal",
|
|
175282
|
+
/**
|
|
175283
|
+
* Upward diagonal pattern fill.
|
|
175284
|
+
* @remarks
|
|
175285
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175286
|
+
* @beta
|
|
175287
|
+
*/
|
|
175288
|
+
upwardDiagonal = "UpwardDiagonal",
|
|
175289
|
+
/**
|
|
175290
|
+
* Light downward diagonal pattern fill.
|
|
175291
|
+
* @remarks
|
|
175292
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175293
|
+
* @beta
|
|
175294
|
+
*/
|
|
175295
|
+
lightDownwardDiagonal = "LightDownwardDiagonal",
|
|
175296
|
+
/**
|
|
175297
|
+
* Light upward diagonal pattern fill.
|
|
175298
|
+
* @remarks
|
|
175299
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175300
|
+
* @beta
|
|
175301
|
+
*/
|
|
175302
|
+
lightUpwardDiagonal = "LightUpwardDiagonal",
|
|
175303
|
+
/**
|
|
175304
|
+
* Dark downward diagonal pattern fill.
|
|
175305
|
+
* @remarks
|
|
175306
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175307
|
+
* @beta
|
|
175308
|
+
*/
|
|
175309
|
+
darkDownwardDiagonal = "DarkDownwardDiagonal",
|
|
175310
|
+
/**
|
|
175311
|
+
* Dark upward diagonal pattern fill.
|
|
175312
|
+
* @remarks
|
|
175313
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175314
|
+
* @beta
|
|
175315
|
+
*/
|
|
175316
|
+
darkUpwardDiagonal = "DarkUpwardDiagonal",
|
|
175317
|
+
/**
|
|
175318
|
+
* Wide downward diagonal pattern fill.
|
|
175319
|
+
* @remarks
|
|
175320
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175321
|
+
* @beta
|
|
175322
|
+
*/
|
|
175323
|
+
wideDownwardDiagonal = "WideDownwardDiagonal",
|
|
175324
|
+
/**
|
|
175325
|
+
* Wide upward diagonal pattern fill.
|
|
175326
|
+
* @remarks
|
|
175327
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175328
|
+
* @beta
|
|
175329
|
+
*/
|
|
175330
|
+
wideUpwardDiagonal = "WideUpwardDiagonal",
|
|
175331
|
+
/**
|
|
175332
|
+
* Dashed downward diagonal pattern fill.
|
|
175333
|
+
* @remarks
|
|
175334
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175335
|
+
* @beta
|
|
175336
|
+
*/
|
|
175337
|
+
dashedDownwardDiagonal = "DashedDownwardDiagonal",
|
|
175338
|
+
/**
|
|
175339
|
+
* Dashed upward diagonal pattern fill.
|
|
175340
|
+
* @remarks
|
|
175341
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175342
|
+
* @beta
|
|
175343
|
+
*/
|
|
175344
|
+
dashedUpwardDiagonal = "DashedUpwardDiagonal",
|
|
175345
|
+
/**
|
|
175346
|
+
* Diagonal cross pattern fill.
|
|
175347
|
+
* @remarks
|
|
175348
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175349
|
+
* @beta
|
|
175350
|
+
*/
|
|
175351
|
+
diagonalCross = "DiagonalCross",
|
|
175352
|
+
/**
|
|
175353
|
+
* Small checker board pattern fill.
|
|
175354
|
+
* @remarks
|
|
175355
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175356
|
+
* @beta
|
|
175357
|
+
*/
|
|
175358
|
+
smallCheckerBoard = "SmallCheckerBoard",
|
|
175359
|
+
/**
|
|
175360
|
+
* Large checker board pattern fill.
|
|
175361
|
+
* @remarks
|
|
175362
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175363
|
+
* @beta
|
|
175364
|
+
*/
|
|
175365
|
+
largeCheckerBoard = "LargeCheckerBoard",
|
|
175366
|
+
/**
|
|
175367
|
+
* Small grid pattern fill.
|
|
175368
|
+
* @remarks
|
|
175369
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175370
|
+
* @beta
|
|
175371
|
+
*/
|
|
175372
|
+
smallGrid = "SmallGrid",
|
|
175373
|
+
/**
|
|
175374
|
+
* Large grid pattern fill.
|
|
175375
|
+
* @remarks
|
|
175376
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175377
|
+
* @beta
|
|
175378
|
+
*/
|
|
175379
|
+
largeGrid = "LargeGrid",
|
|
175380
|
+
/**
|
|
175381
|
+
* Dotted grid pattern fill.
|
|
175382
|
+
* @remarks
|
|
175383
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175384
|
+
* @beta
|
|
175385
|
+
*/
|
|
175386
|
+
dottedGrid = "DottedGrid",
|
|
175387
|
+
/**
|
|
175388
|
+
* Small confetti pattern fill.
|
|
175389
|
+
* @remarks
|
|
175390
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175391
|
+
* @beta
|
|
175392
|
+
*/
|
|
175393
|
+
smallConfetti = "SmallConfetti",
|
|
175394
|
+
/**
|
|
175395
|
+
* Large confetti pattern fill.
|
|
175396
|
+
* @remarks
|
|
175397
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175398
|
+
* @beta
|
|
175399
|
+
*/
|
|
175400
|
+
largeConfetti = "LargeConfetti",
|
|
175401
|
+
/**
|
|
175402
|
+
* Horizontal brick pattern fill.
|
|
175403
|
+
* @remarks
|
|
175404
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175405
|
+
* @beta
|
|
175406
|
+
*/
|
|
175407
|
+
horizontalBrick = "HorizontalBrick",
|
|
175408
|
+
/**
|
|
175409
|
+
* Diagonal brick pattern fill.
|
|
175410
|
+
* @remarks
|
|
175411
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175412
|
+
* @beta
|
|
175413
|
+
*/
|
|
175414
|
+
diagonalBrick = "DiagonalBrick",
|
|
175415
|
+
/**
|
|
175416
|
+
* Solid diamond pattern fill.
|
|
175417
|
+
* @remarks
|
|
175418
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175419
|
+
* @beta
|
|
175420
|
+
*/
|
|
175421
|
+
solidDiamond = "SolidDiamond",
|
|
175422
|
+
/**
|
|
175423
|
+
* Outlined diamond pattern fill.
|
|
175424
|
+
* @remarks
|
|
175425
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175426
|
+
* @beta
|
|
175427
|
+
*/
|
|
175428
|
+
outlinedDiamond = "OutlinedDiamond",
|
|
175429
|
+
/**
|
|
175430
|
+
* Dotted diamond pattern fill.
|
|
175431
|
+
* @remarks
|
|
175432
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175433
|
+
* @beta
|
|
175434
|
+
*/
|
|
175435
|
+
dottedDiamond = "DottedDiamond",
|
|
175436
|
+
/**
|
|
175437
|
+
* Plaid pattern fill.
|
|
175438
|
+
* @remarks
|
|
175439
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175440
|
+
* @beta
|
|
175441
|
+
*/
|
|
175442
|
+
plaid = "Plaid",
|
|
175443
|
+
/**
|
|
175444
|
+
* Sphere pattern fill.
|
|
175445
|
+
* @remarks
|
|
175446
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175447
|
+
* @beta
|
|
175448
|
+
*/
|
|
175449
|
+
sphere = "Sphere",
|
|
175450
|
+
/**
|
|
175451
|
+
* Weave pattern fill.
|
|
175452
|
+
* @remarks
|
|
175453
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175454
|
+
* @beta
|
|
175455
|
+
*/
|
|
175456
|
+
weave = "Weave",
|
|
175457
|
+
/**
|
|
175458
|
+
* Divot pattern fill.
|
|
175459
|
+
* @remarks
|
|
175460
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175461
|
+
* @beta
|
|
175462
|
+
*/
|
|
175463
|
+
divot = "Divot",
|
|
175464
|
+
/**
|
|
175465
|
+
* Shingle pattern fill.
|
|
175466
|
+
* @remarks
|
|
175467
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175468
|
+
* @beta
|
|
175469
|
+
*/
|
|
175470
|
+
shingle = "Shingle",
|
|
175471
|
+
/**
|
|
175472
|
+
* Wave pattern fill.
|
|
175473
|
+
* @remarks
|
|
175474
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175475
|
+
* @beta
|
|
175476
|
+
*/
|
|
175477
|
+
wave = "Wave",
|
|
175478
|
+
/**
|
|
175479
|
+
* Trellis pattern fill.
|
|
175480
|
+
* @remarks
|
|
175481
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175482
|
+
* @beta
|
|
175483
|
+
*/
|
|
175484
|
+
trellis = "Trellis",
|
|
175485
|
+
/**
|
|
175486
|
+
* Zig zag pattern fill.
|
|
175487
|
+
* @remarks
|
|
175488
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175489
|
+
* @beta
|
|
175490
|
+
*/
|
|
175491
|
+
zigZag = "ZigZag",
|
|
175492
|
+
}
|
|
175493
|
+
/**
|
|
175494
|
+
* Represents {@link PowerPoint.SlideBackground} pattern fill properties.
|
|
175495
|
+
*
|
|
175496
|
+
* @remarks
|
|
175497
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175498
|
+
* @beta
|
|
175499
|
+
*/
|
|
175500
|
+
class SlideBackgroundPatternFill extends OfficeExtension.ClientObject {
|
|
175501
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175502
|
+
context: RequestContext;
|
|
175503
|
+
/**
|
|
175504
|
+
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
175505
|
+
*
|
|
175506
|
+
* @remarks
|
|
175507
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175508
|
+
* @beta
|
|
175509
|
+
*/
|
|
175510
|
+
backgroundColor: string;
|
|
175511
|
+
/**
|
|
175512
|
+
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
175513
|
+
*
|
|
175514
|
+
* @remarks
|
|
175515
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175516
|
+
* @beta
|
|
175517
|
+
*/
|
|
175518
|
+
foregroundColor: string;
|
|
175519
|
+
/**
|
|
175520
|
+
* Specifies the pattern type.
|
|
175521
|
+
*
|
|
175522
|
+
* @remarks
|
|
175523
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175524
|
+
* @beta
|
|
175525
|
+
*/
|
|
175526
|
+
pattern: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
|
|
175527
|
+
/**
|
|
175528
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175529
|
+
*
|
|
175530
|
+
* @param options Provides options for which properties of the object to load.
|
|
175531
|
+
*/
|
|
175532
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundPatternFillLoadOptions): PowerPoint.SlideBackgroundPatternFill;
|
|
175533
|
+
/**
|
|
175534
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175535
|
+
*
|
|
175536
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
175537
|
+
*/
|
|
175538
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPatternFill;
|
|
175539
|
+
/**
|
|
175540
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175541
|
+
*
|
|
175542
|
+
* @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.
|
|
175543
|
+
*/
|
|
175544
|
+
load(propertyNamesAndPaths?: {
|
|
175545
|
+
select?: string;
|
|
175546
|
+
expand?: string;
|
|
175547
|
+
}): PowerPoint.SlideBackgroundPatternFill;
|
|
175548
|
+
/**
|
|
175549
|
+
* 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.)
|
|
175550
|
+
* Whereas the original `PowerPoint.SlideBackgroundPatternFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPatternFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
175551
|
+
*/
|
|
175552
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundPatternFillData;
|
|
175553
|
+
}
|
|
175554
|
+
/**
|
|
175555
|
+
* Represents the available options for setting a {@link PowerPoint.SlideBackground} pattern fill.
|
|
175556
|
+
*
|
|
175557
|
+
* @remarks
|
|
175558
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175559
|
+
* @beta
|
|
175560
|
+
*/
|
|
175561
|
+
interface SlideBackgroundPatternFillOptions {
|
|
175562
|
+
/**
|
|
175563
|
+
* If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
175564
|
+
*
|
|
175565
|
+
* @remarks
|
|
175566
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175567
|
+
* @beta
|
|
175568
|
+
*/
|
|
175569
|
+
backgroundColor?: string;
|
|
175570
|
+
/**
|
|
175571
|
+
* If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
175572
|
+
*
|
|
175573
|
+
* @remarks
|
|
175574
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175575
|
+
* @beta
|
|
175576
|
+
*/
|
|
175577
|
+
foregroundColor?: string;
|
|
175578
|
+
/**
|
|
175579
|
+
* If provided, specifies the pattern type.
|
|
175580
|
+
*
|
|
175581
|
+
* @remarks
|
|
175582
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175583
|
+
* @beta
|
|
175584
|
+
*/
|
|
175585
|
+
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
|
|
175586
|
+
}
|
|
175587
|
+
/**
|
|
175588
|
+
* Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
|
|
175589
|
+
*
|
|
175590
|
+
* @remarks
|
|
175591
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175592
|
+
* @beta
|
|
175593
|
+
*/
|
|
175594
|
+
class SlideBackgroundPictureOrTextureFill extends OfficeExtension.ClientObject {
|
|
175595
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175596
|
+
context: RequestContext;
|
|
175597
|
+
/**
|
|
175598
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
175599
|
+
*
|
|
175600
|
+
* @remarks
|
|
175601
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175602
|
+
* @beta
|
|
175603
|
+
*/
|
|
175604
|
+
transparency: number;
|
|
175605
|
+
/**
|
|
175606
|
+
* Sets the image used to fill.
|
|
175607
|
+
*
|
|
175608
|
+
* @remarks
|
|
175609
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175610
|
+
* @beta
|
|
175611
|
+
*
|
|
175612
|
+
* @param base64EncodedImage A string that is a Base64 encoding of the image data.
|
|
175613
|
+
*/
|
|
175614
|
+
setImage(base64EncodedImage: string): void;
|
|
175615
|
+
/**
|
|
175616
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175617
|
+
*
|
|
175618
|
+
* @param options Provides options for which properties of the object to load.
|
|
175619
|
+
*/
|
|
175620
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillLoadOptions): PowerPoint.SlideBackgroundPictureOrTextureFill;
|
|
175621
|
+
/**
|
|
175622
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175623
|
+
*
|
|
175624
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
175625
|
+
*/
|
|
175626
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundPictureOrTextureFill;
|
|
175627
|
+
/**
|
|
175628
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175629
|
+
*
|
|
175630
|
+
* @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.
|
|
175631
|
+
*/
|
|
175632
|
+
load(propertyNamesAndPaths?: {
|
|
175633
|
+
select?: string;
|
|
175634
|
+
expand?: string;
|
|
175635
|
+
}): PowerPoint.SlideBackgroundPictureOrTextureFill;
|
|
175636
|
+
/**
|
|
175637
|
+
* 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.)
|
|
175638
|
+
* Whereas the original `PowerPoint.SlideBackgroundPictureOrTextureFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
175639
|
+
*/
|
|
175640
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundPictureOrTextureFillData;
|
|
175641
|
+
}
|
|
175642
|
+
/**
|
|
175643
|
+
* Represents {@link PowerPoint.SlideBackground} picture or texture fill options.
|
|
175644
|
+
*
|
|
175645
|
+
* @remarks
|
|
175646
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175647
|
+
* @beta
|
|
175648
|
+
*/
|
|
175649
|
+
interface SlideBackgroundPictureOrTextureFillOptions {
|
|
175650
|
+
/**
|
|
175651
|
+
* If provided, specifies the Base64-encoded image data for the fill.
|
|
175652
|
+
*
|
|
175653
|
+
* @remarks
|
|
175654
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175655
|
+
* @beta
|
|
175656
|
+
*/
|
|
175657
|
+
imageBase64?: string;
|
|
175658
|
+
/**
|
|
175659
|
+
* If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
175660
|
+
*
|
|
175661
|
+
* @remarks
|
|
175662
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175663
|
+
* @beta
|
|
175664
|
+
*/
|
|
175665
|
+
transparency: number;
|
|
175666
|
+
}
|
|
175667
|
+
/**
|
|
175668
|
+
* Specifies the fill type for a {@link PowerPoint.SlideBackground}.
|
|
175669
|
+
*
|
|
175670
|
+
* @remarks
|
|
175671
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175672
|
+
* @beta
|
|
175673
|
+
*/
|
|
175674
|
+
enum SlideBackgroundFillType {
|
|
175675
|
+
/**
|
|
175676
|
+
* Unsupported slide background fill.
|
|
175677
|
+
* @remarks
|
|
175678
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175679
|
+
* @beta
|
|
175680
|
+
*/
|
|
175681
|
+
unsupported = "Unsupported",
|
|
175682
|
+
/**
|
|
175683
|
+
* Specifies that the slide background should have regular solid fill.
|
|
175684
|
+
* @remarks
|
|
175685
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175686
|
+
* @beta
|
|
175687
|
+
*/
|
|
175688
|
+
solid = "Solid",
|
|
175689
|
+
/**
|
|
175690
|
+
* Specifies that the slide background should have gradient fill.
|
|
175691
|
+
* @remarks
|
|
175692
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175693
|
+
* @beta
|
|
175694
|
+
*/
|
|
175695
|
+
gradient = "Gradient",
|
|
175696
|
+
/**
|
|
175697
|
+
* Specifies that the slide background should have picture or texture fill.
|
|
175698
|
+
* @remarks
|
|
175699
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175700
|
+
* @beta
|
|
175701
|
+
*/
|
|
175702
|
+
pictureOrTexture = "PictureOrTexture",
|
|
175703
|
+
/**
|
|
175704
|
+
* Specifies that the slide background should have pattern fill.
|
|
175705
|
+
* @remarks
|
|
175706
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175707
|
+
* @beta
|
|
175708
|
+
*/
|
|
175709
|
+
pattern = "Pattern",
|
|
175710
|
+
}
|
|
175711
|
+
/**
|
|
175712
|
+
* Represents {@link PowerPoint.SlideBackground} solid fill properties.
|
|
175713
|
+
*
|
|
175714
|
+
* @remarks
|
|
175715
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175716
|
+
* @beta
|
|
175717
|
+
*/
|
|
175718
|
+
class SlideBackgroundSolidFill extends OfficeExtension.ClientObject {
|
|
175719
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175720
|
+
context: RequestContext;
|
|
175721
|
+
/**
|
|
175722
|
+
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
175723
|
+
*
|
|
175724
|
+
* @remarks
|
|
175725
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175726
|
+
* @beta
|
|
175727
|
+
*/
|
|
175728
|
+
color: string;
|
|
175729
|
+
/**
|
|
175730
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
175731
|
+
*
|
|
175732
|
+
* @remarks
|
|
175733
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175734
|
+
* @beta
|
|
175735
|
+
*/
|
|
175736
|
+
transparency: number;
|
|
175737
|
+
/**
|
|
175738
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175739
|
+
*
|
|
175740
|
+
* @param options Provides options for which properties of the object to load.
|
|
175741
|
+
*/
|
|
175742
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundSolidFillLoadOptions): PowerPoint.SlideBackgroundSolidFill;
|
|
175743
|
+
/**
|
|
175744
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175745
|
+
*
|
|
175746
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
175747
|
+
*/
|
|
175748
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundSolidFill;
|
|
175749
|
+
/**
|
|
175750
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175751
|
+
*
|
|
175752
|
+
* @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.
|
|
175753
|
+
*/
|
|
175754
|
+
load(propertyNamesAndPaths?: {
|
|
175755
|
+
select?: string;
|
|
175756
|
+
expand?: string;
|
|
175757
|
+
}): PowerPoint.SlideBackgroundSolidFill;
|
|
175758
|
+
/**
|
|
175759
|
+
* 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.)
|
|
175760
|
+
* Whereas the original `PowerPoint.SlideBackgroundSolidFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundSolidFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
175761
|
+
*/
|
|
175762
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundSolidFillData;
|
|
175763
|
+
}
|
|
175764
|
+
/**
|
|
175765
|
+
* Represents the available options for setting a {@link PowerPoint.SlideBackground} solid fill.
|
|
175766
|
+
*
|
|
175767
|
+
* @remarks
|
|
175768
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175769
|
+
* @beta
|
|
175770
|
+
*/
|
|
175771
|
+
interface SlideBackgroundSolidFillOptions {
|
|
175772
|
+
/**
|
|
175773
|
+
* If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
175774
|
+
*
|
|
175775
|
+
* @remarks
|
|
175776
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175777
|
+
* @beta
|
|
175778
|
+
*/
|
|
175779
|
+
color?: string;
|
|
175780
|
+
/**
|
|
175781
|
+
* If provided, specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
175782
|
+
*
|
|
175783
|
+
* @remarks
|
|
175784
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175785
|
+
* @beta
|
|
175786
|
+
*/
|
|
175787
|
+
transparency?: number;
|
|
175788
|
+
}
|
|
175789
|
+
/**
|
|
175790
|
+
* Represents the fill formatting of a slide background object.
|
|
175791
|
+
*
|
|
175792
|
+
* @remarks
|
|
175793
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175794
|
+
* @beta
|
|
175795
|
+
*/
|
|
175796
|
+
class SlideBackgroundFill extends OfficeExtension.ClientObject {
|
|
175797
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175798
|
+
context: RequestContext;
|
|
175799
|
+
/**
|
|
175800
|
+
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
|
|
175801
|
+
*
|
|
175802
|
+
* @remarks
|
|
175803
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175804
|
+
* @beta
|
|
175805
|
+
*/
|
|
175806
|
+
readonly type: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
|
|
175807
|
+
/**
|
|
175808
|
+
* Gets the gradient fill properties. If the fill type is not `gradient`, an object with an `isNullObject` property set to `true` is returned.
|
|
175809
|
+
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}.
|
|
175810
|
+
*
|
|
175811
|
+
* @remarks
|
|
175812
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175813
|
+
* @beta
|
|
175814
|
+
*/
|
|
175815
|
+
getGradientFillOrNullObject(): PowerPoint.SlideBackgroundGradientFill;
|
|
175816
|
+
/**
|
|
175817
|
+
* Gets the pattern fill properties. If the fill type is not `pattern`, an object with an `isNullObject` property set to `true` is returned.
|
|
175818
|
+
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}.
|
|
175819
|
+
*
|
|
175820
|
+
* @remarks
|
|
175821
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175822
|
+
* @beta
|
|
175823
|
+
*/
|
|
175824
|
+
getPatternFillOrNullObject(): PowerPoint.SlideBackgroundPatternFill;
|
|
175825
|
+
/**
|
|
175826
|
+
* Gets the picture or texture fill properties. If the fill type is not `pictureOrTexture`, an object with an `isNullObject` property set to `true` is returned.
|
|
175827
|
+
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}.
|
|
175828
|
+
*
|
|
175829
|
+
* @remarks
|
|
175830
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175831
|
+
* @beta
|
|
175832
|
+
*/
|
|
175833
|
+
getPictureOrTextureFillOrNullObject(): PowerPoint.SlideBackgroundPictureOrTextureFill;
|
|
175834
|
+
/**
|
|
175835
|
+
* Gets the solid fill properties. If the fill type is not `solid`, an object with an `isNullObject` property set to `true` is returned.
|
|
175836
|
+
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}.
|
|
175837
|
+
*
|
|
175838
|
+
* @remarks
|
|
175839
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175840
|
+
* @beta
|
|
175841
|
+
*/
|
|
175842
|
+
getSolidFillOrNullObject(): PowerPoint.SlideBackgroundSolidFill;
|
|
175843
|
+
/**
|
|
175844
|
+
* Sets the fill formatting of the slide background to a gradient fill. This changes the fill type to `gradient`.
|
|
175845
|
+
*
|
|
175846
|
+
* @remarks
|
|
175847
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175848
|
+
* @beta
|
|
175849
|
+
*
|
|
175850
|
+
* @param options Options for the gradient fill.
|
|
175851
|
+
*/
|
|
175852
|
+
setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions): void;
|
|
175853
|
+
/**
|
|
175854
|
+
* Sets the fill formatting of the slide background to a pattern fill. This changes the fill type to `pattern`.
|
|
175855
|
+
*
|
|
175856
|
+
* @remarks
|
|
175857
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175858
|
+
* @beta
|
|
175859
|
+
*
|
|
175860
|
+
* @param options Options for the pattern fill.
|
|
175861
|
+
*/
|
|
175862
|
+
setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions): void;
|
|
175863
|
+
/**
|
|
175864
|
+
* Sets the fill formatting of the slide background to a picture or texture fill. This changes the fill type to `pictureOrTexture`.
|
|
175865
|
+
*
|
|
175866
|
+
* @remarks
|
|
175867
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175868
|
+
* @beta
|
|
175869
|
+
*
|
|
175870
|
+
* @param options Options for the picture or texture fill.
|
|
175871
|
+
*/
|
|
175872
|
+
setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions): void;
|
|
175873
|
+
/**
|
|
175874
|
+
* Sets the fill formatting of the slide background to a solid fill. This changes the fill type to `solid`.
|
|
175875
|
+
*
|
|
175876
|
+
* @remarks
|
|
175877
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175878
|
+
* @beta
|
|
175879
|
+
*
|
|
175880
|
+
* @param options Options for the solid fill.
|
|
175881
|
+
*/
|
|
175882
|
+
setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions): void;
|
|
175883
|
+
/**
|
|
175884
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175885
|
+
*
|
|
175886
|
+
* @param options Provides options for which properties of the object to load.
|
|
175887
|
+
*/
|
|
175888
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions): PowerPoint.SlideBackgroundFill;
|
|
175889
|
+
/**
|
|
175890
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175891
|
+
*
|
|
175892
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
175893
|
+
*/
|
|
175894
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackgroundFill;
|
|
175895
|
+
/**
|
|
175896
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175897
|
+
*
|
|
175898
|
+
* @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.
|
|
175899
|
+
*/
|
|
175900
|
+
load(propertyNamesAndPaths?: {
|
|
175901
|
+
select?: string;
|
|
175902
|
+
expand?: string;
|
|
175903
|
+
}): PowerPoint.SlideBackgroundFill;
|
|
175904
|
+
/**
|
|
175905
|
+
* 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.)
|
|
175906
|
+
* Whereas the original `PowerPoint.SlideBackgroundFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundFillData`) that contains shallow copies of any loaded child properties from the original object.
|
|
175907
|
+
*/
|
|
175908
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundFillData;
|
|
175909
|
+
}
|
|
175910
|
+
/**
|
|
175911
|
+
* Represents a background of a slide.
|
|
175912
|
+
*
|
|
175913
|
+
* @remarks
|
|
175914
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175915
|
+
* @beta
|
|
175916
|
+
*/
|
|
175917
|
+
class SlideBackground extends OfficeExtension.ClientObject {
|
|
175918
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175919
|
+
context: RequestContext;
|
|
175920
|
+
/**
|
|
175921
|
+
* Returns the fill formatting of the background.
|
|
175922
|
+
*
|
|
175923
|
+
* @remarks
|
|
175924
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175925
|
+
* @beta
|
|
175926
|
+
*/
|
|
175927
|
+
readonly fill: PowerPoint.SlideBackgroundFill;
|
|
175928
|
+
/**
|
|
175929
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
175930
|
+
*
|
|
175931
|
+
* @remarks
|
|
175932
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175933
|
+
* @beta
|
|
175934
|
+
*/
|
|
175935
|
+
areBackgroundGraphicsHidden: boolean;
|
|
175936
|
+
/**
|
|
175937
|
+
* Specifies if the slide background follows the slide master background.
|
|
175938
|
+
*
|
|
175939
|
+
* @remarks
|
|
175940
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175941
|
+
* @beta
|
|
175942
|
+
*/
|
|
175943
|
+
isMasterBackgroundFollowed: boolean;
|
|
175944
|
+
/**
|
|
175945
|
+
* Resets the fill formatting of the slide background.
|
|
175946
|
+
*
|
|
175947
|
+
* @remarks
|
|
175948
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
175949
|
+
* @beta
|
|
175950
|
+
*/
|
|
175951
|
+
reset(): void;
|
|
175952
|
+
/**
|
|
175953
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175954
|
+
*
|
|
175955
|
+
* @param options Provides options for which properties of the object to load.
|
|
175956
|
+
*/
|
|
175957
|
+
load(options?: PowerPoint.Interfaces.SlideBackgroundLoadOptions): PowerPoint.SlideBackground;
|
|
175958
|
+
/**
|
|
175959
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175960
|
+
*
|
|
175961
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
175962
|
+
*/
|
|
175963
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideBackground;
|
|
175964
|
+
/**
|
|
175965
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
175966
|
+
*
|
|
175967
|
+
* @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.
|
|
175968
|
+
*/
|
|
175969
|
+
load(propertyNamesAndPaths?: {
|
|
175970
|
+
select?: string;
|
|
175971
|
+
expand?: string;
|
|
175972
|
+
}): PowerPoint.SlideBackground;
|
|
175973
|
+
/**
|
|
175974
|
+
* 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.)
|
|
175975
|
+
* Whereas the original `PowerPoint.SlideBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
|
|
175976
|
+
*/
|
|
175977
|
+
toJSON(): PowerPoint.Interfaces.SlideBackgroundData;
|
|
175978
|
+
}
|
|
175030
175979
|
/**
|
|
175031
175980
|
* Represents the available options when getting an image of a slide.
|
|
175032
175981
|
*
|
|
@@ -175049,6 +175998,75 @@ declare namespace PowerPoint {
|
|
|
175049
175998
|
*/
|
|
175050
175999
|
width?: number;
|
|
175051
176000
|
}
|
|
176001
|
+
/**
|
|
176002
|
+
* Represents the background of a slide layout.
|
|
176003
|
+
*
|
|
176004
|
+
* @remarks
|
|
176005
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176006
|
+
* @beta
|
|
176007
|
+
*/
|
|
176008
|
+
class SlideLayoutBackground extends OfficeExtension.ClientObject {
|
|
176009
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
176010
|
+
context: RequestContext;
|
|
176011
|
+
/**
|
|
176012
|
+
* Returns the fill formatting of the background.
|
|
176013
|
+
*
|
|
176014
|
+
* @remarks
|
|
176015
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176016
|
+
* @beta
|
|
176017
|
+
*/
|
|
176018
|
+
readonly fill: PowerPoint.SlideBackgroundFill;
|
|
176019
|
+
/**
|
|
176020
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
176021
|
+
*
|
|
176022
|
+
* @remarks
|
|
176023
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176024
|
+
* @beta
|
|
176025
|
+
*/
|
|
176026
|
+
areBackgroundGraphicsHidden: boolean;
|
|
176027
|
+
/**
|
|
176028
|
+
* Specifies if the slide layout background follows the slide master background.
|
|
176029
|
+
*
|
|
176030
|
+
* @remarks
|
|
176031
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176032
|
+
* @beta
|
|
176033
|
+
*/
|
|
176034
|
+
isMasterBackgroundFollowed: boolean;
|
|
176035
|
+
/**
|
|
176036
|
+
* Resets the fill formatting of the slide layout background.
|
|
176037
|
+
*
|
|
176038
|
+
* @remarks
|
|
176039
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176040
|
+
* @beta
|
|
176041
|
+
*/
|
|
176042
|
+
reset(): void;
|
|
176043
|
+
/**
|
|
176044
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
176045
|
+
*
|
|
176046
|
+
* @param options Provides options for which properties of the object to load.
|
|
176047
|
+
*/
|
|
176048
|
+
load(options?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions): PowerPoint.SlideLayoutBackground;
|
|
176049
|
+
/**
|
|
176050
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
176051
|
+
*
|
|
176052
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
176053
|
+
*/
|
|
176054
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideLayoutBackground;
|
|
176055
|
+
/**
|
|
176056
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
176057
|
+
*
|
|
176058
|
+
* @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.
|
|
176059
|
+
*/
|
|
176060
|
+
load(propertyNamesAndPaths?: {
|
|
176061
|
+
select?: string;
|
|
176062
|
+
expand?: string;
|
|
176063
|
+
}): PowerPoint.SlideLayoutBackground;
|
|
176064
|
+
/**
|
|
176065
|
+
* 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.)
|
|
176066
|
+
* Whereas the original `PowerPoint.SlideLayoutBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideLayoutBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
|
|
176067
|
+
*/
|
|
176068
|
+
toJSON(): PowerPoint.Interfaces.SlideLayoutBackgroundData;
|
|
176069
|
+
}
|
|
175052
176070
|
/**
|
|
175053
176071
|
* Specifies the type of a slide layout.
|
|
175054
176072
|
*
|
|
@@ -175279,6 +176297,175 @@ declare namespace PowerPoint {
|
|
|
175279
176297
|
*/
|
|
175280
176298
|
verticalTitleAndTextOverChart = "VerticalTitleAndTextOverChart",
|
|
175281
176299
|
}
|
|
176300
|
+
/**
|
|
176301
|
+
* Specifies the theme colors used in PowerPoint.
|
|
176302
|
+
*
|
|
176303
|
+
* @remarks
|
|
176304
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176305
|
+
* @beta
|
|
176306
|
+
*/
|
|
176307
|
+
enum ThemeColor {
|
|
176308
|
+
/**
|
|
176309
|
+
* Specifies a mixed theme color.
|
|
176310
|
+
* @remarks
|
|
176311
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176312
|
+
* @beta
|
|
176313
|
+
*/
|
|
176314
|
+
mixed = "Mixed",
|
|
176315
|
+
/**
|
|
176316
|
+
* Specifies no theme color.
|
|
176317
|
+
* @remarks
|
|
176318
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176319
|
+
* @beta
|
|
176320
|
+
*/
|
|
176321
|
+
none = "None",
|
|
176322
|
+
/**
|
|
176323
|
+
* Specifies the Accent 1 theme color.
|
|
176324
|
+
* @remarks
|
|
176325
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176326
|
+
* @beta
|
|
176327
|
+
*/
|
|
176328
|
+
accent1 = "Accent1",
|
|
176329
|
+
/**
|
|
176330
|
+
* Specifies the Accent 2 theme color.
|
|
176331
|
+
* @remarks
|
|
176332
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176333
|
+
* @beta
|
|
176334
|
+
*/
|
|
176335
|
+
accent2 = "Accent2",
|
|
176336
|
+
/**
|
|
176337
|
+
* Specifies the Accent 3 theme color.
|
|
176338
|
+
* @remarks
|
|
176339
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176340
|
+
* @beta
|
|
176341
|
+
*/
|
|
176342
|
+
accent3 = "Accent3",
|
|
176343
|
+
/**
|
|
176344
|
+
* Specifies the Accent 4 theme color.
|
|
176345
|
+
* @remarks
|
|
176346
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176347
|
+
* @beta
|
|
176348
|
+
*/
|
|
176349
|
+
accent4 = "Accent4",
|
|
176350
|
+
/**
|
|
176351
|
+
* Specifies the Accent 5 theme color.
|
|
176352
|
+
* @remarks
|
|
176353
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176354
|
+
* @beta
|
|
176355
|
+
*/
|
|
176356
|
+
accent5 = "Accent5",
|
|
176357
|
+
/**
|
|
176358
|
+
* Specifies the Accent 6 theme color.
|
|
176359
|
+
* @remarks
|
|
176360
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176361
|
+
* @beta
|
|
176362
|
+
*/
|
|
176363
|
+
accent6 = "Accent6",
|
|
176364
|
+
/**
|
|
176365
|
+
* Specifies the Dark 1 theme color.
|
|
176366
|
+
* @remarks
|
|
176367
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176368
|
+
* @beta
|
|
176369
|
+
*/
|
|
176370
|
+
dark1 = "Dark1",
|
|
176371
|
+
/**
|
|
176372
|
+
* Specifies the Dark 2 theme color.
|
|
176373
|
+
* @remarks
|
|
176374
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176375
|
+
* @beta
|
|
176376
|
+
*/
|
|
176377
|
+
dark2 = "Dark2",
|
|
176378
|
+
/**
|
|
176379
|
+
* Specifies the clicked hyperlink theme color.
|
|
176380
|
+
* @remarks
|
|
176381
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176382
|
+
* @beta
|
|
176383
|
+
*/
|
|
176384
|
+
followedHyperlink = "FollowedHyperlink",
|
|
176385
|
+
/**
|
|
176386
|
+
* Specifies the hyperlink theme color.
|
|
176387
|
+
* @remarks
|
|
176388
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176389
|
+
* @beta
|
|
176390
|
+
*/
|
|
176391
|
+
hyperlink = "Hyperlink",
|
|
176392
|
+
/**
|
|
176393
|
+
* Specifies the Light 1 theme color.
|
|
176394
|
+
* @remarks
|
|
176395
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176396
|
+
* @beta
|
|
176397
|
+
*/
|
|
176398
|
+
light1 = "Light1",
|
|
176399
|
+
/**
|
|
176400
|
+
* Specifies the Light 2 theme color.
|
|
176401
|
+
* @remarks
|
|
176402
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176403
|
+
* @beta
|
|
176404
|
+
*/
|
|
176405
|
+
light2 = "Light2",
|
|
176406
|
+
}
|
|
176407
|
+
/**
|
|
176408
|
+
* Represents a theme color scheme.
|
|
176409
|
+
*
|
|
176410
|
+
* @remarks
|
|
176411
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176412
|
+
* @beta
|
|
176413
|
+
*/
|
|
176414
|
+
class ThemeColorScheme extends OfficeExtension.ClientObject {
|
|
176415
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
176416
|
+
context: RequestContext;
|
|
176417
|
+
/**
|
|
176418
|
+
* Gets the color value for the specified `ThemeColor`.
|
|
176419
|
+
*
|
|
176420
|
+
* @remarks
|
|
176421
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176422
|
+
* @beta
|
|
176423
|
+
*
|
|
176424
|
+
* @param color The theme color.
|
|
176425
|
+
* @returns The color value in #RRGGBB format (e.g., "FFA500").
|
|
176426
|
+
*/
|
|
176427
|
+
getThemeColor(color: PowerPoint.ThemeColor): OfficeExtension.ClientResult<string>;
|
|
176428
|
+
/**
|
|
176429
|
+
* Gets the color value for the specified `ThemeColor`.
|
|
176430
|
+
*
|
|
176431
|
+
* @remarks
|
|
176432
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176433
|
+
* @beta
|
|
176434
|
+
*
|
|
176435
|
+
* @param color The theme color.
|
|
176436
|
+
* @returns The color value in #RRGGBB format (e.g., "FFA500").
|
|
176437
|
+
*/
|
|
176438
|
+
getThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2"): OfficeExtension.ClientResult<string>;
|
|
176439
|
+
/**
|
|
176440
|
+
* Sets the color value for the specified `ThemeColor`.
|
|
176441
|
+
*
|
|
176442
|
+
* @remarks
|
|
176443
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176444
|
+
* @beta
|
|
176445
|
+
*
|
|
176446
|
+
* @param color The theme color.
|
|
176447
|
+
* @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
176448
|
+
*/
|
|
176449
|
+
setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string): void;
|
|
176450
|
+
/**
|
|
176451
|
+
* Sets the color value for the specified `ThemeColor`.
|
|
176452
|
+
*
|
|
176453
|
+
* @remarks
|
|
176454
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176455
|
+
* @beta
|
|
176456
|
+
*
|
|
176457
|
+
* @param color The theme color.
|
|
176458
|
+
* @param rgbColor The color value in #RRGGBB format (e.g., "FFA500") or as a named HTML color (e.g., "orange").
|
|
176459
|
+
*/
|
|
176460
|
+
setThemeColor(color: "Mixed" | "None" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Dark1" | "Dark2" | "FollowedHyperlink" | "Hyperlink" | "Light1" | "Light2", rgbColor: string): void;
|
|
176461
|
+
/**
|
|
176462
|
+
* 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.)
|
|
176463
|
+
* Whereas the original `PowerPoint.ThemeColorScheme` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.ThemeColorSchemeData`) that contains shallow copies of any loaded child properties from the original object.
|
|
176464
|
+
*/
|
|
176465
|
+
toJSON(): {
|
|
176466
|
+
[key: string]: string;
|
|
176467
|
+
};
|
|
176468
|
+
}
|
|
175282
176469
|
/**
|
|
175283
176470
|
* Represents the layout of a slide.
|
|
175284
176471
|
*
|
|
@@ -175288,6 +176475,14 @@ declare namespace PowerPoint {
|
|
|
175288
176475
|
class SlideLayout extends OfficeExtension.ClientObject {
|
|
175289
176476
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175290
176477
|
context: RequestContext;
|
|
176478
|
+
/**
|
|
176479
|
+
* Gets the background of the slide layout.
|
|
176480
|
+
*
|
|
176481
|
+
* @remarks
|
|
176482
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176483
|
+
* @beta
|
|
176484
|
+
*/
|
|
176485
|
+
readonly background: PowerPoint.SlideLayoutBackground;
|
|
175291
176486
|
/**
|
|
175292
176487
|
* Returns a collection of custom XML parts in the slide layout.
|
|
175293
176488
|
*
|
|
@@ -175302,6 +176497,14 @@ declare namespace PowerPoint {
|
|
|
175302
176497
|
* [Api set: PowerPointApi 1.3]
|
|
175303
176498
|
*/
|
|
175304
176499
|
readonly shapes: PowerPoint.ShapeCollection;
|
|
176500
|
+
/**
|
|
176501
|
+
* Returns the `ThemeColorScheme` of the slide layout.
|
|
176502
|
+
*
|
|
176503
|
+
* @remarks
|
|
176504
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176505
|
+
* @beta
|
|
176506
|
+
*/
|
|
176507
|
+
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
|
|
175305
176508
|
/**
|
|
175306
176509
|
* Gets the unique ID of the slide layout.
|
|
175307
176510
|
*
|
|
@@ -175424,6 +176627,51 @@ declare namespace PowerPoint {
|
|
|
175424
176627
|
*/
|
|
175425
176628
|
toJSON(): PowerPoint.Interfaces.SlideLayoutCollectionData;
|
|
175426
176629
|
}
|
|
176630
|
+
/**
|
|
176631
|
+
* Represents the background of a slide master.
|
|
176632
|
+
*
|
|
176633
|
+
* @remarks
|
|
176634
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176635
|
+
* @beta
|
|
176636
|
+
*/
|
|
176637
|
+
class SlideMasterBackground extends OfficeExtension.ClientObject {
|
|
176638
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
176639
|
+
context: RequestContext;
|
|
176640
|
+
/**
|
|
176641
|
+
* Returns the fill formatting of the background.
|
|
176642
|
+
*
|
|
176643
|
+
* @remarks
|
|
176644
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176645
|
+
* @beta
|
|
176646
|
+
*/
|
|
176647
|
+
readonly fill: PowerPoint.SlideBackgroundFill;
|
|
176648
|
+
/**
|
|
176649
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
176650
|
+
*
|
|
176651
|
+
* @param options Provides options for which properties of the object to load.
|
|
176652
|
+
*/
|
|
176653
|
+
load(options?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions): PowerPoint.SlideMasterBackground;
|
|
176654
|
+
/**
|
|
176655
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
176656
|
+
*
|
|
176657
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
176658
|
+
*/
|
|
176659
|
+
load(propertyNames?: string | string[]): PowerPoint.SlideMasterBackground;
|
|
176660
|
+
/**
|
|
176661
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
176662
|
+
*
|
|
176663
|
+
* @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.
|
|
176664
|
+
*/
|
|
176665
|
+
load(propertyNamesAndPaths?: {
|
|
176666
|
+
select?: string;
|
|
176667
|
+
expand?: string;
|
|
176668
|
+
}): PowerPoint.SlideMasterBackground;
|
|
176669
|
+
/**
|
|
176670
|
+
* 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.)
|
|
176671
|
+
* Whereas the original `PowerPoint.SlideMasterBackground` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SlideMasterBackgroundData`) that contains shallow copies of any loaded child properties from the original object.
|
|
176672
|
+
*/
|
|
176673
|
+
toJSON(): PowerPoint.Interfaces.SlideMasterBackgroundData;
|
|
176674
|
+
}
|
|
175427
176675
|
/**
|
|
175428
176676
|
* Represents the Slide Master of a slide.
|
|
175429
176677
|
*
|
|
@@ -175433,6 +176681,14 @@ declare namespace PowerPoint {
|
|
|
175433
176681
|
class SlideMaster extends OfficeExtension.ClientObject {
|
|
175434
176682
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175435
176683
|
context: RequestContext;
|
|
176684
|
+
/**
|
|
176685
|
+
* Gets the background of the Slide Master.
|
|
176686
|
+
*
|
|
176687
|
+
* @remarks
|
|
176688
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176689
|
+
* @beta
|
|
176690
|
+
*/
|
|
176691
|
+
readonly background: PowerPoint.SlideMasterBackground;
|
|
175436
176692
|
/**
|
|
175437
176693
|
* Returns a collection of custom XML parts in the Slide Master.
|
|
175438
176694
|
*
|
|
@@ -175454,6 +176710,14 @@ declare namespace PowerPoint {
|
|
|
175454
176710
|
* [Api set: PowerPointApi 1.3]
|
|
175455
176711
|
*/
|
|
175456
176712
|
readonly shapes: PowerPoint.ShapeCollection;
|
|
176713
|
+
/**
|
|
176714
|
+
* Returns the `ThemeColorScheme` of the Slide Master.
|
|
176715
|
+
*
|
|
176716
|
+
* @remarks
|
|
176717
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176718
|
+
* @beta
|
|
176719
|
+
*/
|
|
176720
|
+
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
|
|
175457
176721
|
/**
|
|
175458
176722
|
* Gets the unique ID of the Slide Master.
|
|
175459
176723
|
*
|
|
@@ -175646,6 +176910,14 @@ declare namespace PowerPoint {
|
|
|
175646
176910
|
class Slide extends OfficeExtension.ClientObject {
|
|
175647
176911
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
175648
176912
|
context: RequestContext;
|
|
176913
|
+
/**
|
|
176914
|
+
* Gets the background of the slide.
|
|
176915
|
+
*
|
|
176916
|
+
* @remarks
|
|
176917
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176918
|
+
* @beta
|
|
176919
|
+
*/
|
|
176920
|
+
readonly background: PowerPoint.SlideBackground;
|
|
175649
176921
|
/**
|
|
175650
176922
|
* Returns a collection of custom XML parts in the slide.
|
|
175651
176923
|
*
|
|
@@ -175688,6 +176960,14 @@ declare namespace PowerPoint {
|
|
|
175688
176960
|
* [Api set: PowerPointApi 1.3]
|
|
175689
176961
|
*/
|
|
175690
176962
|
readonly tags: PowerPoint.TagCollection;
|
|
176963
|
+
/**
|
|
176964
|
+
* Returns the `ThemeColorScheme` of the slide.
|
|
176965
|
+
*
|
|
176966
|
+
* @remarks
|
|
176967
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
176968
|
+
* @beta
|
|
176969
|
+
*/
|
|
176970
|
+
readonly themeColorScheme: PowerPoint.ThemeColorScheme;
|
|
175691
176971
|
/**
|
|
175692
176972
|
* Gets the unique ID of the slide.
|
|
175693
176973
|
*
|
|
@@ -175784,6 +177064,60 @@ declare namespace PowerPoint {
|
|
|
175784
177064
|
*/
|
|
175785
177065
|
toJSON(): PowerPoint.Interfaces.SlideData;
|
|
175786
177066
|
}
|
|
177067
|
+
/**
|
|
177068
|
+
* Represents the format of an image.
|
|
177069
|
+
*
|
|
177070
|
+
* @remarks
|
|
177071
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177072
|
+
* @beta
|
|
177073
|
+
*/
|
|
177074
|
+
enum ShapeGetImageFormatType {
|
|
177075
|
+
/**
|
|
177076
|
+
* The picture is in PNG format.
|
|
177077
|
+
* @remarks
|
|
177078
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177079
|
+
* @beta
|
|
177080
|
+
*/
|
|
177081
|
+
png = "Png",
|
|
177082
|
+
}
|
|
177083
|
+
/**
|
|
177084
|
+
* Represents the available options when getting an image of a shape.
|
|
177085
|
+
The image is scaled to fit into the desired dimensions. If width and height aren't specified, the true size of the shape is used.
|
|
177086
|
+
If only one of either width or height is specified, the other will be calculated to preserve aspect ratio.
|
|
177087
|
+
The resulting dimensions will automatically be clamped to the maximum supported size if too large.
|
|
177088
|
+
*
|
|
177089
|
+
* @remarks
|
|
177090
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177091
|
+
* @beta
|
|
177092
|
+
*/
|
|
177093
|
+
interface ShapeGetImageOptions {
|
|
177094
|
+
/**
|
|
177095
|
+
* The desired format of the resulting image.
|
|
177096
|
+
*
|
|
177097
|
+
* @remarks
|
|
177098
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177099
|
+
* @beta
|
|
177100
|
+
*/
|
|
177101
|
+
format?: PowerPoint.ShapeGetImageFormatType | "Png";
|
|
177102
|
+
/**
|
|
177103
|
+
* The desired height of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large.
|
|
177104
|
+
Throws an `InvalidArgument` exception when set with a non-positive integer.
|
|
177105
|
+
*
|
|
177106
|
+
* @remarks
|
|
177107
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177108
|
+
* @beta
|
|
177109
|
+
*/
|
|
177110
|
+
height?: number;
|
|
177111
|
+
/**
|
|
177112
|
+
* The desired width of the resulting image in pixels. This value will automatically be clamped to the maximum supported size if too large.
|
|
177113
|
+
Throws an `InvalidArgument` exception when set with a non-positive integer.
|
|
177114
|
+
*
|
|
177115
|
+
* @remarks
|
|
177116
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177117
|
+
* @beta
|
|
177118
|
+
*/
|
|
177119
|
+
width?: number;
|
|
177120
|
+
}
|
|
175787
177121
|
/**
|
|
175788
177122
|
* Represents a collection of shapes.
|
|
175789
177123
|
*
|
|
@@ -176078,6 +177412,346 @@ declare namespace PowerPoint {
|
|
|
176078
177412
|
*/
|
|
176079
177413
|
autoSizeMixed = "AutoSizeMixed",
|
|
176080
177414
|
}
|
|
177415
|
+
/**
|
|
177416
|
+
* Specifies the style of a bullet.
|
|
177417
|
+
*
|
|
177418
|
+
* @remarks
|
|
177419
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177420
|
+
* @beta
|
|
177421
|
+
*/
|
|
177422
|
+
enum BulletStyle {
|
|
177423
|
+
/**
|
|
177424
|
+
* Style is unsupported.
|
|
177425
|
+
* @remarks
|
|
177426
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177427
|
+
* @beta
|
|
177428
|
+
*/
|
|
177429
|
+
unsupported = "Unsupported",
|
|
177430
|
+
/**
|
|
177431
|
+
* Lowercase alphabetical characters with a period.
|
|
177432
|
+
* @remarks
|
|
177433
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177434
|
+
* @beta
|
|
177435
|
+
*/
|
|
177436
|
+
alphabetLowercasePeriod = "AlphabetLowercasePeriod",
|
|
177437
|
+
/**
|
|
177438
|
+
* Uppercase alphabetical characters with a period.
|
|
177439
|
+
* @remarks
|
|
177440
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177441
|
+
* @beta
|
|
177442
|
+
*/
|
|
177443
|
+
alphabetUppercasePeriod = "AlphabetUppercasePeriod",
|
|
177444
|
+
/**
|
|
177445
|
+
* Arabic numerals with closing parenthesis.
|
|
177446
|
+
* @remarks
|
|
177447
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177448
|
+
* @beta
|
|
177449
|
+
*/
|
|
177450
|
+
arabicNumeralParenthesisRight = "ArabicNumeralParenthesisRight",
|
|
177451
|
+
/**
|
|
177452
|
+
* Arabic numerals with a period.
|
|
177453
|
+
* @remarks
|
|
177454
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177455
|
+
* @beta
|
|
177456
|
+
*/
|
|
177457
|
+
arabicNumeralPeriod = "ArabicNumeralPeriod",
|
|
177458
|
+
/**
|
|
177459
|
+
* Lowercase Roman numerals with both parentheses.
|
|
177460
|
+
* @remarks
|
|
177461
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177462
|
+
* @beta
|
|
177463
|
+
*/
|
|
177464
|
+
romanLowercaseParenthesesBoth = "RomanLowercaseParenthesesBoth",
|
|
177465
|
+
/**
|
|
177466
|
+
* Lowercase Roman numerals with closing parenthesis.
|
|
177467
|
+
* @remarks
|
|
177468
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177469
|
+
* @beta
|
|
177470
|
+
*/
|
|
177471
|
+
romanLowercaseParenthesisRight = "RomanLowercaseParenthesisRight",
|
|
177472
|
+
/**
|
|
177473
|
+
* Lowercase Roman numerals with period.
|
|
177474
|
+
* @remarks
|
|
177475
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177476
|
+
* @beta
|
|
177477
|
+
*/
|
|
177478
|
+
romanLowercasePeriod = "RomanLowercasePeriod",
|
|
177479
|
+
/**
|
|
177480
|
+
* Uppercase Roman numerals with period.
|
|
177481
|
+
* @remarks
|
|
177482
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177483
|
+
* @beta
|
|
177484
|
+
*/
|
|
177485
|
+
romanUppercasePeriod = "RomanUppercasePeriod",
|
|
177486
|
+
/**
|
|
177487
|
+
* Lowercase alphabetical characters with both parentheses.
|
|
177488
|
+
* @remarks
|
|
177489
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177490
|
+
* @beta
|
|
177491
|
+
*/
|
|
177492
|
+
alphabetLowercaseParenthesesBoth = "AlphabetLowercaseParenthesesBoth",
|
|
177493
|
+
/**
|
|
177494
|
+
* Lowercase alphabetical characters with closing parenthesis.
|
|
177495
|
+
* @remarks
|
|
177496
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177497
|
+
* @beta
|
|
177498
|
+
*/
|
|
177499
|
+
alphabetLowercaseParenthesisRight = "AlphabetLowercaseParenthesisRight",
|
|
177500
|
+
/**
|
|
177501
|
+
* Uppercase alphabetical characters with both parentheses.
|
|
177502
|
+
* @remarks
|
|
177503
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177504
|
+
* @beta
|
|
177505
|
+
*/
|
|
177506
|
+
alphabetUppercaseParenthesesBoth = "AlphabetUppercaseParenthesesBoth",
|
|
177507
|
+
/**
|
|
177508
|
+
* Uppercase alphabetical characters with closing parenthesis.
|
|
177509
|
+
* @remarks
|
|
177510
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177511
|
+
* @beta
|
|
177512
|
+
*/
|
|
177513
|
+
alphabetUppercaseParenthesisRight = "AlphabetUppercaseParenthesisRight",
|
|
177514
|
+
/**
|
|
177515
|
+
* Arabic numerals with both parentheses.
|
|
177516
|
+
* @remarks
|
|
177517
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177518
|
+
* @beta
|
|
177519
|
+
*/
|
|
177520
|
+
arabicNumeralParenthesesBoth = "ArabicNumeralParenthesesBoth",
|
|
177521
|
+
/**
|
|
177522
|
+
* Arabic numerals.
|
|
177523
|
+
* @remarks
|
|
177524
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177525
|
+
* @beta
|
|
177526
|
+
*/
|
|
177527
|
+
arabicNumeralPlain = "ArabicNumeralPlain",
|
|
177528
|
+
/**
|
|
177529
|
+
* Uppercase Roman numerals with both parentheses.
|
|
177530
|
+
* @remarks
|
|
177531
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177532
|
+
* @beta
|
|
177533
|
+
*/
|
|
177534
|
+
romanUppercaseParenthesesBoth = "RomanUppercaseParenthesesBoth",
|
|
177535
|
+
/**
|
|
177536
|
+
* Uppercase Roman numerals with closing parenthesis.
|
|
177537
|
+
* @remarks
|
|
177538
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177539
|
+
* @beta
|
|
177540
|
+
*/
|
|
177541
|
+
romanUppercaseParenthesisRight = "RomanUppercaseParenthesisRight",
|
|
177542
|
+
/**
|
|
177543
|
+
* Simplified Chinese without a period.
|
|
177544
|
+
* @remarks
|
|
177545
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177546
|
+
* @beta
|
|
177547
|
+
*/
|
|
177548
|
+
simplifiedChinesePlain = "SimplifiedChinesePlain",
|
|
177549
|
+
/**
|
|
177550
|
+
* Simplified Chinese with a period.
|
|
177551
|
+
* @remarks
|
|
177552
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177553
|
+
* @beta
|
|
177554
|
+
*/
|
|
177555
|
+
simplifiedChinesePeriod = "SimplifiedChinesePeriod",
|
|
177556
|
+
/**
|
|
177557
|
+
* Double-byte circled number for values up to 10.
|
|
177558
|
+
* @remarks
|
|
177559
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177560
|
+
* @beta
|
|
177561
|
+
*/
|
|
177562
|
+
circleNumberDoubleBytePlain = "CircleNumberDoubleBytePlain",
|
|
177563
|
+
/**
|
|
177564
|
+
* Text colored number with same color circle drawn around it.
|
|
177565
|
+
* @remarks
|
|
177566
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177567
|
+
* @beta
|
|
177568
|
+
*/
|
|
177569
|
+
circleNumberWideDoubleByteWhitePlain = "CircleNumberWideDoubleByteWhitePlain",
|
|
177570
|
+
/**
|
|
177571
|
+
* Shadow color number with circular background of normal text color.
|
|
177572
|
+
* @remarks
|
|
177573
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177574
|
+
* @beta
|
|
177575
|
+
*/
|
|
177576
|
+
circleNumberWideDoubleByteBlackPlain = "CircleNumberWideDoubleByteBlackPlain",
|
|
177577
|
+
/**
|
|
177578
|
+
* Traditional Chinese without a period.
|
|
177579
|
+
* @remarks
|
|
177580
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177581
|
+
* @beta
|
|
177582
|
+
*/
|
|
177583
|
+
traditionalChinesePlain = "TraditionalChinesePlain",
|
|
177584
|
+
/**
|
|
177585
|
+
* Traditional Chinese with a period.
|
|
177586
|
+
* @remarks
|
|
177587
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177588
|
+
* @beta
|
|
177589
|
+
*/
|
|
177590
|
+
traditionalChinesePeriod = "TraditionalChinesePeriod",
|
|
177591
|
+
/**
|
|
177592
|
+
* Arabic alphabet with a dash.
|
|
177593
|
+
* @remarks
|
|
177594
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177595
|
+
* @beta
|
|
177596
|
+
*/
|
|
177597
|
+
arabicAlphabetDash = "ArabicAlphabetDash",
|
|
177598
|
+
/**
|
|
177599
|
+
* Arabic Abjad alphabet with a dash.
|
|
177600
|
+
* @remarks
|
|
177601
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177602
|
+
* @beta
|
|
177603
|
+
*/
|
|
177604
|
+
arabicAbjadDash = "ArabicAbjadDash",
|
|
177605
|
+
/**
|
|
177606
|
+
* Hebrew alphabet with a dash.
|
|
177607
|
+
* @remarks
|
|
177608
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177609
|
+
* @beta
|
|
177610
|
+
*/
|
|
177611
|
+
hebrewAlphabetDash = "HebrewAlphabetDash",
|
|
177612
|
+
/**
|
|
177613
|
+
* Japanese/Korean numbers without a period.
|
|
177614
|
+
* @remarks
|
|
177615
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177616
|
+
* @beta
|
|
177617
|
+
*/
|
|
177618
|
+
kanjiKoreanPlain = "KanjiKoreanPlain",
|
|
177619
|
+
/**
|
|
177620
|
+
* Japanese/Korean numbers with a period.
|
|
177621
|
+
* @remarks
|
|
177622
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177623
|
+
* @beta
|
|
177624
|
+
*/
|
|
177625
|
+
kanjiKoreanPeriod = "KanjiKoreanPeriod",
|
|
177626
|
+
/**
|
|
177627
|
+
* Double-byte Arabic numbering scheme (no punctuation).
|
|
177628
|
+
* @remarks
|
|
177629
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177630
|
+
* @beta
|
|
177631
|
+
*/
|
|
177632
|
+
arabicDoubleBytePlain = "ArabicDoubleBytePlain",
|
|
177633
|
+
/**
|
|
177634
|
+
* Double-byte Arabic numbering scheme with double-byte period.
|
|
177635
|
+
* @remarks
|
|
177636
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177637
|
+
* @beta
|
|
177638
|
+
*/
|
|
177639
|
+
arabicDoubleBytePeriod = "ArabicDoubleBytePeriod",
|
|
177640
|
+
/**
|
|
177641
|
+
* Thai alphabet with a period.
|
|
177642
|
+
* @remarks
|
|
177643
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177644
|
+
* @beta
|
|
177645
|
+
*/
|
|
177646
|
+
thaiAlphabetPeriod = "ThaiAlphabetPeriod",
|
|
177647
|
+
/**
|
|
177648
|
+
* Thai alphabet with closing parenthesis.
|
|
177649
|
+
* @remarks
|
|
177650
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177651
|
+
* @beta
|
|
177652
|
+
*/
|
|
177653
|
+
thaiAlphabetParenthesisRight = "ThaiAlphabetParenthesisRight",
|
|
177654
|
+
/**
|
|
177655
|
+
* Thai alphabet with both parentheses.
|
|
177656
|
+
* @remarks
|
|
177657
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177658
|
+
* @beta
|
|
177659
|
+
*/
|
|
177660
|
+
thaiAlphabetParenthesesBoth = "ThaiAlphabetParenthesesBoth",
|
|
177661
|
+
/**
|
|
177662
|
+
* Thai numerals with a period.
|
|
177663
|
+
* @remarks
|
|
177664
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177665
|
+
* @beta
|
|
177666
|
+
*/
|
|
177667
|
+
thaiNumeralPeriod = "ThaiNumeralPeriod",
|
|
177668
|
+
/**
|
|
177669
|
+
* Thai numerals with closing parenthesis.
|
|
177670
|
+
* @remarks
|
|
177671
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177672
|
+
* @beta
|
|
177673
|
+
*/
|
|
177674
|
+
thaiNumeralParenthesisRight = "ThaiNumeralParenthesisRight",
|
|
177675
|
+
/**
|
|
177676
|
+
* Thai numerals with both parentheses.
|
|
177677
|
+
* @remarks
|
|
177678
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177679
|
+
* @beta
|
|
177680
|
+
*/
|
|
177681
|
+
thaiNumeralParenthesesBoth = "ThaiNumeralParenthesesBoth",
|
|
177682
|
+
/**
|
|
177683
|
+
* Hindi alphabet (vowels) with a period.
|
|
177684
|
+
* @remarks
|
|
177685
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177686
|
+
* @beta
|
|
177687
|
+
*/
|
|
177688
|
+
hindiAlphabetPeriod = "HindiAlphabetPeriod",
|
|
177689
|
+
/**
|
|
177690
|
+
* Hindi numerals with a period.
|
|
177691
|
+
* @remarks
|
|
177692
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177693
|
+
* @beta
|
|
177694
|
+
*/
|
|
177695
|
+
hindiNumeralPeriod = "HindiNumeralPeriod",
|
|
177696
|
+
/**
|
|
177697
|
+
* Kanji Simplified Chinese with double-byte period.
|
|
177698
|
+
* @remarks
|
|
177699
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177700
|
+
* @beta
|
|
177701
|
+
*/
|
|
177702
|
+
kanjiSimplifiedChineseDoubleBytePeriod = "KanjiSimplifiedChineseDoubleBytePeriod",
|
|
177703
|
+
/**
|
|
177704
|
+
* Hindi numerals with closing parenthesis.
|
|
177705
|
+
* @remarks
|
|
177706
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177707
|
+
* @beta
|
|
177708
|
+
*/
|
|
177709
|
+
hindiNumeralParenthesisRight = "HindiNumeralParenthesisRight",
|
|
177710
|
+
/**
|
|
177711
|
+
* Hindi alphabet (consonants) with a period.
|
|
177712
|
+
* @remarks
|
|
177713
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177714
|
+
* @beta
|
|
177715
|
+
*/
|
|
177716
|
+
hindiAlphabet1Period = "HindiAlphabet1Period",
|
|
177717
|
+
}
|
|
177718
|
+
/**
|
|
177719
|
+
* Specifies the type of a bullet.
|
|
177720
|
+
*
|
|
177721
|
+
* @remarks
|
|
177722
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177723
|
+
* @beta
|
|
177724
|
+
*/
|
|
177725
|
+
enum BulletType {
|
|
177726
|
+
/**
|
|
177727
|
+
* Type is unsupported.
|
|
177728
|
+
* @remarks
|
|
177729
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177730
|
+
* @beta
|
|
177731
|
+
*/
|
|
177732
|
+
unsupported = "Unsupported",
|
|
177733
|
+
/**
|
|
177734
|
+
* No bullets.
|
|
177735
|
+
* @remarks
|
|
177736
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177737
|
+
* @beta
|
|
177738
|
+
*/
|
|
177739
|
+
none = "None",
|
|
177740
|
+
/**
|
|
177741
|
+
* Numbered bullet (e.g., 1, 2, 3 or a, b, c).
|
|
177742
|
+
* @remarks
|
|
177743
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177744
|
+
* @beta
|
|
177745
|
+
*/
|
|
177746
|
+
numbered = "Numbered",
|
|
177747
|
+
/**
|
|
177748
|
+
* Symbol-based bullet (e.g., disc, circle, square).
|
|
177749
|
+
* @remarks
|
|
177750
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177751
|
+
* @beta
|
|
177752
|
+
*/
|
|
177753
|
+
unnumbered = "Unnumbered",
|
|
177754
|
+
}
|
|
176081
177755
|
/**
|
|
176082
177756
|
* Represents the bullet formatting properties of a text that is attached to the {@link PowerPoint.ParagraphFormat}.
|
|
176083
177757
|
*
|
|
@@ -176087,6 +177761,24 @@ declare namespace PowerPoint {
|
|
|
176087
177761
|
class BulletFormat extends OfficeExtension.ClientObject {
|
|
176088
177762
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
176089
177763
|
context: RequestContext;
|
|
177764
|
+
/**
|
|
177765
|
+
* Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
|
|
177766
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
177767
|
+
*
|
|
177768
|
+
* @remarks
|
|
177769
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177770
|
+
* @beta
|
|
177771
|
+
*/
|
|
177772
|
+
style: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
|
|
177773
|
+
/**
|
|
177774
|
+
* Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
|
|
177775
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
177776
|
+
*
|
|
177777
|
+
* @remarks
|
|
177778
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177779
|
+
* @beta
|
|
177780
|
+
*/
|
|
177781
|
+
type: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
|
|
176090
177782
|
/**
|
|
176091
177783
|
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
|
|
176092
177784
|
*
|
|
@@ -176144,6 +177836,14 @@ declare namespace PowerPoint {
|
|
|
176144
177836
|
* [Api set: PowerPointApi 1.4]
|
|
176145
177837
|
*/
|
|
176146
177838
|
horizontalAlignment: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
|
|
177839
|
+
/**
|
|
177840
|
+
* Represents the indent level of the paragraph.
|
|
177841
|
+
*
|
|
177842
|
+
* @remarks
|
|
177843
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
177844
|
+
* @beta
|
|
177845
|
+
*/
|
|
177846
|
+
indentLevel: number;
|
|
176147
177847
|
/**
|
|
176148
177848
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
176149
177849
|
*
|
|
@@ -176522,6 +178222,15 @@ declare namespace PowerPoint {
|
|
|
176522
178222
|
* [Api set: PowerPointApi 1.4]
|
|
176523
178223
|
*/
|
|
176524
178224
|
name: string;
|
|
178225
|
+
/**
|
|
178226
|
+
* Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
178227
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
178228
|
+
*
|
|
178229
|
+
* @remarks
|
|
178230
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
178231
|
+
* @beta
|
|
178232
|
+
*/
|
|
178233
|
+
rotation: number;
|
|
176525
178234
|
/**
|
|
176526
178235
|
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
176527
178236
|
*
|
|
@@ -176536,6 +178245,14 @@ declare namespace PowerPoint {
|
|
|
176536
178245
|
* [Api set: PowerPointApi 1.4]
|
|
176537
178246
|
*/
|
|
176538
178247
|
readonly type: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
|
|
178248
|
+
/**
|
|
178249
|
+
* Specifies if the shape is visible.
|
|
178250
|
+
*
|
|
178251
|
+
* @remarks
|
|
178252
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
178253
|
+
* @beta
|
|
178254
|
+
*/
|
|
178255
|
+
visible: boolean;
|
|
176539
178256
|
/**
|
|
176540
178257
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
176541
178258
|
*
|
|
@@ -176558,6 +178275,17 @@ declare namespace PowerPoint {
|
|
|
176558
178275
|
* [Api set: PowerPointApi 1.3]
|
|
176559
178276
|
*/
|
|
176560
178277
|
delete(): void;
|
|
178278
|
+
/**
|
|
178279
|
+
* Renders an image of the shape.
|
|
178280
|
+
*
|
|
178281
|
+
* @remarks
|
|
178282
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
178283
|
+
* @beta
|
|
178284
|
+
*
|
|
178285
|
+
* @param options Optional. Options to specify the desired output image properties.
|
|
178286
|
+
* @returns A Base64-encoded string of the shape image in the specified format.
|
|
178287
|
+
*/
|
|
178288
|
+
getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions): OfficeExtension.ClientResult<string>;
|
|
176561
178289
|
/**
|
|
176562
178290
|
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
|
|
176563
178291
|
*
|
|
@@ -176607,6 +178335,15 @@ declare namespace PowerPoint {
|
|
|
176607
178335
|
* [Api set: PowerPointApi 1.8]
|
|
176608
178336
|
*/
|
|
176609
178337
|
getTable(): PowerPoint.Table;
|
|
178338
|
+
/**
|
|
178339
|
+
* Returns the {@link PowerPoint.TextFrame} object of this `Shape`. If the shape doesn't support a `TextFrame`, an object with an `isNullObject` property set to `true` is returned.
|
|
178340
|
+
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}.
|
|
178341
|
+
*
|
|
178342
|
+
* @remarks
|
|
178343
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
178344
|
+
* @beta
|
|
178345
|
+
*/
|
|
178346
|
+
getTextFrameOrNullObject(): PowerPoint.TextFrame;
|
|
176610
178347
|
/**
|
|
176611
178348
|
* Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.
|
|
176612
178349
|
*
|
|
@@ -177186,6 +178923,59 @@ declare namespace PowerPoint {
|
|
|
177186
178923
|
*/
|
|
177187
178924
|
targetSlideId?: string;
|
|
177188
178925
|
}
|
|
178926
|
+
/**
|
|
178927
|
+
* Represents the page setup information for the presentation.
|
|
178928
|
+
*
|
|
178929
|
+
* @remarks
|
|
178930
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
178931
|
+
* @beta
|
|
178932
|
+
*/
|
|
178933
|
+
class PageSetup extends OfficeExtension.ClientObject {
|
|
178934
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
178935
|
+
context: RequestContext;
|
|
178936
|
+
/**
|
|
178937
|
+
* Specifies the height of the slides in the presentation, in points.
|
|
178938
|
+
*
|
|
178939
|
+
* @remarks
|
|
178940
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
178941
|
+
* @beta
|
|
178942
|
+
*/
|
|
178943
|
+
slideHeight: number;
|
|
178944
|
+
/**
|
|
178945
|
+
* Specifies the width of the slides in the presentation, in points.
|
|
178946
|
+
*
|
|
178947
|
+
* @remarks
|
|
178948
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
178949
|
+
* @beta
|
|
178950
|
+
*/
|
|
178951
|
+
slideWidth: number;
|
|
178952
|
+
/**
|
|
178953
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178954
|
+
*
|
|
178955
|
+
* @param options Provides options for which properties of the object to load.
|
|
178956
|
+
*/
|
|
178957
|
+
load(options?: PowerPoint.Interfaces.PageSetupLoadOptions): PowerPoint.PageSetup;
|
|
178958
|
+
/**
|
|
178959
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178960
|
+
*
|
|
178961
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
178962
|
+
*/
|
|
178963
|
+
load(propertyNames?: string | string[]): PowerPoint.PageSetup;
|
|
178964
|
+
/**
|
|
178965
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
178966
|
+
*
|
|
178967
|
+
* @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.
|
|
178968
|
+
*/
|
|
178969
|
+
load(propertyNamesAndPaths?: {
|
|
178970
|
+
select?: string;
|
|
178971
|
+
expand?: string;
|
|
178972
|
+
}): PowerPoint.PageSetup;
|
|
178973
|
+
/**
|
|
178974
|
+
* 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.)
|
|
178975
|
+
* Whereas the original `PowerPoint.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object.
|
|
178976
|
+
*/
|
|
178977
|
+
toJSON(): PowerPoint.Interfaces.PageSetupData;
|
|
178978
|
+
}
|
|
177189
178979
|
/**
|
|
177190
178980
|
* Represents the collection of slides in the presentation.
|
|
177191
178981
|
*
|
|
@@ -177206,6 +178996,18 @@ declare namespace PowerPoint {
|
|
|
177206
178996
|
* @param options The options that define the theme of the new slide.
|
|
177207
178997
|
*/
|
|
177208
178998
|
add(options?: PowerPoint.AddSlideOptions): void;
|
|
178999
|
+
/**
|
|
179000
|
+
* Exports one or more slides found in this collection to their own presentation file, returned as Base64-encoded data.
|
|
179001
|
+
Throws an `InvalidArgument` exception if provided slide IDs or `Slide` objects are not found in this collection.
|
|
179002
|
+
*
|
|
179003
|
+
* @remarks
|
|
179004
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179005
|
+
* @beta
|
|
179006
|
+
*
|
|
179007
|
+
* @param values An array of slide IDs or `Slide` objects.
|
|
179008
|
+
* @returns A Base64-encoded string.
|
|
179009
|
+
*/
|
|
179010
|
+
exportAsBase64Presentation(values: Array<string | Slide>): OfficeExtension.ClientResult<string>;
|
|
177209
179011
|
/**
|
|
177210
179012
|
* Gets the number of slides in the collection.
|
|
177211
179013
|
*
|
|
@@ -177281,6 +179083,15 @@ declare namespace PowerPoint {
|
|
|
177281
179083
|
context: RequestContext;
|
|
177282
179084
|
/** Gets the loaded child items in this collection. */
|
|
177283
179085
|
readonly items: PowerPoint.Slide[];
|
|
179086
|
+
/**
|
|
179087
|
+
* Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.
|
|
179088
|
+
*
|
|
179089
|
+
* @remarks
|
|
179090
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179091
|
+
* @beta
|
|
179092
|
+
* @returns A Base64-encoded string.
|
|
179093
|
+
*/
|
|
179094
|
+
exportAsBase64Presentation(): OfficeExtension.ClientResult<string>;
|
|
177284
179095
|
/**
|
|
177285
179096
|
* Gets the number of slides in the collection.
|
|
177286
179097
|
*
|
|
@@ -177712,7 +179523,7 @@ declare namespace PowerPoint {
|
|
|
177712
179523
|
*/
|
|
177713
179524
|
text?: string;
|
|
177714
179525
|
/**
|
|
177715
|
-
* Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
179526
|
+
* Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
|
|
177716
179527
|
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
177717
179528
|
*
|
|
177718
179529
|
* @remarks
|
|
@@ -177826,6 +179637,112 @@ declare namespace PowerPoint {
|
|
|
177826
179637
|
interface ShapeCollectionUpdateData {
|
|
177827
179638
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
177828
179639
|
}
|
|
179640
|
+
/** An interface for updating data on the `SlideBackgroundGradientFill` object, for use in `slideBackgroundGradientFill.set({ ... })`. */
|
|
179641
|
+
interface SlideBackgroundGradientFillUpdateData {
|
|
179642
|
+
/**
|
|
179643
|
+
* Specifies the type of gradient fill.
|
|
179644
|
+
*
|
|
179645
|
+
* @remarks
|
|
179646
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179647
|
+
* @beta
|
|
179648
|
+
*/
|
|
179649
|
+
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
|
|
179650
|
+
}
|
|
179651
|
+
/** An interface for updating data on the `SlideBackgroundPatternFill` object, for use in `slideBackgroundPatternFill.set({ ... })`. */
|
|
179652
|
+
interface SlideBackgroundPatternFillUpdateData {
|
|
179653
|
+
/**
|
|
179654
|
+
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
179655
|
+
*
|
|
179656
|
+
* @remarks
|
|
179657
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179658
|
+
* @beta
|
|
179659
|
+
*/
|
|
179660
|
+
backgroundColor?: string;
|
|
179661
|
+
/**
|
|
179662
|
+
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
179663
|
+
*
|
|
179664
|
+
* @remarks
|
|
179665
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179666
|
+
* @beta
|
|
179667
|
+
*/
|
|
179668
|
+
foregroundColor?: string;
|
|
179669
|
+
/**
|
|
179670
|
+
* Specifies the pattern type.
|
|
179671
|
+
*
|
|
179672
|
+
* @remarks
|
|
179673
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179674
|
+
* @beta
|
|
179675
|
+
*/
|
|
179676
|
+
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
|
|
179677
|
+
}
|
|
179678
|
+
/** An interface for updating data on the `SlideBackgroundPictureOrTextureFill` object, for use in `slideBackgroundPictureOrTextureFill.set({ ... })`. */
|
|
179679
|
+
interface SlideBackgroundPictureOrTextureFillUpdateData {
|
|
179680
|
+
/**
|
|
179681
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
179682
|
+
*
|
|
179683
|
+
* @remarks
|
|
179684
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179685
|
+
* @beta
|
|
179686
|
+
*/
|
|
179687
|
+
transparency?: number;
|
|
179688
|
+
}
|
|
179689
|
+
/** An interface for updating data on the `SlideBackgroundSolidFill` object, for use in `slideBackgroundSolidFill.set({ ... })`. */
|
|
179690
|
+
interface SlideBackgroundSolidFillUpdateData {
|
|
179691
|
+
/**
|
|
179692
|
+
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
179693
|
+
*
|
|
179694
|
+
* @remarks
|
|
179695
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179696
|
+
* @beta
|
|
179697
|
+
*/
|
|
179698
|
+
color?: string;
|
|
179699
|
+
/**
|
|
179700
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
179701
|
+
*
|
|
179702
|
+
* @remarks
|
|
179703
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179704
|
+
* @beta
|
|
179705
|
+
*/
|
|
179706
|
+
transparency?: number;
|
|
179707
|
+
}
|
|
179708
|
+
/** An interface for updating data on the `SlideBackground` object, for use in `slideBackground.set({ ... })`. */
|
|
179709
|
+
interface SlideBackgroundUpdateData {
|
|
179710
|
+
/**
|
|
179711
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
179712
|
+
*
|
|
179713
|
+
* @remarks
|
|
179714
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179715
|
+
* @beta
|
|
179716
|
+
*/
|
|
179717
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
179718
|
+
/**
|
|
179719
|
+
* Specifies if the slide background follows the slide master background.
|
|
179720
|
+
*
|
|
179721
|
+
* @remarks
|
|
179722
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179723
|
+
* @beta
|
|
179724
|
+
*/
|
|
179725
|
+
isMasterBackgroundFollowed?: boolean;
|
|
179726
|
+
}
|
|
179727
|
+
/** An interface for updating data on the `SlideLayoutBackground` object, for use in `slideLayoutBackground.set({ ... })`. */
|
|
179728
|
+
interface SlideLayoutBackgroundUpdateData {
|
|
179729
|
+
/**
|
|
179730
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
179731
|
+
*
|
|
179732
|
+
* @remarks
|
|
179733
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179734
|
+
* @beta
|
|
179735
|
+
*/
|
|
179736
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
179737
|
+
/**
|
|
179738
|
+
* Specifies if the slide layout background follows the slide master background.
|
|
179739
|
+
*
|
|
179740
|
+
* @remarks
|
|
179741
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179742
|
+
* @beta
|
|
179743
|
+
*/
|
|
179744
|
+
isMasterBackgroundFollowed?: boolean;
|
|
179745
|
+
}
|
|
177829
179746
|
/** An interface for updating data on the `SlideLayoutCollection` object, for use in `slideLayoutCollection.set({ ... })`. */
|
|
177830
179747
|
interface SlideLayoutCollectionUpdateData {
|
|
177831
179748
|
items?: PowerPoint.Interfaces.SlideLayoutData[];
|
|
@@ -177895,6 +179812,24 @@ declare namespace PowerPoint {
|
|
|
177895
179812
|
}
|
|
177896
179813
|
/** An interface for updating data on the `BulletFormat` object, for use in `bulletFormat.set({ ... })`. */
|
|
177897
179814
|
interface BulletFormatUpdateData {
|
|
179815
|
+
/**
|
|
179816
|
+
* Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
|
|
179817
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
179818
|
+
*
|
|
179819
|
+
* @remarks
|
|
179820
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179821
|
+
* @beta
|
|
179822
|
+
*/
|
|
179823
|
+
style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
|
|
179824
|
+
/**
|
|
179825
|
+
* Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
|
|
179826
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
179827
|
+
*
|
|
179828
|
+
* @remarks
|
|
179829
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179830
|
+
* @beta
|
|
179831
|
+
*/
|
|
179832
|
+
type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
|
|
177898
179833
|
/**
|
|
177899
179834
|
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
|
|
177900
179835
|
*
|
|
@@ -177912,6 +179847,14 @@ declare namespace PowerPoint {
|
|
|
177912
179847
|
* [Api set: PowerPointApi 1.4]
|
|
177913
179848
|
*/
|
|
177914
179849
|
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
|
|
179850
|
+
/**
|
|
179851
|
+
* Represents the indent level of the paragraph.
|
|
179852
|
+
*
|
|
179853
|
+
* @remarks
|
|
179854
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179855
|
+
* @beta
|
|
179856
|
+
*/
|
|
179857
|
+
indentLevel?: number;
|
|
177915
179858
|
}
|
|
177916
179859
|
/** An interface for updating data on the `TextRange` object, for use in `textRange.set({ ... })`. */
|
|
177917
179860
|
interface TextRangeUpdateData {
|
|
@@ -178014,6 +179957,15 @@ declare namespace PowerPoint {
|
|
|
178014
179957
|
* [Api set: PowerPointApi 1.4]
|
|
178015
179958
|
*/
|
|
178016
179959
|
name?: string;
|
|
179960
|
+
/**
|
|
179961
|
+
* Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
179962
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
179963
|
+
*
|
|
179964
|
+
* @remarks
|
|
179965
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179966
|
+
* @beta
|
|
179967
|
+
*/
|
|
179968
|
+
rotation?: number;
|
|
178017
179969
|
/**
|
|
178018
179970
|
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
178019
179971
|
*
|
|
@@ -178021,6 +179973,14 @@ declare namespace PowerPoint {
|
|
|
178021
179973
|
* [Api set: PowerPointApi 1.4]
|
|
178022
179974
|
*/
|
|
178023
179975
|
top?: number;
|
|
179976
|
+
/**
|
|
179977
|
+
* Specifies if the shape is visible.
|
|
179978
|
+
*
|
|
179979
|
+
* @remarks
|
|
179980
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
179981
|
+
* @beta
|
|
179982
|
+
*/
|
|
179983
|
+
visible?: boolean;
|
|
178024
179984
|
/**
|
|
178025
179985
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
178026
179986
|
*
|
|
@@ -178114,6 +180074,25 @@ declare namespace PowerPoint {
|
|
|
178114
180074
|
*/
|
|
178115
180075
|
title?: string;
|
|
178116
180076
|
}
|
|
180077
|
+
/** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */
|
|
180078
|
+
interface PageSetupUpdateData {
|
|
180079
|
+
/**
|
|
180080
|
+
* Specifies the height of the slides in the presentation, in points.
|
|
180081
|
+
*
|
|
180082
|
+
* @remarks
|
|
180083
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180084
|
+
* @beta
|
|
180085
|
+
*/
|
|
180086
|
+
slideHeight?: number;
|
|
180087
|
+
/**
|
|
180088
|
+
* Specifies the width of the slides in the presentation, in points.
|
|
180089
|
+
*
|
|
180090
|
+
* @remarks
|
|
180091
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180092
|
+
* @beta
|
|
180093
|
+
*/
|
|
180094
|
+
slideWidth?: number;
|
|
180095
|
+
}
|
|
178117
180096
|
/** An interface for updating data on the `SlideCollection` object, for use in `slideCollection.set({ ... })`. */
|
|
178118
180097
|
interface SlideCollectionUpdateData {
|
|
178119
180098
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -178489,7 +180468,7 @@ declare namespace PowerPoint {
|
|
|
178489
180468
|
*/
|
|
178490
180469
|
text?: string;
|
|
178491
180470
|
/**
|
|
178492
|
-
* Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
180471
|
+
* Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
|
|
178493
180472
|
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
178494
180473
|
*
|
|
178495
180474
|
* @remarks
|
|
@@ -178651,6 +180630,123 @@ declare namespace PowerPoint {
|
|
|
178651
180630
|
interface ShapeCollectionData {
|
|
178652
180631
|
items?: PowerPoint.Interfaces.ShapeData[];
|
|
178653
180632
|
}
|
|
180633
|
+
/** An interface describing the data returned by calling `slideBackgroundGradientFill.toJSON()`. */
|
|
180634
|
+
interface SlideBackgroundGradientFillData {
|
|
180635
|
+
/**
|
|
180636
|
+
* Specifies the type of gradient fill.
|
|
180637
|
+
*
|
|
180638
|
+
* @remarks
|
|
180639
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180640
|
+
* @beta
|
|
180641
|
+
*/
|
|
180642
|
+
type?: PowerPoint.SlideBackgroundGradientFillType | "Unsupported" | "Linear" | "Radial" | "Rectangular" | "Path" | "ShadeFromTitle";
|
|
180643
|
+
}
|
|
180644
|
+
/** An interface describing the data returned by calling `slideBackgroundPatternFill.toJSON()`. */
|
|
180645
|
+
interface SlideBackgroundPatternFillData {
|
|
180646
|
+
/**
|
|
180647
|
+
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
180648
|
+
*
|
|
180649
|
+
* @remarks
|
|
180650
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180651
|
+
* @beta
|
|
180652
|
+
*/
|
|
180653
|
+
backgroundColor?: string;
|
|
180654
|
+
/**
|
|
180655
|
+
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
180656
|
+
*
|
|
180657
|
+
* @remarks
|
|
180658
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180659
|
+
* @beta
|
|
180660
|
+
*/
|
|
180661
|
+
foregroundColor?: string;
|
|
180662
|
+
/**
|
|
180663
|
+
* Specifies the pattern type.
|
|
180664
|
+
*
|
|
180665
|
+
* @remarks
|
|
180666
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180667
|
+
* @beta
|
|
180668
|
+
*/
|
|
180669
|
+
pattern?: PowerPoint.SlideBackgroundPatternFillType | "Unsupported" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "Horizontal" | "Vertical" | "LightHorizontal" | "LightVertical" | "DarkHorizontal" | "DarkVertical" | "NarrowHorizontal" | "NarrowVertical" | "DashedHorizontal" | "DashedVertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedDownwardDiagonal" | "DashedUpwardDiagonal" | "DiagonalCross" | "SmallCheckerBoard" | "LargeCheckerBoard" | "SmallGrid" | "LargeGrid" | "DottedGrid" | "SmallConfetti" | "LargeConfetti" | "HorizontalBrick" | "DiagonalBrick" | "SolidDiamond" | "OutlinedDiamond" | "DottedDiamond" | "Plaid" | "Sphere" | "Weave" | "Divot" | "Shingle" | "Wave" | "Trellis" | "ZigZag";
|
|
180670
|
+
}
|
|
180671
|
+
/** An interface describing the data returned by calling `slideBackgroundPictureOrTextureFill.toJSON()`. */
|
|
180672
|
+
interface SlideBackgroundPictureOrTextureFillData {
|
|
180673
|
+
/**
|
|
180674
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
180675
|
+
*
|
|
180676
|
+
* @remarks
|
|
180677
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180678
|
+
* @beta
|
|
180679
|
+
*/
|
|
180680
|
+
transparency?: number;
|
|
180681
|
+
}
|
|
180682
|
+
/** An interface describing the data returned by calling `slideBackgroundSolidFill.toJSON()`. */
|
|
180683
|
+
interface SlideBackgroundSolidFillData {
|
|
180684
|
+
/**
|
|
180685
|
+
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
180686
|
+
*
|
|
180687
|
+
* @remarks
|
|
180688
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180689
|
+
* @beta
|
|
180690
|
+
*/
|
|
180691
|
+
color?: string;
|
|
180692
|
+
/**
|
|
180693
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
180694
|
+
*
|
|
180695
|
+
* @remarks
|
|
180696
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180697
|
+
* @beta
|
|
180698
|
+
*/
|
|
180699
|
+
transparency?: number;
|
|
180700
|
+
}
|
|
180701
|
+
/** An interface describing the data returned by calling `slideBackgroundFill.toJSON()`. */
|
|
180702
|
+
interface SlideBackgroundFillData {
|
|
180703
|
+
/**
|
|
180704
|
+
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
|
|
180705
|
+
*
|
|
180706
|
+
* @remarks
|
|
180707
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180708
|
+
* @beta
|
|
180709
|
+
*/
|
|
180710
|
+
type?: PowerPoint.SlideBackgroundFillType | "Unsupported" | "Solid" | "Gradient" | "PictureOrTexture" | "Pattern";
|
|
180711
|
+
}
|
|
180712
|
+
/** An interface describing the data returned by calling `slideBackground.toJSON()`. */
|
|
180713
|
+
interface SlideBackgroundData {
|
|
180714
|
+
/**
|
|
180715
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
180716
|
+
*
|
|
180717
|
+
* @remarks
|
|
180718
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180719
|
+
* @beta
|
|
180720
|
+
*/
|
|
180721
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
180722
|
+
/**
|
|
180723
|
+
* Specifies if the slide background follows the slide master background.
|
|
180724
|
+
*
|
|
180725
|
+
* @remarks
|
|
180726
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180727
|
+
* @beta
|
|
180728
|
+
*/
|
|
180729
|
+
isMasterBackgroundFollowed?: boolean;
|
|
180730
|
+
}
|
|
180731
|
+
/** An interface describing the data returned by calling `slideLayoutBackground.toJSON()`. */
|
|
180732
|
+
interface SlideLayoutBackgroundData {
|
|
180733
|
+
/**
|
|
180734
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
180735
|
+
*
|
|
180736
|
+
* @remarks
|
|
180737
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180738
|
+
* @beta
|
|
180739
|
+
*/
|
|
180740
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
180741
|
+
/**
|
|
180742
|
+
* Specifies if the slide layout background follows the slide master background.
|
|
180743
|
+
*
|
|
180744
|
+
* @remarks
|
|
180745
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180746
|
+
* @beta
|
|
180747
|
+
*/
|
|
180748
|
+
isMasterBackgroundFollowed?: boolean;
|
|
180749
|
+
}
|
|
178654
180750
|
/** An interface describing the data returned by calling `slideLayout.toJSON()`. */
|
|
178655
180751
|
interface SlideLayoutData {
|
|
178656
180752
|
/**
|
|
@@ -178679,6 +180775,9 @@ declare namespace PowerPoint {
|
|
|
178679
180775
|
interface SlideLayoutCollectionData {
|
|
178680
180776
|
items?: PowerPoint.Interfaces.SlideLayoutData[];
|
|
178681
180777
|
}
|
|
180778
|
+
/** An interface describing the data returned by calling `slideMasterBackground.toJSON()`. */
|
|
180779
|
+
interface SlideMasterBackgroundData {
|
|
180780
|
+
}
|
|
178682
180781
|
/** An interface describing the data returned by calling `slideMaster.toJSON()`. */
|
|
178683
180782
|
interface SlideMasterData {
|
|
178684
180783
|
/**
|
|
@@ -178795,6 +180894,24 @@ declare namespace PowerPoint {
|
|
|
178795
180894
|
}
|
|
178796
180895
|
/** An interface describing the data returned by calling `bulletFormat.toJSON()`. */
|
|
178797
180896
|
interface BulletFormatData {
|
|
180897
|
+
/**
|
|
180898
|
+
* Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
|
|
180899
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
180900
|
+
*
|
|
180901
|
+
* @remarks
|
|
180902
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180903
|
+
* @beta
|
|
180904
|
+
*/
|
|
180905
|
+
style?: PowerPoint.BulletStyle | "Unsupported" | "AlphabetLowercasePeriod" | "AlphabetUppercasePeriod" | "ArabicNumeralParenthesisRight" | "ArabicNumeralPeriod" | "RomanLowercaseParenthesesBoth" | "RomanLowercaseParenthesisRight" | "RomanLowercasePeriod" | "RomanUppercasePeriod" | "AlphabetLowercaseParenthesesBoth" | "AlphabetLowercaseParenthesisRight" | "AlphabetUppercaseParenthesesBoth" | "AlphabetUppercaseParenthesisRight" | "ArabicNumeralParenthesesBoth" | "ArabicNumeralPlain" | "RomanUppercaseParenthesesBoth" | "RomanUppercaseParenthesisRight" | "SimplifiedChinesePlain" | "SimplifiedChinesePeriod" | "CircleNumberDoubleBytePlain" | "CircleNumberWideDoubleByteWhitePlain" | "CircleNumberWideDoubleByteBlackPlain" | "TraditionalChinesePlain" | "TraditionalChinesePeriod" | "ArabicAlphabetDash" | "ArabicAbjadDash" | "HebrewAlphabetDash" | "KanjiKoreanPlain" | "KanjiKoreanPeriod" | "ArabicDoubleBytePlain" | "ArabicDoubleBytePeriod" | "ThaiAlphabetPeriod" | "ThaiAlphabetParenthesisRight" | "ThaiAlphabetParenthesesBoth" | "ThaiNumeralPeriod" | "ThaiNumeralParenthesisRight" | "ThaiNumeralParenthesesBoth" | "HindiAlphabetPeriod" | "HindiNumeralPeriod" | "KanjiSimplifiedChineseDoubleBytePeriod" | "HindiNumeralParenthesisRight" | "HindiAlphabet1Period" | null;
|
|
180906
|
+
/**
|
|
180907
|
+
* Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
|
|
180908
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
180909
|
+
*
|
|
180910
|
+
* @remarks
|
|
180911
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180912
|
+
* @beta
|
|
180913
|
+
*/
|
|
180914
|
+
type?: PowerPoint.BulletType | "Unsupported" | "None" | "Numbered" | "Unnumbered" | null;
|
|
178798
180915
|
/**
|
|
178799
180916
|
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
|
|
178800
180917
|
*
|
|
@@ -178812,6 +180929,14 @@ declare namespace PowerPoint {
|
|
|
178812
180929
|
* [Api set: PowerPointApi 1.4]
|
|
178813
180930
|
*/
|
|
178814
180931
|
horizontalAlignment?: PowerPoint.ParagraphHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed" | null;
|
|
180932
|
+
/**
|
|
180933
|
+
* Represents the indent level of the paragraph.
|
|
180934
|
+
*
|
|
180935
|
+
* @remarks
|
|
180936
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
180937
|
+
* @beta
|
|
180938
|
+
*/
|
|
180939
|
+
indentLevel?: number;
|
|
178815
180940
|
}
|
|
178816
180941
|
/** An interface describing the data returned by calling `textRange.toJSON()`. */
|
|
178817
180942
|
interface TextRangeData {
|
|
@@ -178941,6 +181066,15 @@ declare namespace PowerPoint {
|
|
|
178941
181066
|
* [Api set: PowerPointApi 1.4]
|
|
178942
181067
|
*/
|
|
178943
181068
|
name?: string;
|
|
181069
|
+
/**
|
|
181070
|
+
* Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
181071
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
181072
|
+
*
|
|
181073
|
+
* @remarks
|
|
181074
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181075
|
+
* @beta
|
|
181076
|
+
*/
|
|
181077
|
+
rotation?: number;
|
|
178944
181078
|
/**
|
|
178945
181079
|
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
178946
181080
|
*
|
|
@@ -178955,6 +181089,14 @@ declare namespace PowerPoint {
|
|
|
178955
181089
|
* [Api set: PowerPointApi 1.4]
|
|
178956
181090
|
*/
|
|
178957
181091
|
type?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox";
|
|
181092
|
+
/**
|
|
181093
|
+
* Specifies if the shape is visible.
|
|
181094
|
+
*
|
|
181095
|
+
* @remarks
|
|
181096
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181097
|
+
* @beta
|
|
181098
|
+
*/
|
|
181099
|
+
visible?: boolean;
|
|
178958
181100
|
/**
|
|
178959
181101
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
178960
181102
|
*
|
|
@@ -179101,6 +181243,25 @@ declare namespace PowerPoint {
|
|
|
179101
181243
|
*/
|
|
179102
181244
|
title?: string;
|
|
179103
181245
|
}
|
|
181246
|
+
/** An interface describing the data returned by calling `pageSetup.toJSON()`. */
|
|
181247
|
+
interface PageSetupData {
|
|
181248
|
+
/**
|
|
181249
|
+
* Specifies the height of the slides in the presentation, in points.
|
|
181250
|
+
*
|
|
181251
|
+
* @remarks
|
|
181252
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181253
|
+
* @beta
|
|
181254
|
+
*/
|
|
181255
|
+
slideHeight?: number;
|
|
181256
|
+
/**
|
|
181257
|
+
* Specifies the width of the slides in the presentation, in points.
|
|
181258
|
+
*
|
|
181259
|
+
* @remarks
|
|
181260
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181261
|
+
* @beta
|
|
181262
|
+
*/
|
|
181263
|
+
slideWidth?: number;
|
|
181264
|
+
}
|
|
179104
181265
|
/** An interface describing the data returned by calling `slideCollection.toJSON()`. */
|
|
179105
181266
|
interface SlideCollectionData {
|
|
179106
181267
|
items?: PowerPoint.Interfaces.SlideData[];
|
|
@@ -179122,6 +181283,14 @@ declare namespace PowerPoint {
|
|
|
179122
181283
|
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`).
|
|
179123
181284
|
*/
|
|
179124
181285
|
$all?: boolean;
|
|
181286
|
+
/**
|
|
181287
|
+
* Returns the page setup information whose properties control slide setup attributes for the presentation.
|
|
181288
|
+
*
|
|
181289
|
+
* @remarks
|
|
181290
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181291
|
+
* @beta
|
|
181292
|
+
*/
|
|
181293
|
+
pageSetup?: PowerPoint.Interfaces.PageSetupLoadOptions;
|
|
179125
181294
|
/**
|
|
179126
181295
|
* Gets the properties of the presentation.
|
|
179127
181296
|
*
|
|
@@ -179355,52 +181524,52 @@ declare namespace PowerPoint {
|
|
|
179355
181524
|
*/
|
|
179356
181525
|
$all?: boolean;
|
|
179357
181526
|
/**
|
|
179358
|
-
|
|
179359
|
-
|
|
179360
|
-
|
|
179361
|
-
|
|
179362
|
-
|
|
179363
|
-
|
|
181527
|
+
* Gets the bottom border.
|
|
181528
|
+
*
|
|
181529
|
+
* @remarks
|
|
181530
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181531
|
+
* @beta
|
|
181532
|
+
*/
|
|
179364
181533
|
bottom?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
179365
181534
|
/**
|
|
179366
|
-
|
|
179367
|
-
|
|
179368
|
-
|
|
179369
|
-
|
|
179370
|
-
|
|
179371
|
-
|
|
181535
|
+
* Gets the diagonal border (top-left to bottom-right).
|
|
181536
|
+
*
|
|
181537
|
+
* @remarks
|
|
181538
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181539
|
+
* @beta
|
|
181540
|
+
*/
|
|
179372
181541
|
diagonalDown?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
179373
181542
|
/**
|
|
179374
|
-
|
|
179375
|
-
|
|
179376
|
-
|
|
179377
|
-
|
|
179378
|
-
|
|
179379
|
-
|
|
181543
|
+
* Gets the diagonal border (bottom-left to top-right).
|
|
181544
|
+
*
|
|
181545
|
+
* @remarks
|
|
181546
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181547
|
+
* @beta
|
|
181548
|
+
*/
|
|
179380
181549
|
diagonalUp?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
179381
181550
|
/**
|
|
179382
|
-
|
|
179383
|
-
|
|
179384
|
-
|
|
179385
|
-
|
|
179386
|
-
|
|
179387
|
-
|
|
181551
|
+
* Gets the left border.
|
|
181552
|
+
*
|
|
181553
|
+
* @remarks
|
|
181554
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181555
|
+
* @beta
|
|
181556
|
+
*/
|
|
179388
181557
|
left?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
179389
181558
|
/**
|
|
179390
|
-
|
|
179391
|
-
|
|
179392
|
-
|
|
179393
|
-
|
|
179394
|
-
|
|
179395
|
-
|
|
181559
|
+
* Gets the right border.
|
|
181560
|
+
*
|
|
181561
|
+
* @remarks
|
|
181562
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181563
|
+
* @beta
|
|
181564
|
+
*/
|
|
179396
181565
|
right?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
179397
181566
|
/**
|
|
179398
|
-
|
|
179399
|
-
|
|
179400
|
-
|
|
179401
|
-
|
|
179402
|
-
|
|
179403
|
-
|
|
181567
|
+
* Gets the top border.
|
|
181568
|
+
*
|
|
181569
|
+
* @remarks
|
|
181570
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181571
|
+
* @beta
|
|
181572
|
+
*/
|
|
179404
181573
|
top?: PowerPoint.Interfaces.BorderLoadOptions;
|
|
179405
181574
|
}
|
|
179406
181575
|
/**
|
|
@@ -179637,36 +181806,36 @@ declare namespace PowerPoint {
|
|
|
179637
181806
|
*/
|
|
179638
181807
|
$all?: boolean;
|
|
179639
181808
|
/**
|
|
179640
|
-
|
|
179641
|
-
|
|
179642
|
-
|
|
179643
|
-
|
|
179644
|
-
|
|
179645
|
-
|
|
181809
|
+
* Gets the collection of borders for the table cell.
|
|
181810
|
+
*
|
|
181811
|
+
* @remarks
|
|
181812
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181813
|
+
* @beta
|
|
181814
|
+
*/
|
|
179646
181815
|
borders?: PowerPoint.Interfaces.BordersLoadOptions;
|
|
179647
181816
|
/**
|
|
179648
|
-
|
|
179649
|
-
|
|
179650
|
-
|
|
179651
|
-
|
|
179652
|
-
|
|
179653
|
-
|
|
181817
|
+
* Gets the fill color of the table cell.
|
|
181818
|
+
*
|
|
181819
|
+
* @remarks
|
|
181820
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181821
|
+
* @beta
|
|
181822
|
+
*/
|
|
179654
181823
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
179655
181824
|
/**
|
|
179656
|
-
|
|
179657
|
-
|
|
179658
|
-
|
|
179659
|
-
|
|
179660
|
-
|
|
179661
|
-
|
|
181825
|
+
* Gets the font of the table cell.
|
|
181826
|
+
*
|
|
181827
|
+
* @remarks
|
|
181828
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181829
|
+
* @beta
|
|
181830
|
+
*/
|
|
179662
181831
|
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
|
|
179663
181832
|
/**
|
|
179664
|
-
|
|
179665
|
-
|
|
179666
|
-
|
|
179667
|
-
|
|
179668
|
-
|
|
179669
|
-
|
|
181833
|
+
* Gets the set of margins in the table cell.
|
|
181834
|
+
*
|
|
181835
|
+
* @remarks
|
|
181836
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181837
|
+
* @beta
|
|
181838
|
+
*/
|
|
179670
181839
|
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
|
|
179671
181840
|
/**
|
|
179672
181841
|
* Gets the number of table columns this cell spans across.
|
|
@@ -179722,7 +181891,7 @@ declare namespace PowerPoint {
|
|
|
179722
181891
|
*/
|
|
179723
181892
|
text?: boolean;
|
|
179724
181893
|
/**
|
|
179725
|
-
* Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
181894
|
+
* Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
|
|
179726
181895
|
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
179727
181896
|
*
|
|
179728
181897
|
* @remarks
|
|
@@ -179751,36 +181920,36 @@ declare namespace PowerPoint {
|
|
|
179751
181920
|
*/
|
|
179752
181921
|
$all?: boolean;
|
|
179753
181922
|
/**
|
|
179754
|
-
|
|
179755
|
-
|
|
179756
|
-
|
|
179757
|
-
|
|
179758
|
-
|
|
179759
|
-
|
|
181923
|
+
* For EACH ITEM in the collection: Gets the collection of borders for the table cell.
|
|
181924
|
+
*
|
|
181925
|
+
* @remarks
|
|
181926
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181927
|
+
* @beta
|
|
181928
|
+
*/
|
|
179760
181929
|
borders?: PowerPoint.Interfaces.BordersLoadOptions;
|
|
179761
181930
|
/**
|
|
179762
|
-
|
|
179763
|
-
|
|
179764
|
-
|
|
179765
|
-
|
|
179766
|
-
|
|
179767
|
-
|
|
181931
|
+
* For EACH ITEM in the collection: Gets the fill color of the table cell.
|
|
181932
|
+
*
|
|
181933
|
+
* @remarks
|
|
181934
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181935
|
+
* @beta
|
|
181936
|
+
*/
|
|
179768
181937
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
179769
181938
|
/**
|
|
179770
|
-
|
|
179771
|
-
|
|
179772
|
-
|
|
179773
|
-
|
|
179774
|
-
|
|
179775
|
-
|
|
181939
|
+
* For EACH ITEM in the collection: Gets the font of the table cell.
|
|
181940
|
+
*
|
|
181941
|
+
* @remarks
|
|
181942
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181943
|
+
* @beta
|
|
181944
|
+
*/
|
|
179776
181945
|
font?: PowerPoint.Interfaces.ShapeFontLoadOptions;
|
|
179777
181946
|
/**
|
|
179778
|
-
|
|
179779
|
-
|
|
179780
|
-
|
|
179781
|
-
|
|
179782
|
-
|
|
179783
|
-
|
|
181947
|
+
* For EACH ITEM in the collection: Gets the set of margins in the table cell.
|
|
181948
|
+
*
|
|
181949
|
+
* @remarks
|
|
181950
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
181951
|
+
* @beta
|
|
181952
|
+
*/
|
|
179784
181953
|
margins?: PowerPoint.Interfaces.MarginsLoadOptions;
|
|
179785
181954
|
/**
|
|
179786
181955
|
* For EACH ITEM in the collection: Gets the number of table columns this cell spans across.
|
|
@@ -179836,7 +182005,7 @@ declare namespace PowerPoint {
|
|
|
179836
182005
|
*/
|
|
179837
182006
|
text?: boolean;
|
|
179838
182007
|
/**
|
|
179839
|
-
* For EACH ITEM in the collection: Specifies the contents of the table cell as an array of {@link TextRun} objects.
|
|
182008
|
+
* For EACH ITEM in the collection: Specifies the contents of the table cell as an array of {@link PowerPoint.TextRun} objects.
|
|
179840
182009
|
Each `TextRun` object represents a sequence of one or more characters that share the same font attributes.
|
|
179841
182010
|
*
|
|
179842
182011
|
* @remarks
|
|
@@ -180066,12 +182235,12 @@ declare namespace PowerPoint {
|
|
|
180066
182235
|
*/
|
|
180067
182236
|
$all?: boolean;
|
|
180068
182237
|
/**
|
|
180069
|
-
|
|
180070
|
-
|
|
180071
|
-
|
|
180072
|
-
|
|
180073
|
-
|
|
180074
|
-
|
|
182238
|
+
* Gets the table style options.
|
|
182239
|
+
*
|
|
182240
|
+
* @remarks
|
|
182241
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182242
|
+
* @beta
|
|
182243
|
+
*/
|
|
180075
182244
|
styleOptions?: PowerPoint.Interfaces.TableStyleOptionsLoadOptions;
|
|
180076
182245
|
/**
|
|
180077
182246
|
* Gets the number of columns in the table.
|
|
@@ -180192,6 +182361,15 @@ declare namespace PowerPoint {
|
|
|
180192
182361
|
* [Api set: PowerPointApi 1.4]
|
|
180193
182362
|
*/
|
|
180194
182363
|
name?: boolean;
|
|
182364
|
+
/**
|
|
182365
|
+
* For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
182366
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
182367
|
+
*
|
|
182368
|
+
* @remarks
|
|
182369
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182370
|
+
* @beta
|
|
182371
|
+
*/
|
|
182372
|
+
rotation?: boolean;
|
|
180195
182373
|
/**
|
|
180196
182374
|
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
180197
182375
|
*
|
|
@@ -180206,6 +182384,14 @@ declare namespace PowerPoint {
|
|
|
180206
182384
|
* [Api set: PowerPointApi 1.4]
|
|
180207
182385
|
*/
|
|
180208
182386
|
type?: boolean;
|
|
182387
|
+
/**
|
|
182388
|
+
* For EACH ITEM in the collection: Specifies if the shape is visible.
|
|
182389
|
+
*
|
|
182390
|
+
* @remarks
|
|
182391
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182392
|
+
* @beta
|
|
182393
|
+
*/
|
|
182394
|
+
visible?: boolean;
|
|
180209
182395
|
/**
|
|
180210
182396
|
* For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
180211
182397
|
*
|
|
@@ -180222,6 +182408,209 @@ declare namespace PowerPoint {
|
|
|
180222
182408
|
*/
|
|
180223
182409
|
zOrderPosition?: boolean;
|
|
180224
182410
|
}
|
|
182411
|
+
/**
|
|
182412
|
+
* Represents {@link PowerPoint.SlideBackground} gradient fill properties.
|
|
182413
|
+
*
|
|
182414
|
+
* @remarks
|
|
182415
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182416
|
+
* @beta
|
|
182417
|
+
*/
|
|
182418
|
+
interface SlideBackgroundGradientFillLoadOptions {
|
|
182419
|
+
/**
|
|
182420
|
+
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`).
|
|
182421
|
+
*/
|
|
182422
|
+
$all?: boolean;
|
|
182423
|
+
/**
|
|
182424
|
+
* Specifies the type of gradient fill.
|
|
182425
|
+
*
|
|
182426
|
+
* @remarks
|
|
182427
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182428
|
+
* @beta
|
|
182429
|
+
*/
|
|
182430
|
+
type?: boolean;
|
|
182431
|
+
}
|
|
182432
|
+
/**
|
|
182433
|
+
* Represents {@link PowerPoint.SlideBackground} pattern fill properties.
|
|
182434
|
+
*
|
|
182435
|
+
* @remarks
|
|
182436
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182437
|
+
* @beta
|
|
182438
|
+
*/
|
|
182439
|
+
interface SlideBackgroundPatternFillLoadOptions {
|
|
182440
|
+
/**
|
|
182441
|
+
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`).
|
|
182442
|
+
*/
|
|
182443
|
+
$all?: boolean;
|
|
182444
|
+
/**
|
|
182445
|
+
* Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").
|
|
182446
|
+
*
|
|
182447
|
+
* @remarks
|
|
182448
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182449
|
+
* @beta
|
|
182450
|
+
*/
|
|
182451
|
+
backgroundColor?: boolean;
|
|
182452
|
+
/**
|
|
182453
|
+
* Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").
|
|
182454
|
+
*
|
|
182455
|
+
* @remarks
|
|
182456
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182457
|
+
* @beta
|
|
182458
|
+
*/
|
|
182459
|
+
foregroundColor?: boolean;
|
|
182460
|
+
/**
|
|
182461
|
+
* Specifies the pattern type.
|
|
182462
|
+
*
|
|
182463
|
+
* @remarks
|
|
182464
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182465
|
+
* @beta
|
|
182466
|
+
*/
|
|
182467
|
+
pattern?: boolean;
|
|
182468
|
+
}
|
|
182469
|
+
/**
|
|
182470
|
+
* Represents {@link PowerPoint.SlideBackground} picture or texture fill properties.
|
|
182471
|
+
*
|
|
182472
|
+
* @remarks
|
|
182473
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182474
|
+
* @beta
|
|
182475
|
+
*/
|
|
182476
|
+
interface SlideBackgroundPictureOrTextureFillLoadOptions {
|
|
182477
|
+
/**
|
|
182478
|
+
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`).
|
|
182479
|
+
*/
|
|
182480
|
+
$all?: boolean;
|
|
182481
|
+
/**
|
|
182482
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
182483
|
+
*
|
|
182484
|
+
* @remarks
|
|
182485
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182486
|
+
* @beta
|
|
182487
|
+
*/
|
|
182488
|
+
transparency?: boolean;
|
|
182489
|
+
}
|
|
182490
|
+
/**
|
|
182491
|
+
* Represents {@link PowerPoint.SlideBackground} solid fill properties.
|
|
182492
|
+
*
|
|
182493
|
+
* @remarks
|
|
182494
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182495
|
+
* @beta
|
|
182496
|
+
*/
|
|
182497
|
+
interface SlideBackgroundSolidFillLoadOptions {
|
|
182498
|
+
/**
|
|
182499
|
+
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`).
|
|
182500
|
+
*/
|
|
182501
|
+
$all?: boolean;
|
|
182502
|
+
/**
|
|
182503
|
+
* Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").
|
|
182504
|
+
*
|
|
182505
|
+
* @remarks
|
|
182506
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182507
|
+
* @beta
|
|
182508
|
+
*/
|
|
182509
|
+
color?: boolean;
|
|
182510
|
+
/**
|
|
182511
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).
|
|
182512
|
+
*
|
|
182513
|
+
* @remarks
|
|
182514
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182515
|
+
* @beta
|
|
182516
|
+
*/
|
|
182517
|
+
transparency?: boolean;
|
|
182518
|
+
}
|
|
182519
|
+
/**
|
|
182520
|
+
* Represents the fill formatting of a slide background object.
|
|
182521
|
+
*
|
|
182522
|
+
* @remarks
|
|
182523
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182524
|
+
* @beta
|
|
182525
|
+
*/
|
|
182526
|
+
interface SlideBackgroundFillLoadOptions {
|
|
182527
|
+
/**
|
|
182528
|
+
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`).
|
|
182529
|
+
*/
|
|
182530
|
+
$all?: boolean;
|
|
182531
|
+
/**
|
|
182532
|
+
* Returns the fill type of the slide background. See {@link PowerPoint.SlideBackgroundFillType} for details.
|
|
182533
|
+
*
|
|
182534
|
+
* @remarks
|
|
182535
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182536
|
+
* @beta
|
|
182537
|
+
*/
|
|
182538
|
+
type?: boolean;
|
|
182539
|
+
}
|
|
182540
|
+
/**
|
|
182541
|
+
* Represents a background of a slide.
|
|
182542
|
+
*
|
|
182543
|
+
* @remarks
|
|
182544
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182545
|
+
* @beta
|
|
182546
|
+
*/
|
|
182547
|
+
interface SlideBackgroundLoadOptions {
|
|
182548
|
+
/**
|
|
182549
|
+
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`).
|
|
182550
|
+
*/
|
|
182551
|
+
$all?: boolean;
|
|
182552
|
+
/**
|
|
182553
|
+
* Returns the fill formatting of the background.
|
|
182554
|
+
*
|
|
182555
|
+
* @remarks
|
|
182556
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182557
|
+
* @beta
|
|
182558
|
+
*/
|
|
182559
|
+
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
|
|
182560
|
+
/**
|
|
182561
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
182562
|
+
*
|
|
182563
|
+
* @remarks
|
|
182564
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182565
|
+
* @beta
|
|
182566
|
+
*/
|
|
182567
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
182568
|
+
/**
|
|
182569
|
+
* Specifies if the slide background follows the slide master background.
|
|
182570
|
+
*
|
|
182571
|
+
* @remarks
|
|
182572
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182573
|
+
* @beta
|
|
182574
|
+
*/
|
|
182575
|
+
isMasterBackgroundFollowed?: boolean;
|
|
182576
|
+
}
|
|
182577
|
+
/**
|
|
182578
|
+
* Represents the background of a slide layout.
|
|
182579
|
+
*
|
|
182580
|
+
* @remarks
|
|
182581
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182582
|
+
* @beta
|
|
182583
|
+
*/
|
|
182584
|
+
interface SlideLayoutBackgroundLoadOptions {
|
|
182585
|
+
/**
|
|
182586
|
+
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`).
|
|
182587
|
+
*/
|
|
182588
|
+
$all?: boolean;
|
|
182589
|
+
/**
|
|
182590
|
+
* Returns the fill formatting of the background.
|
|
182591
|
+
*
|
|
182592
|
+
* @remarks
|
|
182593
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182594
|
+
* @beta
|
|
182595
|
+
*/
|
|
182596
|
+
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
|
|
182597
|
+
/**
|
|
182598
|
+
* Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.
|
|
182599
|
+
*
|
|
182600
|
+
* @remarks
|
|
182601
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182602
|
+
* @beta
|
|
182603
|
+
*/
|
|
182604
|
+
areBackgroundGraphicsHidden?: boolean;
|
|
182605
|
+
/**
|
|
182606
|
+
* Specifies if the slide layout background follows the slide master background.
|
|
182607
|
+
*
|
|
182608
|
+
* @remarks
|
|
182609
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182610
|
+
* @beta
|
|
182611
|
+
*/
|
|
182612
|
+
isMasterBackgroundFollowed?: boolean;
|
|
182613
|
+
}
|
|
180225
182614
|
/**
|
|
180226
182615
|
* Represents the layout of a slide.
|
|
180227
182616
|
*
|
|
@@ -180233,6 +182622,14 @@ declare namespace PowerPoint {
|
|
|
180233
182622
|
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`).
|
|
180234
182623
|
*/
|
|
180235
182624
|
$all?: boolean;
|
|
182625
|
+
/**
|
|
182626
|
+
* Gets the background of the slide layout.
|
|
182627
|
+
*
|
|
182628
|
+
* @remarks
|
|
182629
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182630
|
+
* @beta
|
|
182631
|
+
*/
|
|
182632
|
+
background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
|
|
180236
182633
|
/**
|
|
180237
182634
|
* Gets the unique ID of the slide layout.
|
|
180238
182635
|
*
|
|
@@ -180266,6 +182663,14 @@ declare namespace PowerPoint {
|
|
|
180266
182663
|
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`).
|
|
180267
182664
|
*/
|
|
180268
182665
|
$all?: boolean;
|
|
182666
|
+
/**
|
|
182667
|
+
* For EACH ITEM in the collection: Gets the background of the slide layout.
|
|
182668
|
+
*
|
|
182669
|
+
* @remarks
|
|
182670
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182671
|
+
* @beta
|
|
182672
|
+
*/
|
|
182673
|
+
background?: PowerPoint.Interfaces.SlideLayoutBackgroundLoadOptions;
|
|
180269
182674
|
/**
|
|
180270
182675
|
* For EACH ITEM in the collection: Gets the unique ID of the slide layout.
|
|
180271
182676
|
*
|
|
@@ -180288,6 +182693,27 @@ declare namespace PowerPoint {
|
|
|
180288
182693
|
*/
|
|
180289
182694
|
type?: boolean;
|
|
180290
182695
|
}
|
|
182696
|
+
/**
|
|
182697
|
+
* Represents the background of a slide master.
|
|
182698
|
+
*
|
|
182699
|
+
* @remarks
|
|
182700
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182701
|
+
* @beta
|
|
182702
|
+
*/
|
|
182703
|
+
interface SlideMasterBackgroundLoadOptions {
|
|
182704
|
+
/**
|
|
182705
|
+
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`).
|
|
182706
|
+
*/
|
|
182707
|
+
$all?: boolean;
|
|
182708
|
+
/**
|
|
182709
|
+
* Returns the fill formatting of the background.
|
|
182710
|
+
*
|
|
182711
|
+
* @remarks
|
|
182712
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182713
|
+
* @beta
|
|
182714
|
+
*/
|
|
182715
|
+
fill?: PowerPoint.Interfaces.SlideBackgroundFillLoadOptions;
|
|
182716
|
+
}
|
|
180291
182717
|
/**
|
|
180292
182718
|
* Represents the Slide Master of a slide.
|
|
180293
182719
|
*
|
|
@@ -180299,6 +182725,14 @@ declare namespace PowerPoint {
|
|
|
180299
182725
|
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`).
|
|
180300
182726
|
*/
|
|
180301
182727
|
$all?: boolean;
|
|
182728
|
+
/**
|
|
182729
|
+
* Gets the background of the Slide Master.
|
|
182730
|
+
*
|
|
182731
|
+
* @remarks
|
|
182732
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182733
|
+
* @beta
|
|
182734
|
+
*/
|
|
182735
|
+
background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
|
|
180302
182736
|
/**
|
|
180303
182737
|
* Gets the unique ID of the Slide Master.
|
|
180304
182738
|
*
|
|
@@ -180377,6 +182811,14 @@ declare namespace PowerPoint {
|
|
|
180377
182811
|
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`).
|
|
180378
182812
|
*/
|
|
180379
182813
|
$all?: boolean;
|
|
182814
|
+
/**
|
|
182815
|
+
* Gets the background of the slide.
|
|
182816
|
+
*
|
|
182817
|
+
* @remarks
|
|
182818
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182819
|
+
* @beta
|
|
182820
|
+
*/
|
|
182821
|
+
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
|
|
180380
182822
|
/**
|
|
180381
182823
|
* Gets the layout of the slide.
|
|
180382
182824
|
*
|
|
@@ -180456,7 +182898,7 @@ declare namespace PowerPoint {
|
|
|
180456
182898
|
*/
|
|
180457
182899
|
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
180458
182900
|
/**
|
|
180459
|
-
|
|
182901
|
+
* For EACH ITEM in the collection: Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
|
|
180460
182902
|
*
|
|
180461
182903
|
* @remarks
|
|
180462
182904
|
* [Api set: PowerPointApi 1.5]
|
|
@@ -180503,6 +182945,15 @@ declare namespace PowerPoint {
|
|
|
180503
182945
|
* [Api set: PowerPointApi 1.4]
|
|
180504
182946
|
*/
|
|
180505
182947
|
name?: boolean;
|
|
182948
|
+
/**
|
|
182949
|
+
* For EACH ITEM in the collection: Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
182950
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
182951
|
+
*
|
|
182952
|
+
* @remarks
|
|
182953
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182954
|
+
* @beta
|
|
182955
|
+
*/
|
|
182956
|
+
rotation?: boolean;
|
|
180506
182957
|
/**
|
|
180507
182958
|
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
180508
182959
|
*
|
|
@@ -180517,6 +182968,14 @@ declare namespace PowerPoint {
|
|
|
180517
182968
|
* [Api set: PowerPointApi 1.4]
|
|
180518
182969
|
*/
|
|
180519
182970
|
type?: boolean;
|
|
182971
|
+
/**
|
|
182972
|
+
* For EACH ITEM in the collection: Specifies if the shape is visible.
|
|
182973
|
+
*
|
|
182974
|
+
* @remarks
|
|
182975
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
182976
|
+
* @beta
|
|
182977
|
+
*/
|
|
182978
|
+
visible?: boolean;
|
|
180520
182979
|
/**
|
|
180521
182980
|
* For EACH ITEM in the collection: Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
180522
182981
|
*
|
|
@@ -180624,6 +183083,24 @@ declare namespace PowerPoint {
|
|
|
180624
183083
|
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`).
|
|
180625
183084
|
*/
|
|
180626
183085
|
$all?: boolean;
|
|
183086
|
+
/**
|
|
183087
|
+
* Specifies the style of the bullets in the paragraph. See {@link PowerPoint.BulletStyle} for details.
|
|
183088
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
183089
|
+
*
|
|
183090
|
+
* @remarks
|
|
183091
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183092
|
+
* @beta
|
|
183093
|
+
*/
|
|
183094
|
+
style?: boolean;
|
|
183095
|
+
/**
|
|
183096
|
+
* Specifies the type of the bullets in the paragraph. See {@link PowerPoint.BulletType} for details.
|
|
183097
|
+
Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet formatting properties.
|
|
183098
|
+
*
|
|
183099
|
+
* @remarks
|
|
183100
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183101
|
+
* @beta
|
|
183102
|
+
*/
|
|
183103
|
+
type?: boolean;
|
|
180627
183104
|
/**
|
|
180628
183105
|
* Specifies if the bullets in the paragraph are visible. Returns `null` if the {@link PowerPoint.TextRange} includes text fragments with different bullet visibility values.
|
|
180629
183106
|
*
|
|
@@ -180657,6 +183134,14 @@ declare namespace PowerPoint {
|
|
|
180657
183134
|
* [Api set: PowerPointApi 1.4]
|
|
180658
183135
|
*/
|
|
180659
183136
|
horizontalAlignment?: boolean;
|
|
183137
|
+
/**
|
|
183138
|
+
* Represents the indent level of the paragraph.
|
|
183139
|
+
*
|
|
183140
|
+
* @remarks
|
|
183141
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183142
|
+
* @beta
|
|
183143
|
+
*/
|
|
183144
|
+
indentLevel?: boolean;
|
|
180660
183145
|
}
|
|
180661
183146
|
/**
|
|
180662
183147
|
* Contains the text that is attached to a shape, in addition to properties and methods for manipulating the text.
|
|
@@ -180832,7 +183317,7 @@ declare namespace PowerPoint {
|
|
|
180832
183317
|
*/
|
|
180833
183318
|
placeholderFormat?: PowerPoint.Interfaces.PlaceholderFormatLoadOptions;
|
|
180834
183319
|
/**
|
|
180835
|
-
|
|
183320
|
+
* Returns the {@link PowerPoint.TextFrame} object of this `Shape`. Throws an `InvalidArgument` exception if the shape doesn't support a `TextFrame`.
|
|
180836
183321
|
*
|
|
180837
183322
|
* @remarks
|
|
180838
183323
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -180879,6 +183364,15 @@ declare namespace PowerPoint {
|
|
|
180879
183364
|
* [Api set: PowerPointApi 1.4]
|
|
180880
183365
|
*/
|
|
180881
183366
|
name?: boolean;
|
|
183367
|
+
/**
|
|
183368
|
+
* Specifies the rotation, in degrees, of the shape around the z-axis.
|
|
183369
|
+
A positive value indicates clockwise rotation, and a negative value indicates counterclockwise rotation.
|
|
183370
|
+
*
|
|
183371
|
+
* @remarks
|
|
183372
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183373
|
+
* @beta
|
|
183374
|
+
*/
|
|
183375
|
+
rotation?: boolean;
|
|
180882
183376
|
/**
|
|
180883
183377
|
* The distance, in points, from the top edge of the shape to the top edge of the slide.
|
|
180884
183378
|
*
|
|
@@ -180893,6 +183387,14 @@ declare namespace PowerPoint {
|
|
|
180893
183387
|
* [Api set: PowerPointApi 1.4]
|
|
180894
183388
|
*/
|
|
180895
183389
|
type?: boolean;
|
|
183390
|
+
/**
|
|
183391
|
+
* Specifies if the shape is visible.
|
|
183392
|
+
*
|
|
183393
|
+
* @remarks
|
|
183394
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183395
|
+
* @beta
|
|
183396
|
+
*/
|
|
183397
|
+
visible?: boolean;
|
|
180896
183398
|
/**
|
|
180897
183399
|
* Specifies the width, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
180898
183400
|
*
|
|
@@ -181118,6 +183620,35 @@ declare namespace PowerPoint {
|
|
|
181118
183620
|
*/
|
|
181119
183621
|
title?: boolean;
|
|
181120
183622
|
}
|
|
183623
|
+
/**
|
|
183624
|
+
* Represents the page setup information for the presentation.
|
|
183625
|
+
*
|
|
183626
|
+
* @remarks
|
|
183627
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183628
|
+
* @beta
|
|
183629
|
+
*/
|
|
183630
|
+
interface PageSetupLoadOptions {
|
|
183631
|
+
/**
|
|
183632
|
+
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`).
|
|
183633
|
+
*/
|
|
183634
|
+
$all?: boolean;
|
|
183635
|
+
/**
|
|
183636
|
+
* Specifies the height of the slides in the presentation, in points.
|
|
183637
|
+
*
|
|
183638
|
+
* @remarks
|
|
183639
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183640
|
+
* @beta
|
|
183641
|
+
*/
|
|
183642
|
+
slideHeight?: boolean;
|
|
183643
|
+
/**
|
|
183644
|
+
* Specifies the width of the slides in the presentation, in points.
|
|
183645
|
+
*
|
|
183646
|
+
* @remarks
|
|
183647
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183648
|
+
* @beta
|
|
183649
|
+
*/
|
|
183650
|
+
slideWidth?: boolean;
|
|
183651
|
+
}
|
|
181121
183652
|
/**
|
|
181122
183653
|
* Represents the collection of slides in the presentation.
|
|
181123
183654
|
*
|
|
@@ -181130,18 +183661,26 @@ declare namespace PowerPoint {
|
|
|
181130
183661
|
*/
|
|
181131
183662
|
$all?: boolean;
|
|
181132
183663
|
/**
|
|
181133
|
-
|
|
181134
|
-
|
|
181135
|
-
|
|
181136
|
-
|
|
181137
|
-
|
|
183664
|
+
* For EACH ITEM in the collection: Gets the background of the slide.
|
|
183665
|
+
*
|
|
183666
|
+
* @remarks
|
|
183667
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183668
|
+
* @beta
|
|
183669
|
+
*/
|
|
183670
|
+
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
|
|
183671
|
+
/**
|
|
183672
|
+
* For EACH ITEM in the collection: Gets the layout of the slide.
|
|
183673
|
+
*
|
|
183674
|
+
* @remarks
|
|
183675
|
+
* [Api set: PowerPointApi 1.3]
|
|
183676
|
+
*/
|
|
181138
183677
|
layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
|
|
181139
183678
|
/**
|
|
181140
|
-
|
|
181141
|
-
|
|
181142
|
-
|
|
181143
|
-
|
|
181144
|
-
|
|
183679
|
+
* For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
|
|
183680
|
+
*
|
|
183681
|
+
* @remarks
|
|
183682
|
+
* [Api set: PowerPointApi 1.3]
|
|
183683
|
+
*/
|
|
181145
183684
|
slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
|
|
181146
183685
|
/**
|
|
181147
183686
|
* For EACH ITEM in the collection: Gets the unique ID of the slide.
|
|
@@ -181170,18 +183709,26 @@ declare namespace PowerPoint {
|
|
|
181170
183709
|
*/
|
|
181171
183710
|
$all?: boolean;
|
|
181172
183711
|
/**
|
|
181173
|
-
|
|
181174
|
-
|
|
181175
|
-
|
|
181176
|
-
|
|
181177
|
-
|
|
183712
|
+
* For EACH ITEM in the collection: Gets the background of the slide.
|
|
183713
|
+
*
|
|
183714
|
+
* @remarks
|
|
183715
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183716
|
+
* @beta
|
|
183717
|
+
*/
|
|
183718
|
+
background?: PowerPoint.Interfaces.SlideBackgroundLoadOptions;
|
|
183719
|
+
/**
|
|
183720
|
+
* For EACH ITEM in the collection: Gets the layout of the slide.
|
|
183721
|
+
*
|
|
183722
|
+
* @remarks
|
|
183723
|
+
* [Api set: PowerPointApi 1.5]
|
|
183724
|
+
*/
|
|
181178
183725
|
layout?: PowerPoint.Interfaces.SlideLayoutLoadOptions;
|
|
181179
183726
|
/**
|
|
181180
|
-
|
|
181181
|
-
|
|
181182
|
-
|
|
181183
|
-
|
|
181184
|
-
|
|
183727
|
+
* For EACH ITEM in the collection: Gets the `SlideMaster` object that represents the slide's default content.
|
|
183728
|
+
*
|
|
183729
|
+
* @remarks
|
|
183730
|
+
* [Api set: PowerPointApi 1.5]
|
|
183731
|
+
*/
|
|
181185
183732
|
slideMaster?: PowerPoint.Interfaces.SlideMasterLoadOptions;
|
|
181186
183733
|
/**
|
|
181187
183734
|
* For EACH ITEM in the collection: Gets the unique ID of the slide.
|
|
@@ -181209,6 +183756,14 @@ declare namespace PowerPoint {
|
|
|
181209
183756
|
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`).
|
|
181210
183757
|
*/
|
|
181211
183758
|
$all?: boolean;
|
|
183759
|
+
/**
|
|
183760
|
+
* For EACH ITEM in the collection: Gets the background of the Slide Master.
|
|
183761
|
+
*
|
|
183762
|
+
* @remarks
|
|
183763
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
183764
|
+
* @beta
|
|
183765
|
+
*/
|
|
183766
|
+
background?: PowerPoint.Interfaces.SlideMasterBackgroundLoadOptions;
|
|
181212
183767
|
/**
|
|
181213
183768
|
* For EACH ITEM in the collection: Gets the unique ID of the Slide Master.
|
|
181214
183769
|
*
|