@types/office-js-preview 1.0.661 → 1.0.663
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 +216 -0
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Fri, 07 Nov 2025 19:02:11 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js-preview/index.d.ts
CHANGED
|
@@ -288,6 +288,8 @@ declare namespace Office {
|
|
|
288
288
|
*/
|
|
289
289
|
function initialize(reason: InitializationReason): void;
|
|
290
290
|
/**
|
|
291
|
+
* **WARNING**: This API returns inaccurate values when used on desktop applications. Use `Office.context.requirements.isSetSupported` instead.
|
|
292
|
+
*
|
|
291
293
|
* Checks if the specified requirement set is supported by the Office application.
|
|
292
294
|
* @param name - Set name; e.g., "MatrixBindings".
|
|
293
295
|
* @param minVersion - The minimum required version; e.g., "1.4".
|
|
@@ -186769,6 +186771,16 @@ declare namespace PowerPoint {
|
|
|
186769
186771
|
* [Api set: PowerPointApi 1.0]
|
|
186770
186772
|
*/
|
|
186771
186773
|
readonly title: string;
|
|
186774
|
+
/**
|
|
186775
|
+
* Returns the current active {@link PowerPoint.Slide} that is visible in the editing area.
|
|
186776
|
+
If there's no active slide, an object with an `isNullObject` property set to `true` is returned.
|
|
186777
|
+
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}.
|
|
186778
|
+
*
|
|
186779
|
+
* @remarks
|
|
186780
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
186781
|
+
* @beta
|
|
186782
|
+
*/
|
|
186783
|
+
getActiveSlideOrNullObject(): PowerPoint.Slide;
|
|
186772
186784
|
/**
|
|
186773
186785
|
* Returns the selected shapes in the current slide of the presentation.
|
|
186774
186786
|
If no shapes are selected, an empty collection is returned.
|
|
@@ -194780,6 +194792,29 @@ declare namespace PowerPoint {
|
|
|
194780
194792
|
* [Api set: PowerPointApi 1.4]
|
|
194781
194793
|
*/
|
|
194782
194794
|
readonly textFrame: PowerPoint.TextFrame;
|
|
194795
|
+
/**
|
|
194796
|
+
* The alt text description of the Shape.
|
|
194797
|
+
|
|
194798
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
194799
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
194800
|
+
*
|
|
194801
|
+
* @remarks
|
|
194802
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
194803
|
+
* @beta
|
|
194804
|
+
*/
|
|
194805
|
+
altTextDescription: string;
|
|
194806
|
+
/**
|
|
194807
|
+
* The alt text title of the Shape.
|
|
194808
|
+
|
|
194809
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
194810
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
194811
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
194812
|
+
*
|
|
194813
|
+
* @remarks
|
|
194814
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
194815
|
+
* @beta
|
|
194816
|
+
*/
|
|
194817
|
+
altTextTitle: string;
|
|
194783
194818
|
/**
|
|
194784
194819
|
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
194785
194820
|
*
|
|
@@ -194802,6 +194837,17 @@ declare namespace PowerPoint {
|
|
|
194802
194837
|
* [Api set: PowerPointApi 1.3]
|
|
194803
194838
|
*/
|
|
194804
194839
|
readonly id: string;
|
|
194840
|
+
/**
|
|
194841
|
+
* Represents whether the shape is decorative or not.
|
|
194842
|
+
|
|
194843
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
194844
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
194845
|
+
*
|
|
194846
|
+
* @remarks
|
|
194847
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
194848
|
+
* @beta
|
|
194849
|
+
*/
|
|
194850
|
+
isDecorative: boolean;
|
|
194805
194851
|
/**
|
|
194806
194852
|
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
194807
194853
|
*
|
|
@@ -196549,6 +196595,29 @@ declare namespace PowerPoint {
|
|
|
196549
196595
|
}
|
|
196550
196596
|
/** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */
|
|
196551
196597
|
interface ShapeUpdateData {
|
|
196598
|
+
/**
|
|
196599
|
+
* The alt text description of the Shape.
|
|
196600
|
+
|
|
196601
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
196602
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
196603
|
+
*
|
|
196604
|
+
* @remarks
|
|
196605
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196606
|
+
* @beta
|
|
196607
|
+
*/
|
|
196608
|
+
altTextDescription?: string;
|
|
196609
|
+
/**
|
|
196610
|
+
* The alt text title of the Shape.
|
|
196611
|
+
|
|
196612
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
196613
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
196614
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
196615
|
+
*
|
|
196616
|
+
* @remarks
|
|
196617
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196618
|
+
* @beta
|
|
196619
|
+
*/
|
|
196620
|
+
altTextTitle?: string;
|
|
196552
196621
|
/**
|
|
196553
196622
|
* Specifies the height, in points, of the shape. Throws an `InvalidArgument` exception when set with a negative value.
|
|
196554
196623
|
*
|
|
@@ -196556,6 +196625,17 @@ declare namespace PowerPoint {
|
|
|
196556
196625
|
* [Api set: PowerPointApi 1.4]
|
|
196557
196626
|
*/
|
|
196558
196627
|
height?: number;
|
|
196628
|
+
/**
|
|
196629
|
+
* Represents whether the shape is decorative or not.
|
|
196630
|
+
|
|
196631
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
196632
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
196633
|
+
*
|
|
196634
|
+
* @remarks
|
|
196635
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
196636
|
+
* @beta
|
|
196637
|
+
*/
|
|
196638
|
+
isDecorative?: boolean;
|
|
196559
196639
|
/**
|
|
196560
196640
|
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
196561
196641
|
*
|
|
@@ -197651,6 +197731,29 @@ declare namespace PowerPoint {
|
|
|
197651
197731
|
}
|
|
197652
197732
|
/** An interface describing the data returned by calling `shape.toJSON()`. */
|
|
197653
197733
|
interface ShapeData {
|
|
197734
|
+
/**
|
|
197735
|
+
* The alt text description of the Shape.
|
|
197736
|
+
|
|
197737
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
197738
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
197739
|
+
*
|
|
197740
|
+
* @remarks
|
|
197741
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197742
|
+
* @beta
|
|
197743
|
+
*/
|
|
197744
|
+
altTextDescription?: string;
|
|
197745
|
+
/**
|
|
197746
|
+
* The alt text title of the Shape.
|
|
197747
|
+
|
|
197748
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
197749
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
197750
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
197751
|
+
*
|
|
197752
|
+
* @remarks
|
|
197753
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197754
|
+
* @beta
|
|
197755
|
+
*/
|
|
197756
|
+
altTextTitle?: string;
|
|
197654
197757
|
/**
|
|
197655
197758
|
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
197656
197759
|
*
|
|
@@ -197673,6 +197776,17 @@ declare namespace PowerPoint {
|
|
|
197673
197776
|
* [Api set: PowerPointApi 1.3]
|
|
197674
197777
|
*/
|
|
197675
197778
|
id?: string;
|
|
197779
|
+
/**
|
|
197780
|
+
* Represents whether the shape is decorative or not.
|
|
197781
|
+
|
|
197782
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
197783
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
197784
|
+
*
|
|
197785
|
+
* @remarks
|
|
197786
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
197787
|
+
* @beta
|
|
197788
|
+
*/
|
|
197789
|
+
isDecorative?: boolean;
|
|
197676
197790
|
/**
|
|
197677
197791
|
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
197678
197792
|
*
|
|
@@ -199183,6 +199297,29 @@ declare namespace PowerPoint {
|
|
|
199183
199297
|
* [Api set: PowerPointApi 1.4]
|
|
199184
199298
|
*/
|
|
199185
199299
|
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
199300
|
+
/**
|
|
199301
|
+
* For EACH ITEM in the collection: The alt text description of the Shape.
|
|
199302
|
+
|
|
199303
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
199304
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
199305
|
+
*
|
|
199306
|
+
* @remarks
|
|
199307
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199308
|
+
* @beta
|
|
199309
|
+
*/
|
|
199310
|
+
altTextDescription?: boolean;
|
|
199311
|
+
/**
|
|
199312
|
+
* For EACH ITEM in the collection: The alt text title of the Shape.
|
|
199313
|
+
|
|
199314
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
199315
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
199316
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
199317
|
+
*
|
|
199318
|
+
* @remarks
|
|
199319
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199320
|
+
* @beta
|
|
199321
|
+
*/
|
|
199322
|
+
altTextTitle?: boolean;
|
|
199186
199323
|
/**
|
|
199187
199324
|
* For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
199188
199325
|
*
|
|
@@ -199205,6 +199342,17 @@ declare namespace PowerPoint {
|
|
|
199205
199342
|
* [Api set: PowerPointApi 1.3]
|
|
199206
199343
|
*/
|
|
199207
199344
|
id?: boolean;
|
|
199345
|
+
/**
|
|
199346
|
+
* For EACH ITEM in the collection: Represents whether the shape is decorative or not.
|
|
199347
|
+
|
|
199348
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
199349
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
199350
|
+
*
|
|
199351
|
+
* @remarks
|
|
199352
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199353
|
+
* @beta
|
|
199354
|
+
*/
|
|
199355
|
+
isDecorative?: boolean;
|
|
199208
199356
|
/**
|
|
199209
199357
|
* For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
|
|
199210
199358
|
*
|
|
@@ -199783,6 +199931,29 @@ declare namespace PowerPoint {
|
|
|
199783
199931
|
* [Api set: PowerPointApi 1.5]
|
|
199784
199932
|
*/
|
|
199785
199933
|
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
199934
|
+
/**
|
|
199935
|
+
* For EACH ITEM in the collection: The alt text description of the Shape.
|
|
199936
|
+
|
|
199937
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
199938
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
199939
|
+
*
|
|
199940
|
+
* @remarks
|
|
199941
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199942
|
+
* @beta
|
|
199943
|
+
*/
|
|
199944
|
+
altTextDescription?: boolean;
|
|
199945
|
+
/**
|
|
199946
|
+
* For EACH ITEM in the collection: The alt text title of the Shape.
|
|
199947
|
+
|
|
199948
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
199949
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
199950
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
199951
|
+
*
|
|
199952
|
+
* @remarks
|
|
199953
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199954
|
+
* @beta
|
|
199955
|
+
*/
|
|
199956
|
+
altTextTitle?: boolean;
|
|
199786
199957
|
/**
|
|
199787
199958
|
* For EACH ITEM in the collection: Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
199788
199959
|
*
|
|
@@ -199805,6 +199976,17 @@ declare namespace PowerPoint {
|
|
|
199805
199976
|
* [Api set: PowerPointApi 1.3]
|
|
199806
199977
|
*/
|
|
199807
199978
|
id?: boolean;
|
|
199979
|
+
/**
|
|
199980
|
+
* For EACH ITEM in the collection: Represents whether the shape is decorative or not.
|
|
199981
|
+
|
|
199982
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
199983
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
199984
|
+
*
|
|
199985
|
+
* @remarks
|
|
199986
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
199987
|
+
* @beta
|
|
199988
|
+
*/
|
|
199989
|
+
isDecorative?: boolean;
|
|
199808
199990
|
/**
|
|
199809
199991
|
* For EACH ITEM in the collection: The distance, in points, from the left side of the shape to the left side of the slide.
|
|
199810
199992
|
*
|
|
@@ -200031,6 +200213,29 @@ declare namespace PowerPoint {
|
|
|
200031
200213
|
* [Api set: PowerPointApi 1.4]
|
|
200032
200214
|
*/
|
|
200033
200215
|
textFrame?: PowerPoint.Interfaces.TextFrameLoadOptions;
|
|
200216
|
+
/**
|
|
200217
|
+
* The alt text description of the Shape.
|
|
200218
|
+
|
|
200219
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
200220
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
200221
|
+
*
|
|
200222
|
+
* @remarks
|
|
200223
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
200224
|
+
* @beta
|
|
200225
|
+
*/
|
|
200226
|
+
altTextDescription?: boolean;
|
|
200227
|
+
/**
|
|
200228
|
+
* The alt text title of the Shape.
|
|
200229
|
+
|
|
200230
|
+
Alt text provides alternative, text-based representations of the information contained in the Shape.
|
|
200231
|
+
This information is useful for people with vision or cognitive impairments who may not be able to see or understand the shape.
|
|
200232
|
+
A title can be read to a person with a disability and is used to determine whether they wish to hear the description of the content.
|
|
200233
|
+
*
|
|
200234
|
+
* @remarks
|
|
200235
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
200236
|
+
* @beta
|
|
200237
|
+
*/
|
|
200238
|
+
altTextTitle?: boolean;
|
|
200034
200239
|
/**
|
|
200035
200240
|
* Gets the creation ID of the shape. Returns `null` if the shape has no creation ID.
|
|
200036
200241
|
*
|
|
@@ -200053,6 +200258,17 @@ declare namespace PowerPoint {
|
|
|
200053
200258
|
* [Api set: PowerPointApi 1.3]
|
|
200054
200259
|
*/
|
|
200055
200260
|
id?: boolean;
|
|
200261
|
+
/**
|
|
200262
|
+
* Represents whether the shape is decorative or not.
|
|
200263
|
+
|
|
200264
|
+
Decorative objects add visual interest but aren't informative (e.g. stylistic borders).
|
|
200265
|
+
People using screen readers will hear these are decorative so they know they aren't missing any important information.
|
|
200266
|
+
*
|
|
200267
|
+
* @remarks
|
|
200268
|
+
* [Api set: PowerPointApi BETA (PREVIEW ONLY)]
|
|
200269
|
+
* @beta
|
|
200270
|
+
*/
|
|
200271
|
+
isDecorative?: boolean;
|
|
200056
200272
|
/**
|
|
200057
200273
|
* The distance, in points, from the left side of the shape to the left side of the slide.
|
|
200058
200274
|
*
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.663",
|
|
4
4
|
"description": "TypeScript definitions for office-js-preview",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
48
|
"peerDependencies": {},
|
|
49
|
-
"typesPublisherContentHash": "
|
|
49
|
+
"typesPublisherContentHash": "c5e1ac292f3160a396fa596dcb0fd454729e70596a6c67b8cd4bce32ac3922ac",
|
|
50
50
|
"typeScriptVersion": "5.2",
|
|
51
51
|
"nonNpm": true
|
|
52
52
|
}
|