@types/office-js 1.0.493 → 1.0.495
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 +73 -72
- 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: Mon, 05 May 2025 20:02:28 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -4561,7 +4561,7 @@ declare namespace Office {
|
|
|
4561
4561
|
*
|
|
4562
4562
|
* @remarks
|
|
4563
4563
|
*
|
|
4564
|
-
* The `contentLanguage` value reflects the **Editing Language** setting specified with **File**
|
|
4564
|
+
* The `contentLanguage` value reflects the **Editing Language** setting specified with **File** > **Options** > **Language** in the Office
|
|
4565
4565
|
* application.
|
|
4566
4566
|
*
|
|
4567
4567
|
* **Support details**
|
|
@@ -4597,7 +4597,7 @@ declare namespace Office {
|
|
|
4597
4597
|
*
|
|
4598
4598
|
* The returned value is a string in the RFC 1766 Language tag format, such as en-US.
|
|
4599
4599
|
*
|
|
4600
|
-
* The `displayLanguage` value reflects the current **Display Language** setting specified with **File**
|
|
4600
|
+
* The `displayLanguage` value reflects the current **Display Language** setting specified with **File** > **Options** > **Language** in the Office
|
|
4601
4601
|
* application.
|
|
4602
4602
|
*
|
|
4603
4603
|
* When using in Outlook, the applicable modes are Compose or Read.
|
|
@@ -7102,7 +7102,7 @@ declare namespace Office {
|
|
|
7102
7102
|
* Provides access to the properties for Office theme colors.
|
|
7103
7103
|
*
|
|
7104
7104
|
* Using Office theme colors lets you coordinate the color scheme of your add-in with the current Office theme selected by the user.
|
|
7105
|
-
* The user sets a theme in an Office application through **File**
|
|
7105
|
+
* The user sets a theme in an Office application through **File** > **Account** or **Office Account** > **Office Theme**.
|
|
7106
7106
|
* The selected theme is then applied across all Office applications. Using Office theme colors is appropriate for mail and
|
|
7107
7107
|
* task pane add-ins.
|
|
7108
7108
|
*
|
|
@@ -8094,7 +8094,7 @@ declare namespace Office {
|
|
|
8094
8094
|
* </table>
|
|
8095
8095
|
*
|
|
8096
8096
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8097
|
-
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home**
|
|
8097
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
|
|
8098
8098
|
*
|
|
8099
8099
|
* @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
|
|
8100
8100
|
* @param formats An array specifying the format properties to get.
|
|
@@ -8148,7 +8148,7 @@ declare namespace Office {
|
|
|
8148
8148
|
* </table>
|
|
8149
8149
|
*
|
|
8150
8150
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8151
|
-
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home**
|
|
8151
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
|
|
8152
8152
|
*
|
|
8153
8153
|
* @param cellReference An object literal containing name-value pairs that specify the range of cells to get formatting from.
|
|
8154
8154
|
* @param formats An array specifying the format properties to get.
|
|
@@ -8205,7 +8205,7 @@ declare namespace Office {
|
|
|
8205
8205
|
* </table>
|
|
8206
8206
|
*
|
|
8207
8207
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8208
|
-
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home**
|
|
8208
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
|
|
8209
8209
|
*
|
|
8210
8210
|
* You specify the value of the `format:` property as a list of one or more property name - value pairs in a JavaScript object literal. The
|
|
8211
8211
|
* property name specifies the name of the formatting property to set, and value specifies the property value.
|
|
@@ -8304,7 +8304,7 @@ declare namespace Office {
|
|
|
8304
8304
|
* </table>
|
|
8305
8305
|
*
|
|
8306
8306
|
* The `format:` property specifies values that correspond to a subset of the settings available in the Format Cells dialog box in Excel
|
|
8307
|
-
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home**
|
|
8307
|
+
* (Open the context menu (right-click or select and hold) then select **Format Cells**, or **Home** > **Format** > **Format Cells**).
|
|
8308
8308
|
*
|
|
8309
8309
|
* You specify the value of the `format:` property as a list of one or more property name - value pairs in a JavaScript object literal. The
|
|
8310
8310
|
* property name specifies the name of the formatting property to set, and value specifies the property value.
|
|
@@ -125205,6 +125205,7 @@ declare namespace PowerPoint {
|
|
|
125205
125205
|
/**
|
|
125206
125206
|
* Returns the selected {@link PowerPoint.TextRange} in the current view of the presentation.
|
|
125207
125207
|
If no text is selected, an object with an `isNullObject` property set to `true` is returned.
|
|
125208
|
+
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}.
|
|
125208
125209
|
*
|
|
125209
125210
|
* @remarks
|
|
125210
125211
|
* [Api set: PowerPointApi 1.5]
|
|
@@ -127180,7 +127181,7 @@ declare namespace PowerPoint {
|
|
|
127180
127181
|
*/
|
|
127181
127182
|
right = "Right",
|
|
127182
127183
|
/**
|
|
127183
|
-
* Align text so that it
|
|
127184
|
+
* Align text so that it's justified across the whole line.
|
|
127184
127185
|
* @remarks
|
|
127185
127186
|
* [Api set: PowerPointApi 1.4]
|
|
127186
127187
|
*/
|
|
@@ -127265,7 +127266,7 @@ declare namespace PowerPoint {
|
|
|
127265
127266
|
*/
|
|
127266
127267
|
foregroundColor: string;
|
|
127267
127268
|
/**
|
|
127268
|
-
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type
|
|
127269
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type doesn't support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
127269
127270
|
*
|
|
127270
127271
|
* @remarks
|
|
127271
127272
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -127861,7 +127862,7 @@ declare namespace PowerPoint {
|
|
|
127861
127862
|
*/
|
|
127862
127863
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
127863
127864
|
/**
|
|
127864
|
-
* Gets the table cell using its zero-based index in the collection. If the `TableCell`
|
|
127865
|
+
* Gets the table cell using its zero-based index in the collection. If the `TableCell` doesn't exist, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link [https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties) | *OrNullObject methods and properties}.
|
|
127865
127866
|
*
|
|
127866
127867
|
* @remarks
|
|
127867
127868
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -128151,7 +128152,7 @@ declare namespace PowerPoint {
|
|
|
128151
128152
|
*
|
|
128152
128153
|
* @param rowIndex The zero-based row index of the cell.
|
|
128153
128154
|
* @param columnIndex The zero-based column index of the cell.
|
|
128154
|
-
* @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned.
|
|
128155
|
+
* @returns The cell at the specified row and column. If the cell is part of a merged area and not the top left cell of the merged area, an object with the `isNullObject` property set to `true` is returned. 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}.
|
|
128155
128156
|
*/
|
|
128156
128157
|
getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
|
|
128157
128158
|
/**
|
|
@@ -128208,7 +128209,7 @@ declare namespace PowerPoint {
|
|
|
128208
128209
|
|
|
128209
128210
|
When a table is being added, for columns whose width is undefined,
|
|
128210
128211
|
the column width will be calculated by evenly dividing the remaining width
|
|
128211
|
-
of the table amongst those columns. If the table
|
|
128212
|
+
of the table amongst those columns. If the table doesn't have a defined width,
|
|
128212
128213
|
a default column width will be used.
|
|
128213
128214
|
*
|
|
128214
128215
|
* @remarks
|
|
@@ -128266,7 +128267,7 @@ declare namespace PowerPoint {
|
|
|
128266
128267
|
|
|
128267
128268
|
When a table is being added, for rows whose height is undefined,
|
|
128268
128269
|
the row height will be calculated by evenly dividing the remaining height
|
|
128269
|
-
of the table amongst those rows. If the table
|
|
128270
|
+
of the table amongst those rows. If the table doesn't have a defined height,
|
|
128270
128271
|
a default row height will be used.
|
|
128271
128272
|
*
|
|
128272
128273
|
* @remarks
|
|
@@ -128292,7 +128293,7 @@ declare namespace PowerPoint {
|
|
|
128292
128293
|
columns?: PowerPoint.TableColumnProperties[];
|
|
128293
128294
|
/**
|
|
128294
128295
|
* Specifies the height, in points, of the table.
|
|
128295
|
-
A default value is used when this parameter
|
|
128296
|
+
A default value is used when this parameter isn't provided.
|
|
128296
128297
|
Throws an `InvalidArgument` exception when set with a negative value.
|
|
128297
128298
|
*
|
|
128298
128299
|
* @remarks
|
|
@@ -128301,7 +128302,7 @@ declare namespace PowerPoint {
|
|
|
128301
128302
|
height?: number | undefined;
|
|
128302
128303
|
/**
|
|
128303
128304
|
* Specifies the distance, in points, from the left side of the table to the left side of the slide.
|
|
128304
|
-
The table is centered horizontally when this parameter
|
|
128305
|
+
The table is centered horizontally when this parameter isn't provided.
|
|
128305
128306
|
*
|
|
128306
128307
|
* @remarks
|
|
128307
128308
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -128327,7 +128328,7 @@ declare namespace PowerPoint {
|
|
|
128327
128328
|
* If provided, specifies properties for each cell in the table.
|
|
128328
128329
|
|
|
128329
128330
|
This should be an 2D array with the same number of rows and columns as the table.
|
|
128330
|
-
If a cell
|
|
128331
|
+
If a cell doesn't require specific formatting, specify an empty object for that cell.
|
|
128331
128332
|
Only the top left cell of a merged are can have properties specified, which will be applied
|
|
128332
128333
|
to the entire merged area. For the other cells in the merged area, an empty object should be provided.
|
|
128333
128334
|
*
|
|
@@ -128337,7 +128338,7 @@ declare namespace PowerPoint {
|
|
|
128337
128338
|
specificCellProperties?: PowerPoint.TableCellProperties[][];
|
|
128338
128339
|
/**
|
|
128339
128340
|
* Specifies the distance, in points, from the top edge of the table to the top edge of the slide.
|
|
128340
|
-
A default value is used when this parameter
|
|
128341
|
+
A default value is used when this parameter isn't provided.
|
|
128341
128342
|
*
|
|
128342
128343
|
* @remarks
|
|
128343
128344
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -128353,7 +128354,7 @@ declare namespace PowerPoint {
|
|
|
128353
128354
|
appearance as when the user adds a table through the PowerPoint UI.
|
|
128354
128355
|
|
|
128355
128356
|
To provide a plain appearance for the table, set this property to an empty object
|
|
128356
|
-
and
|
|
128357
|
+
and don't specify specificCellProperties.
|
|
128357
128358
|
*
|
|
128358
128359
|
* @remarks
|
|
128359
128360
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -128373,7 +128374,7 @@ declare namespace PowerPoint {
|
|
|
128373
128374
|
values?: string[][];
|
|
128374
128375
|
/**
|
|
128375
128376
|
* Specifies the width, in points, of the table.
|
|
128376
|
-
A default value is used when this parameter
|
|
128377
|
+
A default value is used when this parameter isn't provided.
|
|
128377
128378
|
Throws an `InvalidArgument` exception when set with a negative value.
|
|
128378
128379
|
*
|
|
128379
128380
|
* @remarks
|
|
@@ -128479,13 +128480,13 @@ declare namespace PowerPoint {
|
|
|
128479
128480
|
*/
|
|
128480
128481
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
128481
128482
|
/**
|
|
128482
|
-
* Gets a shape using its unique ID. An error is thrown if the shape
|
|
128483
|
+
* Gets a shape using its unique ID. An error is thrown if the shape doesn't exist.
|
|
128483
128484
|
*
|
|
128484
128485
|
* @remarks
|
|
128485
128486
|
* [Api set: PowerPointApi 1.3]
|
|
128486
128487
|
*
|
|
128487
128488
|
* @param key The ID of the shape.
|
|
128488
|
-
* @returns The shape with the unique ID. If such a shape
|
|
128489
|
+
* @returns The shape with the unique ID. If such a shape doesn't exist, an error is thrown.
|
|
128489
128490
|
*/
|
|
128490
128491
|
getItem(key: string): PowerPoint.Shape;
|
|
128491
128492
|
/**
|
|
@@ -128499,13 +128500,13 @@ declare namespace PowerPoint {
|
|
|
128499
128500
|
*/
|
|
128500
128501
|
getItemAt(index: number): PowerPoint.Shape;
|
|
128501
128502
|
/**
|
|
128502
|
-
* Gets a shape using its unique ID. If such a shape
|
|
128503
|
+
* Gets a shape using its unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned. 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}.
|
|
128503
128504
|
*
|
|
128504
128505
|
* @remarks
|
|
128505
128506
|
* [Api set: PowerPointApi 1.3]
|
|
128506
128507
|
*
|
|
128507
128508
|
* @param id The ID of the shape.
|
|
128508
|
-
* @returns The shape with the unique ID. If such a shape
|
|
128509
|
+
* @returns The shape with the unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned.
|
|
128509
128510
|
*/
|
|
128510
128511
|
getItemOrNullObject(id: string): PowerPoint.Shape;
|
|
128511
128512
|
/**
|
|
@@ -128881,7 +128882,7 @@ declare namespace PowerPoint {
|
|
|
128881
128882
|
* [Api set: PowerPointApi 1.3]
|
|
128882
128883
|
*
|
|
128883
128884
|
* @param key The ID of the layout.
|
|
128884
|
-
* @returns The layout with the unique ID. If such a layout
|
|
128885
|
+
* @returns The layout with the unique ID. If such a layout doesn't exist, an error is thrown.
|
|
128885
128886
|
*/
|
|
128886
128887
|
getItem(key: string): PowerPoint.SlideLayout;
|
|
128887
128888
|
/**
|
|
@@ -128895,7 +128896,7 @@ declare namespace PowerPoint {
|
|
|
128895
128896
|
*/
|
|
128896
128897
|
getItemAt(index: number): PowerPoint.SlideLayout;
|
|
128897
128898
|
/**
|
|
128898
|
-
* Gets a layout using its unique ID. If such a layout
|
|
128899
|
+
* Gets a layout using its unique ID. If such a layout doesn't exist, an object with an `isNullObject` property set to true is returned. For further information,
|
|
128899
128900
|
see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
128900
128901
|
*
|
|
128901
128902
|
* @remarks
|
|
@@ -129067,12 +129068,12 @@ declare namespace PowerPoint {
|
|
|
129067
129068
|
* @remarks
|
|
129068
129069
|
* [Api set: PowerPointApi 1.3]
|
|
129069
129070
|
*
|
|
129070
|
-
* @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it
|
|
129071
|
+
* @param key The unique ID of a tag, which is unique within this `TagCollection`. 'key' parameter is case-insensitive, but it's always capitalized when saved in the document.
|
|
129071
129072
|
* @param value The value of the tag.
|
|
129072
129073
|
*/
|
|
129073
129074
|
add(key: string, value: string): void;
|
|
129074
129075
|
/**
|
|
129075
|
-
* Deletes the tag with the given `key` in this collection. Does nothing if the `key`
|
|
129076
|
+
* Deletes the tag with the given `key` in this collection. Does nothing if the `key` doesn't exist.
|
|
129076
129077
|
*
|
|
129077
129078
|
* @remarks
|
|
129078
129079
|
* [Api set: PowerPointApi 1.3]
|
|
@@ -129089,13 +129090,13 @@ declare namespace PowerPoint {
|
|
|
129089
129090
|
*/
|
|
129090
129091
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
129091
129092
|
/**
|
|
129092
|
-
* Gets a tag using its unique ID. An error is thrown if the tag
|
|
129093
|
+
* Gets a tag using its unique ID. An error is thrown if the tag doesn't exist.
|
|
129093
129094
|
*
|
|
129094
129095
|
* @remarks
|
|
129095
129096
|
* [Api set: PowerPointApi 1.3]
|
|
129096
129097
|
*
|
|
129097
129098
|
* @param key The ID of the tag.
|
|
129098
|
-
* @returns The tag with the unique ID. If such a tag
|
|
129099
|
+
* @returns The tag with the unique ID. If such a tag doesn't exist, an error is thrown.
|
|
129099
129100
|
*/
|
|
129100
129101
|
getItem(key: string): PowerPoint.Tag;
|
|
129101
129102
|
/**
|
|
@@ -129109,13 +129110,13 @@ declare namespace PowerPoint {
|
|
|
129109
129110
|
*/
|
|
129110
129111
|
getItemAt(index: number): PowerPoint.Tag;
|
|
129111
129112
|
/**
|
|
129112
|
-
* Gets a tag using its unique ID. If such a tag
|
|
129113
|
+
* Gets a tag using its unique ID. If such a tag doesn't exist, an object with an `isNullObject` property set to true is returned. 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}.
|
|
129113
129114
|
*
|
|
129114
129115
|
* @remarks
|
|
129115
129116
|
* [Api set: PowerPointApi 1.3]
|
|
129116
129117
|
*
|
|
129117
129118
|
* @param key The ID of the tag.
|
|
129118
|
-
* @returns The tag with the unique ID. If such a tag
|
|
129119
|
+
* @returns The tag with the unique ID. If such a tag doesn't exist, an object with an `isNullObject` property set to true is returned.
|
|
129119
129120
|
*/
|
|
129120
129121
|
getItemOrNullObject(key: string): PowerPoint.Tag;
|
|
129121
129122
|
/**
|
|
@@ -129217,7 +129218,7 @@ declare namespace PowerPoint {
|
|
|
129217
129218
|
*/
|
|
129218
129219
|
applyLayout(slideLayout: PowerPoint.SlideLayout): void;
|
|
129219
129220
|
/**
|
|
129220
|
-
* Deletes the slide from the presentation. Does nothing if the slide
|
|
129221
|
+
* Deletes the slide from the presentation. Does nothing if the slide doesn't exist.
|
|
129221
129222
|
*
|
|
129222
129223
|
* @remarks
|
|
129223
129224
|
* [Api set: PowerPointApi 1.2]
|
|
@@ -129307,13 +129308,13 @@ declare namespace PowerPoint {
|
|
|
129307
129308
|
*/
|
|
129308
129309
|
getCount(): OfficeExtension.ClientResult<number>;
|
|
129309
129310
|
/**
|
|
129310
|
-
* Gets a shape using its unique ID. An error is thrown if the shape
|
|
129311
|
+
* Gets a shape using its unique ID. An error is thrown if the shape doesn't exist.
|
|
129311
129312
|
*
|
|
129312
129313
|
* @remarks
|
|
129313
129314
|
* [Api set: PowerPointApi 1.5]
|
|
129314
129315
|
*
|
|
129315
129316
|
* @param key The ID of the shape.
|
|
129316
|
-
* @returns The shape with the unique ID. If such a shape
|
|
129317
|
+
* @returns The shape with the unique ID. If such a shape doesn't exist, an error is thrown.
|
|
129317
129318
|
*/
|
|
129318
129319
|
getItem(key: string): PowerPoint.Shape;
|
|
129319
129320
|
/**
|
|
@@ -129327,13 +129328,13 @@ declare namespace PowerPoint {
|
|
|
129327
129328
|
*/
|
|
129328
129329
|
getItemAt(index: number): PowerPoint.Shape;
|
|
129329
129330
|
/**
|
|
129330
|
-
* Gets a shape using its unique ID. If such a shape
|
|
129331
|
+
* Gets a shape using its unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned. 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}.
|
|
129331
129332
|
*
|
|
129332
129333
|
* @remarks
|
|
129333
129334
|
* [Api set: PowerPointApi 1.5]
|
|
129334
129335
|
*
|
|
129335
129336
|
* @param id The ID of the shape.
|
|
129336
|
-
* @returns The shape with the unique ID. If such a shape
|
|
129337
|
+
* @returns The shape with the unique ID. If such a shape doesn't exist, an object with an `isNullObject` property set to true is returned.
|
|
129337
129338
|
*/
|
|
129338
129339
|
getItemOrNullObject(id: string): PowerPoint.Shape;
|
|
129339
129340
|
/**
|
|
@@ -129488,14 +129489,14 @@ declare namespace PowerPoint {
|
|
|
129488
129489
|
*/
|
|
129489
129490
|
color: string;
|
|
129490
129491
|
/**
|
|
129491
|
-
* Represents the dash style of the line. Returns null when the line
|
|
129492
|
+
* Represents the dash style of the line. Returns null when the line isn't visible or there are inconsistent dash styles. See {@linkPowerPoint.ShapeLineDashStyle} for details.
|
|
129492
129493
|
*
|
|
129493
129494
|
* @remarks
|
|
129494
129495
|
* [Api set: PowerPointApi 1.4]
|
|
129495
129496
|
*/
|
|
129496
129497
|
dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
|
|
129497
129498
|
/**
|
|
129498
|
-
* Represents the line style of the shape. Returns null when the line
|
|
129499
|
+
* Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link PowerPoint.ShapeLineStyle} for details.
|
|
129499
129500
|
*
|
|
129500
129501
|
* @remarks
|
|
129501
129502
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -129516,7 +129517,7 @@ declare namespace PowerPoint {
|
|
|
129516
129517
|
*/
|
|
129517
129518
|
visible: boolean;
|
|
129518
129519
|
/**
|
|
129519
|
-
* Represents the weight of the line, in points. Returns `null` when the line
|
|
129520
|
+
* Represents the weight of the line, in points. Returns `null` when the line isn't visible or there are inconsistent line weights.
|
|
129520
129521
|
*
|
|
129521
129522
|
* @remarks
|
|
129522
129523
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -130055,49 +130056,49 @@ declare namespace PowerPoint {
|
|
|
130055
130056
|
*/
|
|
130056
130057
|
readonly zOrderPosition: number;
|
|
130057
130058
|
/**
|
|
130058
|
-
* Deletes the shape from the shape collection. Does nothing if the shape
|
|
130059
|
+
* Deletes the shape from the shape collection. Does nothing if the shape doesn't exist.
|
|
130059
130060
|
*
|
|
130060
130061
|
* @remarks
|
|
130061
130062
|
* [Api set: PowerPointApi 1.3]
|
|
130062
130063
|
*/
|
|
130063
130064
|
delete(): void;
|
|
130064
130065
|
/**
|
|
130065
|
-
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape
|
|
130066
|
+
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `Slide`.
|
|
130066
130067
|
*
|
|
130067
130068
|
* @remarks
|
|
130068
130069
|
* [Api set: PowerPointApi 1.5]
|
|
130069
130070
|
*/
|
|
130070
130071
|
getParentSlide(): PowerPoint.Slide;
|
|
130071
130072
|
/**
|
|
130072
|
-
* Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape
|
|
130073
|
+
* Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `SlideLayout`.
|
|
130073
130074
|
*
|
|
130074
130075
|
* @remarks
|
|
130075
130076
|
* [Api set: PowerPointApi 1.5]
|
|
130076
130077
|
*/
|
|
130077
130078
|
getParentSlideLayout(): PowerPoint.SlideLayout;
|
|
130078
130079
|
/**
|
|
130079
|
-
* Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape
|
|
130080
|
+
* Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape doesn't belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned. 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}.
|
|
130080
130081
|
*
|
|
130081
130082
|
* @remarks
|
|
130082
130083
|
* [Api set: PowerPointApi 1.5]
|
|
130083
130084
|
*/
|
|
130084
130085
|
getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;
|
|
130085
130086
|
/**
|
|
130086
|
-
* Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape
|
|
130087
|
+
* Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape doesn't belong to a `SlideMaster`.
|
|
130087
130088
|
*
|
|
130088
130089
|
* @remarks
|
|
130089
130090
|
* [Api set: PowerPointApi 1.5]
|
|
130090
130091
|
*/
|
|
130091
130092
|
getParentSlideMaster(): PowerPoint.SlideMaster;
|
|
130092
130093
|
/**
|
|
130093
|
-
* Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape
|
|
130094
|
+
* Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape doesn't belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned. 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}.
|
|
130094
130095
|
*
|
|
130095
130096
|
* @remarks
|
|
130096
130097
|
* [Api set: PowerPointApi 1.5]
|
|
130097
130098
|
*/
|
|
130098
130099
|
getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;
|
|
130099
130100
|
/**
|
|
130100
|
-
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape
|
|
130101
|
+
* Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape doesn't belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned. 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}.
|
|
130101
130102
|
*
|
|
130102
130103
|
* @remarks
|
|
130103
130104
|
* [Api set: PowerPointApi 1.5]
|
|
@@ -130186,7 +130187,7 @@ declare namespace PowerPoint {
|
|
|
130186
130187
|
*/
|
|
130187
130188
|
delete(): void;
|
|
130188
130189
|
/**
|
|
130189
|
-
* Returns the shape represented by the binding. Will throw an error if the binding
|
|
130190
|
+
* Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type.
|
|
130190
130191
|
*
|
|
130191
130192
|
* @remarks
|
|
130192
130193
|
* [Api set: PowerPointApi 1.8]
|
|
@@ -130672,8 +130673,8 @@ declare namespace PowerPoint {
|
|
|
130672
130673
|
/**
|
|
130673
130674
|
* Specifies the slides from the source presentation that will be inserted into the current presentation. These slides are represented by their IDs which can be retrieved from a `Slide` object.
|
|
130674
130675
|
The order of these slides is preserved during the insertion.
|
|
130675
|
-
If any of the source slides
|
|
130676
|
-
All of the source slides will be inserted when `sourceSlideIds`
|
|
130676
|
+
If any of the source slides aren't found, or if the IDs are invalid, the operation throws a `SlideNotFound` exception and no slides will be inserted.
|
|
130677
|
+
All of the source slides will be inserted when `sourceSlideIds` isn't provided (this is the default behavior).
|
|
130677
130678
|
*
|
|
130678
130679
|
* @remarks
|
|
130679
130680
|
* [Api set: PowerPointApi 1.2]
|
|
@@ -130681,8 +130682,8 @@ declare namespace PowerPoint {
|
|
|
130681
130682
|
sourceSlideIds?: string[];
|
|
130682
130683
|
/**
|
|
130683
130684
|
* Specifies where in the presentation the new slides will be inserted. The new slides will be inserted after the slide with the given slide ID.
|
|
130684
|
-
If `targetSlideId`
|
|
130685
|
-
If `targetSlideId` is invalid or if it
|
|
130685
|
+
If `targetSlideId` isn't provided, the slides will be inserted at the beginning of the presentation.
|
|
130686
|
+
If `targetSlideId` is invalid or if it's pointing to a non-existing slide, the operation throws a `SlideNotFound` exception and no slides will be inserted.
|
|
130686
130687
|
*
|
|
130687
130688
|
* @remarks
|
|
130688
130689
|
* [Api set: PowerPointApi 1.2]
|
|
@@ -130724,7 +130725,7 @@ declare namespace PowerPoint {
|
|
|
130724
130725
|
* [Api set: PowerPointApi 1.2]
|
|
130725
130726
|
*
|
|
130726
130727
|
* @param key The ID of the slide.
|
|
130727
|
-
* @returns The slide with the unique ID. If such a slide
|
|
130728
|
+
* @returns The slide with the unique ID. If such a slide doesn't exist, an error is thrown.
|
|
130728
130729
|
*/
|
|
130729
130730
|
getItem(key: string): PowerPoint.Slide;
|
|
130730
130731
|
/**
|
|
@@ -130739,7 +130740,7 @@ declare namespace PowerPoint {
|
|
|
130739
130740
|
*/
|
|
130740
130741
|
getItemAt(index: number): PowerPoint.Slide;
|
|
130741
130742
|
/**
|
|
130742
|
-
* Gets a slide using its unique ID. If such a slide
|
|
130743
|
+
* Gets a slide using its unique ID. If such a slide doesn't exist, an object with an `isNullObject` property set to true is returned. For further information, see
|
|
130743
130744
|
{@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
130744
130745
|
*
|
|
130745
130746
|
* @remarks
|
|
@@ -130799,7 +130800,7 @@ declare namespace PowerPoint {
|
|
|
130799
130800
|
* [Api set: PowerPointApi 1.5]
|
|
130800
130801
|
*
|
|
130801
130802
|
* @param key The ID of the slide.
|
|
130802
|
-
* @returns The slide with the unique ID. If such a slide
|
|
130803
|
+
* @returns The slide with the unique ID. If such a slide doesn't exist, an error is thrown.
|
|
130803
130804
|
*/
|
|
130804
130805
|
getItem(key: string): PowerPoint.Slide;
|
|
130805
130806
|
/**
|
|
@@ -130813,7 +130814,7 @@ declare namespace PowerPoint {
|
|
|
130813
130814
|
*/
|
|
130814
130815
|
getItemAt(index: number): PowerPoint.Slide;
|
|
130815
130816
|
/**
|
|
130816
|
-
* Gets a slide using its unique ID. If such a slide
|
|
130817
|
+
* Gets a slide using its unique ID. If such a slide doesn't exist, an object with an `isNullObject` property set to true is returned. For further information, see
|
|
130817
130818
|
{@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
130818
130819
|
*
|
|
130819
130820
|
* @remarks
|
|
@@ -130873,7 +130874,7 @@ declare namespace PowerPoint {
|
|
|
130873
130874
|
* [Api set: PowerPointApi 1.3]
|
|
130874
130875
|
*
|
|
130875
130876
|
* @param key The ID of the Slide Master.
|
|
130876
|
-
* @returns The Slide Master with the unique ID. If such a Slide Master
|
|
130877
|
+
* @returns The Slide Master with the unique ID. If such a Slide Master doesn't exist, an error is thrown.
|
|
130877
130878
|
*/
|
|
130878
130879
|
getItem(key: string): PowerPoint.SlideMaster;
|
|
130879
130880
|
/**
|
|
@@ -130887,7 +130888,7 @@ declare namespace PowerPoint {
|
|
|
130887
130888
|
*/
|
|
130888
130889
|
getItemAt(index: number): PowerPoint.SlideMaster;
|
|
130889
130890
|
/**
|
|
130890
|
-
* Gets a Slide Master using its unique ID. If such a Slide Master
|
|
130891
|
+
* Gets a Slide Master using its unique ID. If such a Slide Master doesn't exist, an object with an `isNullObject` property set to true is returned.
|
|
130891
130892
|
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}.
|
|
130892
130893
|
*
|
|
130893
130894
|
* @remarks
|
|
@@ -130977,7 +130978,7 @@ declare namespace PowerPoint {
|
|
|
130977
130978
|
*/
|
|
130978
130979
|
foregroundColor?: string;
|
|
130979
130980
|
/**
|
|
130980
|
-
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type
|
|
130981
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type doesn't support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
130981
130982
|
*
|
|
130982
130983
|
* @remarks
|
|
130983
130984
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -131046,7 +131047,7 @@ declare namespace PowerPoint {
|
|
|
131046
131047
|
*/
|
|
131047
131048
|
italic?: boolean | null;
|
|
131048
131049
|
/**
|
|
131049
|
-
* Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it
|
|
131050
|
+
* Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
|
|
131050
131051
|
*
|
|
131051
131052
|
* @remarks
|
|
131052
131053
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -131169,14 +131170,14 @@ declare namespace PowerPoint {
|
|
|
131169
131170
|
*/
|
|
131170
131171
|
color?: string;
|
|
131171
131172
|
/**
|
|
131172
|
-
* Represents the dash style of the line. Returns null when the line
|
|
131173
|
+
* Represents the dash style of the line. Returns null when the line isn't visible or there are inconsistent dash styles. See {@link PowerPoint.ShapeLineDashStyle} for details.
|
|
131173
131174
|
*
|
|
131174
131175
|
* @remarks
|
|
131175
131176
|
* [Api set: PowerPointApi 1.4]
|
|
131176
131177
|
*/
|
|
131177
131178
|
dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
|
|
131178
131179
|
/**
|
|
131179
|
-
* Represents the line style of the shape. Returns null when the line
|
|
131180
|
+
* Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link PowerPoint.ShapeLineStyle} for details.
|
|
131180
131181
|
*
|
|
131181
131182
|
* @remarks
|
|
131182
131183
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -131197,7 +131198,7 @@ declare namespace PowerPoint {
|
|
|
131197
131198
|
*/
|
|
131198
131199
|
visible?: boolean;
|
|
131199
131200
|
/**
|
|
131200
|
-
* Represents the weight of the line, in points. Returns `null` when the line
|
|
131201
|
+
* Represents the weight of the line, in points. Returns `null` when the line isn't visible or there are inconsistent line weights.
|
|
131201
131202
|
*
|
|
131202
131203
|
* @remarks
|
|
131203
131204
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -131522,7 +131523,7 @@ declare namespace PowerPoint {
|
|
|
131522
131523
|
*/
|
|
131523
131524
|
foregroundColor?: string;
|
|
131524
131525
|
/**
|
|
131525
|
-
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type
|
|
131526
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type doesn't support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
131526
131527
|
*
|
|
131527
131528
|
* @remarks
|
|
131528
131529
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -131598,7 +131599,7 @@ declare namespace PowerPoint {
|
|
|
131598
131599
|
*/
|
|
131599
131600
|
italic?: boolean | null;
|
|
131600
131601
|
/**
|
|
131601
|
-
* Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it
|
|
131602
|
+
* Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
|
|
131602
131603
|
*
|
|
131603
131604
|
* @remarks
|
|
131604
131605
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -131850,14 +131851,14 @@ declare namespace PowerPoint {
|
|
|
131850
131851
|
*/
|
|
131851
131852
|
color?: string;
|
|
131852
131853
|
/**
|
|
131853
|
-
* Represents the dash style of the line. Returns null when the line
|
|
131854
|
+
* Represents the dash style of the line. Returns null when the line isn't visible or there are inconsistent dash styles. See {@link PowerPoint.ShapeLineDashStyle} for details.
|
|
131854
131855
|
*
|
|
131855
131856
|
* @remarks
|
|
131856
131857
|
* [Api set: PowerPointApi 1.4]
|
|
131857
131858
|
*/
|
|
131858
131859
|
dashStyle?: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";
|
|
131859
131860
|
/**
|
|
131860
|
-
* Represents the line style of the shape. Returns null when the line
|
|
131861
|
+
* Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link PowerPoint.ShapeLineStyle} for details.
|
|
131861
131862
|
*
|
|
131862
131863
|
* @remarks
|
|
131863
131864
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -131878,7 +131879,7 @@ declare namespace PowerPoint {
|
|
|
131878
131879
|
*/
|
|
131879
131880
|
visible?: boolean;
|
|
131880
131881
|
/**
|
|
131881
|
-
* Represents the weight of the line, in points. Returns `null` when the line
|
|
131882
|
+
* Represents the weight of the line, in points. Returns `null` when the line isn't visible or there are inconsistent line weights.
|
|
131882
131883
|
*
|
|
131883
131884
|
* @remarks
|
|
131884
131885
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -132408,7 +132409,7 @@ declare namespace PowerPoint {
|
|
|
132408
132409
|
*/
|
|
132409
132410
|
foregroundColor?: boolean;
|
|
132410
132411
|
/**
|
|
132411
|
-
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type
|
|
132412
|
+
* Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type doesn't support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type.
|
|
132412
132413
|
*
|
|
132413
132414
|
* @remarks
|
|
132414
132415
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -132493,7 +132494,7 @@ declare namespace PowerPoint {
|
|
|
132493
132494
|
*/
|
|
132494
132495
|
italic?: boolean;
|
|
132495
132496
|
/**
|
|
132496
|
-
* Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it
|
|
132497
|
+
* Specifies the font name (e.g., "Calibri"). If the text is a Complex Script or East Asian language, this is the corresponding font name; otherwise it's the Latin font name. Returns `null` if the `TextRange` contains text fragments with different font names.
|
|
132497
132498
|
*
|
|
132498
132499
|
* @remarks
|
|
132499
132500
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -133180,14 +133181,14 @@ declare namespace PowerPoint {
|
|
|
133180
133181
|
*/
|
|
133181
133182
|
color?: boolean;
|
|
133182
133183
|
/**
|
|
133183
|
-
* Represents the dash style of the line. Returns null when the line
|
|
133184
|
+
* Represents the dash style of the line. Returns null when the line isn't visible or there are inconsistent dash styles. See {@link PowerPoint.ShapeLineDashStyle} for details.
|
|
133184
133185
|
*
|
|
133185
133186
|
* @remarks
|
|
133186
133187
|
* [Api set: PowerPointApi 1.4]
|
|
133187
133188
|
*/
|
|
133188
133189
|
dashStyle?: boolean;
|
|
133189
133190
|
/**
|
|
133190
|
-
* Represents the line style of the shape. Returns null when the line
|
|
133191
|
+
* Represents the line style of the shape. Returns null when the line isn't visible or there are inconsistent styles. See {@link PowerPoint.ShapeLineStyle} for details.
|
|
133191
133192
|
*
|
|
133192
133193
|
* @remarks
|
|
133193
133194
|
* [Api set: PowerPointApi 1.4]
|
|
@@ -133208,7 +133209,7 @@ declare namespace PowerPoint {
|
|
|
133208
133209
|
*/
|
|
133209
133210
|
visible?: boolean;
|
|
133210
133211
|
/**
|
|
133211
|
-
* Represents the weight of the line, in points. Returns `null` when the line
|
|
133212
|
+
* Represents the weight of the line, in points. Returns `null` when the line isn't visible or there are inconsistent line weights.
|
|
133212
133213
|
*
|
|
133213
133214
|
* @remarks
|
|
133214
133215
|
* [Api set: PowerPointApi 1.4]
|
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.495",
|
|
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": "e91bbf9e53b7e387ee8a433f41c775fbc1c2cc5e3732349ab96ff7103fd532c1",
|
|
50
50
|
"typeScriptVersion": "5.1"
|
|
51
51
|
}
|