@types/office-js-preview 1.0.432 → 1.0.434
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 +369 -143
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -19804,7 +19804,7 @@ declare namespace Office {
|
|
|
19804
19804
|
*/
|
|
19805
19805
|
owner: string;
|
|
19806
19806
|
/**
|
|
19807
|
-
* The REST API's base URL (currently https://outlook.office.com/api).
|
|
19807
|
+
* The REST API's base URL (currently `https://outlook.office.com/api`).
|
|
19808
19808
|
*
|
|
19809
19809
|
* Use with `targetMailbox` to construct the REST operation's URL.
|
|
19810
19810
|
*
|
|
@@ -19905,12 +19905,17 @@ declare namespace Office {
|
|
|
19905
19905
|
*
|
|
19906
19906
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19907
19907
|
*
|
|
19908
|
-
* **Important**:
|
|
19908
|
+
* **Important**:
|
|
19909
|
+
*
|
|
19910
|
+
* - If you specify the `contextData` option in your `event.completed` call, you must also assign a task pane ID to the `commandId` option.
|
|
19909
19911
|
* Otherwise, the JSON data assigned to `contextData` is ignored.
|
|
19910
19912
|
*
|
|
19913
|
+
* - To retrieve the value of the `contextData` property, you must call `Office.context.mailbox.item.getInitializationContextAsync` in the JavaScript implementation
|
|
19914
|
+
* of your task pane.
|
|
19915
|
+
*
|
|
19911
19916
|
* @beta
|
|
19912
19917
|
*/
|
|
19913
|
-
contextData?:
|
|
19918
|
+
contextData?: any;
|
|
19914
19919
|
/**
|
|
19915
19920
|
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler and set its `allowEvent` property
|
|
19916
19921
|
* to `false`, this property sets the error message displayed to the user. For an example, see the
|
|
@@ -25550,6 +25555,14 @@ declare namespace Excel {
|
|
|
25550
25555
|
*/
|
|
25551
25556
|
error = "Error",
|
|
25552
25557
|
/**
|
|
25558
|
+
* Represents an `ExternalCodeServiceObjectCellValue`.
|
|
25559
|
+
*
|
|
25560
|
+
* @remarks
|
|
25561
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25562
|
+
* @beta
|
|
25563
|
+
*/
|
|
25564
|
+
externalCodeServiceObject = "ExternalCodeServiceObject",
|
|
25565
|
+
/**
|
|
25553
25566
|
* Represents a `FormattedNumberCellValue`.
|
|
25554
25567
|
*
|
|
25555
25568
|
* @remarks
|
|
@@ -25567,7 +25580,8 @@ declare namespace Excel {
|
|
|
25567
25580
|
* Represents a `LocalImageCellValue`.
|
|
25568
25581
|
*
|
|
25569
25582
|
* @remarks
|
|
25570
|
-
* [Api set: ExcelApi
|
|
25583
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25584
|
+
* @beta
|
|
25571
25585
|
*/
|
|
25572
25586
|
localImage = "LocalImage",
|
|
25573
25587
|
/**
|
|
@@ -25605,7 +25619,7 @@ declare namespace Excel {
|
|
|
25605
25619
|
* @remarks
|
|
25606
25620
|
* [Api set: ExcelApi 1.16]
|
|
25607
25621
|
*/
|
|
25608
|
-
type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | LocalImageCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
|
|
25622
|
+
type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | ExternalCodeServiceObjectCellValue | FormattedNumberCellValue | LinkedEntityCellValue | LocalImageCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
|
|
25609
25623
|
/**
|
|
25610
25624
|
* These extra properties may appear on a `CellValue` and provide information about that `CellValue`, but the extra properties are not part of the value in the cell.
|
|
25611
25625
|
*
|
|
@@ -25816,6 +25830,49 @@ declare namespace Excel {
|
|
|
25816
25830
|
dotNotation?: boolean;
|
|
25817
25831
|
}
|
|
25818
25832
|
/**
|
|
25833
|
+
* Represents the value of a cell containing a #PYTHON! error.
|
|
25834
|
+
*
|
|
25835
|
+
* @remarks
|
|
25836
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25837
|
+
* @beta
|
|
25838
|
+
*/
|
|
25839
|
+
interface PythonErrorCellValue {
|
|
25840
|
+
/**
|
|
25841
|
+
* Represents the type of this cell value.
|
|
25842
|
+
*
|
|
25843
|
+
* @remarks
|
|
25844
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25845
|
+
* @beta
|
|
25846
|
+
*/
|
|
25847
|
+
type: CellValueType.error | "Error";
|
|
25848
|
+
/**
|
|
25849
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
25850
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
25851
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
25852
|
+
*
|
|
25853
|
+
* @remarks
|
|
25854
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25855
|
+
* @beta
|
|
25856
|
+
*/
|
|
25857
|
+
basicValue?: "#PYTHON!" | string;
|
|
25858
|
+
/**
|
|
25859
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
25860
|
+
*
|
|
25861
|
+
* @remarks
|
|
25862
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25863
|
+
* @beta
|
|
25864
|
+
*/
|
|
25865
|
+
basicType?: RangeValueType.error | "Error";
|
|
25866
|
+
/**
|
|
25867
|
+
* Represents the type of `ErrorCellValue`.
|
|
25868
|
+
*
|
|
25869
|
+
* @remarks
|
|
25870
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25871
|
+
* @beta
|
|
25872
|
+
*/
|
|
25873
|
+
errorType?: ErrorCellValueType.python | "Python";
|
|
25874
|
+
}
|
|
25875
|
+
/**
|
|
25819
25876
|
* Represents types of #CONNECT! errors.
|
|
25820
25877
|
*
|
|
25821
25878
|
* @remarks
|
|
@@ -26311,6 +26368,14 @@ declare namespace Excel {
|
|
|
26311
26368
|
*/
|
|
26312
26369
|
placeholder = "Placeholder",
|
|
26313
26370
|
/**
|
|
26371
|
+
* Represents a `PythonErrorCellValue`.
|
|
26372
|
+
*
|
|
26373
|
+
* @remarks
|
|
26374
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26375
|
+
* @beta
|
|
26376
|
+
*/
|
|
26377
|
+
python = "Python",
|
|
26378
|
+
/**
|
|
26314
26379
|
* Represents a `RefErrorCellValue`.
|
|
26315
26380
|
*
|
|
26316
26381
|
* @remarks
|
|
@@ -26325,6 +26390,14 @@ declare namespace Excel {
|
|
|
26325
26390
|
*/
|
|
26326
26391
|
spill = "Spill",
|
|
26327
26392
|
/**
|
|
26393
|
+
* Represents a `TimeoutErrorCellValue`.
|
|
26394
|
+
*
|
|
26395
|
+
* @remarks
|
|
26396
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26397
|
+
* @beta
|
|
26398
|
+
*/
|
|
26399
|
+
timeout = "Timeout",
|
|
26400
|
+
/**
|
|
26328
26401
|
* Represents a `ValueErrorCellValue`.
|
|
26329
26402
|
*
|
|
26330
26403
|
* @remarks
|
|
@@ -26338,7 +26411,7 @@ declare namespace Excel {
|
|
|
26338
26411
|
* @remarks
|
|
26339
26412
|
* [Api set: ExcelApi 1.16]
|
|
26340
26413
|
*/
|
|
26341
|
-
type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | ExternalErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | PlaceholderErrorCellValue | RefErrorCellValue | SpillErrorCellValue | ValueErrorCellValue;
|
|
26414
|
+
type ErrorCellValue = BlockedErrorCellValue | BusyErrorCellValue | CalcErrorCellValue | ConnectErrorCellValue | Div0ErrorCellValue | ExternalErrorCellValue | FieldErrorCellValue | GettingDataErrorCellValue | NotAvailableErrorCellValue | NameErrorCellValue | NullErrorCellValue | NumErrorCellValue | PlaceholderErrorCellValue | PythonErrorCellValue | RefErrorCellValue | SpillErrorCellValue | TimeoutErrorCellValue | ValueErrorCellValue;
|
|
26342
26415
|
/**
|
|
26343
26416
|
* Represents types of #EXTERNAL! errors.
|
|
26344
26417
|
*
|
|
@@ -26400,6 +26473,79 @@ declare namespace Excel {
|
|
|
26400
26473
|
errorSubType?: ExternalErrorCellValueSubType | "Unknown";
|
|
26401
26474
|
}
|
|
26402
26475
|
/**
|
|
26476
|
+
* Represents the value of a cell containing an External Code Service Object, such as Python code formula.
|
|
26477
|
+
*
|
|
26478
|
+
* @remarks
|
|
26479
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26480
|
+
* @beta
|
|
26481
|
+
*/
|
|
26482
|
+
interface ExternalCodeServiceObjectCellValue {
|
|
26483
|
+
/**
|
|
26484
|
+
* Represents the type of this cell value.
|
|
26485
|
+
*
|
|
26486
|
+
* @remarks
|
|
26487
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26488
|
+
* @beta
|
|
26489
|
+
*/
|
|
26490
|
+
type: CellValueType.externalCodeServiceObject | "ExternalCodeServiceObject";
|
|
26491
|
+
/**
|
|
26492
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
26493
|
+
*
|
|
26494
|
+
* @remarks
|
|
26495
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26496
|
+
* @beta
|
|
26497
|
+
*/
|
|
26498
|
+
basicValue?: boolean | number | string;
|
|
26499
|
+
/**
|
|
26500
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
26501
|
+
*
|
|
26502
|
+
* @remarks
|
|
26503
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26504
|
+
* @beta
|
|
26505
|
+
*/
|
|
26506
|
+
basicType?: RangeValueType | "Boolean" | "Double" | "Error" | "Empty" | "String";
|
|
26507
|
+
/**
|
|
26508
|
+
* Represents the preview value shown in the cell.
|
|
26509
|
+
*
|
|
26510
|
+
* @remarks
|
|
26511
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26512
|
+
* @beta
|
|
26513
|
+
*/
|
|
26514
|
+
preview?: CellValue;
|
|
26515
|
+
/**
|
|
26516
|
+
* Represents the runtime language of this external code service.
|
|
26517
|
+
*
|
|
26518
|
+
* @remarks
|
|
26519
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26520
|
+
* @beta
|
|
26521
|
+
*/
|
|
26522
|
+
language: "Python";
|
|
26523
|
+
/**
|
|
26524
|
+
* Represents the full type name of this object.
|
|
26525
|
+
*
|
|
26526
|
+
* @remarks
|
|
26527
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26528
|
+
* @beta
|
|
26529
|
+
*/
|
|
26530
|
+
Python_type: string;
|
|
26531
|
+
/**
|
|
26532
|
+
* Represents the short type name of this object.
|
|
26533
|
+
*
|
|
26534
|
+
* @remarks
|
|
26535
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26536
|
+
* @beta
|
|
26537
|
+
*/
|
|
26538
|
+
Python_typeName: string;
|
|
26539
|
+
/**
|
|
26540
|
+
* Represents the output of str() function when used on this object.
|
|
26541
|
+
*
|
|
26542
|
+
* @remarks
|
|
26543
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26544
|
+
* @beta
|
|
26545
|
+
*/
|
|
26546
|
+
Python_str: string;
|
|
26547
|
+
}
|
|
26548
|
+
/**
|
|
26403
26549
|
* Represents types of #FIELD! errors.
|
|
26404
26550
|
*
|
|
26405
26551
|
* @remarks
|
|
@@ -26431,7 +26577,7 @@ declare namespace Excel {
|
|
|
26431
26577
|
* An error caused by a missing file. In this case, the RichValueRel.xml file is missing from the metro package. Displays as error type #FIELD! in Excel.
|
|
26432
26578
|
*
|
|
26433
26579
|
* @remarks
|
|
26434
|
-
* [Api set: 1.16]
|
|
26580
|
+
* [Api set: ExcelApi 1.16]
|
|
26435
26581
|
*/
|
|
26436
26582
|
richValueRelMissingFilePart = "RichValueRelMissingFilePart"
|
|
26437
26583
|
}
|
|
@@ -27163,6 +27309,82 @@ declare namespace Excel {
|
|
|
27163
27309
|
basicType?: RangeValueType.string | "String";
|
|
27164
27310
|
}
|
|
27165
27311
|
/**
|
|
27312
|
+
* Represents types of #TIMEOUT! errors.
|
|
27313
|
+
*
|
|
27314
|
+
* @remarks
|
|
27315
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27316
|
+
* @beta
|
|
27317
|
+
*/
|
|
27318
|
+
enum TimeoutErrorCellValueSubType {
|
|
27319
|
+
/**
|
|
27320
|
+
* An unknown type of error. Displays as error type #TIMEOUT! in Excel.
|
|
27321
|
+
*
|
|
27322
|
+
* @remarks
|
|
27323
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27324
|
+
* @beta
|
|
27325
|
+
*/
|
|
27326
|
+
unknown = "Unknown",
|
|
27327
|
+
/**
|
|
27328
|
+
* Python function timed out. Displays as error type #TIMEOUT! in Excel.
|
|
27329
|
+
*
|
|
27330
|
+
* @remarks
|
|
27331
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27332
|
+
* @beta
|
|
27333
|
+
*/
|
|
27334
|
+
pythonTimeoutLimitReached = "PythonTimeoutLimitReached"
|
|
27335
|
+
}
|
|
27336
|
+
/**
|
|
27337
|
+
* Represents the value of a cell containing a #TIMEOUT! error.
|
|
27338
|
+
*
|
|
27339
|
+
* @remarks
|
|
27340
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27341
|
+
* @beta
|
|
27342
|
+
*/
|
|
27343
|
+
interface TimeoutErrorCellValue {
|
|
27344
|
+
/**
|
|
27345
|
+
* Represents the type of this cell value.
|
|
27346
|
+
*
|
|
27347
|
+
* @remarks
|
|
27348
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27349
|
+
* @beta
|
|
27350
|
+
*/
|
|
27351
|
+
type: CellValueType.error | "Error";
|
|
27352
|
+
/**
|
|
27353
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
27354
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
27355
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
27356
|
+
*
|
|
27357
|
+
* @remarks
|
|
27358
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27359
|
+
* @beta
|
|
27360
|
+
*/
|
|
27361
|
+
basicValue?: "#TIMEOUT!" | string;
|
|
27362
|
+
/**
|
|
27363
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
27364
|
+
*
|
|
27365
|
+
* @remarks
|
|
27366
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27367
|
+
* @beta
|
|
27368
|
+
*/
|
|
27369
|
+
basicType?: RangeValueType.error | "Error";
|
|
27370
|
+
/**
|
|
27371
|
+
* Represents the type of `ErrorCellValue`.
|
|
27372
|
+
*
|
|
27373
|
+
* @remarks
|
|
27374
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27375
|
+
* @beta
|
|
27376
|
+
*/
|
|
27377
|
+
errorType?: ErrorCellValueType.timeout | "Timeout";
|
|
27378
|
+
/**
|
|
27379
|
+
* Represents the type of `TimeoutErrorCellValue`.
|
|
27380
|
+
*
|
|
27381
|
+
* @remarks
|
|
27382
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
27383
|
+
* @beta
|
|
27384
|
+
*/
|
|
27385
|
+
errorSubType?: TimeoutErrorCellValueSubType | "Unknown" | "PythonTimeoutLimitReached";
|
|
27386
|
+
}
|
|
27387
|
+
/**
|
|
27166
27388
|
* Represents types of #VALUE! errors.
|
|
27167
27389
|
*
|
|
27168
27390
|
* @remarks
|
|
@@ -28328,7 +28550,7 @@ declare namespace Excel {
|
|
|
28328
28550
|
* [Api set: ExcelApiOnline 1.1]
|
|
28329
28551
|
*
|
|
28330
28552
|
* @param key The title of the `AllowEditRange`.
|
|
28331
|
-
* @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
28553
|
+
* @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, 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 | *OrNullObject methods and properties}.
|
|
28332
28554
|
*/
|
|
28333
28555
|
getItemOrNullObject(key: string): Excel.AllowEditRange;
|
|
28334
28556
|
/**
|
|
@@ -28824,7 +29046,7 @@ declare namespace Excel {
|
|
|
28824
29046
|
getItem(key: string): Excel.LinkedWorkbook;
|
|
28825
29047
|
/**
|
|
28826
29048
|
* Gets information about a linked workbook by its URL. If the workbook does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
28827
|
-
For further information, see {@link https://
|
|
29049
|
+
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}.
|
|
28828
29050
|
*
|
|
28829
29051
|
* @remarks
|
|
28830
29052
|
* [Api set: ExcelApiOnline 1.1]
|
|
@@ -29468,7 +29690,7 @@ declare namespace Excel {
|
|
|
29468
29690
|
*
|
|
29469
29691
|
* @param key The ID of the task.
|
|
29470
29692
|
* @returns The task with the given ID. If there is no task with the given ID, then this method returns an object with its `isNullObject` property set to `true`.
|
|
29471
|
-
For further information, see {@link https://
|
|
29693
|
+
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}.
|
|
29472
29694
|
*/
|
|
29473
29695
|
getItemOrNullObject(key: string): Excel.DocumentTask;
|
|
29474
29696
|
/**
|
|
@@ -31567,7 +31789,7 @@ declare namespace Excel {
|
|
|
31567
31789
|
interface ChangeDirectionState {
|
|
31568
31790
|
/**
|
|
31569
31791
|
* Represents the direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted.
|
|
31570
|
-
Note
|
|
31792
|
+
Note: `insertShiftDirection` and `deleteShiftDirection` are exclusive and both enums can't have a value at the same time. If one has a value, then the other will return `undefined`.
|
|
31571
31793
|
*
|
|
31572
31794
|
* @remarks
|
|
31573
31795
|
* [Api set: ExcelApi 1.14]
|
|
@@ -31575,7 +31797,7 @@ declare namespace Excel {
|
|
|
31575
31797
|
deleteShiftDirection: Excel.DeleteShiftDirection | "Up" | "Left";
|
|
31576
31798
|
/**
|
|
31577
31799
|
* Represents the direction (such as down or to the right) that the existing cells will shift when a new cell or cells are inserted.
|
|
31578
|
-
Note
|
|
31800
|
+
Note: `insertShiftDirection` and `deleteShiftDirection` are exclusive and both enums can't have a value at the same time. If one has a value, then the other will return `undefined`.
|
|
31579
31801
|
*
|
|
31580
31802
|
* @remarks
|
|
31581
31803
|
* [Api set: ExcelApi 1.14]
|
|
@@ -33038,7 +33260,7 @@ declare namespace Excel {
|
|
|
33038
33260
|
}
|
|
33039
33261
|
/**
|
|
33040
33262
|
* Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges.
|
|
33041
|
-
To learn more about the workbook object model, read {@link https://
|
|
33263
|
+
To learn more about the workbook object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}.
|
|
33042
33264
|
*
|
|
33043
33265
|
* @remarks
|
|
33044
33266
|
* [Api set: ExcelApi 1.1]
|
|
@@ -33335,7 +33557,7 @@ declare namespace Excel {
|
|
|
33335
33557
|
getActiveChart(): Excel.Chart;
|
|
33336
33558
|
/**
|
|
33337
33559
|
* Gets the currently active chart in the workbook. If there is no active chart, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33338
|
-
For further information, see {@link https://
|
|
33560
|
+
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}.
|
|
33339
33561
|
*
|
|
33340
33562
|
* @remarks
|
|
33341
33563
|
* [Api set: ExcelApi 1.9]
|
|
@@ -33350,7 +33572,7 @@ declare namespace Excel {
|
|
|
33350
33572
|
getActiveSlicer(): Excel.Slicer;
|
|
33351
33573
|
/**
|
|
33352
33574
|
* Gets the currently active slicer in the workbook. If there is no active slicer, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33353
|
-
For further information, see {@link https://
|
|
33575
|
+
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}.
|
|
33354
33576
|
*
|
|
33355
33577
|
* @remarks
|
|
33356
33578
|
* [Api set: ExcelApi 1.10]
|
|
@@ -33406,7 +33628,7 @@ declare namespace Excel {
|
|
|
33406
33628
|
* @remarks
|
|
33407
33629
|
* [Api set: ExcelApi 1.11]
|
|
33408
33630
|
*
|
|
33409
|
-
* @param saveBehavior
|
|
33631
|
+
* @param saveBehavior The save behavior must be "Save" or "Prompt". Default value is "Save".
|
|
33410
33632
|
*/
|
|
33411
33633
|
save(saveBehavior?: Excel.SaveBehavior): void;
|
|
33412
33634
|
/**
|
|
@@ -33415,7 +33637,7 @@ declare namespace Excel {
|
|
|
33415
33637
|
* @remarks
|
|
33416
33638
|
* [Api set: ExcelApi 1.11]
|
|
33417
33639
|
*
|
|
33418
|
-
* @param saveBehavior
|
|
33640
|
+
* @param saveBehavior The save behavior must be "Save" or "Prompt". Default value is "Save".
|
|
33419
33641
|
*/
|
|
33420
33642
|
save(saveBehavior?: "Save" | "Prompt"): void;
|
|
33421
33643
|
/**
|
|
@@ -33565,7 +33787,7 @@ declare namespace Excel {
|
|
|
33565
33787
|
}
|
|
33566
33788
|
/**
|
|
33567
33789
|
* An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.
|
|
33568
|
-
To learn more about the worksheet object model, read {@link https://
|
|
33790
|
+
To learn more about the worksheet object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | Work with worksheets using the Excel JavaScript API}.
|
|
33569
33791
|
*
|
|
33570
33792
|
* @remarks
|
|
33571
33793
|
* [Api set: ExcelApi 1.1]
|
|
@@ -33840,7 +34062,7 @@ declare namespace Excel {
|
|
|
33840
34062
|
* @param text The string to find.
|
|
33841
34063
|
* @param criteria Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive.
|
|
33842
34064
|
* @returns A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33843
|
-
For further information, see {@link https://
|
|
34065
|
+
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}.
|
|
33844
34066
|
*/
|
|
33845
34067
|
findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;
|
|
33846
34068
|
/**
|
|
@@ -33864,7 +34086,7 @@ declare namespace Excel {
|
|
|
33864
34086
|
getNext(visibleOnly?: boolean): Excel.Worksheet;
|
|
33865
34087
|
/**
|
|
33866
34088
|
* Gets the worksheet that follows this one. If there are no worksheets following this one, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33867
|
-
For further information, see {@link https://
|
|
34089
|
+
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}.
|
|
33868
34090
|
*
|
|
33869
34091
|
* @remarks
|
|
33870
34092
|
* [Api set: ExcelApi 1.5]
|
|
@@ -33883,7 +34105,7 @@ declare namespace Excel {
|
|
|
33883
34105
|
getPrevious(visibleOnly?: boolean): Excel.Worksheet;
|
|
33884
34106
|
/**
|
|
33885
34107
|
* Gets the worksheet that precedes this one. If there are no previous worksheets, then this method returns an object with its `isNullObject` property set to `true`.
|
|
33886
|
-
For further information, see {@link https://
|
|
34108
|
+
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}.
|
|
33887
34109
|
*
|
|
33888
34110
|
* @remarks
|
|
33889
34111
|
* [Api set: ExcelApi 1.5]
|
|
@@ -33931,7 +34153,7 @@ declare namespace Excel {
|
|
|
33931
34153
|
*/
|
|
33932
34154
|
getUsedRange(valuesOnly?: boolean): Excel.Range;
|
|
33933
34155
|
/**
|
|
33934
|
-
* The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://
|
|
34156
|
+
* The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them. If the entire worksheet is blank, 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 | *OrNullObject methods and properties}.
|
|
33935
34157
|
*
|
|
33936
34158
|
* @remarks
|
|
33937
34159
|
* [Api set: ExcelApi 1.4]
|
|
@@ -34220,7 +34442,7 @@ declare namespace Excel {
|
|
|
34220
34442
|
getItem(key: string): Excel.Worksheet;
|
|
34221
34443
|
/**
|
|
34222
34444
|
* Gets a worksheet object using its name or ID. If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34223
|
-
For further information, see {@link https://
|
|
34445
|
+
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}.
|
|
34224
34446
|
*
|
|
34225
34447
|
* @remarks
|
|
34226
34448
|
* [Api set: ExcelApi 1.4]
|
|
@@ -34489,7 +34711,7 @@ declare namespace Excel {
|
|
|
34489
34711
|
/**
|
|
34490
34712
|
* Specifies if the password can be used to unlock worksheet protection.
|
|
34491
34713
|
This method doesn't change the worksheet protection state.
|
|
34492
|
-
If a password is
|
|
34714
|
+
If a password is entered but no password is required to unlock worksheet protection, this method will return false.
|
|
34493
34715
|
*
|
|
34494
34716
|
* @remarks
|
|
34495
34717
|
* [Api set: ExcelApiOnline 1.1]
|
|
@@ -34741,7 +34963,7 @@ declare namespace Excel {
|
|
|
34741
34963
|
* Gets a range that describes the frozen cells in the active worksheet view.
|
|
34742
34964
|
The frozen range corresponds to cells that are frozen in the top- and left-most pane.
|
|
34743
34965
|
If there is no frozen pane, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34744
|
-
For further information, see {@link https://
|
|
34966
|
+
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}.
|
|
34745
34967
|
*
|
|
34746
34968
|
* @remarks
|
|
34747
34969
|
* [Api set: ExcelApi 1.7]
|
|
@@ -34793,7 +35015,7 @@ declare namespace Excel {
|
|
|
34793
35015
|
}
|
|
34794
35016
|
/**
|
|
34795
35017
|
* Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.
|
|
34796
|
-
To learn more about how ranges are used throughout the API, start with {@link https://
|
|
35018
|
+
To learn more about how ranges are used throughout the API, start with {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges | Ranges in the Excel JavaScript API}.
|
|
34797
35019
|
*
|
|
34798
35020
|
* @remarks
|
|
34799
35021
|
* [Api set: ExcelApi 1.1]
|
|
@@ -35091,7 +35313,7 @@ declare namespace Excel {
|
|
|
35091
35313
|
* @remarks
|
|
35092
35314
|
* [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
|
|
35093
35315
|
*
|
|
35094
|
-
* @param destinationRange The destination range to AutoFill. If the destination range is `null`, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI
|
|
35316
|
+
* @param destinationRange The destination range to AutoFill. If the destination range is `null`, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
|
|
35095
35317
|
* @param autoFillType The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault".
|
|
35096
35318
|
*/
|
|
35097
35319
|
autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;
|
|
@@ -35105,7 +35327,7 @@ declare namespace Excel {
|
|
|
35105
35327
|
* @remarks
|
|
35106
35328
|
* [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
|
|
35107
35329
|
*
|
|
35108
|
-
* @param destinationRange The destination range to AutoFill. If the destination range is `null`, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI
|
|
35330
|
+
* @param destinationRange The destination range to AutoFill. If the destination range is `null`, data is filled out based on the surrounding cells (which is the behavior when double-clicking the UI's range fill handle).
|
|
35109
35331
|
* @param autoFillType The type of AutoFill. Specifies how the destination range is to be filled, based on the contents of the current range. Default is "FillDefault".
|
|
35110
35332
|
*/
|
|
35111
35333
|
autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;
|
|
@@ -35176,7 +35398,7 @@ declare namespace Excel {
|
|
|
35176
35398
|
* @param skipBlanks True if to skip blank cells in the source range. Default is false.
|
|
35177
35399
|
* @param transpose True if to transpose the cells in the destination range. Default is false.
|
|
35178
35400
|
*/
|
|
35179
|
-
copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats", skipBlanks?: boolean, transpose?: boolean): void;
|
|
35401
|
+
copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void;
|
|
35180
35402
|
/**
|
|
35181
35403
|
* Deletes the cells associated with the range.
|
|
35182
35404
|
*
|
|
@@ -35211,7 +35433,7 @@ declare namespace Excel {
|
|
|
35211
35433
|
* Finds the given string based on the criteria specified.
|
|
35212
35434
|
If the current range is larger than a single cell, then the search will be limited to that range, else the search will cover the entire sheet starting after that cell.
|
|
35213
35435
|
If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35214
|
-
For further information, see {@link https://
|
|
35436
|
+
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}.
|
|
35215
35437
|
*
|
|
35216
35438
|
* @remarks
|
|
35217
35439
|
* [Api set: ExcelApi 1.9]
|
|
@@ -35378,7 +35600,7 @@ declare namespace Excel {
|
|
|
35378
35600
|
getIntersection(anotherRange: Range | string): Excel.Range;
|
|
35379
35601
|
/**
|
|
35380
35602
|
* Gets the range object that represents the rectangular intersection of the given ranges. If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35381
|
-
For further information, see {@link https://
|
|
35603
|
+
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}.
|
|
35382
35604
|
*
|
|
35383
35605
|
* @remarks
|
|
35384
35606
|
* [Api set: ExcelApi 1.4]
|
|
@@ -35409,7 +35631,7 @@ declare namespace Excel {
|
|
|
35409
35631
|
getLastRow(): Excel.Range;
|
|
35410
35632
|
/**
|
|
35411
35633
|
* Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this function will return an object with its `isNullObject` property set to `true`.
|
|
35412
|
-
For further information, see {@link https://
|
|
35634
|
+
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}.
|
|
35413
35635
|
*
|
|
35414
35636
|
* @remarks
|
|
35415
35637
|
* [Api set: ExcelApi 1.13]
|
|
@@ -35534,7 +35756,7 @@ declare namespace Excel {
|
|
|
35534
35756
|
/**
|
|
35535
35757
|
* Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
|
|
35536
35758
|
If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35537
|
-
For further information, see {@link https://
|
|
35759
|
+
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}.
|
|
35538
35760
|
*
|
|
35539
35761
|
* @remarks
|
|
35540
35762
|
* [Api set: ExcelApi 1.9]
|
|
@@ -35546,7 +35768,7 @@ declare namespace Excel {
|
|
|
35546
35768
|
/**
|
|
35547
35769
|
* Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
|
|
35548
35770
|
If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35549
|
-
For further information, see {@link https://
|
|
35771
|
+
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}.
|
|
35550
35772
|
*
|
|
35551
35773
|
* @remarks
|
|
35552
35774
|
* [Api set: ExcelApi 1.9]
|
|
@@ -35565,7 +35787,7 @@ declare namespace Excel {
|
|
|
35565
35787
|
/**
|
|
35566
35788
|
* Gets the range object containing the anchor cell for the cell getting spilled into.
|
|
35567
35789
|
If it's not a spilled cell, or more than one cell is given, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35568
|
-
For further information, see {@link https://
|
|
35790
|
+
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}.
|
|
35569
35791
|
*
|
|
35570
35792
|
* @remarks
|
|
35571
35793
|
* [Api set: ExcelApi 1.12]
|
|
@@ -35581,7 +35803,7 @@ declare namespace Excel {
|
|
|
35581
35803
|
/**
|
|
35582
35804
|
* Gets the range object containing the spill range when called on an anchor cell.
|
|
35583
35805
|
If the range isn't an anchor cell or the spill range can't be found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35584
|
-
For further information, see {@link https://
|
|
35806
|
+
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}.
|
|
35585
35807
|
*
|
|
35586
35808
|
* @remarks
|
|
35587
35809
|
* [Api set: ExcelApi 1.12]
|
|
@@ -35614,7 +35836,7 @@ declare namespace Excel {
|
|
|
35614
35836
|
getUsedRange(valuesOnly?: boolean): Excel.Range;
|
|
35615
35837
|
/**
|
|
35616
35838
|
* Returns the used range of the given range object. If there are no used cells within the range, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35617
|
-
For further information, see {@link https://
|
|
35839
|
+
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}.
|
|
35618
35840
|
*
|
|
35619
35841
|
* @remarks
|
|
35620
35842
|
* [Api set: ExcelApi 1.4]
|
|
@@ -35910,7 +36132,7 @@ declare namespace Excel {
|
|
|
35910
36132
|
}
|
|
35911
36133
|
/**
|
|
35912
36134
|
* `RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet.
|
|
35913
|
-
To learn how to use discontiguous ranges, read {@link https://
|
|
36135
|
+
To learn how to use discontiguous ranges, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges | Work with multiple ranges simultaneously in Excel add-ins}.
|
|
35914
36136
|
*
|
|
35915
36137
|
* @remarks
|
|
35916
36138
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36079,7 +36301,7 @@ declare namespace Excel {
|
|
|
36079
36301
|
* @param skipBlanks True if to skip blank cells in the source range or `RangeAreas`. Default is false.
|
|
36080
36302
|
* @param transpose True if to transpose the cells in the destination `RangeAreas`. Default is false.
|
|
36081
36303
|
*/
|
|
36082
|
-
copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats", skipBlanks?: boolean, transpose?: boolean): void;
|
|
36304
|
+
copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void;
|
|
36083
36305
|
/**
|
|
36084
36306
|
* Returns a `RangeAreas` object that represents the entire columns of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, H:H").
|
|
36085
36307
|
*
|
|
@@ -36105,7 +36327,7 @@ declare namespace Excel {
|
|
|
36105
36327
|
getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;
|
|
36106
36328
|
/**
|
|
36107
36329
|
* Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`. If no intersection is found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
36108
|
-
For further information, see {@link https://
|
|
36330
|
+
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}.
|
|
36109
36331
|
*
|
|
36110
36332
|
* @remarks
|
|
36111
36333
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36145,7 +36367,7 @@ declare namespace Excel {
|
|
|
36145
36367
|
getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;
|
|
36146
36368
|
/**
|
|
36147
36369
|
* Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
|
|
36148
|
-
For further information, see {@link https://
|
|
36370
|
+
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}.
|
|
36149
36371
|
*
|
|
36150
36372
|
* @remarks
|
|
36151
36373
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36156,7 +36378,7 @@ declare namespace Excel {
|
|
|
36156
36378
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
|
|
36157
36379
|
/**
|
|
36158
36380
|
* Returns a `RangeAreas` object that represents all the cells that match the specified type and value. If no special cells are found that match the criteria, then this method returns an object with its `isNullObject` property set to `true`.
|
|
36159
|
-
For further information, see {@link https://
|
|
36381
|
+
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}.
|
|
36160
36382
|
*
|
|
36161
36383
|
* @remarks
|
|
36162
36384
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36187,7 +36409,7 @@ declare namespace Excel {
|
|
|
36187
36409
|
/**
|
|
36188
36410
|
* Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.
|
|
36189
36411
|
If there are no used cells within the `RangeAreas`, then this method returns an object with its `isNullObject` property set to `true`.
|
|
36190
|
-
For further information, see {@link https://
|
|
36412
|
+
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}.
|
|
36191
36413
|
*
|
|
36192
36414
|
* @remarks
|
|
36193
36415
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36278,7 +36500,7 @@ declare namespace Excel {
|
|
|
36278
36500
|
getRangeAreasBySheet(key: string): Excel.RangeAreas;
|
|
36279
36501
|
/**
|
|
36280
36502
|
* Returns the `RangeAreas` object based on worksheet name or ID in the collection. If the worksheet does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
36281
|
-
For further information, see {@link https://
|
|
36503
|
+
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}.
|
|
36282
36504
|
*
|
|
36283
36505
|
* @remarks
|
|
36284
36506
|
* [Api set: ExcelApi 1.12]
|
|
@@ -37043,7 +37265,7 @@ declare namespace Excel {
|
|
|
37043
37265
|
getItem(key: string): Excel.Setting;
|
|
37044
37266
|
/**
|
|
37045
37267
|
* Gets a setting entry via the key. If the setting does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37046
|
-
For further information, see {@link https://
|
|
37268
|
+
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}.
|
|
37047
37269
|
*
|
|
37048
37270
|
* @remarks
|
|
37049
37271
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37202,7 +37424,7 @@ declare namespace Excel {
|
|
|
37202
37424
|
getItem(name: string): Excel.NamedItem;
|
|
37203
37425
|
/**
|
|
37204
37426
|
* Gets a `NamedItem` object using its name. If the object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37205
|
-
For further information, see {@link https://
|
|
37427
|
+
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}.
|
|
37206
37428
|
*
|
|
37207
37429
|
* @remarks
|
|
37208
37430
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37259,7 +37481,7 @@ declare namespace Excel {
|
|
|
37259
37481
|
readonly worksheet: Excel.Worksheet;
|
|
37260
37482
|
/**
|
|
37261
37483
|
* Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37262
|
-
For further information, see {@link https://
|
|
37484
|
+
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}.
|
|
37263
37485
|
*
|
|
37264
37486
|
* @remarks
|
|
37265
37487
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37301,8 +37523,8 @@ declare namespace Excel {
|
|
|
37301
37523
|
*/
|
|
37302
37524
|
readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";
|
|
37303
37525
|
/**
|
|
37304
|
-
* Represents the value computed by the name's formula. For a named range it will return the range address.
|
|
37305
|
-
|
|
37526
|
+
* Represents the value computed by the name's formula. For a named range, it will return the range address.
|
|
37527
|
+
This API returns the #VALUE! error in the Excel UI if it refers to a user-defined function.
|
|
37306
37528
|
*
|
|
37307
37529
|
* @remarks
|
|
37308
37530
|
* [Api set: ExcelApi 1.1]
|
|
@@ -37357,7 +37579,7 @@ declare namespace Excel {
|
|
|
37357
37579
|
getRange(): Excel.Range;
|
|
37358
37580
|
/**
|
|
37359
37581
|
* Returns the range object that is associated with the name. If the named item's type is not a range, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37360
|
-
For further information, see {@link https://
|
|
37582
|
+
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}.
|
|
37361
37583
|
*
|
|
37362
37584
|
* @remarks
|
|
37363
37585
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37669,7 +37891,7 @@ declare namespace Excel {
|
|
|
37669
37891
|
getItemAt(index: number): Excel.Binding;
|
|
37670
37892
|
/**
|
|
37671
37893
|
* Gets a binding object by ID. If the binding object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37672
|
-
For further information, see {@link https://
|
|
37894
|
+
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}.
|
|
37673
37895
|
*
|
|
37674
37896
|
* @remarks
|
|
37675
37897
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37756,7 +37978,7 @@ declare namespace Excel {
|
|
|
37756
37978
|
getItemAt(index: number): Excel.Table;
|
|
37757
37979
|
/**
|
|
37758
37980
|
* Gets a table by name or ID. If the table doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37759
|
-
For further information, see {@link https://
|
|
37981
|
+
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}.
|
|
37760
37982
|
*
|
|
37761
37983
|
* @remarks
|
|
37762
37984
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37862,7 +38084,7 @@ declare namespace Excel {
|
|
|
37862
38084
|
/**
|
|
37863
38085
|
* Gets a table by name or ID.
|
|
37864
38086
|
If the table object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37865
|
-
For further information, see {@link https://
|
|
38087
|
+
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}.
|
|
37866
38088
|
*
|
|
37867
38089
|
* @remarks
|
|
37868
38090
|
* [Api set: ExcelApi 1.14]
|
|
@@ -37896,7 +38118,7 @@ declare namespace Excel {
|
|
|
37896
38118
|
}
|
|
37897
38119
|
/**
|
|
37898
38120
|
* Represents an Excel table.
|
|
37899
|
-
To learn more about the table object model, read {@link https://
|
|
38121
|
+
To learn more about the table object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | Work with tables using the Excel JavaScript API}.
|
|
37900
38122
|
*
|
|
37901
38123
|
* @remarks
|
|
37902
38124
|
* [Api set: ExcelApi 1.1]
|
|
@@ -38240,7 +38462,7 @@ declare namespace Excel {
|
|
|
38240
38462
|
getItemAt(index: number): Excel.TableColumn;
|
|
38241
38463
|
/**
|
|
38242
38464
|
* Gets a column object by name or ID. If the column doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
38243
|
-
For further information, see {@link https://
|
|
38465
|
+
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}.
|
|
38244
38466
|
*
|
|
38245
38467
|
* @remarks
|
|
38246
38468
|
* [Api set: ExcelApi 1.4]
|
|
@@ -38626,7 +38848,7 @@ declare namespace Excel {
|
|
|
38626
38848
|
}
|
|
38627
38849
|
/**
|
|
38628
38850
|
* Represents the data validation applied to the current range.
|
|
38629
|
-
To learn more about the data validation object model, read {@link https://
|
|
38851
|
+
To learn more about the data validation object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation | Add data validation to Excel ranges}.
|
|
38630
38852
|
*
|
|
38631
38853
|
* @remarks
|
|
38632
38854
|
* [Api set: ExcelApi 1.8]
|
|
@@ -39056,7 +39278,7 @@ declare namespace Excel {
|
|
|
39056
39278
|
*/
|
|
39057
39279
|
autoIndent: boolean;
|
|
39058
39280
|
/**
|
|
39059
|
-
* Specifies the width of all
|
|
39281
|
+
* Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be returned.
|
|
39060
39282
|
*
|
|
39061
39283
|
* @remarks
|
|
39062
39284
|
* [Api set: ExcelApi 1.2]
|
|
@@ -39694,7 +39916,7 @@ declare namespace Excel {
|
|
|
39694
39916
|
getItemAt(index: number): Excel.Chart;
|
|
39695
39917
|
/**
|
|
39696
39918
|
* Gets a chart using its name. If there are multiple charts with the same name, the first one will be returned. If the chart doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39697
|
-
For further information, see {@link https://
|
|
39919
|
+
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}.
|
|
39698
39920
|
*
|
|
39699
39921
|
* @remarks
|
|
39700
39922
|
* [Api set: ExcelApi 1.4]
|
|
@@ -39764,7 +39986,7 @@ declare namespace Excel {
|
|
|
39764
39986
|
}
|
|
39765
39987
|
/**
|
|
39766
39988
|
* Represents a chart object in a workbook.
|
|
39767
|
-
To learn more about the chart object model, see {@link https://
|
|
39989
|
+
To learn more about the chart object model, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | Work with charts using the Excel JavaScript API}.
|
|
39768
39990
|
*
|
|
39769
39991
|
* @remarks
|
|
39770
39992
|
* [Api set: ExcelApi 1.1]
|
|
@@ -39974,7 +40196,7 @@ declare namespace Excel {
|
|
|
39974
40196
|
getDataRange(): OfficeExtension.ClientResult<string>;
|
|
39975
40197
|
/**
|
|
39976
40198
|
* Gets the data source of the whole chart. If the data range is empty, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39977
|
-
For further information, see {@link https://
|
|
40199
|
+
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}.
|
|
39978
40200
|
*
|
|
39979
40201
|
* @remarks
|
|
39980
40202
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -39990,7 +40212,7 @@ declare namespace Excel {
|
|
|
39990
40212
|
getDataTable(): Excel.ChartDataTable;
|
|
39991
40213
|
/**
|
|
39992
40214
|
* Gets the data table on the chart. If the chart doesn't allow a data table, then this method returns an object with its `isNullObject` property set to `true`.
|
|
39993
|
-
For further information, see {@link https://
|
|
40215
|
+
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}.
|
|
39994
40216
|
*
|
|
39995
40217
|
* @remarks
|
|
39996
40218
|
* [Api set: ExcelApi 1.14]
|
|
@@ -40735,7 +40957,7 @@ declare namespace Excel {
|
|
|
40735
40957
|
*/
|
|
40736
40958
|
setValues(sourceData: Range): void;
|
|
40737
40959
|
/**
|
|
40738
|
-
* Sets the values of the x-axis for a chart series.
|
|
40960
|
+
* Sets the values of the x-axis for a chart series.
|
|
40739
40961
|
*
|
|
40740
40962
|
* @remarks
|
|
40741
40963
|
* [Api set: ExcelApi 1.7]
|
|
@@ -41569,7 +41791,7 @@ declare namespace Excel {
|
|
|
41569
41791
|
*/
|
|
41570
41792
|
textOrientation: number;
|
|
41571
41793
|
/**
|
|
41572
|
-
* Specifies if the axis title is
|
|
41794
|
+
* Specifies if the axis title is visible.
|
|
41573
41795
|
*
|
|
41574
41796
|
* @remarks
|
|
41575
41797
|
* [Api set: ExcelApi 1.1]
|
|
@@ -42951,7 +43173,7 @@ declare namespace Excel {
|
|
|
42951
43173
|
*/
|
|
42952
43174
|
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
|
|
42953
43175
|
/**
|
|
42954
|
-
* Specifies if the chart title is
|
|
43176
|
+
* Specifies if the chart title is visible.
|
|
42955
43177
|
*
|
|
42956
43178
|
* @remarks
|
|
42957
43179
|
* [Api set: ExcelApi 1.1]
|
|
@@ -44721,7 +44943,7 @@ declare namespace Excel {
|
|
|
44721
44943
|
/**
|
|
44722
44944
|
* Returns the `Range` object that represents the range to which the AutoFilter applies.
|
|
44723
44945
|
If there is no `Range` object associated with the AutoFilter, then this method returns an object with its `isNullObject` property set to `true`.
|
|
44724
|
-
For further information, see {@link https://
|
|
44946
|
+
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}.
|
|
44725
44947
|
*
|
|
44726
44948
|
* @remarks
|
|
44727
44949
|
* [Api set: ExcelApi 1.9]
|
|
@@ -45007,7 +45229,7 @@ declare namespace Excel {
|
|
|
45007
45229
|
/**
|
|
45008
45230
|
* Gets a custom XML part based on its ID.
|
|
45009
45231
|
If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45010
|
-
For further information, see {@link https://
|
|
45232
|
+
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}.
|
|
45011
45233
|
*
|
|
45012
45234
|
* @remarks
|
|
45013
45235
|
* [Api set: ExcelApi 1.5]
|
|
@@ -45103,7 +45325,7 @@ declare namespace Excel {
|
|
|
45103
45325
|
/**
|
|
45104
45326
|
* Gets a custom XML part based on its ID.
|
|
45105
45327
|
If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45106
|
-
For further information, see {@link https://
|
|
45328
|
+
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}.
|
|
45107
45329
|
*
|
|
45108
45330
|
* @remarks
|
|
45109
45331
|
* [Api set: ExcelApi 1.5]
|
|
@@ -45236,7 +45458,7 @@ declare namespace Excel {
|
|
|
45236
45458
|
/**
|
|
45237
45459
|
* Gets the first PivotTable in the collection. The PivotTables in the collection are sorted top-to-bottom and left-to-right, such that the top-left table is the first PivotTable in the collection.
|
|
45238
45460
|
If the collection is empty, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45239
|
-
For further information, see {@link https://
|
|
45461
|
+
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}.
|
|
45240
45462
|
*
|
|
45241
45463
|
* @remarks
|
|
45242
45464
|
* [Api set: ExcelApi 1.15]
|
|
@@ -45253,7 +45475,7 @@ declare namespace Excel {
|
|
|
45253
45475
|
getItem(key: string): Excel.PivotTable;
|
|
45254
45476
|
/**
|
|
45255
45477
|
* Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45256
|
-
For further information, see {@link https://
|
|
45478
|
+
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}.
|
|
45257
45479
|
*
|
|
45258
45480
|
* @remarks
|
|
45259
45481
|
* [Api set: ExcelApi 1.12]
|
|
@@ -45326,7 +45548,7 @@ declare namespace Excel {
|
|
|
45326
45548
|
getItem(name: string): Excel.PivotTable;
|
|
45327
45549
|
/**
|
|
45328
45550
|
* Gets a PivotTable by name. If the PivotTable does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45329
|
-
For further information, see {@link https://
|
|
45551
|
+
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}.
|
|
45330
45552
|
*
|
|
45331
45553
|
* @remarks
|
|
45332
45554
|
* [Api set: ExcelApi 1.4]
|
|
@@ -45416,7 +45638,7 @@ declare namespace Excel {
|
|
|
45416
45638
|
}
|
|
45417
45639
|
/**
|
|
45418
45640
|
* Represents an Excel PivotTable.
|
|
45419
|
-
To learn more about the PivotTable object model, read {@link https://
|
|
45641
|
+
To learn more about the PivotTable object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | Work with PivotTables using the Excel JavaScript API}.
|
|
45420
45642
|
*
|
|
45421
45643
|
* @remarks
|
|
45422
45644
|
* [Api set: ExcelApi 1.3]
|
|
@@ -45884,7 +46106,7 @@ declare namespace Excel {
|
|
|
45884
46106
|
getItem(name: string): Excel.PivotHierarchy;
|
|
45885
46107
|
/**
|
|
45886
46108
|
* Gets a PivotHierarchy by name. If the PivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45887
|
-
For further information, see {@link https://
|
|
46109
|
+
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}.
|
|
45888
46110
|
*
|
|
45889
46111
|
* @remarks
|
|
45890
46112
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46018,7 +46240,7 @@ declare namespace Excel {
|
|
|
46018
46240
|
getItem(name: string): Excel.RowColumnPivotHierarchy;
|
|
46019
46241
|
/**
|
|
46020
46242
|
* Gets a RowColumnPivotHierarchy by name. If the RowColumnPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
46021
|
-
For further information, see {@link https://
|
|
46243
|
+
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}.
|
|
46022
46244
|
*
|
|
46023
46245
|
* @remarks
|
|
46024
46246
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46173,7 +46395,7 @@ declare namespace Excel {
|
|
|
46173
46395
|
getItem(name: string): Excel.FilterPivotHierarchy;
|
|
46174
46396
|
/**
|
|
46175
46397
|
* Gets a FilterPivotHierarchy by name. If the FilterPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
46176
|
-
For further information, see {@link https://
|
|
46398
|
+
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}.
|
|
46177
46399
|
*
|
|
46178
46400
|
* @remarks
|
|
46179
46401
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46334,7 +46556,7 @@ declare namespace Excel {
|
|
|
46334
46556
|
getItem(name: string): Excel.DataPivotHierarchy;
|
|
46335
46557
|
/**
|
|
46336
46558
|
* Gets a DataPivotHierarchy by name. If the DataPivotHierarchy does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
46337
|
-
For further information, see {@link https://
|
|
46559
|
+
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}.
|
|
46338
46560
|
*
|
|
46339
46561
|
* @remarks
|
|
46340
46562
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46529,7 +46751,7 @@ declare namespace Excel {
|
|
|
46529
46751
|
getItem(name: string): Excel.PivotField;
|
|
46530
46752
|
/**
|
|
46531
46753
|
* Gets a PivotField by name. If the PivotField does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
46532
|
-
For further information, see {@link https://
|
|
46754
|
+
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}.
|
|
46533
46755
|
*
|
|
46534
46756
|
* @remarks
|
|
46535
46757
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46771,7 +46993,7 @@ declare namespace Excel {
|
|
|
46771
46993
|
getItem(name: string): Excel.PivotItem;
|
|
46772
46994
|
/**
|
|
46773
46995
|
* Gets a PivotItem by name. If the PivotItem does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
46774
|
-
For further information, see {@link https://
|
|
46996
|
+
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}.
|
|
46775
46997
|
*
|
|
46776
46998
|
* @remarks
|
|
46777
46999
|
* [Api set: ExcelApi 1.8]
|
|
@@ -47297,7 +47519,7 @@ declare namespace Excel {
|
|
|
47297
47519
|
getItem(key: string): Excel.WorksheetCustomProperty;
|
|
47298
47520
|
/**
|
|
47299
47521
|
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
47300
|
-
For further information, see {@link https://
|
|
47522
|
+
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}.
|
|
47301
47523
|
*
|
|
47302
47524
|
* @remarks
|
|
47303
47525
|
* [Api set: ExcelApi 1.12]
|
|
@@ -47575,7 +47797,7 @@ declare namespace Excel {
|
|
|
47575
47797
|
getItem(key: string): Excel.CustomProperty;
|
|
47576
47798
|
/**
|
|
47577
47799
|
* Gets a custom property object by its key, which is case-insensitive. If the custom property doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
47578
|
-
For further information, see {@link https://
|
|
47800
|
+
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}.
|
|
47579
47801
|
*
|
|
47580
47802
|
* @remarks
|
|
47581
47803
|
* [Api set: ExcelApi 1.7]
|
|
@@ -47672,7 +47894,7 @@ declare namespace Excel {
|
|
|
47672
47894
|
/**
|
|
47673
47895
|
* Returns a conditional format identified by its ID.
|
|
47674
47896
|
If the conditional format object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
47675
|
-
For further information, see {@link https://
|
|
47897
|
+
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}.
|
|
47676
47898
|
*
|
|
47677
47899
|
* @remarks
|
|
47678
47900
|
* [Api set: ExcelApi 1.14]
|
|
@@ -47706,7 +47928,7 @@ declare namespace Excel {
|
|
|
47706
47928
|
}
|
|
47707
47929
|
/**
|
|
47708
47930
|
* An object encapsulating a conditional format's range, format, rule, and other properties.
|
|
47709
|
-
To learn more about the conditional formatting object model, read {@link https://
|
|
47931
|
+
To learn more about the conditional formatting object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting | Apply conditional formatting to Excel ranges}.
|
|
47710
47932
|
*
|
|
47711
47933
|
* @remarks
|
|
47712
47934
|
* [Api set: ExcelApi 1.6]
|
|
@@ -47953,7 +48175,7 @@ declare namespace Excel {
|
|
|
47953
48175
|
getRange(): Excel.Range;
|
|
47954
48176
|
/**
|
|
47955
48177
|
* Returns the range to which the conditonal format is applied. If the conditional format is applied to multiple ranges, then this method returns an object with its `isNullObject` property set to `true`.
|
|
47956
|
-
For further information, see {@link https://
|
|
48178
|
+
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}.
|
|
47957
48179
|
*
|
|
47958
48180
|
* @remarks
|
|
47959
48181
|
* [Api set: ExcelApi 1.6]
|
|
@@ -48048,7 +48270,7 @@ declare namespace Excel {
|
|
|
48048
48270
|
*/
|
|
48049
48271
|
barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";
|
|
48050
48272
|
/**
|
|
48051
|
-
* The rule for what
|
|
48273
|
+
* The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.
|
|
48052
48274
|
The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`).
|
|
48053
48275
|
*
|
|
48054
48276
|
* @remarks
|
|
@@ -49579,7 +49801,7 @@ declare namespace Excel {
|
|
|
49579
49801
|
/**
|
|
49580
49802
|
* Gets a style by name.
|
|
49581
49803
|
If the style object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
49582
|
-
For further information, see {@link https://
|
|
49804
|
+
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}.
|
|
49583
49805
|
*
|
|
49584
49806
|
* @remarks
|
|
49585
49807
|
* [Api set: ExcelApi 1.14]
|
|
@@ -49660,7 +49882,7 @@ declare namespace Excel {
|
|
|
49660
49882
|
getItem(name: string): Excel.TableStyle;
|
|
49661
49883
|
/**
|
|
49662
49884
|
* Gets a `TableStyle` by name. If the table style does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
49663
|
-
For further information, see {@link https://
|
|
49885
|
+
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}.
|
|
49664
49886
|
*
|
|
49665
49887
|
* @remarks
|
|
49666
49888
|
* [Api set: ExcelApi 1.10]
|
|
@@ -49824,7 +50046,7 @@ declare namespace Excel {
|
|
|
49824
50046
|
getItem(name: string): Excel.PivotTableStyle;
|
|
49825
50047
|
/**
|
|
49826
50048
|
* Gets a `PivotTableStyle` by name. If the `PivotTableStyle` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
49827
|
-
For further information, see {@link https://
|
|
50049
|
+
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}.
|
|
49828
50050
|
*
|
|
49829
50051
|
* @remarks
|
|
49830
50052
|
* [Api set: ExcelApi 1.10]
|
|
@@ -49988,7 +50210,7 @@ declare namespace Excel {
|
|
|
49988
50210
|
getItem(name: string): Excel.SlicerStyle;
|
|
49989
50211
|
/**
|
|
49990
50212
|
* Gets a `SlicerStyle` by name. If the slicer style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
49991
|
-
For further information, see {@link https://
|
|
50213
|
+
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}.
|
|
49992
50214
|
*
|
|
49993
50215
|
* @remarks
|
|
49994
50216
|
* [Api set: ExcelApi 1.10]
|
|
@@ -50152,7 +50374,7 @@ declare namespace Excel {
|
|
|
50152
50374
|
getItem(name: string): Excel.TimelineStyle;
|
|
50153
50375
|
/**
|
|
50154
50376
|
* Gets a `TimelineStyle` by name. If the timeline style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
50155
|
-
For further information, see {@link https://
|
|
50377
|
+
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}.
|
|
50156
50378
|
*
|
|
50157
50379
|
* @remarks
|
|
50158
50380
|
* [Api set: ExcelApi 1.10]
|
|
@@ -50434,7 +50656,7 @@ declare namespace Excel {
|
|
|
50434
50656
|
getPrintArea(): Excel.RangeAreas;
|
|
50435
50657
|
/**
|
|
50436
50658
|
* Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet. If there is no print area, then this method returns an object with its `isNullObject` property set to `true`.
|
|
50437
|
-
For further information, see {@link https://
|
|
50659
|
+
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}.
|
|
50438
50660
|
*
|
|
50439
50661
|
* @remarks
|
|
50440
50662
|
* [Api set: ExcelApi 1.9]
|
|
@@ -50449,7 +50671,7 @@ declare namespace Excel {
|
|
|
50449
50671
|
getPrintTitleColumns(): Excel.Range;
|
|
50450
50672
|
/**
|
|
50451
50673
|
* Gets the range object representing the title columns. If not set, then this method returns an object with its `isNullObject` property set to `true`.
|
|
50452
|
-
For further information, see {@link https://
|
|
50674
|
+
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}.
|
|
50453
50675
|
*
|
|
50454
50676
|
* @remarks
|
|
50455
50677
|
* [Api set: ExcelApi 1.9]
|
|
@@ -50464,7 +50686,7 @@ declare namespace Excel {
|
|
|
50464
50686
|
getPrintTitleRows(): Excel.Range;
|
|
50465
50687
|
/**
|
|
50466
50688
|
* Gets the range object representing the title rows. If not set, then this method returns an object with its `isNullObject` property set to `true`.
|
|
50467
|
-
For further information, see {@link https://
|
|
50689
|
+
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}.
|
|
50468
50690
|
*
|
|
50469
50691
|
* @remarks
|
|
50470
50692
|
* [Api set: ExcelApi 1.9]
|
|
@@ -51166,7 +51388,7 @@ declare namespace Excel {
|
|
|
51166
51388
|
*/
|
|
51167
51389
|
getItemAt(index: number): Excel.Comment;
|
|
51168
51390
|
/**
|
|
51169
|
-
* Gets the comment from the specified cell.
|
|
51391
|
+
* Gets the comment from the specified cell. If there is no comment in the cell, an error is thrown.
|
|
51170
51392
|
*
|
|
51171
51393
|
* @remarks
|
|
51172
51394
|
* [Api set: ExcelApi 1.10]
|
|
@@ -51186,7 +51408,7 @@ declare namespace Excel {
|
|
|
51186
51408
|
/**
|
|
51187
51409
|
* Gets a comment from the collection based on its ID.
|
|
51188
51410
|
If the comment object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
51189
|
-
For further information, see {@link https://
|
|
51411
|
+
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}.
|
|
51190
51412
|
*
|
|
51191
51413
|
* @remarks
|
|
51192
51414
|
* [Api set: ExcelApi 1.14]
|
|
@@ -51366,7 +51588,7 @@ declare namespace Excel {
|
|
|
51366
51588
|
getTask(): Excel.DocumentTask;
|
|
51367
51589
|
/**
|
|
51368
51590
|
* Gets the task associated with this comment. If there is no task for the comment thread, then this method returns an object with its `isNullObject` property set to `true`.
|
|
51369
|
-
For further information, see {@link https://
|
|
51591
|
+
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}.
|
|
51370
51592
|
*
|
|
51371
51593
|
* @remarks
|
|
51372
51594
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -51468,7 +51690,7 @@ declare namespace Excel {
|
|
|
51468
51690
|
/**
|
|
51469
51691
|
* Returns a comment reply identified by its ID.
|
|
51470
51692
|
If the comment reply object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
51471
|
-
For further information, see {@link https://
|
|
51693
|
+
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}.
|
|
51472
51694
|
*
|
|
51473
51695
|
* @remarks
|
|
51474
51696
|
* [Api set: ExcelApi 1.14]
|
|
@@ -51621,7 +51843,7 @@ declare namespace Excel {
|
|
|
51621
51843
|
getTask(): Excel.DocumentTask;
|
|
51622
51844
|
/**
|
|
51623
51845
|
* Gets the task associated with this comment reply's thread. If there is no task for the comment thread, then this method returns an object with its `isNullObject` property set to `true`.
|
|
51624
|
-
For further information, see {@link https://
|
|
51846
|
+
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}.
|
|
51625
51847
|
*
|
|
51626
51848
|
* @remarks
|
|
51627
51849
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -51784,7 +52006,7 @@ declare namespace Excel {
|
|
|
51784
52006
|
/**
|
|
51785
52007
|
* Gets a shape using its name or ID.
|
|
51786
52008
|
If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
51787
|
-
For further information, see {@link https://
|
|
52009
|
+
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}.
|
|
51788
52010
|
*
|
|
51789
52011
|
* @remarks
|
|
51790
52012
|
* [Api set: ExcelApi 1.14]
|
|
@@ -51818,7 +52040,7 @@ declare namespace Excel {
|
|
|
51818
52040
|
}
|
|
51819
52041
|
/**
|
|
51820
52042
|
* Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc.
|
|
51821
|
-
To learn more about the shape object model, read {@link https://
|
|
52043
|
+
To learn more about the shape object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes | Work with shapes using the Excel JavaScript API}.
|
|
51822
52044
|
*
|
|
51823
52045
|
* @remarks
|
|
51824
52046
|
* [Api set: ExcelApi 1.9]
|
|
@@ -52402,7 +52624,7 @@ declare namespace Excel {
|
|
|
52402
52624
|
/**
|
|
52403
52625
|
* Gets a shape using its name or ID.
|
|
52404
52626
|
If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
52405
|
-
For further information, see {@link https://
|
|
52627
|
+
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}.
|
|
52406
52628
|
*
|
|
52407
52629
|
* @remarks
|
|
52408
52630
|
* [Api set: ExcelApi 1.14]
|
|
@@ -53319,7 +53541,7 @@ declare namespace Excel {
|
|
|
53319
53541
|
getItemAt(index: number): Excel.Slicer;
|
|
53320
53542
|
/**
|
|
53321
53543
|
* Gets a slicer using its name or ID. If the slicer doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
53322
|
-
For further information, see {@link https://
|
|
53544
|
+
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}.
|
|
53323
53545
|
*
|
|
53324
53546
|
* @remarks
|
|
53325
53547
|
* [Api set: ExcelApi 1.10]
|
|
@@ -53463,7 +53685,7 @@ declare namespace Excel {
|
|
|
53463
53685
|
getItemAt(index: number): Excel.SlicerItem;
|
|
53464
53686
|
/**
|
|
53465
53687
|
* Gets a slicer item using its key or name. If the slicer item doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
53466
|
-
For further information, see {@link https://
|
|
53688
|
+
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}.
|
|
53467
53689
|
*
|
|
53468
53690
|
* @remarks
|
|
53469
53691
|
* [Api set: ExcelApi 1.10]
|
|
@@ -53665,7 +53887,7 @@ declare namespace Excel {
|
|
|
53665
53887
|
getItemAt(index: number): Excel.LinkedDataType;
|
|
53666
53888
|
/**
|
|
53667
53889
|
* Gets a linked data type by ID. If the linked data type doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
53668
|
-
For further information, see {@link https://
|
|
53890
|
+
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}.
|
|
53669
53891
|
*
|
|
53670
53892
|
* @remarks
|
|
53671
53893
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -54737,7 +54959,7 @@ declare namespace Excel {
|
|
|
54737
54959
|
}
|
|
54738
54960
|
/**
|
|
54739
54961
|
* Specifies the data source type of the chart series.
|
|
54740
|
-
*
|
|
54962
|
+
*
|
|
54741
54963
|
* @remarks
|
|
54742
54964
|
* [Api set: ExcelApi 1.15]
|
|
54743
54965
|
*/
|
|
@@ -57389,6 +57611,8 @@ declare namespace Excel {
|
|
|
57389
57611
|
fill = "Fill"
|
|
57390
57612
|
}
|
|
57391
57613
|
/**
|
|
57614
|
+
* Determines the direction in which existing cells will be shifted to accommodate what is being inserted.
|
|
57615
|
+
*
|
|
57392
57616
|
* @remarks
|
|
57393
57617
|
* [Api set: ExcelApi 1.1]
|
|
57394
57618
|
*/
|
|
@@ -57640,6 +57864,8 @@ declare namespace Excel {
|
|
|
57640
57864
|
columns = "Columns"
|
|
57641
57865
|
}
|
|
57642
57866
|
/**
|
|
57867
|
+
* Represents the part of the cell used as the sorting criteria.
|
|
57868
|
+
*
|
|
57643
57869
|
* @remarks
|
|
57644
57870
|
* [Api set: ExcelApi 1.2]
|
|
57645
57871
|
*/
|
|
@@ -58181,13 +58407,6 @@ declare namespace Excel {
|
|
|
58181
58407
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
58182
58408
|
*/
|
|
58183
58409
|
annotationAdded = "AnnotationAdded",
|
|
58184
|
-
/**
|
|
58185
|
-
* Workbook Action Recorded represents the type of event registered when the workbook records an action.
|
|
58186
|
-
* @remarks
|
|
58187
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
58188
|
-
* @beta
|
|
58189
|
-
*/
|
|
58190
|
-
workbookActionRecorded = "WorkbookActionRecorded"
|
|
58191
58410
|
}
|
|
58192
58411
|
/**
|
|
58193
58412
|
* @remarks
|
|
@@ -58893,6 +59112,8 @@ declare namespace Excel {
|
|
|
58893
59112
|
notAvailable = "NotAvailable"
|
|
58894
59113
|
}
|
|
58895
59114
|
/**
|
|
59115
|
+
* The position of a worksheet relative to another worksheet or the entire worksheet collection.
|
|
59116
|
+
*
|
|
58896
59117
|
* @remarks
|
|
58897
59118
|
* [Api set: ExcelApi 1.7]
|
|
58898
59119
|
*/
|
|
@@ -59045,7 +59266,7 @@ declare namespace Excel {
|
|
|
59045
59266
|
*/
|
|
59046
59267
|
fillSeries = "FillSeries",
|
|
59047
59268
|
/**
|
|
59048
|
-
* Populates the adjacent cells with the selected
|
|
59269
|
+
* Populates the adjacent cells with the selected formats.
|
|
59049
59270
|
* @remarks
|
|
59050
59271
|
* [Api set: ExcelApi 1.9]
|
|
59051
59272
|
*/
|
|
@@ -59141,7 +59362,12 @@ declare namespace Excel {
|
|
|
59141
59362
|
* @remarks
|
|
59142
59363
|
* [Api set: ExcelApi 1.9]
|
|
59143
59364
|
*/
|
|
59144
|
-
formats = "Formats"
|
|
59365
|
+
formats = "Formats",
|
|
59366
|
+
/**
|
|
59367
|
+
* @remarks
|
|
59368
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59369
|
+
*/
|
|
59370
|
+
link = "Link"
|
|
59145
59371
|
}
|
|
59146
59372
|
/**
|
|
59147
59373
|
* @remarks
|
|
@@ -60967,7 +61193,7 @@ declare namespace Excel {
|
|
|
60967
61193
|
/**
|
|
60968
61194
|
* Gets a sheet view using its name.
|
|
60969
61195
|
If the sheet view object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
60970
|
-
For further information, see {@link https://
|
|
61196
|
+
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}.
|
|
60971
61197
|
*
|
|
60972
61198
|
* @remarks
|
|
60973
61199
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -65600,7 +65826,7 @@ declare namespace Excel {
|
|
|
65600
65826
|
*/
|
|
65601
65827
|
autoIndent?: boolean;
|
|
65602
65828
|
/**
|
|
65603
|
-
* Specifies the width of all
|
|
65829
|
+
* Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be returned.
|
|
65604
65830
|
*
|
|
65605
65831
|
* @remarks
|
|
65606
65832
|
* [Api set: ExcelApi 1.2]
|
|
@@ -66765,7 +66991,7 @@ declare namespace Excel {
|
|
|
66765
66991
|
*/
|
|
66766
66992
|
textOrientation?: number;
|
|
66767
66993
|
/**
|
|
66768
|
-
* Specifies if the axis title is
|
|
66994
|
+
* Specifies if the axis title is visible.
|
|
66769
66995
|
*
|
|
66770
66996
|
* @remarks
|
|
66771
66997
|
* [Api set: ExcelApi 1.1]
|
|
@@ -67385,7 +67611,7 @@ declare namespace Excel {
|
|
|
67385
67611
|
*/
|
|
67386
67612
|
verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
|
|
67387
67613
|
/**
|
|
67388
|
-
* Specifies if the chart title is
|
|
67614
|
+
* Specifies if the chart title is visible.
|
|
67389
67615
|
*
|
|
67390
67616
|
* @remarks
|
|
67391
67617
|
* [Api set: ExcelApi 1.1]
|
|
@@ -68481,7 +68707,7 @@ declare namespace Excel {
|
|
|
68481
68707
|
*/
|
|
68482
68708
|
barDirection?: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";
|
|
68483
68709
|
/**
|
|
68484
|
-
* The rule for what
|
|
68710
|
+
* The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.
|
|
68485
68711
|
The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`).
|
|
68486
68712
|
*
|
|
68487
68713
|
* @remarks
|
|
@@ -71226,8 +71452,8 @@ declare namespace Excel {
|
|
|
71226
71452
|
*/
|
|
71227
71453
|
type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";
|
|
71228
71454
|
/**
|
|
71229
|
-
* Represents the value computed by the name's formula. For a named range it will return the range address.
|
|
71230
|
-
|
|
71455
|
+
* Represents the value computed by the name's formula. For a named range, it will return the range address.
|
|
71456
|
+
This API returns the #VALUE! error in the Excel UI if it refers to a user-defined function.
|
|
71231
71457
|
*
|
|
71232
71458
|
* @remarks
|
|
71233
71459
|
* [Api set: ExcelApi 1.1]
|
|
@@ -71644,7 +71870,7 @@ declare namespace Excel {
|
|
|
71644
71870
|
*/
|
|
71645
71871
|
autoIndent?: boolean;
|
|
71646
71872
|
/**
|
|
71647
|
-
* Specifies the width of all
|
|
71873
|
+
* Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be returned.
|
|
71648
71874
|
*
|
|
71649
71875
|
* @remarks
|
|
71650
71876
|
* [Api set: ExcelApi 1.2]
|
|
@@ -72899,7 +73125,7 @@ declare namespace Excel {
|
|
|
72899
73125
|
*/
|
|
72900
73126
|
textOrientation?: number;
|
|
72901
73127
|
/**
|
|
72902
|
-
* Specifies if the axis title is
|
|
73128
|
+
* Specifies if the axis title is visible.
|
|
72903
73129
|
*
|
|
72904
73130
|
* @remarks
|
|
72905
73131
|
* [Api set: ExcelApi 1.1]
|
|
@@ -73582,7 +73808,7 @@ declare namespace Excel {
|
|
|
73582
73808
|
*/
|
|
73583
73809
|
verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
|
|
73584
73810
|
/**
|
|
73585
|
-
* Specifies if the chart title is
|
|
73811
|
+
* Specifies if the chart title is visible.
|
|
73586
73812
|
*
|
|
73587
73813
|
* @remarks
|
|
73588
73814
|
* [Api set: ExcelApi 1.1]
|
|
@@ -75028,7 +75254,7 @@ declare namespace Excel {
|
|
|
75028
75254
|
*/
|
|
75029
75255
|
barDirection?: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";
|
|
75030
75256
|
/**
|
|
75031
|
-
* The rule for what
|
|
75257
|
+
* The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.
|
|
75032
75258
|
The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`).
|
|
75033
75259
|
*
|
|
75034
75260
|
* @remarks
|
|
@@ -77590,7 +77816,7 @@ declare namespace Excel {
|
|
|
77590
77816
|
}
|
|
77591
77817
|
/**
|
|
77592
77818
|
* Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges.
|
|
77593
|
-
To learn more about the workbook object model, read {@link https://
|
|
77819
|
+
To learn more about the workbook object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-workbooks | Work with workbooks using the Excel JavaScript API}.
|
|
77594
77820
|
*
|
|
77595
77821
|
* @remarks
|
|
77596
77822
|
* [Api set: ExcelApi 1.1]
|
|
@@ -77748,7 +77974,7 @@ declare namespace Excel {
|
|
|
77748
77974
|
}
|
|
77749
77975
|
/**
|
|
77750
77976
|
* An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.
|
|
77751
|
-
To learn more about the worksheet object model, read {@link https://
|
|
77977
|
+
To learn more about the worksheet object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets | Work with worksheets using the Excel JavaScript API}.
|
|
77752
77978
|
*
|
|
77753
77979
|
* @remarks
|
|
77754
77980
|
* [Api set: ExcelApi 1.1]
|
|
@@ -78060,7 +78286,7 @@ declare namespace Excel {
|
|
|
78060
78286
|
}
|
|
78061
78287
|
/**
|
|
78062
78288
|
* Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.
|
|
78063
|
-
To learn more about how ranges are used throughout the API, start with {@link https://
|
|
78289
|
+
To learn more about how ranges are used throughout the API, start with {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-core-concepts#ranges | Ranges in the Excel JavaScript API}.
|
|
78064
78290
|
*
|
|
78065
78291
|
* @remarks
|
|
78066
78292
|
* [Api set: ExcelApi 1.1]
|
|
@@ -78331,7 +78557,7 @@ declare namespace Excel {
|
|
|
78331
78557
|
}
|
|
78332
78558
|
/**
|
|
78333
78559
|
* `RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet.
|
|
78334
|
-
To learn how to use discontiguous ranges, read {@link https://
|
|
78560
|
+
To learn how to use discontiguous ranges, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-multiple-ranges | Work with multiple ranges simultaneously in Excel add-ins}.
|
|
78335
78561
|
*
|
|
78336
78562
|
* @remarks
|
|
78337
78563
|
* [Api set: ExcelApi 1.9]
|
|
@@ -78726,7 +78952,7 @@ declare namespace Excel {
|
|
|
78726
78952
|
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
|
|
78727
78953
|
/**
|
|
78728
78954
|
* For EACH ITEM in the collection: Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
|
|
78729
|
-
For further information, see {@link https://
|
|
78955
|
+
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}.
|
|
78730
78956
|
*
|
|
78731
78957
|
* @remarks
|
|
78732
78958
|
* [Api set: ExcelApi 1.4]
|
|
@@ -78768,8 +78994,8 @@ declare namespace Excel {
|
|
|
78768
78994
|
*/
|
|
78769
78995
|
type?: boolean;
|
|
78770
78996
|
/**
|
|
78771
|
-
* For EACH ITEM in the collection: Represents the value computed by the name's formula. For a named range it will return the range address.
|
|
78772
|
-
|
|
78997
|
+
* For EACH ITEM in the collection: Represents the value computed by the name's formula. For a named range, it will return the range address.
|
|
78998
|
+
This API returns the #VALUE! error in the Excel UI if it refers to a user-defined function.
|
|
78773
78999
|
*
|
|
78774
79000
|
* @remarks
|
|
78775
79001
|
* [Api set: ExcelApi 1.1]
|
|
@@ -78828,7 +79054,7 @@ declare namespace Excel {
|
|
|
78828
79054
|
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
|
|
78829
79055
|
/**
|
|
78830
79056
|
* Returns the worksheet to which the named item is scoped. If the item is scoped to the workbook instead, then this method returns an object with its `isNullObject` property set to `true`.
|
|
78831
|
-
For further information, see {@link https://
|
|
79057
|
+
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}.
|
|
78832
79058
|
*
|
|
78833
79059
|
* @remarks
|
|
78834
79060
|
* [Api set: ExcelApi 1.4]
|
|
@@ -78870,8 +79096,8 @@ declare namespace Excel {
|
|
|
78870
79096
|
*/
|
|
78871
79097
|
type?: boolean;
|
|
78872
79098
|
/**
|
|
78873
|
-
* Represents the value computed by the name's formula. For a named range, will return the range address.
|
|
78874
|
-
|
|
79099
|
+
* Represents the value computed by the name's formula. For a named range, it will return the range address.
|
|
79100
|
+
This API returns the #VALUE! error in the Excel UI if it refers to a user-defined function.
|
|
78875
79101
|
*
|
|
78876
79102
|
* @remarks
|
|
78877
79103
|
* [Api set: ExcelApi 1.1]
|
|
@@ -79269,7 +79495,7 @@ declare namespace Excel {
|
|
|
79269
79495
|
}
|
|
79270
79496
|
/**
|
|
79271
79497
|
* Represents an Excel table.
|
|
79272
|
-
To learn more about the table object model, read {@link https://
|
|
79498
|
+
To learn more about the table object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-tables | Work with tables using the Excel JavaScript API}.
|
|
79273
79499
|
*
|
|
79274
79500
|
* @remarks
|
|
79275
79501
|
* [Api set: ExcelApi 1.1]
|
|
@@ -79636,7 +79862,7 @@ declare namespace Excel {
|
|
|
79636
79862
|
}
|
|
79637
79863
|
/**
|
|
79638
79864
|
* Represents the data validation applied to the current range.
|
|
79639
|
-
To learn more about the data validation object model, read {@link https://
|
|
79865
|
+
To learn more about the data validation object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-data-validation | Add data validation to Excel ranges}.
|
|
79640
79866
|
*
|
|
79641
79867
|
* @remarks
|
|
79642
79868
|
* [Api set: ExcelApi 1.8]
|
|
@@ -79764,7 +79990,7 @@ declare namespace Excel {
|
|
|
79764
79990
|
*/
|
|
79765
79991
|
autoIndent?: boolean;
|
|
79766
79992
|
/**
|
|
79767
|
-
* Specifies the width of all
|
|
79993
|
+
* Specifies the width of all columns within the range. If the column widths are not uniform, `null` will be returned.
|
|
79768
79994
|
*
|
|
79769
79995
|
* @remarks
|
|
79770
79996
|
* [Api set: ExcelApi 1.2]
|
|
@@ -80296,7 +80522,7 @@ declare namespace Excel {
|
|
|
80296
80522
|
}
|
|
80297
80523
|
/**
|
|
80298
80524
|
* Represents a chart object in a workbook.
|
|
80299
|
-
To learn more about the chart object model, see {@link https://
|
|
80525
|
+
To learn more about the chart object model, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-charts | Work with charts using the Excel JavaScript API}.
|
|
80300
80526
|
*
|
|
80301
80527
|
* @remarks
|
|
80302
80528
|
* [Api set: ExcelApi 1.1]
|
|
@@ -81766,7 +81992,7 @@ declare namespace Excel {
|
|
|
81766
81992
|
*/
|
|
81767
81993
|
textOrientation?: boolean;
|
|
81768
81994
|
/**
|
|
81769
|
-
* Specifies if the axis title is
|
|
81995
|
+
* Specifies if the axis title is visible.
|
|
81770
81996
|
*
|
|
81771
81997
|
* @remarks
|
|
81772
81998
|
* [Api set: ExcelApi 1.1]
|
|
@@ -82627,7 +82853,7 @@ declare namespace Excel {
|
|
|
82627
82853
|
*/
|
|
82628
82854
|
verticalAlignment?: boolean;
|
|
82629
82855
|
/**
|
|
82630
|
-
* Specifies if the chart title is
|
|
82856
|
+
* Specifies if the chart title is visible.
|
|
82631
82857
|
*
|
|
82632
82858
|
* @remarks
|
|
82633
82859
|
* [Api set: ExcelApi 1.1]
|
|
@@ -83760,7 +83986,7 @@ declare namespace Excel {
|
|
|
83760
83986
|
}
|
|
83761
83987
|
/**
|
|
83762
83988
|
* Represents an Excel PivotTable.
|
|
83763
|
-
To learn more about the PivotTable object model, read {@link https://
|
|
83989
|
+
To learn more about the PivotTable object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-pivottables | Work with PivotTables using the Excel JavaScript API}.
|
|
83764
83990
|
*
|
|
83765
83991
|
* @remarks
|
|
83766
83992
|
* [Api set: ExcelApi 1.3]
|
|
@@ -84792,7 +85018,7 @@ declare namespace Excel {
|
|
|
84792
85018
|
}
|
|
84793
85019
|
/**
|
|
84794
85020
|
* An object encapsulating a conditional format's range, format, rule, and other properties.
|
|
84795
|
-
To learn more about the conditional formatting object model, read {@link https://
|
|
85021
|
+
To learn more about the conditional formatting object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-conditional-formatting | Apply conditional formatting to Excel ranges}.
|
|
84796
85022
|
*
|
|
84797
85023
|
* @remarks
|
|
84798
85024
|
* [Api set: ExcelApi 1.6]
|
|
@@ -85000,7 +85226,7 @@ declare namespace Excel {
|
|
|
85000
85226
|
*/
|
|
85001
85227
|
barDirection?: boolean;
|
|
85002
85228
|
/**
|
|
85003
|
-
* The rule for what
|
|
85229
|
+
* The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.
|
|
85004
85230
|
The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`).
|
|
85005
85231
|
*
|
|
85006
85232
|
* @remarks
|
|
@@ -87226,7 +87452,7 @@ declare namespace Excel {
|
|
|
87226
87452
|
}
|
|
87227
87453
|
/**
|
|
87228
87454
|
* Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc.
|
|
87229
|
-
To learn more about the shape object model, read {@link https://
|
|
87455
|
+
To learn more about the shape object model, read {@link https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-shapes | Work with shapes using the Excel JavaScript API}.
|
|
87230
87456
|
*
|
|
87231
87457
|
* @remarks
|
|
87232
87458
|
* [Api set: ExcelApi 1.9]
|