Skip to content

Commit 3633e9c

Browse files
author
github-actions
committed
Merge branch 'main' into live
2 parents 624e5a8 + 9ecd4d7 commit 3633e9c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1923
-156
lines changed

‎docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.interfaces.placeholderformatdata.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,15 @@ properties:
2323
isPreview: true
2424
isDeprecated: false
2525
syntax:
26-
content: 'containedType?: ShapeType | null;'
26+
content: >-
27+
containedType?: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" | "Table" |
28+
"Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D" | "Ole" |
29+
"Placeholder" | "SmartArt" | "TextBox" | null;
2730
return:
28-
type: '<xref uid="powerpoint!PowerPoint.ShapeType:enum" /> | null'
31+
type: >-
32+
<xref uid="powerpoint!PowerPoint.ShapeType:enum" /> | "Unsupported" | "Image" | "GeometricShape" | "Group" |
33+
"Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" |
34+
"Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null
2935
- name: type
3036
uid: 'powerpoint!PowerPoint.Interfaces.PlaceholderFormatData#type:member'
3137
package: powerpoint!

‎docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.placeholderformat.yml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,15 @@ properties:
2525
isPreview: true
2626
isDeprecated: false
2727
syntax:
28-
content: 'readonly containedType: ShapeType | null;'
28+
content: >-
29+
readonly containedType: PowerPoint.ShapeType | "Unsupported" | "Image" | "GeometricShape" | "Group" | "Line" |
30+
"Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" | "Model3D"
31+
| "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null;
2932
return:
30-
type: '<xref uid="powerpoint!PowerPoint.ShapeType:enum" /> | null'
33+
type: >-
34+
<xref uid="powerpoint!PowerPoint.ShapeType:enum" /> | "Unsupported" | "Image" | "GeometricShape" | "Group" |
35+
"Line" | "Table" | "Callout" | "Chart" | "ContentApp" | "Diagram" | "Freeform" | "Graphic" | "Ink" | "Media" |
36+
"Model3D" | "Ole" | "Placeholder" | "SmartArt" | "TextBox" | null
3137
- name: context
3238
uid: 'powerpoint!PowerPoint.PlaceholderFormat#context:member'
3339
package: powerpoint!

‎docs/docs-ref-autogen/word/toc.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,10 @@ items:
113113
uid: 'word!Word.ShapeTextOrientation:enum'
114114
- name: ShapeTextVerticalAlignment
115115
uid: 'word!Word.ShapeTextVerticalAlignment:enum'
116+
- name: ShapeTextWrapSide
117+
uid: 'word!Word.ShapeTextWrapSide:enum'
118+
- name: ShapeTextWrapType
119+
uid: 'word!Word.ShapeTextWrapType:enum'
116120
- name: ShapeType
117121
uid: 'word!Word.ShapeType:enum'
118122
- name: StyleType
@@ -295,6 +299,8 @@ items:
295299
uid: 'word!Word.ShapeFill:class'
296300
- name: ShapeGroup
297301
uid: 'word!Word.ShapeGroup:class'
302+
- name: ShapeTextWrap
303+
uid: 'word!Word.ShapeTextWrap:class'
298304
- name: Style
299305
uid: 'word!Word.Style:class'
300306
- name: StyleCollection

‎docs/docs-ref-autogen/word/word.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ enums:
5151
- 'word!Word.ShapeFillType:enum'
5252
- 'word!Word.ShapeTextOrientation:enum'
5353
- 'word!Word.ShapeTextVerticalAlignment:enum'
54+
- 'word!Word.ShapeTextWrapSide:enum'
55+
- 'word!Word.ShapeTextWrapType:enum'
5456
- 'word!Word.ShapeType:enum'
5557
- 'word!Word.StyleType:enum'
5658
- 'word!Word.TrackedChangeType:enum'
@@ -119,6 +121,7 @@ classes:
119121
- 'word!Word.ShapeCollection:class'
120122
- 'word!Word.ShapeFill:class'
121123
- 'word!Word.ShapeGroup:class'
124+
- 'word!Word.ShapeTextWrap:class'
122125
- 'word!Word.Style:class'
123126
- 'word!Word.StyleCollection:class'
124127
- 'word!Word.Table:class'
@@ -321,6 +324,9 @@ interfaces:
321324
- 'word!Word.Interfaces.ShapeGroupLoadOptions:interface'
322325
- 'word!Word.Interfaces.ShapeGroupUpdateData:interface'
323326
- 'word!Word.Interfaces.ShapeLoadOptions:interface'
327+
- 'word!Word.Interfaces.ShapeTextWrapData:interface'
328+
- 'word!Word.Interfaces.ShapeTextWrapLoadOptions:interface'
329+
- 'word!Word.Interfaces.ShapeTextWrapUpdateData:interface'
324330
- 'word!Word.Interfaces.ShapeUpdateData:interface'
325331
- 'word!Word.Interfaces.StyleCollectionData:interface'
326332
- 'word!Word.Interfaces.StyleCollectionLoadOptions:interface'

