@types/office-js 1.0.560 → 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 +33 -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
|
@@ -30677,7 +30677,7 @@ declare namespace Excel {
|
|
|
30677
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}.
|
|
30678
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.
|
|
30679
30679
|
*
|
|
30680
|
-
* @deprecated As of
|
|
30680
|
+
* @deprecated As of ExcelApi 1.19, use {@link https://learn.microsoft.com/javascript/api/excel/excel.doublecellvalue | DoubleCellValue} instead.
|
|
30681
30681
|
*
|
|
30682
30682
|
* @remarks
|
|
30683
30683
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30686,7 +30686,7 @@ declare namespace Excel {
|
|
|
30686
30686
|
/**
|
|
30687
30687
|
* Represents the type of this cell value.
|
|
30688
30688
|
*
|
|
30689
|
-
* @deprecated Deprecated since
|
|
30689
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30690
30690
|
*
|
|
30691
30691
|
* @remarks
|
|
30692
30692
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30695,7 +30695,7 @@ declare namespace Excel {
|
|
|
30695
30695
|
/**
|
|
30696
30696
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
30697
30697
|
*
|
|
30698
|
-
* @deprecated Deprecated since
|
|
30698
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30699
30699
|
*
|
|
30700
30700
|
* @remarks
|
|
30701
30701
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30704,7 +30704,7 @@ declare namespace Excel {
|
|
|
30704
30704
|
/**
|
|
30705
30705
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
30706
30706
|
*
|
|
30707
|
-
* @deprecated Deprecated since
|
|
30707
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30708
30708
|
*
|
|
30709
30709
|
* @remarks
|
|
30710
30710
|
* [Api set: ExcelApi 1.16]
|
|
@@ -30716,7 +30716,7 @@ declare namespace Excel {
|
|
|
30716
30716
|
* Number format strings must conform to Excel guidelines.
|
|
30717
30717
|
* To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
30718
30718
|
*
|
|
30719
|
-
* @deprecated Deprecated since
|
|
30719
|
+
* @deprecated Deprecated since ExcelApi 1.19.
|
|
30720
30720
|
*
|
|
30721
30721
|
* @remarks
|
|
30722
30722
|
* [Api set: ExcelApi 1.16]
|
|
@@ -32170,10 +32170,17 @@ declare namespace Excel {
|
|
|
32170
32170
|
}
|
|
32171
32171
|
/**
|
|
32172
32172
|
*
|
|
32173
|
-
* Creates and opens a new workbook.
|
|
32174
|
-
*
|
|
32175
|
-
|
|
32176
|
-
*
|
|
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."
|
|
32177
32184
|
* [Api set: ExcelApi 1.8]
|
|
32178
32185
|
*
|
|
32179
32186
|
* @param base64File Optional. The Base64-encoded .xlsx file. The default value is null.
|
|
@@ -32365,7 +32372,6 @@ declare namespace Excel {
|
|
|
32365
32372
|
*
|
|
32366
32373
|
* When false, each `context.sync()` call creates an undo record.
|
|
32367
32374
|
* When true, all `context.sync()` calls in a single `Excel.run` are merged into one `undo` group.
|
|
32368
|
-
*
|
|
32369
32375
|
* @remarks
|
|
32370
32376
|
* [Api set: ExcelApi 1.20]
|
|
32371
32377
|
*/
|
|
@@ -35781,8 +35787,7 @@ declare namespace Excel {
|
|
|
35781
35787
|
*/
|
|
35782
35788
|
close(closeBehavior?: "Save" | "SkipSave"): void;
|
|
35783
35789
|
/**
|
|
35784
|
-
* Sets focus on the workbook. This
|
|
35785
|
-
to receive keyboard events.
|
|
35790
|
+
* Sets focus on the workbook. This causes the Excel grid or the currently active object to receive keyboard events.
|
|
35786
35791
|
*
|
|
35787
35792
|
* @remarks
|
|
35788
35793
|
* [Api set: ExcelApiDesktop 1.1]
|
|
@@ -35877,7 +35882,10 @@ declare namespace Excel {
|
|
|
35877
35882
|
getSelectedRanges(): Excel.RangeAreas;
|
|
35878
35883
|
/**
|
|
35879
35884
|
* Inserts the specified worksheets from a source workbook into the current workbook.
|
|
35880
|
-
|
|
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.
|
|
35881
35889
|
*
|
|
35882
35890
|
* @remarks
|
|
35883
35891
|
* [Api set: ExcelApi 1.13]
|
|
@@ -64306,6 +64314,7 @@ declare namespace Excel {
|
|
|
64306
64314
|
content: string;
|
|
64307
64315
|
/**
|
|
64308
64316
|
* Specifies the height of the note.
|
|
64317
|
+
* Note: This property is not supported in Excel on the web.
|
|
64309
64318
|
*
|
|
64310
64319
|
* @remarks
|
|
64311
64320
|
* [Api set: ExcelApi 1.18]
|
|
@@ -64313,6 +64322,7 @@ declare namespace Excel {
|
|
|
64313
64322
|
height: number;
|
|
64314
64323
|
/**
|
|
64315
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.
|
|
64316
64326
|
*
|
|
64317
64327
|
* @remarks
|
|
64318
64328
|
* [Api set: ExcelApi 1.18]
|
|
@@ -64320,6 +64330,7 @@ declare namespace Excel {
|
|
|
64320
64330
|
visible: boolean;
|
|
64321
64331
|
/**
|
|
64322
64332
|
* Specifies the width of the note.
|
|
64333
|
+
* Note: This property is not supported in Excel on the web.
|
|
64323
64334
|
*
|
|
64324
64335
|
* @remarks
|
|
64325
64336
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74108,6 +74119,7 @@ declare namespace Excel {
|
|
|
74108
74119
|
content?: string;
|
|
74109
74120
|
/**
|
|
74110
74121
|
* Specifies the height of the note.
|
|
74122
|
+
* Note: This property is not supported in Excel on the web.
|
|
74111
74123
|
*
|
|
74112
74124
|
* @remarks
|
|
74113
74125
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74115,6 +74127,7 @@ declare namespace Excel {
|
|
|
74115
74127
|
height?: number;
|
|
74116
74128
|
/**
|
|
74117
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.
|
|
74118
74131
|
*
|
|
74119
74132
|
* @remarks
|
|
74120
74133
|
* [Api set: ExcelApi 1.18]
|
|
@@ -74122,6 +74135,7 @@ declare namespace Excel {
|
|
|
74122
74135
|
visible?: boolean;
|
|
74123
74136
|
/**
|
|
74124
74137
|
* Specifies the width of the note.
|
|
74138
|
+
* Note: This property is not supported in Excel on the web.
|
|
74125
74139
|
*
|
|
74126
74140
|
* @remarks
|
|
74127
74141
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81425,6 +81439,7 @@ declare namespace Excel {
|
|
|
81425
81439
|
content?: string;
|
|
81426
81440
|
/**
|
|
81427
81441
|
* Specifies the height of the note.
|
|
81442
|
+
* Note: This property is not supported in Excel on the web.
|
|
81428
81443
|
*
|
|
81429
81444
|
* @remarks
|
|
81430
81445
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81432,6 +81447,7 @@ declare namespace Excel {
|
|
|
81432
81447
|
height?: number;
|
|
81433
81448
|
/**
|
|
81434
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.
|
|
81435
81451
|
*
|
|
81436
81452
|
* @remarks
|
|
81437
81453
|
* [Api set: ExcelApi 1.18]
|
|
@@ -81439,6 +81455,7 @@ declare namespace Excel {
|
|
|
81439
81455
|
visible?: boolean;
|
|
81440
81456
|
/**
|
|
81441
81457
|
* Specifies the width of the note.
|
|
81458
|
+
* Note: This property is not supported in Excel on the web.
|
|
81442
81459
|
*
|
|
81443
81460
|
* @remarks
|
|
81444
81461
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93509,6 +93526,7 @@ declare namespace Excel {
|
|
|
93509
93526
|
content?: boolean;
|
|
93510
93527
|
/**
|
|
93511
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.
|
|
93512
93530
|
*
|
|
93513
93531
|
* @remarks
|
|
93514
93532
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93516,6 +93534,7 @@ declare namespace Excel {
|
|
|
93516
93534
|
height?: boolean;
|
|
93517
93535
|
/**
|
|
93518
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.
|
|
93519
93538
|
*
|
|
93520
93539
|
* @remarks
|
|
93521
93540
|
* [Api set: ExcelApi 1.18]
|
|
@@ -93523,6 +93542,7 @@ declare namespace Excel {
|
|
|
93523
93542
|
visible?: boolean;
|
|
93524
93543
|
/**
|
|
93525
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.
|
|
93526
93546
|
*
|
|
93527
93547
|
* @remarks
|
|
93528
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
|
}
|