@types/office-js 1.0.337 → 1.0.338

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 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: Thu, 13 Jul 2023 21:02:43 GMT
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/index.d.ts CHANGED
@@ -32394,9 +32394,9 @@ declare namespace Excel {
32394
32394
  * [Api set: ExcelApi 1.10]
32395
32395
  *
32396
32396
  * @param groupOption Specifies how the range can be grouped by rows or columns.
32397
- An `InvalidArgument` error is thrown when the group option differs from the range's
32398
- `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns"
32399
- or `range.isEntireColumn` is true and `groupOption` is "ByRows").
32397
+ * An `InvalidArgument` error is thrown when the group option differs from the range's
32398
+ * `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns"
32399
+ * or `range.isEntireColumn` is true and `groupOption` is "ByRows").
32400
32400
  */
32401
32401
  group(groupOption: Excel.GroupOption): void;
32402
32402
  /**
@@ -32406,9 +32406,9 @@ declare namespace Excel {
32406
32406
  * [Api set: ExcelApi 1.10]
32407
32407
  *
32408
32408
  * @param groupOption Specifies how the range can be grouped by rows or columns.
32409
- An `InvalidArgument` error is thrown when the group option differs from the range's
32410
- `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns"
32411
- or `range.isEntireColumn` is true and `groupOption` is "ByRows").
32409
+ * An `InvalidArgument` error is thrown when the group option differs from the range's
32410
+ * `isEntireRow` or `isEntireColumn` property (i.e., `range.isEntireRow` is true and `groupOption` is "ByColumns"
32411
+ * or `range.isEntireColumn` is true and `groupOption` is "ByRows").
32412
32412
  */
32413
32413
  group(groupOption: "ByRows" | "ByColumns"): void;
32414
32414
  /**
@@ -35869,8 +35869,8 @@ declare namespace Excel {
35869
35869
  * [Api set: ExcelApi 1.11]
35870
35870
  *
35871
35871
  * @param amount The number of character spaces by which the current indent is adjusted. This value should be between -250 and 250.
35872
- **Note**: If the amount would raise the indent level above 250, the indent level stays with 250.
35873
- Similarly, if the amount would lower the indent level below 0, the indent level stays 0.
35872
+ * **Note**: If the amount would raise the indent level above 250, the indent level stays with 250.
35873
+ * Similarly, if the amount would lower the indent level below 0, the indent level stays 0.
35874
35874
  */
35875
35875
  adjustIndent(amount: number): void;
35876
35876
  /**
@@ -37266,7 +37266,7 @@ declare namespace Excel {
37266
37266
  */
37267
37267
  name: string;
37268
37268
  /**
37269
- * 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.
37269
+ * 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.
37270
37270
  *
37271
37271
  * @remarks
37272
37272
  * [Api set: ExcelApi 1.8]
@@ -41402,8 +41402,8 @@ declare namespace Excel {
41402
41402
  * [Api set: ExcelApi 1.14]
41403
41403
  *
41404
41404
  * @param columnIndex The zero-based column index, which represents which column filter needs to be cleared.
41405
- 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),
41406
- then an `InvalidArgument` error will be thrown.
41405
+ * 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),
41406
+ * then an `InvalidArgument` error will be thrown.
41407
41407
  */
41408
41408
  clearColumnCriteria(columnIndex: number): void;
41409
41409
  /**
@@ -42264,7 +42264,7 @@ declare namespace Excel {
42264
42264
  */
42265
42265
  altTextTitle: string;
42266
42266
  /**
42267
- * Specifies if formatting will be automatically formatted when its refreshed or when fields are moved.
42267
+ * Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
42268
42268
  *
42269
42269
  * @remarks
42270
42270
  * [Api set: ExcelApi 1.9]
@@ -43317,9 +43317,9 @@ declare namespace Excel {
43317
43317
  * @param sortBy Specifies if the sorting is done in ascending or descending order.
43318
43318
  * @param valuesHierarchy Specifies the values hierarchy on the data axis to be used for sorting.
43319
43319
  * @param pivotItemScope The items that should be used for the scope of the sorting. These will be the
43320
- items that make up the row or column that you want to sort on. If a string is used instead of a PivotItem,
43321
- the string represents the ID of the PivotItem. If there are no items other than data hierarchy on the axis
43322
- you want to sort on, this can be empty.
43320
+ * items that make up the row or column that you want to sort on. If a string is used instead of a PivotItem,
43321
+ * the string represents the ID of the PivotItem. If there are no items other than data hierarchy on the axis
43322
+ * you want to sort on, this can be empty.
43323
43323
  */
43324
43324
  sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;