‎docs/docs-ref-autogen/word/word/word.interfaces.paragraphupdatedata.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Word.Interfaces.ParagraphUpdateData
33
uid: 'word!Word.Interfaces.ParagraphUpdateData:interface'
44
package: word!
55
fullName: Word.Interfaces.ParagraphUpdateData
6-
summary: ''
6+
summary: 'An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`<!-- -->.'
77
remarks: ''
88
isPreview: false
99
isDeprecated: false

‎docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ properties:
9090
fullName: shapes
9191
summary: >-
9292
Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently,
93-
only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
93+
only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
9494
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
9595
isPreview: true
9696
isDeprecated: false

‎docs/docs-ref-autogen/word/word/word.interfaces.shapecollectionloadoptions.yml

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,18 @@ properties:
2525
content: '$all?: boolean;'
2626
return:
2727
type: boolean
28+
- name: allowOverlap
29+
uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#allowOverlap:member'
30+
package: word!
31+
fullName: allowOverlap
32+
summary: 'For EACH ITEM in the collection: Specifies whether a given shape can overlap other shapes.'
33+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
34+
isPreview: true
35+
isDeprecated: false
36+
syntax:
37+
content: 'allowOverlap?: boolean;'
38+
return:
39+
type: boolean
2840
- name: body
2941
uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#body:member'
3042
package: word!
@@ -60,7 +72,7 @@ properties:
6072
uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#fill:member'
6173
package: word!
6274
fullName: fill
63-
summary: 'For EACH ITEM in the collection: Returns the fill formatting of this shape.'
75+
summary: 'For EACH ITEM in the collection: Returns the fill formatting of the shape.'
6476
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
6577
isPreview: true
6678
isDeprecated: false
@@ -231,6 +243,18 @@ properties:
231243
content: 'textFrame?: Word.Interfaces.TextFrameLoadOptions;'
232244
return:
233245
type: '<xref uid="word!Word.Interfaces.TextFrameLoadOptions:interface" />'
246+
- name: textWrap
247+
uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#textWrap:member'
248+
package: word!
249+
fullName: textWrap
250+
summary: 'For EACH ITEM in the collection: Returns the text wrap formatting of the shape.'
251+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
252+
isPreview: true
253+
isDeprecated: false
254+
syntax:
255+
content: 'textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;'
256+
return:
257+
type: '<xref uid="word!Word.Interfaces.ShapeTextWrapLoadOptions:interface" />'
234258
- name: top
235259
uid: 'word!Word.Interfaces.ShapeCollectionLoadOptions#top:member'
236260
package: word!

‎docs/docs-ref-autogen/word/word/word.interfaces.shapedata.yml

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ isPreview: false
99
isDeprecated: false
1010
type: interface
1111
properties:
12+
- name: allowOverlap
13+
uid: 'word!Word.Interfaces.ShapeData#allowOverlap:member'
14+
package: word!
15+
fullName: allowOverlap
16+
summary: Specifies whether a given shape can overlap other shapes.
17+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
18+
isPreview: true
19+
isDeprecated: false
20+
syntax:
21+
content: 'allowOverlap?: boolean;'
22+
return:
23+
type: boolean
1224
- name: body
1325
uid: 'word!Word.Interfaces.ShapeData#body:member'
1426
package: word!
@@ -41,7 +53,7 @@ properties:
4153
uid: 'word!Word.Interfaces.ShapeData#fill:member'
4254
package: word!
4355
fullName: fill
44-
summary: Returns the fill formatting of this shape.
56+
summary: Returns the fill formatting of the shape.
4557
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
4658
isPreview: true
4759
isDeprecated: false
@@ -275,6 +287,18 @@ properties:
275287
content: 'textFrame?: Word.Interfaces.TextFrameData;'
276288
return:
277289
type: '<xref uid="word!Word.Interfaces.TextFrameData:interface" />'
290+
- name: textWrap
291+
uid: 'word!Word.Interfaces.ShapeData#textWrap:member'
292+
package: word!
293+
fullName: textWrap
294+
summary: Returns the text wrap formatting of the shape.
295+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
296+
isPreview: true
297+
isDeprecated: false
298+
syntax:
299+
content: 'textWrap?: Word.Interfaces.ShapeTextWrapData;'
300+
return:
301+
type: '<xref uid="word!Word.Interfaces.ShapeTextWrapData:interface" />'
278302
- name: top
279303
uid: 'word!Word.Interfaces.ShapeData#top:member'
280304
package: word!

