@types/office-js 1.0.473 → 1.0.475
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +214 -103
- office-js/package.json +2 -2
office-js/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Fri, 07 Mar 2025 19:02:31 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -241,6 +241,10 @@ declare namespace Office {
|
|
|
241
241
|
* Represents the Auth interface.
|
|
242
242
|
*/
|
|
243
243
|
const auth: Auth;
|
|
244
|
+
/**
|
|
245
|
+
* Represents the context menu object associated with the Office application.
|
|
246
|
+
*/
|
|
247
|
+
const contextMenu: ContextMenu;
|
|
244
248
|
/**
|
|
245
249
|
* Represents the Device Permission interface.
|
|
246
250
|
*/
|
|
@@ -4744,12 +4748,71 @@ declare namespace Office {
|
|
|
4744
4748
|
*/
|
|
4745
4749
|
version: string;
|
|
4746
4750
|
}
|
|
4751
|
+
/**
|
|
4752
|
+
* Provides options to manage the state of the Office context menu.
|
|
4753
|
+
*
|
|
4754
|
+
* To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands}.
|
|
4755
|
+
*
|
|
4756
|
+
* @remarks
|
|
4757
|
+
*
|
|
4758
|
+
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets | ContextMenuApi 1.1}
|
|
4759
|
+
*/
|
|
4760
|
+
interface ContextMenu {
|
|
4761
|
+
/**
|
|
4762
|
+
* Sends a request to Office to update the context menu.
|
|
4763
|
+
*
|
|
4764
|
+
* @remarks
|
|
4765
|
+
*
|
|
4766
|
+
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets | ContextMenuApi 1.1}
|
|
4767
|
+
*
|
|
4768
|
+
* **Important**: This API is only used to request an update. The actual UI update to the context menu is controlled by the Office application,
|
|
4769
|
+
* so the exact timing of the context menu update (or refresh) can't be determined by the completion of this API.
|
|
4770
|
+
*
|
|
4771
|
+
* @param input - Represents the updates to be made to the context menu controls. Only the changes specified in the `control` parameter are made.
|
|
4772
|
+
* Other context menu controls that aren't specified remain as is in the Office application.
|
|
4773
|
+
*/
|
|
4774
|
+
requestUpdate(input: ContextMenuUpdaterData): Promise<void>;
|
|
4775
|
+
}
|
|
4776
|
+
/**
|
|
4777
|
+
* Represents an individual context menu control and its state.
|
|
4778
|
+
*
|
|
4779
|
+
* To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands}.
|
|
4780
|
+
*
|
|
4781
|
+
* @remarks
|
|
4782
|
+
*
|
|
4783
|
+
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets | ContextMenuApi 1.1}
|
|
4784
|
+
*/
|
|
4785
|
+
interface ContextMenuControl {
|
|
4786
|
+
/**
|
|
4787
|
+
* Identifier of the context menu control as specified in the manifest.
|
|
4788
|
+
*/
|
|
4789
|
+
id: string;
|
|
4790
|
+
/**
|
|
4791
|
+
* Indicates whether the control is available on the context menu.
|
|
4792
|
+
*/
|
|
4793
|
+
enabled?: boolean;
|
|
4794
|
+
}
|
|
4795
|
+
/**
|
|
4796
|
+
* Represents the changes to the context menu.
|
|
4797
|
+
*
|
|
4798
|
+
* To learn more, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands}.
|
|
4799
|
+
*
|
|
4800
|
+
* @remarks
|
|
4801
|
+
*
|
|
4802
|
+
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/context-menu-api-requirement-sets | ContextMenuApi 1.1}
|
|
4803
|
+
*/
|
|
4804
|
+
interface ContextMenuUpdaterData {
|
|
4805
|
+
/**
|
|
4806
|
+
* Collection of context menu controls whose state is set using `Office.contextMenu.requestUpdate`.
|
|
4807
|
+
*/
|
|
4808
|
+
controls: ContextMenuControl[];
|
|
4809
|
+
}
|
|
4747
4810
|
/**
|
|
4748
4811
|
* Represents an individual control or command and the state it should have.
|
|
4749
4812
|
*
|
|
4750
4813
|
* @remarks
|
|
4751
4814
|
*
|
|
4752
|
-
* For code samples showing how to use a `Control` object and its properties, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands |
|
|
4815
|
+
* For code samples showing how to use a `Control` object and its properties, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
|
|
4753
4816
|
*
|
|
4754
4817
|
* **Requirement set**: {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/ribbon-api-requirement-sets | RibbonApi 1.1}
|
|
4755
4818
|
*/
|
|
@@ -7189,7 +7252,7 @@ declare namespace Office {
|
|
|
7189
7252
|
*
|
|
7190
7253
|
* Note that this API is only to request an update. The actual UI update to the ribbon is controlled by the Office application and hence the exact timing of the ribbon update (or refresh) cannot be determined by the completion of this API.
|
|
7191
7254
|
*
|
|
7192
|
-
* For code examples, see
|
|
7255
|
+
* For code examples, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
|
|
7193
7256
|
*
|
|
7194
7257
|
* @param input - Represents the updates to be made to the ribbon. Note that only the changes specified in the input parameter are made.
|
|
7195
7258
|
*/
|
|
@@ -7736,7 +7799,7 @@ declare namespace Office {
|
|
|
7736
7799
|
size: number;
|
|
7737
7800
|
}
|
|
7738
7801
|
/**
|
|
7739
|
-
* Represents an individual tab and the state it should have. For code examples, see
|
|
7802
|
+
* Represents an individual tab and the state it should have. For code examples, see {@link https://learn.microsoft.com/office/dev/add-ins/design/disable-add-in-commands | Change the availability of add-in commands} and {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
|
|
7740
7803
|
*
|
|
7741
7804
|
* @remarks
|
|
7742
7805
|
*
|
|
@@ -96415,7 +96478,7 @@ declare namespace Word {
|
|
|
96415
96478
|
toJSON(): Word.Interfaces.TrackedChangeCollectionData;
|
|
96416
96479
|
}
|
|
96417
96480
|
/**
|
|
96418
|
-
* Represents a shape in the header, footer or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
96481
|
+
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
96419
96482
|
*
|
|
96420
96483
|
* @remarks
|
|
96421
96484
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -96571,7 +96634,7 @@ declare namespace Word {
|
|
|
96571
96634
|
*/
|
|
96572
96635
|
relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
96573
96636
|
/**
|
|
96574
|
-
* The relative vertical position of the shape. For an inline shape, it can't be set. For details,
|
|
96637
|
+
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
96575
96638
|
*
|
|
96576
96639
|
* @remarks
|
|
96577
96640
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -96592,7 +96655,7 @@ declare namespace Word {
|
|
|
96592
96655
|
*/
|
|
96593
96656
|
rotation: number;
|
|
96594
96657
|
/**
|
|
96595
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position,
|
|
96658
|
+
* The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
96596
96659
|
*
|
|
96597
96660
|
* @remarks
|
|
96598
96661
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -96829,9 +96892,9 @@ declare namespace Word {
|
|
|
96829
96892
|
*/
|
|
96830
96893
|
untrack(): Word.ShapeGroup;
|
|
96831
96894
|
/**
|
|
96832
|
-
|
|
96833
|
-
|
|
96834
|
-
|
|
96895
|
+
* 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.)
|
|
96896
|
+
* Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object.
|
|
96897
|
+
*/
|
|
96835
96898
|
toJSON(): Word.Interfaces.ShapeGroupData;
|
|
96836
96899
|
}
|
|
96837
96900
|
/**
|
|
@@ -96908,7 +96971,7 @@ declare namespace Word {
|
|
|
96908
96971
|
toJSON(): Word.Interfaces.CanvasData;
|
|
96909
96972
|
}
|
|
96910
96973
|
/**
|
|
96911
|
-
* Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
96974
|
+
* Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
96912
96975
|
*
|
|
96913
96976
|
* @remarks
|
|
96914
96977
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -104336,7 +104399,7 @@ declare namespace Word {
|
|
|
104336
104399
|
*/
|
|
104337
104400
|
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
104338
104401
|
/**
|
|
104339
|
-
* The relative vertical position of the shape. For an inline shape, it can't be set. For details,
|
|
104402
|
+
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
104340
104403
|
*
|
|
104341
104404
|
* @remarks
|
|
104342
104405
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -104357,7 +104420,7 @@ declare namespace Word {
|
|
|
104357
104420
|
*/
|
|
104358
104421
|
rotation?: number;
|
|
104359
104422
|
/**
|
|
104360
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position,
|
|
104423
|
+
* The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
104361
104424
|
*
|
|
104362
104425
|
* @remarks
|
|
104363
104426
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -104395,11 +104458,11 @@ declare namespace Word {
|
|
|
104395
104458
|
/** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */
|
|
104396
104459
|
interface ShapeGroupUpdateData {
|
|
104397
104460
|
/**
|
|
104398
|
-
|
|
104399
|
-
|
|
104400
|
-
|
|
104401
|
-
|
|
104402
|
-
|
|
104461
|
+
* Gets the Shape object associated with the group.
|
|
104462
|
+
*
|
|
104463
|
+
* @remarks
|
|
104464
|
+
* [Api set: WordApiDesktop 1.2]
|
|
104465
|
+
*/
|
|
104403
104466
|
shape?: Word.Interfaces.ShapeUpdateData;
|
|
104404
104467
|
}
|
|
104405
104468
|
/** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */
|
|
@@ -105888,7 +105951,7 @@ declare namespace Word {
|
|
|
105888
105951
|
*/
|
|
105889
105952
|
listItemOrNullObject?: Word.Interfaces.ListItemData;
|
|
105890
105953
|
/**
|
|
105891
|
-
* Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
105954
|
+
* Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
105892
105955
|
*
|
|
105893
105956
|
* @remarks
|
|
105894
105957
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -107006,7 +107069,7 @@ declare namespace Word {
|
|
|
107006
107069
|
*/
|
|
107007
107070
|
relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";
|
|
107008
107071
|
/**
|
|
107009
|
-
* The relative vertical position of the shape. For an inline shape, it can't be set. For details,
|
|
107072
|
+
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
107010
107073
|
*
|
|
107011
107074
|
* @remarks
|
|
107012
107075
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -107027,7 +107090,7 @@ declare namespace Word {
|
|
|
107027
107090
|
*/
|
|
107028
107091
|
rotation?: number;
|
|
107029
107092
|
/**
|
|
107030
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position,
|
|
107093
|
+
* The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
107031
107094
|
*
|
|
107032
107095
|
* @remarks
|
|
107033
107096
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -107072,18 +107135,18 @@ declare namespace Word {
|
|
|
107072
107135
|
/** An interface describing the data returned by calling `shapeGroup.toJSON()`. */
|
|
107073
107136
|
interface ShapeGroupData {
|
|
107074
107137
|
/**
|
|
107075
|
-
|
|
107076
|
-
|
|
107077
|
-
|
|
107078
|
-
|
|
107079
|
-
|
|
107138
|
+
* Gets the Shape object associated with the group.
|
|
107139
|
+
*
|
|
107140
|
+
* @remarks
|
|
107141
|
+
* [Api set: WordApiDesktop 1.2]
|
|
107142
|
+
*/
|
|
107080
107143
|
shape?: Word.Interfaces.ShapeData;
|
|
107081
107144
|
/**
|
|
107082
|
-
|
|
107083
|
-
|
|
107084
|
-
|
|
107085
|
-
|
|
107086
|
-
|
|
107145
|
+
* Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported.
|
|
107146
|
+
*
|
|
107147
|
+
* @remarks
|
|
107148
|
+
* [Api set: WordApiDesktop 1.2]
|
|
107149
|
+
*/
|
|
107087
107150
|
shapes?: Word.Interfaces.ShapeData[];
|
|
107088
107151
|
/**
|
|
107089
107152
|
* Gets an integer that represents the shape group identifier.
|
|
@@ -107096,18 +107159,18 @@ declare namespace Word {
|
|
|
107096
107159
|
/** An interface describing the data returned by calling `canvas.toJSON()`. */
|
|
107097
107160
|
interface CanvasData {
|
|
107098
107161
|
/**
|
|
107099
|
-
|
|
107100
|
-
|
|
107101
|
-
|
|
107102
|
-
|
|
107103
|
-
|
|
107162
|
+
* Gets the Shape object associated with the canvas.
|
|
107163
|
+
*
|
|
107164
|
+
* @remarks
|
|
107165
|
+
* [Api set: WordApiDesktop 1.2]
|
|
107166
|
+
*/
|
|
107104
107167
|
shape?: Word.Interfaces.ShapeData;
|
|
107105
107168
|
/**
|
|
107106
|
-
|
|
107107
|
-
|
|
107108
|
-
|
|
107109
|
-
|
|
107110
|
-
|
|
107169
|
+
* Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported.
|
|
107170
|
+
*
|
|
107171
|
+
* @remarks
|
|
107172
|
+
* [Api set: WordApiDesktop 1.2]
|
|
107173
|
+
*/
|
|
107111
107174
|
shapes?: Word.Interfaces.ShapeData[];
|
|
107112
107175
|
/**
|
|
107113
107176
|
* Gets an integer that represents the canvas identifier.
|
|
@@ -111692,7 +111755,7 @@ declare namespace Word {
|
|
|
111692
111755
|
type?: boolean;
|
|
111693
111756
|
}
|
|
111694
111757
|
/**
|
|
111695
|
-
* Represents a shape in the header, footer or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures and canvases.
|
|
111758
|
+
* Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases.
|
|
111696
111759
|
*
|
|
111697
111760
|
* @remarks
|
|
111698
111761
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -111759,11 +111822,11 @@ declare namespace Word {
|
|
|
111759
111822
|
*/
|
|
111760
111823
|
textWrap?: Word.Interfaces.ShapeTextWrapLoadOptions;
|
|
111761
111824
|
/**
|
|
111762
|
-
|
|
111763
|
-
|
|
111764
|
-
|
|
111765
|
-
|
|
111766
|
-
|
|
111825
|
+
* Specifies whether a given shape can overlap other shapes.
|
|
111826
|
+
*
|
|
111827
|
+
* @remarks
|
|
111828
|
+
* [Api set: WordApiDesktop 1.2]
|
|
111829
|
+
*/
|
|
111767
111830
|
allowOverlap?: boolean;
|
|
111768
111831
|
/**
|
|
111769
111832
|
* Specifies a string that represents the alternative text associated with the shape.
|
|
@@ -111850,7 +111913,7 @@ declare namespace Word {
|
|
|
111850
111913
|
*/
|
|
111851
111914
|
relativeHorizontalSize?: boolean;
|
|
111852
111915
|
/**
|
|
111853
|
-
* The relative vertical position of the shape. For an inline shape, it can't be set. For details,
|
|
111916
|
+
* The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
111854
111917
|
*
|
|
111855
111918
|
* @remarks
|
|
111856
111919
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -111871,7 +111934,7 @@ declare namespace Word {
|
|
|
111871
111934
|
*/
|
|
111872
111935
|
rotation?: boolean;
|
|
111873
111936
|
/**
|
|
111874
|
-
* The distance, in points, from the top edge of the shape to the vertical relative position,
|
|
111937
|
+
* The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
111875
111938
|
*
|
|
111876
111939
|
* @remarks
|
|
111877
111940
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -112124,7 +112187,7 @@ declare namespace Word {
|
|
|
112124
112187
|
*/
|
|
112125
112188
|
relativeHorizontalSize?: boolean;
|
|
112126
112189
|
/**
|
|
112127
|
-
* For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details,
|
|
112190
|
+
* For EACH ITEM in the collection: The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}.
|
|
112128
112191
|
*
|
|
112129
112192
|
* @remarks
|
|
112130
112193
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -112145,7 +112208,7 @@ declare namespace Word {
|
|
|
112145
112208
|
*/
|
|
112146
112209
|
rotation?: boolean;
|
|
112147
112210
|
/**
|
|
112148
|
-
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position,
|
|
112211
|
+
* For EACH ITEM in the collection: The distance, in points, from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner.
|
|
112149
112212
|
*
|
|
112150
112213
|
* @remarks
|
|
112151
112214
|
* [Api set: WordApiDesktop 1.2]
|
|
@@ -124775,7 +124838,13 @@ declare namespace PowerPoint {
|
|
|
124775
124838
|
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
124776
124839
|
context: RequestContext;
|
|
124777
124840
|
/**
|
|
124778
|
-
* Specifies the
|
|
124841
|
+
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
124842
|
+
*
|
|
124843
|
+
* - `true`: All the text is bold.
|
|
124844
|
+
*
|
|
124845
|
+
* - `false`: None of the text is bold.
|
|
124846
|
+
*
|
|
124847
|
+
* - `null`: Returned if some, but not all, of the text is bold.
|
|
124779
124848
|
*
|
|
124780
124849
|
* @remarks
|
|
124781
124850
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -124789,7 +124858,13 @@ declare namespace PowerPoint {
|
|
|
124789
124858
|
*/
|
|
124790
124859
|
color: string | null;
|
|
124791
124860
|
/**
|
|
124792
|
-
* Specifies the
|
|
124861
|
+
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
124862
|
+
*
|
|
124863
|
+
* - `true`: All the text is italicized.
|
|
124864
|
+
*
|
|
124865
|
+
* - `false`: None of the text is italicized.
|
|
124866
|
+
*
|
|
124867
|
+
* - `null`: Returned if some, but not all, of the text is italicized.
|
|
124793
124868
|
*
|
|
124794
124869
|
* @remarks
|
|
124795
124870
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -126816,7 +126891,13 @@ declare namespace PowerPoint {
|
|
|
126816
126891
|
/** An interface for updating data on the `ShapeFont` object, for use in `shapeFont.set({ ... })`. */
|
|
126817
126892
|
interface ShapeFontUpdateData {
|
|
126818
126893
|
/**
|
|
126819
|
-
* Specifies the
|
|
126894
|
+
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
126895
|
+
*
|
|
126896
|
+
* - `true`: All the text is bold.
|
|
126897
|
+
*
|
|
126898
|
+
* - `false`: None of the text is bold.
|
|
126899
|
+
*
|
|
126900
|
+
* - `null`: Returned if some, but not all, of the text is bold.
|
|
126820
126901
|
*
|
|
126821
126902
|
* @remarks
|
|
126822
126903
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -126830,7 +126911,13 @@ declare namespace PowerPoint {
|
|
|
126830
126911
|
*/
|
|
126831
126912
|
color?: string | null;
|
|
126832
126913
|
/**
|
|
126833
|
-
* Specifies the
|
|
126914
|
+
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
126915
|
+
*
|
|
126916
|
+
* - `true`: All the text is italicized.
|
|
126917
|
+
*
|
|
126918
|
+
* - `false`: None of the text is italicized.
|
|
126919
|
+
*
|
|
126920
|
+
* - `null`: Returned if some, but not all, of the text is italicized.
|
|
126834
126921
|
*
|
|
126835
126922
|
* @remarks
|
|
126836
126923
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -127242,7 +127329,13 @@ declare namespace PowerPoint {
|
|
|
127242
127329
|
/** An interface describing the data returned by calling `shapeFont.toJSON()`. */
|
|
127243
127330
|
interface ShapeFontData {
|
|
127244
127331
|
/**
|
|
127245
|
-
* Specifies the
|
|
127332
|
+
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
127333
|
+
*
|
|
127334
|
+
* - `true`: All the text is bold.
|
|
127335
|
+
*
|
|
127336
|
+
* - `false`: None of the text is bold.
|
|
127337
|
+
*
|
|
127338
|
+
* - `null`: Returned if some, but not all, of the text is bold.
|
|
127246
127339
|
*
|
|
127247
127340
|
* @remarks
|
|
127248
127341
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -127256,7 +127349,13 @@ declare namespace PowerPoint {
|
|
|
127256
127349
|
*/
|
|
127257
127350
|
color?: string | null;
|
|
127258
127351
|
/**
|
|
127259
|
-
* Specifies the
|
|
127352
|
+
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
127353
|
+
*
|
|
127354
|
+
* - `true`: All the text is italicized.
|
|
127355
|
+
*
|
|
127356
|
+
* - `false`: None of the text is italicized.
|
|
127357
|
+
*
|
|
127358
|
+
* - `null`: Returned if some, but not all, of the text is italicized.
|
|
127260
127359
|
*
|
|
127261
127360
|
* @remarks
|
|
127262
127361
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -127886,7 +127985,13 @@ declare namespace PowerPoint {
|
|
|
127886
127985
|
*/
|
|
127887
127986
|
$all?: boolean;
|
|
127888
127987
|
/**
|
|
127889
|
-
* Specifies the
|
|
127988
|
+
* Specifies whether the text in the `TextRange` is set to bold. The possible values are as follows:
|
|
127989
|
+
*
|
|
127990
|
+
* - `true`: All the text is bold.
|
|
127991
|
+
*
|
|
127992
|
+
* - `false`: None of the text is bold.
|
|
127993
|
+
*
|
|
127994
|
+
* - `null`: Returned if some, but not all, of the text is bold.
|
|
127890
127995
|
*
|
|
127891
127996
|
* @remarks
|
|
127892
127997
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -127900,7 +128005,13 @@ declare namespace PowerPoint {
|
|
|
127900
128005
|
*/
|
|
127901
128006
|
color?: boolean;
|
|
127902
128007
|
/**
|
|
127903
|
-
* Specifies the
|
|
128008
|
+
* Specifies whether the text in the `TextRange` is set to italic. The possible values are as follows:
|
|
128009
|
+
*
|
|
128010
|
+
* - `true`: All the text is italicized.
|
|
128011
|
+
*
|
|
128012
|
+
* - `false`: None of the text is italicized.
|
|
128013
|
+
*
|
|
128014
|
+
* - `null`: Returned if some, but not all, of the text is italicized.
|
|
127904
128015
|
*
|
|
127905
128016
|
* @remarks
|
|
127906
128017
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -127940,25 +128051,25 @@ declare namespace PowerPoint {
|
|
|
127940
128051
|
*/
|
|
127941
128052
|
$all?: boolean;
|
|
127942
128053
|
/**
|
|
127943
|
-
|
|
127944
|
-
|
|
127945
|
-
|
|
127946
|
-
|
|
127947
|
-
|
|
128054
|
+
* For EACH ITEM in the collection: Returns the fill formatting of this shape.
|
|
128055
|
+
*
|
|
128056
|
+
* @remarks
|
|
128057
|
+
* [Api set: PowerPointApi 1.4]
|
|
128058
|
+
*/
|
|
127948
128059
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
127949
128060
|
/**
|
|
127950
|
-
|
|
127951
|
-
|
|
127952
|
-
|
|
127953
|
-
|
|
127954
|
-
|
|
128061
|
+
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
128062
|
+
*
|
|
128063
|
+
* @remarks
|
|
128064
|
+
* [Api set: PowerPointApi 1.4]
|
|
128065
|
+
*/
|
|
127955
128066
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
127956
128067
|
/**
|
|
127957
|
-
|
|
127958
|
-
|
|
127959
|
-
|
|
127960
|
-
|
|
127961
|
-
|
|
128068
|
+
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
128069
|
+
*
|
|
128070
|
+
* @remarks
|
|
128071
|
+
* [Api set: PowerPointApi 1.4]
|
|
128072
|
+
*/
|
|
127962
128073
|
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
127963
128074
|
/**
|
|
127964
128075
|
* For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
@@ -128185,25 +128296,25 @@ declare namespace PowerPoint {
|
|
|
128185
128296
|
*/
|
|
128186
128297
|
$all?: boolean;
|
|
128187
128298
|
/**
|
|
128188
|
-
|
|
128189
|
-
|
|
128190
|
-
|
|
128191
|
-
|
|
128192
|
-
|
|
128299
|
+
* For EACH ITEM in the collection: Returns the fill formatting of this shape.
|
|
128300
|
+
*
|
|
128301
|
+
* @remarks
|
|
128302
|
+
* [Api set: PowerPointApi 1.5]
|
|
128303
|
+
*/
|
|
128193
128304
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
128194
128305
|
/**
|
|
128195
|
-
|
|
128196
|
-
|
|
128197
|
-
|
|
128198
|
-
|
|
128199
|
-
|
|
128306
|
+
* For EACH ITEM in the collection: Returns the line formatting of this shape.
|
|
128307
|
+
*
|
|
128308
|
+
* @remarks
|
|
128309
|
+
* [Api set: PowerPointApi 1.5]
|
|
128310
|
+
*/
|
|
128200
128311
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
128201
128312
|
/**
|
|
128202
|
-
|
|
128203
|
-
|
|
128204
|
-
|
|
128205
|
-
|
|
128206
|
-
|
|
128313
|
+
* For EACH ITEM in the collection: Returns the text frame object of this shape.
|
|
128314
|
+
*
|
|
128315
|
+
* @remarks
|
|
128316
|
+
* [Api set: PowerPointApi 1.5]
|
|
128317
|
+
*/
|
|
128207
128318
|
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
128208
128319
|
/**
|
|
128209
128320
|
* For EACH ITEM in the collection: Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
@@ -128490,25 +128601,25 @@ declare namespace PowerPoint {
|
|
|
128490
128601
|
*/
|
|
128491
128602
|
$all?: boolean;
|
|
128492
128603
|
/**
|
|
128493
|
-
|
|
128494
|
-
|
|
128495
|
-
|
|
128496
|
-
|
|
128497
|
-
|
|
128604
|
+
* Returns the fill formatting of this shape.
|
|
128605
|
+
*
|
|
128606
|
+
* @remarks
|
|
128607
|
+
* [Api set: PowerPointApi 1.4]
|
|
128608
|
+
*/
|
|
128498
128609
|
fill?: PowerPoint.Interfaces.ShapeFillLoadOptions;
|
|
128499
128610
|
/**
|
|
128500
|
-
|
|
128501
|
-
|
|
128502
|
-
|
|
128503
|
-
|
|
128504
|
-
|
|
128611
|
+
* Returns the line formatting of this shape.
|
|
128612
|
+
*
|
|
128613
|
+
* @remarks
|
|
128614
|
+
* [Api set: PowerPointApi 1.4]
|
|
128615
|
+
*/
|
|
128505
128616
|
lineFormat?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions;
|
|
128506
128617
|
/**
|
|
128507
|
-
|
|
128508
|
-
|
|
128509
|
-
|
|
128510
|
-
|
|
128511
|
-
|
|
128618
|
+
* Returns the text frame object of this shape.
|
|
128619
|
+
*
|
|
128620
|
+
* @remarks
|
|
128621
|
+
* [Api set: PowerPointApi 1.4]
|
|
128622
|
+
*/
|
|
128512
128623
|
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
128513
128624
|
/**
|
|
128514
128625
|
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
office-js/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.475",
|
|
4
4
|
"description": "TypeScript definitions for office-js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,6 +46,6 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "de6360fcfb86983b5df792a9927bac4cb2eea5042e8ff0f4f4750574d157e866",
|
|
50
50
|
"typeScriptVersion": "5.0"
|
|
51
51
|
}
|