@types/office-js-preview 1.0.401 → 1.0.402
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 +49 -30
- 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 (https://github.com/OfficeD
|
|
|
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: Tue, 18 Jul 2023 19:32:54 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -35219,9 +35219,9 @@ declare namespace Excel {
|
|
|
35219
35219
|
* [Api set: ExcelApi 1.10]
|
|
35220
35220
|
*
|
|
35221
35221
|
* @param groupOption Specifies how the range can be grouped by rows or columns.
|
|
35222
|
-
|
|
35223
|
-
|
|
35224
|
-
|
|
35222
|
+
* An `InvalidArgument` error is thrown when the group option differs from the range's
|
|
35223
|
+
* `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns"
|
|
35224
|
+
* or `range.isEntireColumn` is true and `groupOption` is "ByRows").
|
|
35225
35225
|
*/
|
|
35226
35226
|
group(groupOption: Excel.GroupOption): void;
|
|
35227
35227
|
/**
|
|
@@ -35231,9 +35231,9 @@ declare namespace Excel {
|
|
|
35231
35231
|
* [Api set: ExcelApi 1.10]
|
|
35232
35232
|
*
|
|
35233
35233
|
* @param groupOption Specifies how the range can be grouped by rows or columns.
|
|
35234
|
-
|
|
35235
|
-
|
|
35236
|
-
|
|
35234
|
+
* An `InvalidArgument` error is thrown when the group option differs from the range's
|
|
35235
|
+
* `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns"
|
|
35236
|
+
* or `range.isEntireColumn` is true and `groupOption` is "ByRows").
|
|
35237
35237
|
*/
|
|
35238
35238
|
group(groupOption: "ByRows" | "ByColumns"): void;
|
|
35239
35239
|
/**
|
|
@@ -38740,8 +38740,8 @@ declare namespace Excel {
|
|
|
38740
38740
|
* [Api set: ExcelApi 1.11]
|
|
38741
38741
|
*
|
|
38742
38742
|
* @param amount The number of character spaces by which the current indent is adjusted. This value should be between -250 and 250.
|
|
38743
|
-
|
|
38744
|
-
|
|
38743
|
+
* **Note**: If the amount would raise the indent level above 250, the indent level stays with 250.
|
|
38744
|
+
* Similarly, if the amount would lower the indent level below 0, the indent level stays 0.
|
|
38745
38745
|
*/
|
|
38746
38746
|
adjustIndent(amount: number): void;
|
|
38747
38747
|
/**
|
|
@@ -40154,7 +40154,7 @@ declare namespace Excel {
|
|
|
40154
40154
|
*/
|
|
40155
40155
|
name: string;
|
|
40156
40156
|
/**
|
|
40157
|
-
* Specifies how bars and columns are positioned. Can be a value between
|
|
40157
|
+
* Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.
|
|
40158
40158
|
*
|
|
40159
40159
|
* @remarks
|
|
40160
40160
|
* [Api set: ExcelApi 1.8]
|
|
@@ -44283,8 +44283,8 @@ declare namespace Excel {
|
|
|
44283
44283
|
* [Api set: ExcelApi 1.14]
|
|
44284
44284
|
*
|
|
44285
44285
|
* @param columnIndex The zero-based column index, which represents which column filter needs to be cleared.
|
|
44286
|
-
|
|
44287
|
-
|
|
44286
|
+
* If the index value is not supported (for example, if the value is a negative number, or if the value is greater than the number of available columns in the range),
|
|
44287
|
+
* then an `InvalidArgument` error will be thrown.
|
|
44288
44288
|
*/
|
|
44289
44289
|
clearColumnCriteria(columnIndex: number): void;
|
|
44290
44290
|
/**
|
|
@@ -45202,7 +45202,7 @@ declare namespace Excel {
|
|
|
45202
45202
|
*/
|
|
45203
45203
|
altTextTitle: string;
|
|
45204
45204
|
/**
|
|
45205
|
-
* Specifies if formatting will be automatically formatted when it
|
|
45205
|
+
* Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
|
|
45206
45206
|
*
|
|
45207
45207
|
* @remarks
|
|
45208
45208
|
* [Api set: ExcelApi 1.9]
|
|
@@ -46278,9 +46278,9 @@ declare namespace Excel {
|
|
|
46278
46278
|
* @param sortBy Specifies if the sorting is done in ascending or descending order.
|
|
46279
46279
|
* @param valuesHierarchy Specifies the values hierarchy on the data axis to be used for sorting.
|
|
46280
46280
|
* @param pivotItemScope The items that should be used for the scope of the sorting. These will be the
|
|
46281
|
-
|
|
46282
|
-
|
|
46283
|
-
|
|
46281
|
+
* items that make up the row or column that you want to sort on. If a string is used instead of a PivotItem,
|
|
46282
|
+
* the string represents the ID of the PivotItem. If there are no items other than data hierarchy on the axis
|
|
46283
|
+
* you want to sort on, this can be empty.
|
|
46284
46284
|
*/
|
|
46285
46285
|
sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;
|
|
46286
46286
|
/**
|
|
@@ -46293,9 +46293,9 @@ declare namespace Excel {
|
|
|
46293
46293
|
* @param sortBy Specifies if the sorting is done in ascending or descending order.
|
|
46294
46294
|
* @param valuesHierarchy Specifies the values hierarchy on the data axis to be used for sorting.
|
|
46295
46295
|
* @param pivotItemScope The items that should be used for the scope of the sorting. These will be the
|
|
46296
|
-
|
|
46297
|
-
|
|
46298
|
-
|
|
46296
|
+
* items that make up the row or column that you want to sort on. If a string is used instead of a PivotItem,
|
|
46297
|
+
* the string represents the ID of the PivotItem. If there are no items other than data hierarchy on the axis
|
|
46298
|
+
* you want to sort on, this can be empty.
|
|
46299
46299
|
*/
|
|
46300
46300
|
sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;
|
|
46301
46301
|
/**
|
|
@@ -57751,7 +57751,26 @@ declare namespace Excel {
|
|
|
57751
57751
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
57752
57752
|
* @beta
|
|
57753
57753
|
*/
|
|
57754
|
-
worksheetRowHeightChanged = "WorksheetRowHeightChanged"
|
|
57754
|
+
worksheetRowHeightChanged = "WorksheetRowHeightChanged",
|
|
57755
|
+
/**
|
|
57756
|
+
* RangeValuesPreviewDismissed represents the type of event registered when a RangeValuePreview is dismissed.
|
|
57757
|
+
* @remarks
|
|
57758
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
57759
|
+
* @beta
|
|
57760
|
+
*/
|
|
57761
|
+
rangeValuesPreviewDismissed = "RangeValuesPreviewDismissed",
|
|
57762
|
+
/**
|
|
57763
|
+
* @remarks
|
|
57764
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
57765
|
+
*/
|
|
57766
|
+
annotationAdded = "AnnotationAdded",
|
|
57767
|
+
/**
|
|
57768
|
+
* Workbook Action Recorded represents the type of event registered when the workbook records an action.
|
|
57769
|
+
* @remarks
|
|
57770
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
57771
|
+
* @beta
|
|
57772
|
+
*/
|
|
57773
|
+
workbookActionRecorded = "WorkbookActionRecorded"
|
|
57755
57774
|
}
|
|
57756
57775
|
/**
|
|
57757
57776
|
* @remarks
|
|
@@ -59828,13 +59847,13 @@ declare namespace Excel {
|
|
|
59828
59847
|
*/
|
|
59829
59848
|
enum Placement {
|
|
59830
59849
|
/**
|
|
59831
|
-
* The object is moved with the cells.
|
|
59850
|
+
* The object is moved and sized with the cells.
|
|
59832
59851
|
* @remarks
|
|
59833
59852
|
* [Api set: ExcelApi 1.9]
|
|
59834
59853
|
*/
|
|
59835
59854
|
twoCell = "TwoCell",
|
|
59836
59855
|
/**
|
|
59837
|
-
* The object is moved
|
|
59856
|
+
* The object is moved with the cells.
|
|
59838
59857
|
* @remarks
|
|
59839
59858
|
* [Api set: ExcelApi 1.9]
|
|
59840
59859
|
*/
|
|
@@ -60471,7 +60490,7 @@ declare namespace Excel {
|
|
|
60471
60490
|
* [Api set: ExcelApiOnline 1.1]
|
|
60472
60491
|
*
|
|
60473
60492
|
* @param name The name of the sheet view to be created.
|
|
60474
|
-
|
|
60493
|
+
* Throws an error when the provided name already exists, is empty, or is a name reserved by the worksheet.
|
|
60475
60494
|
* @returns The newly created sheet view object.
|
|
60476
60495
|
*/
|
|
60477
60496
|
add(name: string): Excel.NamedSheetView;
|
|
@@ -60538,7 +60557,7 @@ declare namespace Excel {
|
|
|
60538
60557
|
* @beta
|
|
60539
60558
|
*
|
|
60540
60559
|
* @param key The case-sensitive name of the sheet view.
|
|
60541
|
-
|
|
60560
|
+
* Use the empty string ("") to get the temporary sheet view, if the temporary view exists.
|
|
60542
60561
|
* @returns The sheet view with the given name, or the temporary view if an empty string was provided.
|
|
60543
60562
|
*/
|
|
60544
60563
|
getItemOrNullObject(key: string): Excel.NamedSheetView;
|
|
@@ -65881,7 +65900,7 @@ declare namespace Excel {
|
|
|
65881
65900
|
*/
|
|
65882
65901
|
name?: string;
|
|
65883
65902
|
/**
|
|
65884
|
-
* Specifies how bars and columns are positioned. Can be a value between
|
|
65903
|
+
* Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.
|
|
65885
65904
|
*
|
|
65886
65905
|
* @remarks
|
|
65887
65906
|
* [Api set: ExcelApi 1.8]
|
|
@@ -67519,7 +67538,7 @@ declare namespace Excel {
|
|
|
67519
67538
|
*/
|
|
67520
67539
|
altTextTitle?: string;
|
|
67521
67540
|
/**
|
|
67522
|
-
* Specifies if formatting will be automatically formatted when it
|
|
67541
|
+
* Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
|
|
67523
67542
|
*
|
|
67524
67543
|
* @remarks
|
|
67525
67544
|
* [Api set: ExcelApi 1.9]
|
|
@@ -71943,7 +71962,7 @@ declare namespace Excel {
|
|
|
71943
71962
|
*/
|
|
71944
71963
|
name?: string;
|
|
71945
71964
|
/**
|
|
71946
|
-
* Specifies how bars and columns are positioned. Can be a value between
|
|
71965
|
+
* Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.
|
|
71947
71966
|
*
|
|
71948
71967
|
* @remarks
|
|
71949
71968
|
* [Api set: ExcelApi 1.8]
|
|
@@ -73931,7 +73950,7 @@ declare namespace Excel {
|
|
|
73931
73950
|
*/
|
|
73932
73951
|
altTextTitle?: string;
|
|
73933
73952
|
/**
|
|
73934
|
-
* Specifies if formatting will be automatically formatted when it
|
|
73953
|
+
* Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
|
|
73935
73954
|
*
|
|
73936
73955
|
* @remarks
|
|
73937
73956
|
* [Api set: ExcelApi 1.9]
|
|
@@ -80345,7 +80364,7 @@ declare namespace Excel {
|
|
|
80345
80364
|
*/
|
|
80346
80365
|
name?: boolean;
|
|
80347
80366
|
/**
|
|
80348
|
-
* For EACH ITEM in the collection: Specifies how bars and columns are positioned. Can be a value between
|
|
80367
|
+
* For EACH ITEM in the collection: Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.
|
|
80349
80368
|
*
|
|
80350
80369
|
* @remarks
|
|
80351
80370
|
* [Api set: ExcelApi 1.8]
|
|
@@ -80674,7 +80693,7 @@ declare namespace Excel {
|
|
|
80674
80693
|
*/
|
|
80675
80694
|
name?: boolean;
|
|
80676
80695
|
/**
|
|
80677
|
-
* Specifies how bars and columns are positioned. Can be a value between
|
|
80696
|
+
* Specifies how bars and columns are positioned. Can be a value between -100 and 100. Applies only to 2-D bar and 2-D column charts.
|
|
80678
80697
|
*
|
|
80679
80698
|
* @remarks
|
|
80680
80699
|
* [Api set: ExcelApi 1.8]
|
|
@@ -83405,7 +83424,7 @@ declare namespace Excel {
|
|
|
83405
83424
|
*/
|
|
83406
83425
|
altTextTitle?: boolean;
|
|
83407
83426
|
/**
|
|
83408
|
-
* Specifies if formatting will be automatically formatted when it
|
|
83427
|
+
* Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
|
|
83409
83428
|
*
|
|
83410
83429
|
* @remarks
|
|
83411
83430
|
* [Api set: ExcelApi 1.9]
|
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.402",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "a3545d6007c97f7cee291d7c5d89d3ef78859764061d65765aa8e3283d407122",
|
|
49
49
|
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|