43325
43325
  /**
@@ -43332,9 +43332,9 @@ declare namespace Excel {
43332
43332
  * @param sortBy Specifies if the sorting is done in ascending or descending order.
43333
43333
  * @param valuesHierarchy Specifies the values hierarchy on the data axis to be used for sorting.
43334
43334
  * @param pivotItemScope The items that should be used for the scope of the sorting. These will be the
43335
- items that make up the row or column that you want to sort on. If a string is used instead of a PivotItem,
43336
- the string represents the ID of the PivotItem. If there are no items other than data hierarchy on the axis
43337
- you want to sort on, this can be empty.
43335
+ * items that make up the row or column that you want to sort on. If a string is used instead of a PivotItem,
43336
+ * the string represents the ID of the PivotItem. If there are no items other than data hierarchy on the axis
43337
+ * you want to sort on, this can be empty.
43338
43338
  */
43339
43339
  sortByValues(sortBy: "Ascending" | "Descending", valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array<PivotItem | string>): void;
43340
43340
  /**
@@ -56398,13 +56398,13 @@ declare namespace Excel {
56398
56398
  */
56399
56399
  enum Placement {
56400
56400
  /**
56401
- * The object is moved with the cells.
56401
+ * The object is moved and sized with the cells.
56402
56402
  * @remarks
56403
56403
  * [Api set: ExcelApi 1.9]
56404
56404
  */
56405
56405
  twoCell = "TwoCell",
56406
56406
  /**
56407
- * The object is moved and sized with the cells.
56407
+ * The object is moved with the cells.
56408
56408
  * @remarks
56409
56409
  * [Api set: ExcelApi 1.9]
56410
56410
  */
@@ -57041,7 +57041,7 @@ declare namespace Excel {
57041
57041
  * [Api set: ExcelApiOnline 1.1]
57042
57042
  *
57043
57043
  * @param name The name of the sheet view to be created.
57044
- Throws an error when the provided name already exists, is empty, or is a name reserved by the worksheet.
57044
+ * Throws an error when the provided name already exists, is empty, or is a name reserved by the worksheet.
57045
57045
  * @returns The newly created sheet view object.
57046
57046
  */
57047
57047
  add(name: string): Excel.NamedSheetView;
@@ -62361,7 +62361,7 @@ declare namespace Excel {
62361
62361
  */
62362
62362
  name?: string;
62363
62363
  /**
62364
- * 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.
62364
+ * 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.
62365
62365
  *
62366
62366
  * @remarks
62367
62367
  * [Api set: ExcelApi 1.8]
@@ -63991,7 +63991,7 @@ declare namespace Excel {
63991
63991
  */
63992
63992
  altTextTitle?: string;
63993
63993
  /**
63994
- * Specifies if formatting will be automatically formatted when its refreshed or when fields are moved.
63994
+ * Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
63995
63995
  *
63996
63996
  * @remarks
63997
63997
  * [Api set: ExcelApi 1.9]
@@ -68168,7 +68168,7 @@ declare namespace Excel {
68168
68168
  */
68169
68169
  name?: string;
68170
68170
  /**
68171
- * 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.
68171
+ * 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.
68172
68172
  *
68173
68173
  * @remarks
68174
68174
  * [Api set: ExcelApi 1.8]
@@ -70148,7 +70148,7 @@ declare namespace Excel {
70148
70148
  */
70149
70149
  altTextTitle?: string;
70150
70150
  /**
70151
- * Specifies if formatting will be automatically formatted when its refreshed or when fields are moved.
70151
+ * Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
70152
70152
  *
70153
70153
  * @remarks
70154
70154
  * [Api set: ExcelApi 1.9]
@@ -76005,7 +76005,7 @@ declare namespace Excel {
76005
76005
  */
76006
76006
  name?: boolean;
76007
76007
  /**
76008
- * 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.
76008
+ * 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.
76009
76009
  *
76010
76010
  * @remarks
76011
76011
  * [Api set: ExcelApi 1.8]
@@ -76334,7 +76334,7 @@ declare namespace Excel {
76334
76334
  */
76335
76335
  name?: boolean;
76336
76336
  /**
76337
- * 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.
76337
+ * 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.
76338
76338
  *
76339
76339
  * @remarks
76340
76340
  * [Api set: ExcelApi 1.8]
@@ -79057,7 +79057,7 @@ declare namespace Excel {
79057
79057
  */
79058
79058
  altTextTitle?: boolean;
79059
79059
  /**
79060
- * Specifies if formatting will be automatically formatted when its refreshed or when fields are moved.
79060
+ * Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.
79061
79061
  *
79062
79062
  * @remarks
79063
79063
  * [Api set: ExcelApi 1.9]
office-js/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js",
3
- "version": "1.0.337",
3
+ "version": "1.0.338",
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",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "3d98be5c2f3516797ee8d673cc3a8a0e1f896bb578764f88c80c4bd41a0ec3ce",
48
+ "typesPublisherContentHash": "9040baab563352bddc683c5d233454e8180b3cdfcfd6908ed3f989100b6a0b12",
49
49
  "typeScriptVersion": "4.3"
50
50
  }