@types/office-js-preview 1.0.433 → 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 +361 -140
- office-js-preview/package.json +2 -2
office-js-preview/index.d.ts
CHANGED
|
@@ -25555,6 +25555,14 @@ declare namespace Excel {
|
|
|
25555
25555
|
*/
|
|
25556
25556
|
error = "Error",
|
|
25557
25557
|
/**
|
|
25558
|
+
* Represents an `ExternalCodeServiceObjectCellValue`.
|
|
25559
|
+
*
|
|
25560
|
+
* @remarks
|
|
25561
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25562
|
+
* @beta
|
|
25563
|
+
*/
|
|
25564
|
+
externalCodeServiceObject = "ExternalCodeServiceObject",
|
|
25565
|
+
/**
|
|
25558
25566
|
* Represents a `FormattedNumberCellValue`.
|
|
25559
25567
|
*
|
|
25560
25568
|
* @remarks
|
|
@@ -25572,7 +25580,8 @@ declare namespace Excel {
|
|
|
25572
25580
|
* Represents a `LocalImageCellValue`.
|
|
25573
25581
|
*
|
|
25574
25582
|
* @remarks
|
|
25575
|
-
* [Api set: ExcelApi
|
|
25583
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
25584
|
+
* @beta
|
|
25576
25585
|
*/
|
|
25577
25586
|
localImage = "LocalImage",
|
|
25578
25587
|
/**
|
|
@@ -25610,7 +25619,7 @@ declare namespace Excel {
|
|
|
25610
25619
|
* @remarks
|
|
25611
25620
|
* [Api set: ExcelApi 1.16]
|
|
25612
25621
|
*/
|
|
25613
|
-
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;
|
|
25614
25623
|
/**
|
|
25615
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.
|
|
25616
25625
|
*
|
|
@@ -25821,6 +25830,49 @@ declare namespace Excel {
|
|
|
25821
25830
|
dotNotation?: boolean;
|
|
25822
25831
|
}
|
|
25823
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
|
+
/**
|
|
25824
25876
|
* Represents types of #CONNECT! errors.
|
|
25825
25877
|
*
|
|
25826
25878
|
* @remarks
|
|
@@ -26316,6 +26368,14 @@ declare namespace Excel {
|
|
|
26316
26368
|
*/
|
|
26317
26369
|
placeholder = "Placeholder",
|
|
26318
26370
|
/**
|
|
26371
|
+
* Represents a `PythonErrorCellValue`.
|
|
26372
|
+
*
|
|
26373
|
+
* @remarks
|
|
26374
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26375
|
+
* @beta
|
|
26376
|
+
*/
|
|
26377
|
+
python = "Python",
|
|
26378
|
+
/**
|
|
26319
26379
|
* Represents a `RefErrorCellValue`.
|
|
26320
26380
|
*
|
|
26321
26381
|
* @remarks
|
|
@@ -26330,6 +26390,14 @@ declare namespace Excel {
|
|
|
26330
26390
|
*/
|
|
26331
26391
|
spill = "Spill",
|
|
26332
26392
|
/**
|
|
26393
|
+
* Represents a `TimeoutErrorCellValue`.
|
|
26394
|
+
*
|
|
26395
|
+
* @remarks
|
|
26396
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
26397
|
+
* @beta
|
|
26398
|
+
*/
|
|
26399
|
+
timeout = "Timeout",
|
|
26400
|
+
/**
|
|
26333
26401
|
* Represents a `ValueErrorCellValue`.
|
|
26334
26402
|
*
|
|
26335
26403
|
* @remarks
|
|
@@ -26343,7 +26411,7 @@ declare namespace Excel {
|
|
|
26343
26411
|
* @remarks
|
|
26344
26412
|
* [Api set: ExcelApi 1.16]
|
|
26345
26413
|
*/
|
|
26346
|
-
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;
|
|
26347
26415
|
/**
|
|
26348
26416
|
* Represents types of #EXTERNAL! errors.
|
|
26349
26417
|
*
|
|
@@ -26405,6 +26473,79 @@ declare namespace Excel {
|
|
|
26405
26473
|
errorSubType?: ExternalErrorCellValueSubType | "Unknown";
|
|
26406
26474
|
}
|
|
26407
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
|
+
/**
|
|
26408
26549
|
* Represents types of #FIELD! errors.
|
|
26409
26550
|
*
|
|
26410
26551
|
* @remarks
|
|
@@ -26436,7 +26577,7 @@ declare namespace Excel {
|
|
|
26436
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.
|
|
26437
26578
|
*
|
|
26438
26579
|
* @remarks
|
|
26439
|
-
* [Api set: 1.16]
|
|
26580
|
+
* [Api set: ExcelApi 1.16]
|
|
26440
26581
|
*/
|
|
26441
26582
|
richValueRelMissingFilePart = "RichValueRelMissingFilePart"
|
|
26442
26583
|
}
|
|
@@ -27168,6 +27309,82 @@ declare namespace Excel {
|
|
|
27168
27309
|
basicType?: RangeValueType.string | "String";
|
|
27169
27310
|
}
|
|
27170
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
|
+
/**
|
|
27171
27388
|
* Represents types of #VALUE! errors.
|
|
27172
27389
|
*
|
|
27173
27390
|
* @remarks
|
|
@@ -28333,7 +28550,7 @@ declare namespace Excel {
|
|
|
28333
28550
|
* [Api set: ExcelApiOnline 1.1]
|
|
28334
28551
|
*
|
|
28335
28552
|
* @param key The title of the `AllowEditRange`.
|
|
28336
|
-
* @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}.
|
|
28337
28554
|
*/
|
|
28338
28555
|
getItemOrNullObject(key: string): Excel.AllowEditRange;
|
|
28339
28556
|
/**
|
|
@@ -28829,7 +29046,7 @@ declare namespace Excel {
|
|
|
28829
29046
|
getItem(key: string): Excel.LinkedWorkbook;
|
|
28830
29047
|
/**
|
|
28831
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`.
|
|
28832
|
-
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}.
|
|
28833
29050
|
*
|
|
28834
29051
|
* @remarks
|
|
28835
29052
|
* [Api set: ExcelApiOnline 1.1]
|
|
@@ -29473,7 +29690,7 @@ declare namespace Excel {
|
|
|
29473
29690
|
*
|
|
29474
29691
|
* @param key The ID of the task.
|
|
29475
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`.
|
|
29476
|
-
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}.
|
|
29477
29694
|
*/
|
|
29478
29695
|
getItemOrNullObject(key: string): Excel.DocumentTask;
|
|
29479
29696
|
/**
|
|
@@ -31572,7 +31789,7 @@ declare namespace Excel {
|
|
|
31572
31789
|
interface ChangeDirectionState {
|
|
31573
31790
|
/**
|
|
31574
31791
|
* Represents the direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted.
|
|
31575
|
-
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`.
|
|
31576
31793
|
*
|
|
31577
31794
|
* @remarks
|
|
31578
31795
|
* [Api set: ExcelApi 1.14]
|
|
@@ -31580,7 +31797,7 @@ declare namespace Excel {
|
|
|
31580
31797
|
deleteShiftDirection: Excel.DeleteShiftDirection | "Up" | "Left";
|
|
31581
31798
|
/**
|
|
31582
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.
|
|
31583
|
-
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`.
|
|
31584
31801
|
*
|
|
31585
31802
|
* @remarks
|
|
31586
31803
|
* [Api set: ExcelApi 1.14]
|
|
@@ -33043,7 +33260,7 @@ declare namespace Excel {
|
|
|
33043
33260
|
}
|
|
33044
33261
|
/**
|
|
33045
33262
|
* Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges.
|
|
33046
|
-
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}.
|
|
33047
33264
|
*
|
|
33048
33265
|
* @remarks
|
|
33049
33266
|
* [Api set: ExcelApi 1.1]
|
|
@@ -33340,7 +33557,7 @@ declare namespace Excel {
|
|
|
33340
33557
|
getActiveChart(): Excel.Chart;
|
|
33341
33558
|
/**
|
|
33342
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`.
|
|
33343
|
-
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}.
|
|
33344
33561
|
*
|
|
33345
33562
|
* @remarks
|
|
33346
33563
|
* [Api set: ExcelApi 1.9]
|
|
@@ -33355,7 +33572,7 @@ declare namespace Excel {
|
|
|
33355
33572
|
getActiveSlicer(): Excel.Slicer;
|
|
33356
33573
|
/**
|
|
33357
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`.
|
|
33358
|
-
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}.
|
|
33359
33576
|
*
|
|
33360
33577
|
* @remarks
|
|
33361
33578
|
* [Api set: ExcelApi 1.10]
|
|
@@ -33411,7 +33628,7 @@ declare namespace Excel {
|
|
|
33411
33628
|
* @remarks
|
|
33412
33629
|
* [Api set: ExcelApi 1.11]
|
|
33413
33630
|
*
|
|
33414
|
-
* @param saveBehavior
|
|
33631
|
+
* @param saveBehavior The save behavior must be "Save" or "Prompt". Default value is "Save".
|
|
33415
33632
|
*/
|
|
33416
33633
|
save(saveBehavior?: Excel.SaveBehavior): void;
|
|
33417
33634
|
/**
|
|
@@ -33420,7 +33637,7 @@ declare namespace Excel {
|
|
|
33420
33637
|
* @remarks
|
|
33421
33638
|
* [Api set: ExcelApi 1.11]
|
|
33422
33639
|
*
|
|
33423
|
-
* @param saveBehavior
|
|
33640
|
+
* @param saveBehavior The save behavior must be "Save" or "Prompt". Default value is "Save".
|
|
33424
33641
|
*/
|
|
33425
33642
|
save(saveBehavior?: "Save" | "Prompt"): void;
|
|
33426
33643
|
/**
|
|
@@ -33570,7 +33787,7 @@ declare namespace Excel {
|
|
|
33570
33787
|
}
|
|
33571
33788
|
/**
|
|
33572
33789
|
* An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.
|
|
33573
|
-
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}.
|
|
33574
33791
|
*
|
|
33575
33792
|
* @remarks
|
|
33576
33793
|
* [Api set: ExcelApi 1.1]
|
|
@@ -33845,7 +34062,7 @@ declare namespace Excel {
|
|
|
33845
34062
|
* @param text The string to find.
|
|
33846
34063
|
* @param criteria Additional search criteria, including whether the search needs to match the entire cell or be case-sensitive.
|
|
33847
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`.
|
|
33848
|
-
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}.
|
|
33849
34066
|
*/
|
|
33850
34067
|
findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;
|
|
33851
34068
|
/**
|
|
@@ -33869,7 +34086,7 @@ declare namespace Excel {
|
|
|
33869
34086
|
getNext(visibleOnly?: boolean): Excel.Worksheet;
|
|
33870
34087
|
/**
|
|
33871
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`.
|
|
33872
|
-
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}.
|
|
33873
34090
|
*
|
|
33874
34091
|
* @remarks
|
|
33875
34092
|
* [Api set: ExcelApi 1.5]
|
|
@@ -33888,7 +34105,7 @@ declare namespace Excel {
|
|
|
33888
34105
|
getPrevious(visibleOnly?: boolean): Excel.Worksheet;
|
|
33889
34106
|
/**
|
|
33890
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`.
|
|
33891
|
-
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}.
|
|
33892
34109
|
*
|
|
33893
34110
|
* @remarks
|
|
33894
34111
|
* [Api set: ExcelApi 1.5]
|
|
@@ -33936,7 +34153,7 @@ declare namespace Excel {
|
|
|
33936
34153
|
*/
|
|
33937
34154
|
getUsedRange(valuesOnly?: boolean): Excel.Range;
|
|
33938
34155
|
/**
|
|
33939
|
-
* 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}.
|
|
33940
34157
|
*
|
|
33941
34158
|
* @remarks
|
|
33942
34159
|
* [Api set: ExcelApi 1.4]
|
|
@@ -34225,7 +34442,7 @@ declare namespace Excel {
|
|
|
34225
34442
|
getItem(key: string): Excel.Worksheet;
|
|
34226
34443
|
/**
|
|
34227
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`.
|
|
34228
|
-
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}.
|
|
34229
34446
|
*
|
|
34230
34447
|
* @remarks
|
|
34231
34448
|
* [Api set: ExcelApi 1.4]
|
|
@@ -34494,7 +34711,7 @@ declare namespace Excel {
|
|
|
34494
34711
|
/**
|
|
34495
34712
|
* Specifies if the password can be used to unlock worksheet protection.
|
|
34496
34713
|
This method doesn't change the worksheet protection state.
|
|
34497
|
-
If a password is
|
|
34714
|
+
If a password is entered but no password is required to unlock worksheet protection, this method will return false.
|
|
34498
34715
|
*
|
|
34499
34716
|
* @remarks
|
|
34500
34717
|
* [Api set: ExcelApiOnline 1.1]
|
|
@@ -34746,7 +34963,7 @@ declare namespace Excel {
|
|
|
34746
34963
|
* Gets a range that describes the frozen cells in the active worksheet view.
|
|
34747
34964
|
The frozen range corresponds to cells that are frozen in the top- and left-most pane.
|
|
34748
34965
|
If there is no frozen pane, then this method returns an object with its `isNullObject` property set to `true`.
|
|
34749
|
-
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}.
|
|
34750
34967
|
*
|
|
34751
34968
|
* @remarks
|
|
34752
34969
|
* [Api set: ExcelApi 1.7]
|
|
@@ -34798,7 +35015,7 @@ declare namespace Excel {
|
|
|
34798
35015
|
}
|
|
34799
35016
|
/**
|
|
34800
35017
|
* Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.
|
|
34801
|
-
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}.
|
|
34802
35019
|
*
|
|
34803
35020
|
* @remarks
|
|
34804
35021
|
* [Api set: ExcelApi 1.1]
|
|
@@ -35096,7 +35313,7 @@ declare namespace Excel {
|
|
|
35096
35313
|
* @remarks
|
|
35097
35314
|
* [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
|
|
35098
35315
|
*
|
|
35099
|
-
* @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).
|
|
35100
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".
|
|
35101
35318
|
*/
|
|
35102
35319
|
autoFill(destinationRange?: Range | string, autoFillType?: Excel.AutoFillType): void;
|
|
@@ -35110,7 +35327,7 @@ declare namespace Excel {
|
|
|
35110
35327
|
* @remarks
|
|
35111
35328
|
* [Api set: ExcelApi 1.9, ExcelApi Preview for null `destinationRange`]
|
|
35112
35329
|
*
|
|
35113
|
-
* @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).
|
|
35114
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".
|
|
35115
35332
|
*/
|
|
35116
35333
|
autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;
|
|
@@ -35181,7 +35398,7 @@ declare namespace Excel {
|
|
|
35181
35398
|
* @param skipBlanks True if to skip blank cells in the source range. Default is false.
|
|
35182
35399
|
* @param transpose True if to transpose the cells in the destination range. Default is false.
|
|
35183
35400
|
*/
|
|
35184
|
-
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;
|
|
35185
35402
|
/**
|
|
35186
35403
|
* Deletes the cells associated with the range.
|
|
35187
35404
|
*
|
|
@@ -35216,7 +35433,7 @@ declare namespace Excel {
|
|
|
35216
35433
|
* Finds the given string based on the criteria specified.
|
|
35217
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.
|
|
35218
35435
|
If there are no matches, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35219
|
-
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}.
|
|
35220
35437
|
*
|
|
35221
35438
|
* @remarks
|
|
35222
35439
|
* [Api set: ExcelApi 1.9]
|
|
@@ -35383,7 +35600,7 @@ declare namespace Excel {
|
|
|
35383
35600
|
getIntersection(anotherRange: Range | string): Excel.Range;
|
|
35384
35601
|
/**
|
|
35385
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`.
|
|
35386
|
-
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}.
|
|
35387
35604
|
*
|
|
35388
35605
|
* @remarks
|
|
35389
35606
|
* [Api set: ExcelApi 1.4]
|
|
@@ -35414,7 +35631,7 @@ declare namespace Excel {
|
|
|
35414
35631
|
getLastRow(): Excel.Range;
|
|
35415
35632
|
/**
|
|
35416
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`.
|
|
35417
|
-
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}.
|
|
35418
35635
|
*
|
|
35419
35636
|
* @remarks
|
|
35420
35637
|
* [Api set: ExcelApi 1.13]
|
|
@@ -35539,7 +35756,7 @@ declare namespace Excel {
|
|
|
35539
35756
|
/**
|
|
35540
35757
|
* Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
|
|
35541
35758
|
If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35542
|
-
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}.
|
|
35543
35760
|
*
|
|
35544
35761
|
* @remarks
|
|
35545
35762
|
* [Api set: ExcelApi 1.9]
|
|
@@ -35551,7 +35768,7 @@ declare namespace Excel {
|
|
|
35551
35768
|
/**
|
|
35552
35769
|
* Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.
|
|
35553
35770
|
If no special cells are found, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35554
|
-
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}.
|
|
35555
35772
|
*
|
|
35556
35773
|
* @remarks
|
|
35557
35774
|
* [Api set: ExcelApi 1.9]
|
|
@@ -35570,7 +35787,7 @@ declare namespace Excel {
|
|
|
35570
35787
|
/**
|
|
35571
35788
|
* Gets the range object containing the anchor cell for the cell getting spilled into.
|
|
35572
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`.
|
|
35573
|
-
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}.
|
|
35574
35791
|
*
|
|
35575
35792
|
* @remarks
|
|
35576
35793
|
* [Api set: ExcelApi 1.12]
|
|
@@ -35586,7 +35803,7 @@ declare namespace Excel {
|
|
|
35586
35803
|
/**
|
|
35587
35804
|
* Gets the range object containing the spill range when called on an anchor cell.
|
|
35588
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`.
|
|
35589
|
-
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}.
|
|
35590
35807
|
*
|
|
35591
35808
|
* @remarks
|
|
35592
35809
|
* [Api set: ExcelApi 1.12]
|
|
@@ -35619,7 +35836,7 @@ declare namespace Excel {
|
|
|
35619
35836
|
getUsedRange(valuesOnly?: boolean): Excel.Range;
|
|
35620
35837
|
/**
|
|
35621
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`.
|
|
35622
|
-
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}.
|
|
35623
35840
|
*
|
|
35624
35841
|
* @remarks
|
|
35625
35842
|
* [Api set: ExcelApi 1.4]
|
|
@@ -35915,7 +36132,7 @@ declare namespace Excel {
|
|
|
35915
36132
|
}
|
|
35916
36133
|
/**
|
|
35917
36134
|
* `RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet.
|
|
35918
|
-
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}.
|
|
35919
36136
|
*
|
|
35920
36137
|
* @remarks
|
|
35921
36138
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36084,7 +36301,7 @@ declare namespace Excel {
|
|
|
36084
36301
|
* @param skipBlanks True if to skip blank cells in the source range or `RangeAreas`. Default is false.
|
|
36085
36302
|
* @param transpose True if to transpose the cells in the destination `RangeAreas`. Default is false.
|
|
36086
36303
|
*/
|
|
36087
|
-
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;
|
|
36088
36305
|
/**
|
|
36089
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").
|
|
36090
36307
|
*
|
|
@@ -36110,7 +36327,7 @@ declare namespace Excel {
|
|
|
36110
36327
|
getIntersection(anotherRange: Range | RangeAreas | string): Excel.RangeAreas;
|
|
36111
36328
|
/**
|
|
36112
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`.
|
|
36113
|
-
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}.
|
|
36114
36331
|
*
|
|
36115
36332
|
* @remarks
|
|
36116
36333
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36150,7 +36367,7 @@ declare namespace Excel {
|
|
|
36150
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;
|
|
36151
36368
|
/**
|
|
36152
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`.
|
|
36153
|
-
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}.
|
|
36154
36371
|
*
|
|
36155
36372
|
* @remarks
|
|
36156
36373
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36161,7 +36378,7 @@ declare namespace Excel {
|
|
|
36161
36378
|
getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;
|
|
36162
36379
|
/**
|
|
36163
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`.
|
|
36164
|
-
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}.
|
|
36165
36382
|
*
|
|
36166
36383
|
* @remarks
|
|
36167
36384
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36192,7 +36409,7 @@ declare namespace Excel {
|
|
|
36192
36409
|
/**
|
|
36193
36410
|
* Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.
|
|
36194
36411
|
If there are no used cells within the `RangeAreas`, then this method returns an object with its `isNullObject` property set to `true`.
|
|
36195
|
-
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}.
|
|
36196
36413
|
*
|
|
36197
36414
|
* @remarks
|
|
36198
36415
|
* [Api set: ExcelApi 1.9]
|
|
@@ -36283,7 +36500,7 @@ declare namespace Excel {
|
|
|
36283
36500
|
getRangeAreasBySheet(key: string): Excel.RangeAreas;
|
|
36284
36501
|
/**
|
|
36285
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`.
|
|
36286
|
-
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}.
|
|
36287
36504
|
*
|
|
36288
36505
|
* @remarks
|
|
36289
36506
|
* [Api set: ExcelApi 1.12]
|
|
@@ -37048,7 +37265,7 @@ declare namespace Excel {
|
|
|
37048
37265
|
getItem(key: string): Excel.Setting;
|
|
37049
37266
|
/**
|
|
37050
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`.
|
|
37051
|
-
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}.
|
|
37052
37269
|
*
|
|
37053
37270
|
* @remarks
|
|
37054
37271
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37207,7 +37424,7 @@ declare namespace Excel {
|
|
|
37207
37424
|
getItem(name: string): Excel.NamedItem;
|
|
37208
37425
|
/**
|
|
37209
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`.
|
|
37210
|
-
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}.
|
|
37211
37428
|
*
|
|
37212
37429
|
* @remarks
|
|
37213
37430
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37264,7 +37481,7 @@ declare namespace Excel {
|
|
|
37264
37481
|
readonly worksheet: Excel.Worksheet;
|
|
37265
37482
|
/**
|
|
37266
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`.
|
|
37267
|
-
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}.
|
|
37268
37485
|
*
|
|
37269
37486
|
* @remarks
|
|
37270
37487
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37306,8 +37523,8 @@ declare namespace Excel {
|
|
|
37306
37523
|
*/
|
|
37307
37524
|
readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";
|
|
37308
37525
|
/**
|
|
37309
|
-
* Represents the value computed by the name's formula. For a named range it will return the range address.
|
|
37310
|
-
|
|
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.
|
|
37311
37528
|
*
|
|
37312
37529
|
* @remarks
|
|
37313
37530
|
* [Api set: ExcelApi 1.1]
|
|
@@ -37362,7 +37579,7 @@ declare namespace Excel {
|
|
|
37362
37579
|
getRange(): Excel.Range;
|
|
37363
37580
|
/**
|
|
37364
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`.
|
|
37365
|
-
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}.
|
|
37366
37583
|
*
|
|
37367
37584
|
* @remarks
|
|
37368
37585
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37674,7 +37891,7 @@ declare namespace Excel {
|
|
|
37674
37891
|
getItemAt(index: number): Excel.Binding;
|
|
37675
37892
|
/**
|
|
37676
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`.
|
|
37677
|
-
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}.
|
|
37678
37895
|
*
|
|
37679
37896
|
* @remarks
|
|
37680
37897
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37761,7 +37978,7 @@ declare namespace Excel {
|
|
|
37761
37978
|
getItemAt(index: number): Excel.Table;
|
|
37762
37979
|
/**
|
|
37763
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`.
|
|
37764
|
-
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}.
|
|
37765
37982
|
*
|
|
37766
37983
|
* @remarks
|
|
37767
37984
|
* [Api set: ExcelApi 1.4]
|
|
@@ -37867,7 +38084,7 @@ declare namespace Excel {
|
|
|
37867
38084
|
/**
|
|
37868
38085
|
* Gets a table by name or ID.
|
|
37869
38086
|
If the table object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
37870
|
-
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}.
|
|
37871
38088
|
*
|
|
37872
38089
|
* @remarks
|
|
37873
38090
|
* [Api set: ExcelApi 1.14]
|
|
@@ -37901,7 +38118,7 @@ declare namespace Excel {
|
|
|
37901
38118
|
}
|
|
37902
38119
|
/**
|
|
37903
38120
|
* Represents an Excel table.
|
|
37904
|
-
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}.
|
|
37905
38122
|
*
|
|
37906
38123
|
* @remarks
|
|
37907
38124
|
* [Api set: ExcelApi 1.1]
|
|
@@ -38245,7 +38462,7 @@ declare namespace Excel {
|
|
|
38245
38462
|
getItemAt(index: number): Excel.TableColumn;
|
|
38246
38463
|
/**
|
|
38247
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`.
|
|
38248
|
-
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}.
|
|
38249
38466
|
*
|
|
38250
38467
|
* @remarks
|
|
38251
38468
|
* [Api set: ExcelApi 1.4]
|
|
@@ -38631,7 +38848,7 @@ declare namespace Excel {
|
|
|
38631
38848
|
}
|
|
38632
38849
|
/**
|
|
38633
38850
|
* Represents the data validation applied to the current range.
|
|
38634
|
-
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}.
|
|
38635
38852
|
*
|
|
38636
38853
|
* @remarks
|
|
38637
38854
|
* [Api set: ExcelApi 1.8]
|
|
@@ -39061,7 +39278,7 @@ declare namespace Excel {
|
|
|
39061
39278
|
*/
|
|
39062
39279
|
autoIndent: boolean;
|
|
39063
39280
|
/**
|
|
39064
|
-
* 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.
|
|
39065
39282
|
*
|
|
39066
39283
|
* @remarks
|
|
39067
39284
|
* [Api set: ExcelApi 1.2]
|
|
@@ -39699,7 +39916,7 @@ declare namespace Excel {
|
|
|
39699
39916
|
getItemAt(index: number): Excel.Chart;
|
|
39700
39917
|
/**
|
|
39701
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`.
|
|
39702
|
-
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}.
|
|
39703
39920
|
*
|
|
39704
39921
|
* @remarks
|
|
39705
39922
|
* [Api set: ExcelApi 1.4]
|
|
@@ -39769,7 +39986,7 @@ declare namespace Excel {
|
|
|
39769
39986
|
}
|
|
39770
39987
|
/**
|
|
39771
39988
|
* Represents a chart object in a workbook.
|
|
39772
|
-
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}.
|
|
39773
39990
|
*
|
|
39774
39991
|
* @remarks
|
|
39775
39992
|
* [Api set: ExcelApi 1.1]
|
|
@@ -39979,7 +40196,7 @@ declare namespace Excel {
|
|
|
39979
40196
|
getDataRange(): OfficeExtension.ClientResult<string>;
|
|
39980
40197
|
/**
|
|
39981
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`.
|
|
39982
|
-
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}.
|
|
39983
40200
|
*
|
|
39984
40201
|
* @remarks
|
|
39985
40202
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -39995,7 +40212,7 @@ declare namespace Excel {
|
|
|
39995
40212
|
getDataTable(): Excel.ChartDataTable;
|
|
39996
40213
|
/**
|
|
39997
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`.
|
|
39998
|
-
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}.
|
|
39999
40216
|
*
|
|
40000
40217
|
* @remarks
|
|
40001
40218
|
* [Api set: ExcelApi 1.14]
|
|
@@ -40740,7 +40957,7 @@ declare namespace Excel {
|
|
|
40740
40957
|
*/
|
|
40741
40958
|
setValues(sourceData: Range): void;
|
|
40742
40959
|
/**
|
|
40743
|
-
* Sets the values of the x-axis for a chart series.
|
|
40960
|
+
* Sets the values of the x-axis for a chart series.
|
|
40744
40961
|
*
|
|
40745
40962
|
* @remarks
|
|
40746
40963
|
* [Api set: ExcelApi 1.7]
|
|
@@ -41574,7 +41791,7 @@ declare namespace Excel {
|
|
|
41574
41791
|
*/
|
|
41575
41792
|
textOrientation: number;
|
|
41576
41793
|
/**
|
|
41577
|
-
* Specifies if the axis title is
|
|
41794
|
+
* Specifies if the axis title is visible.
|
|
41578
41795
|
*
|
|
41579
41796
|
* @remarks
|
|
41580
41797
|
* [Api set: ExcelApi 1.1]
|
|
@@ -42956,7 +43173,7 @@ declare namespace Excel {
|
|
|
42956
43173
|
*/
|
|
42957
43174
|
verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
|
|
42958
43175
|
/**
|
|
42959
|
-
* Specifies if the chart title is
|
|
43176
|
+
* Specifies if the chart title is visible.
|
|
42960
43177
|
*
|
|
42961
43178
|
* @remarks
|
|
42962
43179
|
* [Api set: ExcelApi 1.1]
|
|
@@ -44726,7 +44943,7 @@ declare namespace Excel {
|
|
|
44726
44943
|
/**
|
|
44727
44944
|
* Returns the `Range` object that represents the range to which the AutoFilter applies.
|
|
44728
44945
|
If there is no `Range` object associated with the AutoFilter, then this method returns an object with its `isNullObject` property set to `true`.
|
|
44729
|
-
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}.
|
|
44730
44947
|
*
|
|
44731
44948
|
* @remarks
|
|
44732
44949
|
* [Api set: ExcelApi 1.9]
|
|
@@ -45012,7 +45229,7 @@ declare namespace Excel {
|
|
|
45012
45229
|
/**
|
|
45013
45230
|
* Gets a custom XML part based on its ID.
|
|
45014
45231
|
If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45015
|
-
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}.
|
|
45016
45233
|
*
|
|
45017
45234
|
* @remarks
|
|
45018
45235
|
* [Api set: ExcelApi 1.5]
|
|
@@ -45108,7 +45325,7 @@ declare namespace Excel {
|
|
|
45108
45325
|
/**
|
|
45109
45326
|
* Gets a custom XML part based on its ID.
|
|
45110
45327
|
If the `CustomXmlPart` does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45111
|
-
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}.
|
|
45112
45329
|
*
|
|
45113
45330
|
* @remarks
|
|
45114
45331
|
* [Api set: ExcelApi 1.5]
|
|
@@ -45241,7 +45458,7 @@ declare namespace Excel {
|
|
|
45241
45458
|
/**
|
|
45242
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.
|
|
45243
45460
|
If the collection is empty, then this method returns an object with its `isNullObject` property set to `true`.
|
|
45244
|
-
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}.
|
|
45245
45462
|
*
|
|
45246
45463
|
* @remarks
|
|
45247
45464
|
* [Api set: ExcelApi 1.15]
|
|
@@ -45258,7 +45475,7 @@ declare namespace Excel {
|
|
|
45258
45475
|
getItem(key: string): Excel.PivotTable;
|
|
45259
45476
|
/**
|
|
45260
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`.
|
|
45261
|
-
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}.
|
|
45262
45479
|
*
|
|
45263
45480
|
* @remarks
|
|
45264
45481
|
* [Api set: ExcelApi 1.12]
|
|
@@ -45331,7 +45548,7 @@ declare namespace Excel {
|
|
|
45331
45548
|
getItem(name: string): Excel.PivotTable;
|
|
45332
45549
|
/**
|
|
45333
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`.
|
|
45334
|
-
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}.
|
|
45335
45552
|
*
|
|
45336
45553
|
* @remarks
|
|
45337
45554
|
* [Api set: ExcelApi 1.4]
|
|
@@ -45421,7 +45638,7 @@ declare namespace Excel {
|
|
|
45421
45638
|
}
|
|
45422
45639
|
/**
|
|
45423
45640
|
* Represents an Excel PivotTable.
|
|
45424
|
-
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}.
|
|
45425
45642
|
*
|
|
45426
45643
|
* @remarks
|
|
45427
45644
|
* [Api set: ExcelApi 1.3]
|
|
@@ -45889,7 +46106,7 @@ declare namespace Excel {
|
|
|
45889
46106
|
getItem(name: string): Excel.PivotHierarchy;
|
|
45890
46107
|
/**
|
|
45891
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`.
|
|
45892
|
-
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}.
|
|
45893
46110
|
*
|
|
45894
46111
|
* @remarks
|
|
45895
46112
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46023,7 +46240,7 @@ declare namespace Excel {
|
|
|
46023
46240
|
getItem(name: string): Excel.RowColumnPivotHierarchy;
|
|
46024
46241
|
/**
|
|
46025
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`.
|
|
46026
|
-
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}.
|
|
46027
46244
|
*
|
|
46028
46245
|
* @remarks
|
|
46029
46246
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46178,7 +46395,7 @@ declare namespace Excel {
|
|
|
46178
46395
|
getItem(name: string): Excel.FilterPivotHierarchy;
|
|
46179
46396
|
/**
|
|
46180
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`.
|
|
46181
|
-
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}.
|
|
46182
46399
|
*
|
|
46183
46400
|
* @remarks
|
|
46184
46401
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46339,7 +46556,7 @@ declare namespace Excel {
|
|
|
46339
46556
|
getItem(name: string): Excel.DataPivotHierarchy;
|
|
46340
46557
|
/**
|
|
46341
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`.
|
|
46342
|
-
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}.
|
|
46343
46560
|
*
|
|
46344
46561
|
* @remarks
|
|
46345
46562
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46534,7 +46751,7 @@ declare namespace Excel {
|
|
|
46534
46751
|
getItem(name: string): Excel.PivotField;
|
|
46535
46752
|
/**
|
|
46536
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`.
|
|
46537
|
-
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}.
|
|
46538
46755
|
*
|
|
46539
46756
|
* @remarks
|
|
46540
46757
|
* [Api set: ExcelApi 1.8]
|
|
@@ -46776,7 +46993,7 @@ declare namespace Excel {
|
|
|
46776
46993
|
getItem(name: string): Excel.PivotItem;
|
|
46777
46994
|
/**
|
|
46778
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`.
|
|
46779
|
-
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}.
|
|
46780
46997
|
*
|
|
46781
46998
|
* @remarks
|
|
46782
46999
|
* [Api set: ExcelApi 1.8]
|
|
@@ -47302,7 +47519,7 @@ declare namespace Excel {
|
|
|
47302
47519
|
getItem(key: string): Excel.WorksheetCustomProperty;
|
|
47303
47520
|
/**
|
|
47304
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`.
|
|
47305
|
-
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}.
|
|
47306
47523
|
*
|
|
47307
47524
|
* @remarks
|
|
47308
47525
|
* [Api set: ExcelApi 1.12]
|
|
@@ -47580,7 +47797,7 @@ declare namespace Excel {
|
|
|
47580
47797
|
getItem(key: string): Excel.CustomProperty;
|
|
47581
47798
|
/**
|
|
47582
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`.
|
|
47583
|
-
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}.
|
|
47584
47801
|
*
|
|
47585
47802
|
* @remarks
|
|
47586
47803
|
* [Api set: ExcelApi 1.7]
|
|
@@ -47677,7 +47894,7 @@ declare namespace Excel {
|
|
|
47677
47894
|
/**
|
|
47678
47895
|
* Returns a conditional format identified by its ID.
|
|
47679
47896
|
If the conditional format object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
47680
|
-
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}.
|
|
47681
47898
|
*
|
|
47682
47899
|
* @remarks
|
|
47683
47900
|
* [Api set: ExcelApi 1.14]
|
|
@@ -47711,7 +47928,7 @@ declare namespace Excel {
|
|
|
47711
47928
|
}
|
|
47712
47929
|
/**
|
|
47713
47930
|
* An object encapsulating a conditional format's range, format, rule, and other properties.
|
|
47714
|
-
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}.
|
|
47715
47932
|
*
|
|
47716
47933
|
* @remarks
|
|
47717
47934
|
* [Api set: ExcelApi 1.6]
|
|
@@ -47958,7 +48175,7 @@ declare namespace Excel {
|
|
|
47958
48175
|
getRange(): Excel.Range;
|
|
47959
48176
|
/**
|
|
47960
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`.
|
|
47961
|
-
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}.
|
|
47962
48179
|
*
|
|
47963
48180
|
* @remarks
|
|
47964
48181
|
* [Api set: ExcelApi 1.6]
|
|
@@ -48053,7 +48270,7 @@ declare namespace Excel {
|
|
|
48053
48270
|
*/
|
|
48054
48271
|
barDirection: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";
|
|
48055
48272
|
/**
|
|
48056
|
-
* The rule for what
|
|
48273
|
+
* The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.
|
|
48057
48274
|
The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`).
|
|
48058
48275
|
*
|
|
48059
48276
|
* @remarks
|
|
@@ -49584,7 +49801,7 @@ declare namespace Excel {
|
|
|
49584
49801
|
/**
|
|
49585
49802
|
* Gets a style by name.
|
|
49586
49803
|
If the style object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
49587
|
-
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}.
|
|
49588
49805
|
*
|
|
49589
49806
|
* @remarks
|
|
49590
49807
|
* [Api set: ExcelApi 1.14]
|
|
@@ -49665,7 +49882,7 @@ declare namespace Excel {
|
|
|
49665
49882
|
getItem(name: string): Excel.TableStyle;
|
|
49666
49883
|
/**
|
|
49667
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`.
|
|
49668
|
-
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}.
|
|
49669
49886
|
*
|
|
49670
49887
|
* @remarks
|
|
49671
49888
|
* [Api set: ExcelApi 1.10]
|
|
@@ -49829,7 +50046,7 @@ declare namespace Excel {
|
|
|
49829
50046
|
getItem(name: string): Excel.PivotTableStyle;
|
|
49830
50047
|
/**
|
|
49831
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`.
|
|
49832
|
-
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}.
|
|
49833
50050
|
*
|
|
49834
50051
|
* @remarks
|
|
49835
50052
|
* [Api set: ExcelApi 1.10]
|
|
@@ -49993,7 +50210,7 @@ declare namespace Excel {
|
|
|
49993
50210
|
getItem(name: string): Excel.SlicerStyle;
|
|
49994
50211
|
/**
|
|
49995
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`.
|
|
49996
|
-
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}.
|
|
49997
50214
|
*
|
|
49998
50215
|
* @remarks
|
|
49999
50216
|
* [Api set: ExcelApi 1.10]
|
|
@@ -50157,7 +50374,7 @@ declare namespace Excel {
|
|
|
50157
50374
|
getItem(name: string): Excel.TimelineStyle;
|
|
50158
50375
|
/**
|
|
50159
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`.
|
|
50160
|
-
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}.
|
|
50161
50378
|
*
|
|
50162
50379
|
* @remarks
|
|
50163
50380
|
* [Api set: ExcelApi 1.10]
|
|
@@ -50439,7 +50656,7 @@ declare namespace Excel {
|
|
|
50439
50656
|
getPrintArea(): Excel.RangeAreas;
|
|
50440
50657
|
/**
|
|
50441
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`.
|
|
50442
|
-
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}.
|
|
50443
50660
|
*
|
|
50444
50661
|
* @remarks
|
|
50445
50662
|
* [Api set: ExcelApi 1.9]
|
|
@@ -50454,7 +50671,7 @@ declare namespace Excel {
|
|
|
50454
50671
|
getPrintTitleColumns(): Excel.Range;
|
|
50455
50672
|
/**
|
|
50456
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`.
|
|
50457
|
-
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}.
|
|
50458
50675
|
*
|
|
50459
50676
|
* @remarks
|
|
50460
50677
|
* [Api set: ExcelApi 1.9]
|
|
@@ -50469,7 +50686,7 @@ declare namespace Excel {
|
|
|
50469
50686
|
getPrintTitleRows(): Excel.Range;
|
|
50470
50687
|
/**
|
|
50471
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`.
|
|
50472
|
-
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}.
|
|
50473
50690
|
*
|
|
50474
50691
|
* @remarks
|
|
50475
50692
|
* [Api set: ExcelApi 1.9]
|
|
@@ -51171,7 +51388,7 @@ declare namespace Excel {
|
|
|
51171
51388
|
*/
|
|
51172
51389
|
getItemAt(index: number): Excel.Comment;
|
|
51173
51390
|
/**
|
|
51174
|
-
* 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.
|
|
51175
51392
|
*
|
|
51176
51393
|
* @remarks
|
|
51177
51394
|
* [Api set: ExcelApi 1.10]
|
|
@@ -51191,7 +51408,7 @@ declare namespace Excel {
|
|
|
51191
51408
|
/**
|
|
51192
51409
|
* Gets a comment from the collection based on its ID.
|
|
51193
51410
|
If the comment object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
51194
|
-
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}.
|
|
51195
51412
|
*
|
|
51196
51413
|
* @remarks
|
|
51197
51414
|
* [Api set: ExcelApi 1.14]
|
|
@@ -51371,7 +51588,7 @@ declare namespace Excel {
|
|
|
51371
51588
|
getTask(): Excel.DocumentTask;
|
|
51372
51589
|
/**
|
|
51373
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`.
|
|
51374
|
-
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}.
|
|
51375
51592
|
*
|
|
51376
51593
|
* @remarks
|
|
51377
51594
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -51473,7 +51690,7 @@ declare namespace Excel {
|
|
|
51473
51690
|
/**
|
|
51474
51691
|
* Returns a comment reply identified by its ID.
|
|
51475
51692
|
If the comment reply object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
51476
|
-
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}.
|
|
51477
51694
|
*
|
|
51478
51695
|
* @remarks
|
|
51479
51696
|
* [Api set: ExcelApi 1.14]
|
|
@@ -51626,7 +51843,7 @@ declare namespace Excel {
|
|
|
51626
51843
|
getTask(): Excel.DocumentTask;
|
|
51627
51844
|
/**
|
|
51628
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`.
|
|
51629
|
-
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}.
|
|
51630
51847
|
*
|
|
51631
51848
|
* @remarks
|
|
51632
51849
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -51789,7 +52006,7 @@ declare namespace Excel {
|
|
|
51789
52006
|
/**
|
|
51790
52007
|
* Gets a shape using its name or ID.
|
|
51791
52008
|
If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
51792
|
-
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}.
|
|
51793
52010
|
*
|
|
51794
52011
|
* @remarks
|
|
51795
52012
|
* [Api set: ExcelApi 1.14]
|
|
@@ -51823,7 +52040,7 @@ declare namespace Excel {
|
|
|
51823
52040
|
}
|
|
51824
52041
|
/**
|
|
51825
52042
|
* Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc.
|
|
51826
|
-
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}.
|
|
51827
52044
|
*
|
|
51828
52045
|
* @remarks
|
|
51829
52046
|
* [Api set: ExcelApi 1.9]
|
|
@@ -52407,7 +52624,7 @@ declare namespace Excel {
|
|
|
52407
52624
|
/**
|
|
52408
52625
|
* Gets a shape using its name or ID.
|
|
52409
52626
|
If the shape object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
52410
|
-
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}.
|
|
52411
52628
|
*
|
|
52412
52629
|
* @remarks
|
|
52413
52630
|
* [Api set: ExcelApi 1.14]
|
|
@@ -53324,7 +53541,7 @@ declare namespace Excel {
|
|
|
53324
53541
|
getItemAt(index: number): Excel.Slicer;
|
|
53325
53542
|
/**
|
|
53326
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`.
|
|
53327
|
-
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}.
|
|
53328
53545
|
*
|
|
53329
53546
|
* @remarks
|
|
53330
53547
|
* [Api set: ExcelApi 1.10]
|
|
@@ -53468,7 +53685,7 @@ declare namespace Excel {
|
|
|
53468
53685
|
getItemAt(index: number): Excel.SlicerItem;
|
|
53469
53686
|
/**
|
|
53470
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`.
|
|
53471
|
-
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}.
|
|
53472
53689
|
*
|
|
53473
53690
|
* @remarks
|
|
53474
53691
|
* [Api set: ExcelApi 1.10]
|
|
@@ -53670,7 +53887,7 @@ declare namespace Excel {
|
|
|
53670
53887
|
getItemAt(index: number): Excel.LinkedDataType;
|
|
53671
53888
|
/**
|
|
53672
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`.
|
|
53673
|
-
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}.
|
|
53674
53891
|
*
|
|
53675
53892
|
* @remarks
|
|
53676
53893
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -54742,7 +54959,7 @@ declare namespace Excel {
|
|
|
54742
54959
|
}
|
|
54743
54960
|
/**
|
|
54744
54961
|
* Specifies the data source type of the chart series.
|
|
54745
|
-
*
|
|
54962
|
+
*
|
|
54746
54963
|
* @remarks
|
|
54747
54964
|
* [Api set: ExcelApi 1.15]
|
|
54748
54965
|
*/
|
|
@@ -57394,6 +57611,8 @@ declare namespace Excel {
|
|
|
57394
57611
|
fill = "Fill"
|
|
57395
57612
|
}
|
|
57396
57613
|
/**
|
|
57614
|
+
* Determines the direction in which existing cells will be shifted to accommodate what is being inserted.
|
|
57615
|
+
*
|
|
57397
57616
|
* @remarks
|
|
57398
57617
|
* [Api set: ExcelApi 1.1]
|
|
57399
57618
|
*/
|
|
@@ -57645,6 +57864,8 @@ declare namespace Excel {
|
|
|
57645
57864
|
columns = "Columns"
|
|
57646
57865
|
}
|
|
57647
57866
|
/**
|
|
57867
|
+
* Represents the part of the cell used as the sorting criteria.
|
|
57868
|
+
*
|
|
57648
57869
|
* @remarks
|
|
57649
57870
|
* [Api set: ExcelApi 1.2]
|
|
57650
57871
|
*/
|
|
@@ -58186,13 +58407,6 @@ declare namespace Excel {
|
|
|
58186
58407
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
58187
58408
|
*/
|
|
58188
58409
|
annotationAdded = "AnnotationAdded",
|
|
58189
|
-
/**
|
|
58190
|
-
* Workbook Action Recorded represents the type of event registered when the workbook records an action.
|
|
58191
|
-
* @remarks
|
|
58192
|
-
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
58193
|
-
* @beta
|
|
58194
|
-
*/
|
|
58195
|
-
workbookActionRecorded = "WorkbookActionRecorded"
|
|
58196
58410
|
}
|
|
58197
58411
|
/**
|
|
58198
58412
|
* @remarks
|
|
@@ -58898,6 +59112,8 @@ declare namespace Excel {
|
|
|
58898
59112
|
notAvailable = "NotAvailable"
|
|
58899
59113
|
}
|
|
58900
59114
|
/**
|
|
59115
|
+
* The position of a worksheet relative to another worksheet or the entire worksheet collection.
|
|
59116
|
+
*
|
|
58901
59117
|
* @remarks
|
|
58902
59118
|
* [Api set: ExcelApi 1.7]
|
|
58903
59119
|
*/
|
|
@@ -59050,7 +59266,7 @@ declare namespace Excel {
|
|
|
59050
59266
|
*/
|
|
59051
59267
|
fillSeries = "FillSeries",
|
|
59052
59268
|
/**
|
|
59053
|
-
* Populates the adjacent cells with the selected
|
|
59269
|
+
* Populates the adjacent cells with the selected formats.
|
|
59054
59270
|
* @remarks
|
|
59055
59271
|
* [Api set: ExcelApi 1.9]
|
|
59056
59272
|
*/
|
|
@@ -59146,7 +59362,12 @@ declare namespace Excel {
|
|
|
59146
59362
|
* @remarks
|
|
59147
59363
|
* [Api set: ExcelApi 1.9]
|
|
59148
59364
|
*/
|
|
59149
|
-
formats = "Formats"
|
|
59365
|
+
formats = "Formats",
|
|
59366
|
+
/**
|
|
59367
|
+
* @remarks
|
|
59368
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
59369
|
+
*/
|
|
59370
|
+
link = "Link"
|
|
59150
59371
|
}
|
|
59151
59372
|
/**
|
|
59152
59373
|
* @remarks
|
|
@@ -60972,7 +61193,7 @@ declare namespace Excel {
|
|
|
60972
61193
|
/**
|
|
60973
61194
|
* Gets a sheet view using its name.
|
|
60974
61195
|
If the sheet view object does not exist, then this method returns an object with its `isNullObject` property set to `true`.
|
|
60975
|
-
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}.
|
|
60976
61197
|
*
|
|
60977
61198
|
* @remarks
|
|
60978
61199
|
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
@@ -65605,7 +65826,7 @@ declare namespace Excel {
|
|
|
65605
65826
|
*/
|
|
65606
65827
|
autoIndent?: boolean;
|
|
65607
65828
|
/**
|
|
65608
|
-
* 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.
|
|
65609
65830
|
*
|
|
65610
65831
|
* @remarks
|
|
65611
65832
|
* [Api set: ExcelApi 1.2]
|
|
@@ -66770,7 +66991,7 @@ declare namespace Excel {
|
|
|
66770
66991
|
*/
|
|
66771
66992
|
textOrientation?: number;
|
|
66772
66993
|
/**
|
|
66773
|
-
* Specifies if the axis title is
|
|
66994
|
+
* Specifies if the axis title is visible.
|
|
66774
66995
|
*
|
|
66775
66996
|
* @remarks
|
|
66776
66997
|
* [Api set: ExcelApi 1.1]
|
|
@@ -67390,7 +67611,7 @@ declare namespace Excel {
|
|
|
67390
67611
|
*/
|
|
67391
67612
|
verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
|
|
67392
67613
|
/**
|
|
67393
|
-
* Specifies if the chart title is
|
|
67614
|
+
* Specifies if the chart title is visible.
|
|
67394
67615
|
*
|
|
67395
67616
|
* @remarks
|
|
67396
67617
|
* [Api set: ExcelApi 1.1]
|
|
@@ -68486,7 +68707,7 @@ declare namespace Excel {
|
|
|
68486
68707
|
*/
|
|
68487
68708
|
barDirection?: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";
|
|
68488
68709
|
/**
|
|
68489
|
-
* The rule for what
|
|
68710
|
+
* The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.
|
|
68490
68711
|
The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`).
|
|
68491
68712
|
*
|
|
68492
68713
|
* @remarks
|
|
@@ -71231,8 +71452,8 @@ declare namespace Excel {
|
|
|
71231
71452
|
*/
|
|
71232
71453
|
type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";
|
|
71233
71454
|
/**
|
|
71234
|
-
* Represents the value computed by the name's formula. For a named range it will return the range address.
|
|
71235
|
-
|
|
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.
|
|
71236
71457
|
*
|
|
71237
71458
|
* @remarks
|
|
71238
71459
|
* [Api set: ExcelApi 1.1]
|
|
@@ -71649,7 +71870,7 @@ declare namespace Excel {
|
|
|
71649
71870
|
*/
|
|
71650
71871
|
autoIndent?: boolean;
|
|
71651
71872
|
/**
|
|
71652
|
-
* 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.
|
|
71653
71874
|
*
|
|
71654
71875
|
* @remarks
|
|
71655
71876
|
* [Api set: ExcelApi 1.2]
|
|
@@ -72904,7 +73125,7 @@ declare namespace Excel {
|
|
|
72904
73125
|
*/
|
|
72905
73126
|
textOrientation?: number;
|
|
72906
73127
|
/**
|
|
72907
|
-
* Specifies if the axis title is
|
|
73128
|
+
* Specifies if the axis title is visible.
|
|
72908
73129
|
*
|
|
72909
73130
|
* @remarks
|
|
72910
73131
|
* [Api set: ExcelApi 1.1]
|
|
@@ -73587,7 +73808,7 @@ declare namespace Excel {
|
|
|
73587
73808
|
*/
|
|
73588
73809
|
verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";
|
|
73589
73810
|
/**
|
|
73590
|
-
* Specifies if the chart title is
|
|
73811
|
+
* Specifies if the chart title is visible.
|
|
73591
73812
|
*
|
|
73592
73813
|
* @remarks
|
|
73593
73814
|
* [Api set: ExcelApi 1.1]
|
|
@@ -75033,7 +75254,7 @@ declare namespace Excel {
|
|
|
75033
75254
|
*/
|
|
75034
75255
|
barDirection?: Excel.ConditionalDataBarDirection | "Context" | "LeftToRight" | "RightToLeft";
|
|
75035
75256
|
/**
|
|
75036
|
-
* The rule for what
|
|
75257
|
+
* The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.
|
|
75037
75258
|
The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`).
|
|
75038
75259
|
*
|
|
75039
75260
|
* @remarks
|
|
@@ -77595,7 +77816,7 @@ declare namespace Excel {
|
|
|
77595
77816
|
}
|
|
77596
77817
|
/**
|
|
77597
77818
|
* Workbook is the top level object which contains related workbook objects such as worksheets, tables, and ranges.
|
|
77598
|
-
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}.
|
|
77599
77820
|
*
|
|
77600
77821
|
* @remarks
|
|
77601
77822
|
* [Api set: ExcelApi 1.1]
|
|
@@ -77753,7 +77974,7 @@ declare namespace Excel {
|
|
|
77753
77974
|
}
|
|
77754
77975
|
/**
|
|
77755
77976
|
* An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc.
|
|
77756
|
-
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}.
|
|
77757
77978
|
*
|
|
77758
77979
|
* @remarks
|
|
77759
77980
|
* [Api set: ExcelApi 1.1]
|
|
@@ -78065,7 +78286,7 @@ declare namespace Excel {
|
|
|
78065
78286
|
}
|
|
78066
78287
|
/**
|
|
78067
78288
|
* Range represents a set of one or more contiguous cells such as a cell, a row, a column, or a block of cells.
|
|
78068
|
-
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}.
|
|
78069
78290
|
*
|
|
78070
78291
|
* @remarks
|
|
78071
78292
|
* [Api set: ExcelApi 1.1]
|
|
@@ -78336,7 +78557,7 @@ declare namespace Excel {
|
|
|
78336
78557
|
}
|
|
78337
78558
|
/**
|
|
78338
78559
|
* `RangeAreas` represents a collection of one or more rectangular ranges in the same worksheet.
|
|
78339
|
-
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}.
|
|
78340
78561
|
*
|
|
78341
78562
|
* @remarks
|
|
78342
78563
|
* [Api set: ExcelApi 1.9]
|
|
@@ -78731,7 +78952,7 @@ declare namespace Excel {
|
|
|
78731
78952
|
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
|
|
78732
78953
|
/**
|
|
78733
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`.
|
|
78734
|
-
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}.
|
|
78735
78956
|
*
|
|
78736
78957
|
* @remarks
|
|
78737
78958
|
* [Api set: ExcelApi 1.4]
|
|
@@ -78773,8 +78994,8 @@ declare namespace Excel {
|
|
|
78773
78994
|
*/
|
|
78774
78995
|
type?: boolean;
|
|
78775
78996
|
/**
|
|
78776
|
-
* 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.
|
|
78777
|
-
|
|
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.
|
|
78778
78999
|
*
|
|
78779
79000
|
* @remarks
|
|
78780
79001
|
* [Api set: ExcelApi 1.1]
|
|
@@ -78833,7 +79054,7 @@ declare namespace Excel {
|
|
|
78833
79054
|
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
|
|
78834
79055
|
/**
|
|
78835
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`.
|
|
78836
|
-
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}.
|
|
78837
79058
|
*
|
|
78838
79059
|
* @remarks
|
|
78839
79060
|
* [Api set: ExcelApi 1.4]
|
|
@@ -78875,8 +79096,8 @@ declare namespace Excel {
|
|
|
78875
79096
|
*/
|
|
78876
79097
|
type?: boolean;
|
|
78877
79098
|
/**
|
|
78878
|
-
* Represents the value computed by the name's formula. For a named range, will return the range address.
|
|
78879
|
-
|
|
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.
|
|
78880
79101
|
*
|
|
78881
79102
|
* @remarks
|
|
78882
79103
|
* [Api set: ExcelApi 1.1]
|
|
@@ -79274,7 +79495,7 @@ declare namespace Excel {
|
|
|
79274
79495
|
}
|
|
79275
79496
|
/**
|
|
79276
79497
|
* Represents an Excel table.
|
|
79277
|
-
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}.
|
|
79278
79499
|
*
|
|
79279
79500
|
* @remarks
|
|
79280
79501
|
* [Api set: ExcelApi 1.1]
|
|
@@ -79641,7 +79862,7 @@ declare namespace Excel {
|
|
|
79641
79862
|
}
|
|
79642
79863
|
/**
|
|
79643
79864
|
* Represents the data validation applied to the current range.
|
|
79644
|
-
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}.
|
|
79645
79866
|
*
|
|
79646
79867
|
* @remarks
|
|
79647
79868
|
* [Api set: ExcelApi 1.8]
|
|
@@ -79769,7 +79990,7 @@ declare namespace Excel {
|
|
|
79769
79990
|
*/
|
|
79770
79991
|
autoIndent?: boolean;
|
|
79771
79992
|
/**
|
|
79772
|
-
* 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.
|
|
79773
79994
|
*
|
|
79774
79995
|
* @remarks
|
|
79775
79996
|
* [Api set: ExcelApi 1.2]
|
|
@@ -80301,7 +80522,7 @@ declare namespace Excel {
|
|
|
80301
80522
|
}
|
|
80302
80523
|
/**
|
|
80303
80524
|
* Represents a chart object in a workbook.
|
|
80304
|
-
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}.
|
|
80305
80526
|
*
|
|
80306
80527
|
* @remarks
|
|
80307
80528
|
* [Api set: ExcelApi 1.1]
|
|
@@ -81771,7 +81992,7 @@ declare namespace Excel {
|
|
|
81771
81992
|
*/
|
|
81772
81993
|
textOrientation?: boolean;
|
|
81773
81994
|
/**
|
|
81774
|
-
* Specifies if the axis title is
|
|
81995
|
+
* Specifies if the axis title is visible.
|
|
81775
81996
|
*
|
|
81776
81997
|
* @remarks
|
|
81777
81998
|
* [Api set: ExcelApi 1.1]
|
|
@@ -82632,7 +82853,7 @@ declare namespace Excel {
|
|
|
82632
82853
|
*/
|
|
82633
82854
|
verticalAlignment?: boolean;
|
|
82634
82855
|
/**
|
|
82635
|
-
* Specifies if the chart title is
|
|
82856
|
+
* Specifies if the chart title is visible.
|
|
82636
82857
|
*
|
|
82637
82858
|
* @remarks
|
|
82638
82859
|
* [Api set: ExcelApi 1.1]
|
|
@@ -83765,7 +83986,7 @@ declare namespace Excel {
|
|
|
83765
83986
|
}
|
|
83766
83987
|
/**
|
|
83767
83988
|
* Represents an Excel PivotTable.
|
|
83768
|
-
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}.
|
|
83769
83990
|
*
|
|
83770
83991
|
* @remarks
|
|
83771
83992
|
* [Api set: ExcelApi 1.3]
|
|
@@ -84797,7 +85018,7 @@ declare namespace Excel {
|
|
|
84797
85018
|
}
|
|
84798
85019
|
/**
|
|
84799
85020
|
* An object encapsulating a conditional format's range, format, rule, and other properties.
|
|
84800
|
-
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}.
|
|
84801
85022
|
*
|
|
84802
85023
|
* @remarks
|
|
84803
85024
|
* [Api set: ExcelApi 1.6]
|
|
@@ -85005,7 +85226,7 @@ declare namespace Excel {
|
|
|
85005
85226
|
*/
|
|
85006
85227
|
barDirection?: boolean;
|
|
85007
85228
|
/**
|
|
85008
|
-
* The rule for what
|
|
85229
|
+
* The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.
|
|
85009
85230
|
The `ConditionalDataBarRule` object must be set as a JSON object (use `x.lowerBoundRule = {...}` instead of `x.lowerBoundRule.formula = ...`).
|
|
85010
85231
|
*
|
|
85011
85232
|
* @remarks
|
|
@@ -87231,7 +87452,7 @@ declare namespace Excel {
|
|
|
87231
87452
|
}
|
|
87232
87453
|
/**
|
|
87233
87454
|
* Represents a generic shape object in the worksheet. A shape could be a geometric shape, a line, a group of shapes, etc.
|
|
87234
|
-
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}.
|
|
87235
87456
|
*
|
|
87236
87457
|
* @remarks
|
|
87237
87458
|
* [Api set: ExcelApi 1.9]
|