‎docs/docs-ref-autogen/word/word/word.interfaces.shapeloadoptions.yml

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ package: word!
55
fullName: Word.Interfaces.ShapeLoadOptions
66
summary: >-
77
Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text
8-
boxes, geometric shapes, groups, pictures and canvases.
8+
boxes, geometric shapes, groups, pictures, and canvases.
99
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
1010
isPreview: true
1111
isDeprecated: false
@@ -25,6 +25,18 @@ properties:
2525
content: '$all?: boolean;'
2626
return:
2727
type: boolean
28+
- name: allowOverlap
29+
uid: 'word!Word.Interfaces.ShapeLoadOptions#allowOverlap:member'
30+
package: word!
31+
fullName: allowOverlap
32+
summary: Specifies whether a given shape can overlap other shapes.
33+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
34+
isPreview: true
35+
isDeprecated: false
36+
syntax:
37+
content: 'allowOverlap?: boolean;'
38+
return:
39+
type: boolean
2840
- name: body
2941
uid: 'word!Word.Interfaces.ShapeLoadOptions#body:member'
3042
package: word!
@@ -57,7 +69,7 @@ properties:
5769
uid: 'word!Word.Interfaces.ShapeLoadOptions#fill:member'
5870
package: word!
5971
fullName: fill
60-
summary: Returns the fill formatting of this shape.
72+
summary: Returns the fill formatting of the shape.
6173
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
6274
isPreview: true
6375
isDeprecated: false
@@ -220,6 +232,18 @@ properties:
220232
content: 'textFrame?: Word.Interfaces.TextFrameLoadOptions;'
221233
return:
222234
type: '<xref uid="word!Word.Interfaces.TextFrameLoadOptions:interface" />'
235+
- name: textWrap
236+
uid: 'word!Word.Interfaces.ShapeLoadOptions#textWrap:member'
237+
package: word!
238+
fullName: textWrap
239+
summary: Returns the text wrap formatting of the shape.
240+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
241+
isPreview: true
242+
isDeprecated: false
243+
syntax:
244+
content: 'textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;'
245+
return:
246+
type: '<xref uid="word!Word.Interfaces.ShapeTextWrapLoadOptions:interface" />'
223247
- name: top
224248
uid: 'word!Word.Interfaces.ShapeLoadOptions#top:member'
225249
package: word!

‎docs/docs-ref-autogen/word/word/word.interfaces.shapetextwrapdata.yml

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
### YamlMime:TSType
2+
name: Word.Interfaces.ShapeTextWrapData
3+
uid: 'word!Word.Interfaces.ShapeTextWrapData:interface'
4+
package: word!
5+
fullName: Word.Interfaces.ShapeTextWrapData
6+
summary: An interface describing the data returned by calling `shapeTextWrap.toJSON()`<!-- -->.
7+
remarks: ''
8+
isPreview: false
9+
isDeprecated: false
10+
type: interface
11+
properties:
12+
- name: bottomDistance
13+
uid: 'word!Word.Interfaces.ShapeTextWrapData#bottomDistance:member'
14+
package: word!
15+
fullName: bottomDistance
16+
summary: >-
17+
Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding
18+
the specified shape.
19+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
20+
isPreview: true
21+
isDeprecated: false
22+
syntax:
23+
content: 'bottomDistance?: number;'
24+
return:
25+
type: number
26+
- name: leftDistance
27+
uid: 'word!Word.Interfaces.ShapeTextWrapData#leftDistance:member'
28+
package: word!
29+
fullName: leftDistance
30+
summary: >-
31+
Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding
32+
the specified shape.
33+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
34+
isPreview: true
35+
isDeprecated: false
36+
syntax:
37+
content: 'leftDistance?: number;'
38+
return:
39+
type: number
40+
- name: rightDistance
41+
uid: 'word!Word.Interfaces.ShapeTextWrapData#rightDistance:member'
42+
package: word!
43+
fullName: rightDistance
44+
summary: >-
45+
Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding
46+
the specified shape.
47+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
48+
isPreview: true
49+
isDeprecated: false
50+
syntax:
51+
content: 'rightDistance?: number;'
52+
return:
53+
type: number
54+
- name: side
55+
uid: 'word!Word.Interfaces.ShapeTextWrapData#side:member'
56+
package: word!
57+
fullName: side
58+
summary: >-
59+
Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right
60+
side only, or on the side of the shape that's farthest from the page margin.
61+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
62+
isPreview: true
63+
isDeprecated: false
64+
syntax:
65+
content: 'side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";'
66+
return:
67+
type: '<xref uid="word!Word.ShapeTextWrapSide:enum" /> | "None" | "Both" | "Left" | "Right" | "Largest"'
68+
- name: topDistance
69+
uid: 'word!Word.Interfaces.ShapeTextWrapData#topDistance:member'
70+
package: word!
71+
fullName: topDistance
72+
summary: >-
73+
Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding
74+
the specified shape.
75+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
76+
isPreview: true
77+
isDeprecated: false
78+
syntax:
79+
content: 'topDistance?: number;'
80+
return:
81+
type: number
82+
- name: type
83+
uid: 'word!Word.Interfaces.ShapeTextWrapData#type:member'
84+
package: word!
85+
fullName: type
86+
summary: Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details.
87+
remarks: '\[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \]'
88+
isPreview: true
89+
isDeprecated: false
90+
syntax:
91+
content: 'type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";'
92+
return:
93+
type: >-
94+
<xref uid="word!Word.ShapeTextWrapType:enum" /> | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" |
95+
"Behind" | "Front"

0 commit comments

Comments
 (0)