@types/office-js 1.0.559 → 1.0.561
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 +37 -13
- 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, 01 Dec 2025 20:34:48 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
|
|
14
14
|
# Credits
|
office-js/index.d.ts
CHANGED
|
@@ -23846,6 +23846,10 @@ declare namespace Office {
|
|
|
23846
23846
|
*
|
|
23847
23847
|
* **Important**
|
|
23848
23848
|
*
|
|
23849
|
+
* - The `errorMessageMarkdown` property is available for preview in Outlook on Mac starting in Version 16.103 (Build 25102433). To test the property, join the
|
|
23850
|
+
* {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-macos/4401756 | Microsoft 365 Insider program} and
|
|
23851
|
+
* select the **Beta Channel** option to access Office beta builds.
|
|
23852
|
+
*
|
|
23849
23853
|
* - The formatted error message must be 500 characters or less.
|
|
23850
23854
|
*
|
|
23851
23855
|
* - For guidance on supported Markdown elements, see
|
|
@@ -30673,7 +30677,7 @@ declare namespace Excel {
|
|
|
30673
30677
|
* Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
30674
30678
|
* In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation.
|
|
30675
30679
|
*
|
|
30676
|
-
* @deprecated As of
|
|
30680
|
+
* @deprecated As of ExcelApi 1.19, use {@link https://learn.microsoft.com/javascript/api/excel/excel.doublecellvalue | DoubleCellValue} instead.
|
|
30677
30681
|
*
|
|
30678
30682
|
* @remarks
|
|
30679
30683
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30682,7 +30686,7 @@ declare namespace Excel {
|
|
|
30682
30686
|
/**
|
|
30683
30687
|
* Represents the type of this cell value.
|
|
30684
30688
|
*
|
|
30685
|
-
* @deprecated Deprecated since
|
|
30689
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30686
30690
|
*
|
|
30687
30691
|
* @remarks
|
|
30688
30692
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30691,7 +30695,7 @@ declare namespace Excel {
|
|
|
30691
30695
|
/**
|
|
30692
30696
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
30693
30697
|
*
|
|
30694
|
-
* @deprecated Deprecated since
|
|
30698
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30695
30699
|
*
|
|
30696
30700
|
* @remarks
|
|
30697
30701
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30700,7 +30704,7 @@ declare namespace Excel {
|
|
|
30700
30704
|
/**
|
|
30701
30705
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
30702
30706
|
*
|
|
30703
|
-
* @deprecated Deprecated since
|
|
30707
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30704
30708
|
*
|
|
30705
30709
|
* @remarks
|
|
30706
30710
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30712,7 +30716,7 @@ declare namespace Excel {
|
|
|
30712
30716
|
* Number format strings must conform to Excel guidelines.
|
|
30713
30717
|
* To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
30714
30718
|
*
|
|
30715
|
-
* @deprecated Deprecated since
|
|
30719
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30716
30720
|
*
|
|
30717
30721
|
* @remarks
|
|
30718
30722
|
* [Api set: ExcelApi 1.16]
|
|
@@ -32166,10 +32170,17 @@ declare namespace Excel {
|
|
|
32166
32170
|
}
|
|
32167
32171
|
/**
|
|
32168
32172
|
*
|
|
32169
|
-
* Creates and opens a new workbook.
|
|
32170
|
-
*
|
|
32171
|
-
|
|
32172
|
-
*
|
|
32173
|
+
* Creates and opens a new workbook. Optionally, the workbook can be pre-populated
|
|
32174
|
+
* with a Base64-encoded .xlsx file.
|
|
32175
|
+
|
|
32176
|
+
* Note: Macros can be a security risk. If this API is used to create a workbook that
|
|
32177
|
+
* includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog
|
|
32178
|
+
* in the Excel UI. The user must select the "Trust add-in" button to proceed.
|
|
32179
|
+
*
|
|
32180
|
+
* Note: The `extensionHardening` Windows registry key affects the `base64File` param.
|
|
32181
|
+
* The file extension defined by the param must match the real file type of the file.
|
|
32182
|
+
* If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error:
|
|
32183
|
+
* "This operation is not allowed due to the extension hardening policy."
|
|
32173
32184
|
* [Api set: ExcelApi 1.8]
|
|
32174
32185
|
*
|
|
32175
32186
|
* @param base64File Optional. The Base64-encoded .xlsx file. The default value is null.
|
|
@@ -32361,7 +32372,6 @@ declare namespace Excel {
|
|
|
32361
32372
|
*
|
|
32362
32373
|
* When false, each `context.sync()` call creates an undo record.
|
|
32363
32374
|
* When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group.
|
|
32364
|
-
*
|
|
32365
32375
|
* @remarks
|
|
32366
32376
|
* [Api set: ExcelApi 1.20]
|
|
32367
32377
|
*/
|
|
@@ -35777,8 +35787,7 @@ declare namespace Excel {
|
|
|
35777
35787
|
*/
|
|
35778
35788
|
close(closeBehavior?: "Save" | "SkipSave"): void;
|
|
35779
35789
|
/**
|
|
35780
|
-
* Sets focus on the workbook. This
|
|
35781
|
-
to receive keyboard events.
|
|
35790
|
+
* Sets focus on the workbook. This causes the Excel grid or the currently active object to receive keyboard events.
|
|
35782
35791
|
*
|
|
35783
35792
|
* @remarks
|
|
35784
35793
|
* [Api set: ExcelApiDesktop 1.1]
|
|
@@ -35873,7 +35882,10 @@ declare namespace Excel {
|
|
|
35873
35882
|
getSelectedRanges(): Excel.RangeAreas;
|
|
35874
35883
|
/**
|
|
35875
35884
|
* Inserts the specified worksheets from a source workbook into the current workbook.
|
|
35876
|
-
|
|
35885
|
+
|
|
35886
|
+
The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy."
|
|
35887
|
+
|
|
35888
|
+
**Note**: This API is currently only supported for Office on Windows, Mac, and the web.
|
|
35877
35889
|
*
|
|
35878
35890
|
* @remarks
|
|
35879
35891
|
* [Api set: ExcelApi 1.13]
|
|
@@ -64302,6 +64314,7 @@ declare namespace Excel {
|
|
|
64302
64314
|
content: string;
|
|
64303
64315
|
/**
|
|
64304
64316
|
* Specifies the height of the note.
|
|
64317
|
+
* Note: This property is not supported in Excel on the web.
|
|
64305
64318
|
*
|
|
64306
64319
|
* @remarks
|
|
64307
64320
|
* [Api set: ExcelApi 1.18]
|
|
@@ -64309,6 +64322,7 @@ declare namespace Excel {
|
|
|
64309
64322
|
height: number;
|
|
64310
64323
|
/**
|
|
64311
64324
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
64325
|
+
* Note: This property is not supported in Excel on the web.
|
|
64312
64326
|
*
|
|
64313
64327
|
* @remarks
|
|
64314
64328
|
* [Api set: ExcelApi 1.18]
|
|
@@ -64316,6 +64330,7 @@ declare namespace Excel {
|
|
|
64316
64330
|
visible: boolean;
|
|
64317
64331
|
/**
|
|
64318
64332
|
* Specifies the width of the note.
|
|
64333
|
+
* Note: This property is not supported in Excel on the web.
|
|
64319
64334
|
*
|
|
64320
64335
|
* @remarks
|
|
64321
64336
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74104,6 +74119,7 @@ declare namespace Excel {
|
|
|
74104
74119
|
content?: string;
|
|
74105
74120
|
/**
|
|
74106
74121
|
* Specifies the height of the note.
|
|
74122
|
+
* Note: This property is not supported in Excel on the web.
|
|
74107
74123
|
*
|
|
74108
74124
|
* @remarks
|
|
74109
74125
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74111,6 +74127,7 @@ declare namespace Excel {
|
|
|
74111
74127
|
height?: number;
|
|
74112
74128
|
/**
|
|
74113
74129
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
74130
|
+
* Note: This property is not supported in Excel on the web.
|
|
74114
74131
|
*
|
|
74115
74132
|
* @remarks
|
|
74116
74133
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74118,6 +74135,7 @@ declare namespace Excel {
|
|
|
74118
74135
|
visible?: boolean;
|
|
74119
74136
|
/**
|
|
74120
74137
|
* Specifies the width of the note.
|
|
74138
|
+
* Note: This property is not supported in Excel on the web.
|
|
74121
74139
|
*
|
|
74122
74140
|
* @remarks
|
|
74123
74141
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81421,6 +81439,7 @@ declare namespace Excel {
|
|
|
81421
81439
|
content?: string;
|
|
81422
81440
|
/**
|
|
81423
81441
|
* Specifies the height of the note.
|
|
81442
|
+
* Note: This property is not supported in Excel on the web.
|
|
81424
81443
|
*
|
|
81425
81444
|
* @remarks
|
|
81426
81445
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81428,6 +81447,7 @@ declare namespace Excel {
|
|
|
81428
81447
|
height?: number;
|
|
81429
81448
|
/**
|
|
81430
81449
|
* Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
81450
|
+
* Note: This property is not supported in Excel on the web.
|
|
81431
81451
|
*
|
|
81432
81452
|
* @remarks
|
|
81433
81453
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81435,6 +81455,7 @@ declare namespace Excel {
|
|
|
81435
81455
|
visible?: boolean;
|
|
81436
81456
|
/**
|
|
81437
81457
|
* Specifies the width of the note.
|
|
81458
|
+
* Note: This property is not supported in Excel on the web.
|
|
81438
81459
|
*
|
|
81439
81460
|
* @remarks
|
|
81440
81461
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93505,6 +93526,7 @@ declare namespace Excel {
|
|
|
93505
93526
|
content?: boolean;
|
|
93506
93527
|
/**
|
|
93507
93528
|
* For EACH ITEM in the collection: Specifies the height of the note.
|
|
93529
|
+
* Note: This property is not supported in Excel on the web.
|
|
93508
93530
|
*
|
|
93509
93531
|
* @remarks
|
|
93510
93532
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93512,6 +93534,7 @@ declare namespace Excel {
|
|
|
93512
93534
|
height?: boolean;
|
|
93513
93535
|
/**
|
|
93514
93536
|
* For EACH ITEM in the collection: Specifies the visibility of the note. A value of `true` means the note is shown.
|
|
93537
|
+
* Note: This property is not supported in Excel on the web.
|
|
93515
93538
|
*
|
|
93516
93539
|
* @remarks
|
|
93517
93540
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93519,6 +93542,7 @@ declare namespace Excel {
|
|
|
93519
93542
|
visible?: boolean;
|
|
93520
93543
|
/**
|
|
93521
93544
|
* For EACH ITEM in the collection: Specifies the width of the note.
|
|
93545
|
+
* Note: This property is not supported in Excel on the web.
|
|
93522
93546
|
*
|
|
93523
93547
|
* @remarks
|
|
93524
93548
|
* [Api set: ExcelApi 1.18]
|
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.561",
|
|
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": "80e3413b773c3cfd945960a741d5cddf050244ac5e47b8b979ce8f4a63d110b6",
|
|
50
50
|
"typeScriptVersion": "5.2"
|
|
51
51
|
}
|