@types/office-js 1.0.500 → 1.0.501
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- office-js/README.md +1 -1
- office-js/index.d.ts +1731 -5
- office-js/package.json +2 -2
office-js/index.d.ts
CHANGED
|
@@ -24426,6 +24426,59 @@ declare namespace Excel {
|
|
|
24426
24426
|
*/
|
|
24427
24427
|
referencedValues?: ReferencedValue[];
|
|
24428
24428
|
}
|
|
24429
|
+
/**
|
|
24430
|
+
* The basic compact layout properties.
|
|
24431
|
+
*
|
|
24432
|
+
* @remarks
|
|
24433
|
+
* [Api set: ExcelApi 1.19]
|
|
24434
|
+
*/
|
|
24435
|
+
interface BasicCompactLayout {
|
|
24436
|
+
/**
|
|
24437
|
+
* Specifies the name of the icon which is used to open the card.
|
|
24438
|
+
*
|
|
24439
|
+
* @remarks
|
|
24440
|
+
* [Api set: ExcelApi 1.19]
|
|
24441
|
+
*/
|
|
24442
|
+
icon?: string | EntityCompactLayoutIcons;
|
|
24443
|
+
}
|
|
24444
|
+
/**
|
|
24445
|
+
* Represents a card layout used for the Boolean, double, and string basic types.
|
|
24446
|
+
*
|
|
24447
|
+
* @remarks
|
|
24448
|
+
* [Api set: ExcelApi 1.19]
|
|
24449
|
+
*/
|
|
24450
|
+
interface BasicCardLayout extends CardLayoutStandardProperties {
|
|
24451
|
+
/**
|
|
24452
|
+
* Represents the type of this layout.
|
|
24453
|
+
*
|
|
24454
|
+
* @remarks
|
|
24455
|
+
* [Api set: ExcelApi 1.19]
|
|
24456
|
+
*/
|
|
24457
|
+
layout?: EntityCardLayoutType.entity | "Entity";
|
|
24458
|
+
}
|
|
24459
|
+
/**
|
|
24460
|
+
* Represents layout information for various views of the value and its properties.
|
|
24461
|
+
*
|
|
24462
|
+
* @remarks
|
|
24463
|
+
* [Api set: ExcelApi 1.19]
|
|
24464
|
+
*/
|
|
24465
|
+
interface BasicViewLayouts {
|
|
24466
|
+
/**
|
|
24467
|
+
* Represents the layout of this value and its properties in card view.
|
|
24468
|
+
* If the `BasicCardLayout` object does not have a layout property, it is assumed to be "Entity".
|
|
24469
|
+
*
|
|
24470
|
+
* @remarks
|
|
24471
|
+
* [Api set: ExcelApi 1.19]
|
|
24472
|
+
*/
|
|
24473
|
+
card?: BasicCardLayout;
|
|
24474
|
+
/**
|
|
24475
|
+
* Represents the layout used when there is limited space to represent the value.
|
|
24476
|
+
*
|
|
24477
|
+
* @remarks
|
|
24478
|
+
* [Api set: ExcelApi 1.19]
|
|
24479
|
+
*/
|
|
24480
|
+
compact?: BasicCompactLayout;
|
|
24481
|
+
}
|
|
24429
24482
|
/**
|
|
24430
24483
|
* Represents types of #BLOCKED! errors.
|
|
24431
24484
|
*
|
|
@@ -24536,7 +24589,7 @@ declare namespace Excel {
|
|
|
24536
24589
|
errorSubType?: BlockedErrorCellValueSubType | "Unknown" | "DataTypeRestrictedDomain" | "DataTypePrivacySetting" | "DataTypeUnsupportedApp" | "ExternalLinksGeneric" | "RichDataLinkDisabled" | "SignInError" | "NoLicense";
|
|
24537
24590
|
}
|
|
24538
24591
|
/**
|
|
24539
|
-
* Represents the value of a cell containing a
|
|
24592
|
+
* Represents the value of a cell containing a Boolean.
|
|
24540
24593
|
*
|
|
24541
24594
|
* @remarks
|
|
24542
24595
|
* [Api set: ExcelApi 1.16]
|
|
@@ -24563,6 +24616,37 @@ declare namespace Excel {
|
|
|
24563
24616
|
* [Api set: ExcelApi 1.16]
|
|
24564
24617
|
*/
|
|
24565
24618
|
basicType?: RangeValueType.boolean | "Boolean";
|
|
24619
|
+
/**
|
|
24620
|
+
* Represents additional properties of this Boolean value.
|
|
24621
|
+
*
|
|
24622
|
+
* @remarks
|
|
24623
|
+
* [Api set: ExcelApi 1.19]
|
|
24624
|
+
*/
|
|
24625
|
+
properties?: {
|
|
24626
|
+
[key: string]: EntityPropertyType;
|
|
24627
|
+
};
|
|
24628
|
+
/**
|
|
24629
|
+
* Represents layout information for views of this Boolean value.
|
|
24630
|
+
*
|
|
24631
|
+
* @remarks
|
|
24632
|
+
* [Api set: ExcelApi 1.19]
|
|
24633
|
+
*/
|
|
24634
|
+
layouts?: BasicViewLayouts;
|
|
24635
|
+
/**
|
|
24636
|
+
* Represents information that describes the service that provided the data in this `BooleanCellValue`.
|
|
24637
|
+
* This information can be used for branding in card view.
|
|
24638
|
+
*
|
|
24639
|
+
* @remarks
|
|
24640
|
+
* [Api set: ExcelApi 1.19]
|
|
24641
|
+
*/
|
|
24642
|
+
provider?: CellValueProviderAttributes;
|
|
24643
|
+
/**
|
|
24644
|
+
* Represents the cell values which are referenced within `BooleanCellValue.properties`.
|
|
24645
|
+
*
|
|
24646
|
+
* @remarks
|
|
24647
|
+
* [Api set: ExcelApi 1.19]
|
|
24648
|
+
*/
|
|
24649
|
+
referencedValues?: ReferencedValue[];
|
|
24566
24650
|
}
|
|
24567
24651
|
/**
|
|
24568
24652
|
* Represents types of #BUSY! errors.
|
|
@@ -24852,13 +24936,28 @@ declare namespace Excel {
|
|
|
24852
24936
|
*/
|
|
24853
24937
|
layout: "Table";
|
|
24854
24938
|
}
|
|
24939
|
+
/**
|
|
24940
|
+
* Represents a section of a card that is arranged as two columns in card view.
|
|
24941
|
+
*
|
|
24942
|
+
* @remarks
|
|
24943
|
+
* [Api set: ExcelApi 1.19]
|
|
24944
|
+
*/
|
|
24945
|
+
interface CardLayoutTwoColumnSection extends CardLayoutSectionStandardProperties {
|
|
24946
|
+
/**
|
|
24947
|
+
* Represents the type of layout for this section.
|
|
24948
|
+
*
|
|
24949
|
+
* @remarks
|
|
24950
|
+
* [Api set: ExcelApi 1.19]
|
|
24951
|
+
*/
|
|
24952
|
+
layout: "TwoColumn";
|
|
24953
|
+
}
|
|
24855
24954
|
/**
|
|
24856
24955
|
* Represents the layout of a section of a card in card view.
|
|
24857
24956
|
*
|
|
24858
24957
|
* @remarks
|
|
24859
24958
|
* [Api set: ExcelApi 1.16]
|
|
24860
24959
|
*/
|
|
24861
|
-
type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection;
|
|
24960
|
+
type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection | CardLayoutTwoColumnSection;
|
|
24862
24961
|
/**
|
|
24863
24962
|
* Properties of a card layout relevant to most card layouts.
|
|
24864
24963
|
*
|
|
@@ -24902,6 +25001,21 @@ declare namespace Excel {
|
|
|
24902
25001
|
* [Api set: ExcelApi 1.16]
|
|
24903
25002
|
*/
|
|
24904
25003
|
type CardLayout = EntityCardLayout;
|
|
25004
|
+
/**
|
|
25005
|
+
* Types of entity card layouts.
|
|
25006
|
+
*
|
|
25007
|
+
* @remarks
|
|
25008
|
+
* [Api set: ExcelApi 1.19]
|
|
25009
|
+
*/
|
|
25010
|
+
enum EntityCardLayoutType {
|
|
25011
|
+
/**
|
|
25012
|
+
* Entity layout of the entity card.
|
|
25013
|
+
*
|
|
25014
|
+
* @remarks
|
|
25015
|
+
* [Api set: ExcelApi 1.19]
|
|
25016
|
+
*/
|
|
25017
|
+
entity = "Entity"
|
|
25018
|
+
}
|
|
24905
25019
|
/**
|
|
24906
25020
|
* The compact layout properties for an entity.
|
|
24907
25021
|
*
|
|
@@ -24917,6 +25031,80 @@ declare namespace Excel {
|
|
|
24917
25031
|
*/
|
|
24918
25032
|
icon?: string | EntityCompactLayoutIcons;
|
|
24919
25033
|
}
|
|
25034
|
+
/**
|
|
25035
|
+
* Represents the types of the `FunctionCellValue` object.
|
|
25036
|
+
*
|
|
25037
|
+
* @remarks
|
|
25038
|
+
* [Api set: ExcelApi 1.19]
|
|
25039
|
+
*/
|
|
25040
|
+
enum FunctionCellValueType {
|
|
25041
|
+
/**
|
|
25042
|
+
* Reference to a JavaScript custom function. For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-overview | Create custom functions in Excel}.
|
|
25043
|
+
*
|
|
25044
|
+
* @remarks
|
|
25045
|
+
* [Api set: ExcelApi 1.19]
|
|
25046
|
+
*/
|
|
25047
|
+
javaScriptReference = "JavaScriptReference"
|
|
25048
|
+
}
|
|
25049
|
+
/**
|
|
25050
|
+
* Represents a reference to a JavaScript custom function.
|
|
25051
|
+
*
|
|
25052
|
+
* @remarks
|
|
25053
|
+
* [Api set: ExcelApi 1.19]
|
|
25054
|
+
*/
|
|
25055
|
+
interface JavaScriptCustomFunctionReferenceCellValue {
|
|
25056
|
+
/**
|
|
25057
|
+
* Represents the type of this cell value.
|
|
25058
|
+
*
|
|
25059
|
+
* @remarks
|
|
25060
|
+
* [Api set: ExcelApi 1.19]
|
|
25061
|
+
*/
|
|
25062
|
+
type: CellValueType.function | "Function";
|
|
25063
|
+
/**
|
|
25064
|
+
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
25065
|
+
* When accessed through a `valuesAsJson` property, this string value aligns with the en-US locale.
|
|
25066
|
+
* When accessed through a `valuesAsJsonLocal` property, this string value aligns with the user's display locale.
|
|
25067
|
+
*
|
|
25068
|
+
* @remarks
|
|
25069
|
+
* [Api set: ExcelApi 1.19]
|
|
25070
|
+
*/
|
|
25071
|
+
basicValue?: "#VALUE!" | string;
|
|
25072
|
+
/**
|
|
25073
|
+
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
25074
|
+
*
|
|
25075
|
+
* @remarks
|
|
25076
|
+
* [Api set: ExcelApi 1.19]
|
|
25077
|
+
*/
|
|
25078
|
+
basicType?: RangeValueType.error | "Error";
|
|
25079
|
+
/**
|
|
25080
|
+
* Represents the type of `FunctionCellValue`.
|
|
25081
|
+
*
|
|
25082
|
+
* @remarks
|
|
25083
|
+
* [Api set: ExcelApi 1.19]
|
|
25084
|
+
*/
|
|
25085
|
+
functionType: FunctionCellValueType.javaScriptReference | "JavaScriptReference";
|
|
25086
|
+
/**
|
|
25087
|
+
* Represents the namespace used by the custom function. For more information, see {@link https://learn.microsoft.com/javascript/api/manifest/namespace | Manifest reference: Namespace}.
|
|
25088
|
+
*
|
|
25089
|
+
* @remarks
|
|
25090
|
+
* [Api set: ExcelApi 1.19]
|
|
25091
|
+
*/
|
|
25092
|
+
namespace: string;
|
|
25093
|
+
/**
|
|
25094
|
+
* Represents the ID of the custom function. For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID}.
|
|
25095
|
+
*
|
|
25096
|
+
* @remarks
|
|
25097
|
+
* [Api set: ExcelApi 1.19]
|
|
25098
|
+
*/
|
|
25099
|
+
id: string;
|
|
25100
|
+
}
|
|
25101
|
+
/**
|
|
25102
|
+
* Represents a cell value which can be evaluated as a function.
|
|
25103
|
+
*
|
|
25104
|
+
* @remarks
|
|
25105
|
+
* [Api set: ExcelApi 1.19]
|
|
25106
|
+
*/
|
|
25107
|
+
type FunctionCellValue = JavaScriptCustomFunctionReferenceCellValue;
|
|
24920
25108
|
/**
|
|
24921
25109
|
* Represents the layout used when there is limited space to represent the entity.
|
|
24922
25110
|
*
|
|
@@ -28874,7 +29062,28 @@ declare namespace Excel {
|
|
|
28874
29062
|
* @remarks
|
|
28875
29063
|
* [Api set: ExcelApi 1.16]
|
|
28876
29064
|
*/
|
|
28877
|
-
root = "Root"
|
|
29065
|
+
root = "Root",
|
|
29066
|
+
/**
|
|
29067
|
+
* Represents a `DoubleCellValue`.
|
|
29068
|
+
*
|
|
29069
|
+
* @remarks
|
|
29070
|
+
* [Api set: ExcelApi 1.19]
|
|
29071
|
+
*/
|
|
29072
|
+
double = "Double",
|
|
29073
|
+
/**
|
|
29074
|
+
* Represents a `StringCellValue`.
|
|
29075
|
+
*
|
|
29076
|
+
* @remarks
|
|
29077
|
+
* [Api set: ExcelApi 1.19]
|
|
29078
|
+
*/
|
|
29079
|
+
string = "String",
|
|
29080
|
+
/**
|
|
29081
|
+
* Represents a `BooleanCellValue`.
|
|
29082
|
+
*
|
|
29083
|
+
* @remarks
|
|
29084
|
+
* [Api set: ExcelApi 1.19]
|
|
29085
|
+
*/
|
|
29086
|
+
boolean = "Boolean"
|
|
28878
29087
|
}
|
|
28879
29088
|
/**
|
|
28880
29089
|
* Represents the value in a cell.
|
|
@@ -28882,7 +29091,7 @@ declare namespace Excel {
|
|
|
28882
29091
|
* @remarks
|
|
28883
29092
|
* [Api set: ExcelApi 1.16]
|
|
28884
29093
|
*/
|
|
28885
|
-
type ReferencedValue = ArrayCellValue | EntityCellValue | RootReferenceCellValue;
|
|
29094
|
+
type ReferencedValue = ArrayCellValue | EntityCellValue | RootReferenceCellValue | DoubleCellValue | StringCellValue | BooleanCellValue;
|
|
28886
29095
|
/**
|
|
28887
29096
|
* Represents the types of the `CellValue` object.
|
|
28888
29097
|
*
|
|
@@ -28939,6 +29148,13 @@ declare namespace Excel {
|
|
|
28939
29148
|
* [Api set: ExcelApi 1.16]
|
|
28940
29149
|
*/
|
|
28941
29150
|
formattedNumber = "FormattedNumber",
|
|
29151
|
+
/**
|
|
29152
|
+
* Represents a `FunctionCellValue`.
|
|
29153
|
+
*
|
|
29154
|
+
* @remarks
|
|
29155
|
+
* [Api set: ExcelApi 1.19]
|
|
29156
|
+
*/
|
|
29157
|
+
function = "Function",
|
|
28942
29158
|
/**
|
|
28943
29159
|
* Represents a `LinkedEntityCellValue`.
|
|
28944
29160
|
*
|
|
@@ -28981,7 +29197,7 @@ declare namespace Excel {
|
|
|
28981
29197
|
* @remarks
|
|
28982
29198
|
* [Api set: ExcelApi 1.16]
|
|
28983
29199
|
*/
|
|
28984
|
-
type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
|
|
29200
|
+
type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | FunctionCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;
|
|
28985
29201
|
/**
|
|
28986
29202
|
* 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.
|
|
28987
29203
|
*
|
|
@@ -29429,6 +29645,47 @@ declare namespace Excel {
|
|
|
29429
29645
|
* [Api set: ExcelApi 1.16]
|
|
29430
29646
|
*/
|
|
29431
29647
|
basicType?: RangeValueType.double | "Double";
|
|
29648
|
+
/**
|
|
29649
|
+
* Returns the number format string that is used to display this value.
|
|
29650
|
+
* When accessed through a `valuesAsJson` property, this number format string is in the en-US locale. When accessed through a `valuesAsJsonLocal` property, this number format is in the user's display locale.
|
|
29651
|
+
* Number format strings must conform to Excel guidelines.
|
|
29652
|
+
* To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
29653
|
+
*
|
|
29654
|
+
* @remarks
|
|
29655
|
+
* [Api set: ExcelApi 1.19]
|
|
29656
|
+
*/
|
|
29657
|
+
numberFormat?: string;
|
|
29658
|
+
/**
|
|
29659
|
+
* Represents additional properties of this double value.
|
|
29660
|
+
*
|
|
29661
|
+
* @remarks
|
|
29662
|
+
* [Api set: ExcelApi 1.19]
|
|
29663
|
+
*/
|
|
29664
|
+
properties?: {
|
|
29665
|
+
[key: string]: EntityPropertyType;
|
|
29666
|
+
};
|
|
29667
|
+
/**
|
|
29668
|
+
* Represents layout information for views of this double value.
|
|
29669
|
+
*
|
|
29670
|
+
* @remarks
|
|
29671
|
+
* [Api set: ExcelApi 1.19]
|
|
29672
|
+
*/
|
|
29673
|
+
layouts?: BasicViewLayouts;
|
|
29674
|
+
/**
|
|
29675
|
+
* Represents information that describes the service that provided the data in this `DoubleCellValue`.
|
|
29676
|
+
* This information can be used for branding in card view.
|
|
29677
|
+
*
|
|
29678
|
+
* @remarks
|
|
29679
|
+
* [Api set: ExcelApi 1.19]
|
|
29680
|
+
*/
|
|
29681
|
+
provider?: CellValueProviderAttributes;
|
|
29682
|
+
/**
|
|
29683
|
+
* Represents the cell values which are referenced within `DoubleCellValue.properties`.
|
|
29684
|
+
*
|
|
29685
|
+
* @remarks
|
|
29686
|
+
* [Api set: ExcelApi 1.19]
|
|
29687
|
+
*/
|
|
29688
|
+
referencedValues?: ReferencedValue[];
|
|
29432
29689
|
}
|
|
29433
29690
|
/**
|
|
29434
29691
|
* Represents the value of a cell that's empty and has no formulas or data.
|
|
@@ -29867,6 +30124,8 @@ declare namespace Excel {
|
|
|
29867
30124
|
* Represents the value of a cell containing a number with a format string. Number format strings must conform to Excel guidelines. To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
29868
30125
|
* In this scenario, the format is applied to the value and not to the cell, so the value retains its format string throughout calculation.
|
|
29869
30126
|
*
|
|
30127
|
+
* @deprecated As of [Api set: ExcelApi 1.19], use {@link https://learn.microsoft.com/javascript/api/excel/excel.doublecellvalue | DoubleCellValue} instead.
|
|
30128
|
+
*
|
|
29870
30129
|
* @remarks
|
|
29871
30130
|
* [Api set: ExcelApi 1.16]
|
|
29872
30131
|
*/
|
|
@@ -29874,6 +30133,8 @@ declare namespace Excel {
|
|
|
29874
30133
|
/**
|
|
29875
30134
|
* Represents the type of this cell value.
|
|
29876
30135
|
*
|
|
30136
|
+
* @deprecated Deprecated since [Api set: ExcelApi 1.19].
|
|
30137
|
+
*
|
|
29877
30138
|
* @remarks
|
|
29878
30139
|
* [Api set: ExcelApi 1.16]
|
|
29879
30140
|
*/
|
|
@@ -29881,6 +30142,8 @@ declare namespace Excel {
|
|
|
29881
30142
|
/**
|
|
29882
30143
|
* Represents the value that would be returned by `Range.values` for a cell with this value.
|
|
29883
30144
|
*
|
|
30145
|
+
* @deprecated Deprecated since [Api set: ExcelApi 1.19].
|
|
30146
|
+
*
|
|
29884
30147
|
* @remarks
|
|
29885
30148
|
* [Api set: ExcelApi 1.16]
|
|
29886
30149
|
*/
|
|
@@ -29888,6 +30151,8 @@ declare namespace Excel {
|
|
|
29888
30151
|
/**
|
|
29889
30152
|
* Represents the value that would be returned by `Range.valueTypes` for a cell with this value.
|
|
29890
30153
|
*
|
|
30154
|
+
* @deprecated Deprecated since [Api set: ExcelApi 1.19].
|
|
30155
|
+
*
|
|
29891
30156
|
* @remarks
|
|
29892
30157
|
* [Api set: ExcelApi 1.16]
|
|
29893
30158
|
*/
|
|
@@ -29898,6 +30163,8 @@ declare namespace Excel {
|
|
|
29898
30163
|
* Number format strings must conform to Excel guidelines.
|
|
29899
30164
|
* To learn more, see {@link https://support.microsoft.com/office/c0a1d1fa-d3f4-4018-96b7-9c9354dd99f5 | Review guidelines for customizing a number format}.
|
|
29900
30165
|
*
|
|
30166
|
+
* @deprecated Deprecated since [Api set: ExcelApi 1.19].
|
|
30167
|
+
*
|
|
29901
30168
|
* @remarks
|
|
29902
30169
|
* [Api set: ExcelApi 1.16]
|
|
29903
30170
|
*/
|
|
@@ -29941,6 +30208,43 @@ declare namespace Excel {
|
|
|
29941
30208
|
*/
|
|
29942
30209
|
errorType?: ErrorCellValueType.gettingData | "GettingData";
|
|
29943
30210
|
}
|
|
30211
|
+
/**
|
|
30212
|
+
* Represents a request to `@linkedEntityLoadService` custom function to load `LinkedEntityCellValue` objects.
|
|
30213
|
+
*
|
|
30214
|
+
* @remarks
|
|
30215
|
+
* [Api set: ExcelApi 1.19]
|
|
30216
|
+
*/
|
|
30217
|
+
interface LinkedEntityLoadServiceRequest {
|
|
30218
|
+
/**
|
|
30219
|
+
* Represents the domain specific to the service used to create the `LinkedEntityCellValue` objects.
|
|
30220
|
+
*
|
|
30221
|
+
* @remarks
|
|
30222
|
+
* [Api set: ExcelApi 1.19]
|
|
30223
|
+
*/
|
|
30224
|
+
domainId: string;
|
|
30225
|
+
/**
|
|
30226
|
+
* Represents the entity IDs and cultures of the `LinkedEntityCellValue` objects to load.
|
|
30227
|
+
*
|
|
30228
|
+
* @remarks
|
|
30229
|
+
* [Api set: ExcelApi 1.19]
|
|
30230
|
+
*/
|
|
30231
|
+
entities: LinkedEntityIdCulture[];
|
|
30232
|
+
}
|
|
30233
|
+
/**
|
|
30234
|
+
* Represents the result of a request to `@linkedEntityLoadService` custom function to load `LinkedEntityCellValue` objects.
|
|
30235
|
+
*
|
|
30236
|
+
* @remarks
|
|
30237
|
+
* [Api set: ExcelApi 1.19]
|
|
30238
|
+
*/
|
|
30239
|
+
interface LinkedEntityLoadServiceResult {
|
|
30240
|
+
/**
|
|
30241
|
+
* Represents the loaded `LinkedEntityCellValue` objects. The loaded objects must be returned in the same order as the `entities` property of `LinkedEntityLoadServiceRequest`.
|
|
30242
|
+
*
|
|
30243
|
+
* @remarks
|
|
30244
|
+
* [Api set: ExcelApi 1.19]
|
|
30245
|
+
*/
|
|
30246
|
+
entities: LinkedEntityCellValue[];
|
|
30247
|
+
}
|
|
29944
30248
|
/**
|
|
29945
30249
|
* The linked entity ID object represents a set of properties that describes a service and culture for locating this service defined value.
|
|
29946
30250
|
*
|
|
@@ -29977,6 +30281,28 @@ declare namespace Excel {
|
|
|
29977
30281
|
*/
|
|
29978
30282
|
culture: string;
|
|
29979
30283
|
}
|
|
30284
|
+
/**
|
|
30285
|
+
* Represents the entity ID and culture for a `LinkedEntityCellValue` object.
|
|
30286
|
+
*
|
|
30287
|
+
* @remarks
|
|
30288
|
+
* [Api set: ExcelApi 1.19]
|
|
30289
|
+
*/
|
|
30290
|
+
interface LinkedEntityIdCulture {
|
|
30291
|
+
/**
|
|
30292
|
+
* Represents the identifier specific to a service used to create the `LinkedEntityCellValue` object.
|
|
30293
|
+
*
|
|
30294
|
+
* @remarks
|
|
30295
|
+
* [Api set: ExcelApi 1.19]
|
|
30296
|
+
*/
|
|
30297
|
+
entityId: string;
|
|
30298
|
+
/**
|
|
30299
|
+
* Represents the language culture used to create the `LinkedEntityCellValue` object.
|
|
30300
|
+
*
|
|
30301
|
+
* @remarks
|
|
30302
|
+
* [Api set: ExcelApi 1.19]
|
|
30303
|
+
*/
|
|
30304
|
+
culture: string;
|
|
30305
|
+
}
|
|
29980
30306
|
/**
|
|
29981
30307
|
* Represents a value whose properties derive from a service.
|
|
29982
30308
|
*
|
|
@@ -30452,6 +30778,37 @@ declare namespace Excel {
|
|
|
30452
30778
|
* [Api set: ExcelApi 1.16]
|
|
30453
30779
|
*/
|
|
30454
30780
|
basicType?: RangeValueType.string | "String";
|
|
30781
|
+
/**
|
|
30782
|
+
* Represents additional properties of this string value.
|
|
30783
|
+
*
|
|
30784
|
+
* @remarks
|
|
30785
|
+
* [Api set: ExcelApi 1.19]
|
|
30786
|
+
*/
|
|
30787
|
+
properties?: {
|
|
30788
|
+
[key: string]: EntityPropertyType;
|
|
30789
|
+
};
|
|
30790
|
+
/**
|
|
30791
|
+
* Represents layout information for views of this string value.
|
|
30792
|
+
*
|
|
30793
|
+
* @remarks
|
|
30794
|
+
* [Api set: ExcelApi 1.19]
|
|
30795
|
+
*/
|
|
30796
|
+
layouts?: BasicViewLayouts;
|
|
30797
|
+
/**
|
|
30798
|
+
* Represents information that describes the service that provided the data in this `StringCellValue`.
|
|
30799
|
+
* This information can be used for branding in card view.
|
|
30800
|
+
*
|
|
30801
|
+
* @remarks
|
|
30802
|
+
* [Api set: ExcelApi 1.19]
|
|
30803
|
+
*/
|
|
30804
|
+
provider?: CellValueProviderAttributes;
|
|
30805
|
+
/**
|
|
30806
|
+
* Represents the cell values which are referenced within `StringCellValue.properties`.
|
|
30807
|
+
*
|
|
30808
|
+
* @remarks
|
|
30809
|
+
* [Api set: ExcelApi 1.19]
|
|
30810
|
+
*/
|
|
30811
|
+
referencedValues?: ReferencedValue[];
|
|
30455
30812
|
}
|
|
30456
30813
|
/**
|
|
30457
30814
|
* Represents types of #VALUE! errors.
|
|
@@ -30793,6 +31150,13 @@ declare namespace Excel {
|
|
|
30793
31150
|
* [Api set: ExcelApi 1.9]
|
|
30794
31151
|
*/
|
|
30795
31152
|
style?: boolean;
|
|
31153
|
+
/**
|
|
31154
|
+
* Specifies whether to load on the `textRuns` property.
|
|
31155
|
+
*
|
|
31156
|
+
* @remarks
|
|
31157
|
+
* [Api set: ExcelApi 1.18]
|
|
31158
|
+
*/
|
|
31159
|
+
textRuns?: boolean;
|
|
30796
31160
|
}
|
|
30797
31161
|
/**
|
|
30798
31162
|
*
|
|
@@ -30990,6 +31354,13 @@ declare namespace Excel {
|
|
|
30990
31354
|
* [Api set: ExcelApi 1.9]
|
|
30991
31355
|
*/
|
|
30992
31356
|
style?: string;
|
|
31357
|
+
/**
|
|
31358
|
+
* Represents the `textRuns` property.
|
|
31359
|
+
*
|
|
31360
|
+
* @remarks
|
|
31361
|
+
* [Api set: ExcelApi 1.18]
|
|
31362
|
+
*/
|
|
31363
|
+
textRuns?: RangeTextRun[];
|
|
30993
31364
|
}
|
|
30994
31365
|
/**
|
|
30995
31366
|
*
|
|
@@ -34580,6 +34951,13 @@ declare namespace Excel {
|
|
|
34580
34951
|
* [Api set: ExcelApi 1.2]
|
|
34581
34952
|
*/
|
|
34582
34953
|
readonly functions: Excel.Functions;
|
|
34954
|
+
/**
|
|
34955
|
+
* Returns a collection of linked entity data domains that are available in the workbook.
|
|
34956
|
+
*
|
|
34957
|
+
* @remarks
|
|
34958
|
+
* [Api set: ExcelApi 1.19]
|
|
34959
|
+
*/
|
|
34960
|
+
readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection;
|
|
34583
34961
|
/**
|
|
34584
34962
|
* Returns a collection of linked workbooks. In formulas, the workbook links can be used to reference data (cell values and names) outside of the current workbook.
|
|
34585
34963
|
*
|
|
@@ -34799,6 +35177,21 @@ declare namespace Excel {
|
|
|
34799
35177
|
* [Api set: ExcelApi 1.9]
|
|
34800
35178
|
*/
|
|
34801
35179
|
getActiveChartOrNullObject(): Excel.Chart;
|
|
35180
|
+
/**
|
|
35181
|
+
* Gets the active shape in the workbook. If there is no active shape, an `ItemNotFound` error is thrown.
|
|
35182
|
+
*
|
|
35183
|
+
* @remarks
|
|
35184
|
+
* [Api set: ExcelApi 1.19]
|
|
35185
|
+
*/
|
|
35186
|
+
getActiveShape(): Excel.Shape;
|
|
35187
|
+
/**
|
|
35188
|
+
* Gets the active shape in the workbook. If there is no active shape, then this method returns an object with its `isNullObject` property set to `true`.
|
|
35189
|
+
For more information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
35190
|
+
*
|
|
35191
|
+
* @remarks
|
|
35192
|
+
* [Api set: ExcelApi 1.19]
|
|
35193
|
+
*/
|
|
35194
|
+
getActiveShapeOrNullObject(): Excel.Shape;
|
|
34802
35195
|
/**
|
|
34803
35196
|
* Gets the currently active slicer in the workbook. If there is no active slicer, an `ItemNotFound` exception is thrown.
|
|
34804
35197
|
*
|
|
@@ -35172,6 +35565,13 @@ declare namespace Excel {
|
|
|
35172
35565
|
* [Api set: ExcelApi 1.1]
|
|
35173
35566
|
*/
|
|
35174
35567
|
position: number;
|
|
35568
|
+
/**
|
|
35569
|
+
* Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
|
|
35570
|
+
*
|
|
35571
|
+
* @remarks
|
|
35572
|
+
* [Api set: ExcelApi 1.19]
|
|
35573
|
+
*/
|
|
35574
|
+
showDataTypeIcons: boolean;
|
|
35175
35575
|
/**
|
|
35176
35576
|
* Specifies if gridlines are visible to the user.
|
|
35177
35577
|
*
|
|
@@ -36750,6 +37150,17 @@ declare namespace Excel {
|
|
|
36750
37150
|
* [Api set: ExcelApi 1.12]
|
|
36751
37151
|
*/
|
|
36752
37152
|
getDirectPrecedents(): Excel.WorkbookRangeAreas;
|
|
37153
|
+
/**
|
|
37154
|
+
* Returns a 2D array, encapsulating the display data for each cell's font, fill, borders, alignment, and other properties.
|
|
37155
|
+
Unlike `getCellProperties`, which only shows properties that are set directly for the cell, this returns properties that are displayed from indirect sources, such as conditional formatting or styles.
|
|
37156
|
+
*
|
|
37157
|
+
* @remarks
|
|
37158
|
+
* [Api set: ExcelApi 1.19]
|
|
37159
|
+
*
|
|
37160
|
+
* @param cellPropertiesLoadOptions An object that represents which cell properties to load.
|
|
37161
|
+
* @returns A 2D array where each item represents the requested display properties of the corresponding cell.
|
|
37162
|
+
*/
|
|
37163
|
+
getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;
|
|
36753
37164
|
/**
|
|
36754
37165
|
* Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its `getEntireColumn` is a range that represents columns "B:E").
|
|
36755
37166
|
*
|
|
@@ -43103,6 +43514,13 @@ declare namespace Excel {
|
|
|
43103
43514
|
* [Api set: ExcelApi 1.1]
|
|
43104
43515
|
*/
|
|
43105
43516
|
readonly format: Excel.ChartDataLabelFormat;
|
|
43517
|
+
/**
|
|
43518
|
+
* Gets an object that represents the leader lines of the data labels.
|
|
43519
|
+
*
|
|
43520
|
+
* @remarks
|
|
43521
|
+
* [Api set: ExcelApi 1.19]
|
|
43522
|
+
*/
|
|
43523
|
+
readonly leaderLines: Excel.ChartLeaderLines;
|
|
43106
43524
|
/**
|
|
43107
43525
|
* Specifies if data labels automatically generate appropriate text based on context.
|
|
43108
43526
|
*
|
|
@@ -43110,6 +43528,14 @@ declare namespace Excel {
|
|
|
43110
43528
|
* [Api set: ExcelApi 1.8]
|
|
43111
43529
|
*/
|
|
43112
43530
|
autoText: boolean;
|
|
43531
|
+
/**
|
|
43532
|
+
* Specifies the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details.
|
|
43533
|
+
Value is `null` if the data labels are not geometric shapes.
|
|
43534
|
+
*
|
|
43535
|
+
* @remarks
|
|
43536
|
+
* [Api set: ExcelApi 1.19]
|
|
43537
|
+
*/
|
|
43538
|
+
geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
43113
43539
|
/**
|
|
43114
43540
|
* Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
|
|
43115
43541
|
This property is valid only when the `TextOrientation` of data label is 0.
|
|
@@ -43146,6 +43572,13 @@ declare namespace Excel {
|
|
|
43146
43572
|
* [Api set: ExcelApi 1.1]
|
|
43147
43573
|
*/
|
|
43148
43574
|
separator: string;
|
|
43575
|
+
/**
|
|
43576
|
+
* Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
|
|
43577
|
+
*
|
|
43578
|
+
* @remarks
|
|
43579
|
+
* [Api set: ExcelApi 1.19]
|
|
43580
|
+
*/
|
|
43581
|
+
readonly showAsStickyCallout: boolean;
|
|
43149
43582
|
/**
|
|
43150
43583
|
* Specifies if the data label bubble size is visible.
|
|
43151
43584
|
*
|
|
@@ -43160,6 +43593,13 @@ declare namespace Excel {
|
|
|
43160
43593
|
* [Api set: ExcelApi 1.1]
|
|
43161
43594
|
*/
|
|
43162
43595
|
showCategoryName: boolean;
|
|
43596
|
+
/**
|
|
43597
|
+
* Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
|
|
43598
|
+
*
|
|
43599
|
+
* @remarks
|
|
43600
|
+
* [Api set: ExcelApi 1.19]
|
|
43601
|
+
*/
|
|
43602
|
+
showLeaderLines: boolean;
|
|
43163
43603
|
/**
|
|
43164
43604
|
* Specifies if the data label legend key is visible.
|
|
43165
43605
|
*
|
|
@@ -43268,6 +43708,14 @@ declare namespace Excel {
|
|
|
43268
43708
|
* [Api set: ExcelApi 1.8]
|
|
43269
43709
|
*/
|
|
43270
43710
|
formula: string;
|
|
43711
|
+
/**
|
|
43712
|
+
* Specifies the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details.
|
|
43713
|
+
Value is `null` if the data label is not a geometric shape.
|
|
43714
|
+
*
|
|
43715
|
+
* @remarks
|
|
43716
|
+
* [Api set: ExcelApi 1.19]
|
|
43717
|
+
*/
|
|
43718
|
+
geometricShapeType: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
43271
43719
|
/**
|
|
43272
43720
|
* Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
|
|
43273
43721
|
*
|
|
@@ -43318,6 +43766,13 @@ declare namespace Excel {
|
|
|
43318
43766
|
* [Api set: ExcelApi 1.7]
|
|
43319
43767
|
*/
|
|
43320
43768
|
separator: string;
|
|
43769
|
+
/**
|
|
43770
|
+
* Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
|
|
43771
|
+
*
|
|
43772
|
+
* @remarks
|
|
43773
|
+
* [Api set: ExcelApi 1.19]
|
|
43774
|
+
*/
|
|
43775
|
+
readonly showAsStickyCallout: boolean;
|
|
43321
43776
|
/**
|
|
43322
43777
|
* Specifies if the data label bubble size is visible.
|
|
43323
43778
|
*
|
|
@@ -43404,6 +43859,41 @@ declare namespace Excel {
|
|
|
43404
43859
|
set(properties: Interfaces.ChartDataLabelUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
43405
43860
|
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
43406
43861
|
set(properties: Excel.ChartDataLabel): void;
|
|
43862
|
+
/**
|
|
43863
|
+
* Returns a substring of the data label. The line break character '\n' counts as one character.
|
|
43864
|
+
*
|
|
43865
|
+
* @remarks
|
|
43866
|
+
* [Api set: ExcelApi 1.19]
|
|
43867
|
+
*
|
|
43868
|
+
* @param start The zero-based starting character position of a substring in the data label.
|
|
43869
|
+
* @param length Optional. The number of characters in the substring. If length is omitted, all the characters from start to the end of the data label are retrieved.
|
|
43870
|
+
*/
|
|
43871
|
+
getSubstring(start: number, length?: number): Excel.ChartFormatString;
|
|
43872
|
+
/**
|
|
43873
|
+
* Returns the tail anchor of the data label which is shown as a sticky callout.
|
|
43874
|
+
*
|
|
43875
|
+
* @remarks
|
|
43876
|
+
* [Api set: ExcelApi 1.19]
|
|
43877
|
+
*/
|
|
43878
|
+
getTailAnchor(): Excel.ChartDataLabelAnchor;
|
|
43879
|
+
/**
|
|
43880
|
+
* Sets the height of the data label in points.
|
|
43881
|
+
*
|
|
43882
|
+
* @remarks
|
|
43883
|
+
* [Api set: ExcelApi 1.19]
|
|
43884
|
+
*
|
|
43885
|
+
* @param height The height of the data label in points.
|
|
43886
|
+
*/
|
|
43887
|
+
setHeight(height: number): void;
|
|
43888
|
+
/**
|
|
43889
|
+
* Sets the width of the data label in points.
|
|
43890
|
+
*
|
|
43891
|
+
* @remarks
|
|
43892
|
+
* [Api set: ExcelApi 1.19]
|
|
43893
|
+
*
|
|
43894
|
+
* @param width The width of the data label in points.
|
|
43895
|
+
*/
|
|
43896
|
+
setWidth(width: number): void;
|
|
43407
43897
|
/**
|
|
43408
43898
|
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
43409
43899
|
*
|
|
@@ -43496,6 +43986,64 @@ declare namespace Excel {
|
|
|
43496
43986
|
*/
|
|
43497
43987
|
toJSON(): Excel.Interfaces.ChartDataLabelFormatData;
|
|
43498
43988
|
}
|
|
43989
|
+
/**
|
|
43990
|
+
* Represents the chart data label anchor.
|
|
43991
|
+
*
|
|
43992
|
+
* @remarks
|
|
43993
|
+
* [Api set: ExcelApi 1.19]
|
|
43994
|
+
*/
|
|
43995
|
+
class ChartDataLabelAnchor extends OfficeExtension.ClientObject {
|
|
43996
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
43997
|
+
context: RequestContext;
|
|
43998
|
+
/**
|
|
43999
|
+
* Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
|
|
44000
|
+
*
|
|
44001
|
+
* @remarks
|
|
44002
|
+
* [Api set: ExcelApi 1.19]
|
|
44003
|
+
*/
|
|
44004
|
+
left: number;
|
|
44005
|
+
/**
|
|
44006
|
+
* Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
|
|
44007
|
+
*
|
|
44008
|
+
* @remarks
|
|
44009
|
+
* [Api set: ExcelApi 1.19]
|
|
44010
|
+
*/
|
|
44011
|
+
top: number;
|
|
44012
|
+
/**
|
|
44013
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
44014
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
44015
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
44016
|
+
*/
|
|
44017
|
+
set(properties: Interfaces.ChartDataLabelAnchorUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
44018
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
44019
|
+
set(properties: Excel.ChartDataLabelAnchor): void;
|
|
44020
|
+
/**
|
|
44021
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
44022
|
+
*
|
|
44023
|
+
* @param options Provides options for which properties of the object to load.
|
|
44024
|
+
*/
|
|
44025
|
+
load(options?: Excel.Interfaces.ChartDataLabelAnchorLoadOptions): Excel.ChartDataLabelAnchor;
|
|
44026
|
+
/**
|
|
44027
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
44028
|
+
*
|
|
44029
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
44030
|
+
*/
|
|
44031
|
+
load(propertyNames?: string | string[]): Excel.ChartDataLabelAnchor;
|
|
44032
|
+
/**
|
|
44033
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
44034
|
+
*
|
|
44035
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
44036
|
+
*/
|
|
44037
|
+
load(propertyNamesAndPaths?: {
|
|
44038
|
+
select?: string;
|
|
44039
|
+
expand?: string;
|
|
44040
|
+
}): Excel.ChartDataLabelAnchor;
|
|
44041
|
+
/**
|
|
44042
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
44043
|
+
* Whereas the original `Excel.ChartDataLabelAnchor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartDataLabelAnchorData`) that contains shallow copies of any loaded child properties from the original object.
|
|
44044
|
+
*/
|
|
44045
|
+
toJSON(): Excel.Interfaces.ChartDataLabelAnchorData;
|
|
44046
|
+
}
|
|
43499
44047
|
/**
|
|
43500
44048
|
* Represents the data table object of a chart.
|
|
43501
44049
|
*
|
|
@@ -45601,6 +46149,108 @@ declare namespace Excel {
|
|
|
45601
46149
|
*/
|
|
45602
46150
|
toJSON(): Excel.Interfaces.ChartPlotAreaFormatData;
|
|
45603
46151
|
}
|
|
46152
|
+
/**
|
|
46153
|
+
* Gets an object that represents the formatting of chart leader lines.
|
|
46154
|
+
*
|
|
46155
|
+
* @remarks
|
|
46156
|
+
* [Api set: ExcelApi 1.19]
|
|
46157
|
+
*/
|
|
46158
|
+
class ChartLeaderLines extends OfficeExtension.ClientObject {
|
|
46159
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
46160
|
+
context: RequestContext;
|
|
46161
|
+
/**
|
|
46162
|
+
* Represents the formatting of leader lines of data labels in a series.
|
|
46163
|
+
*
|
|
46164
|
+
* @remarks
|
|
46165
|
+
* [Api set: ExcelApi 1.19]
|
|
46166
|
+
*/
|
|
46167
|
+
readonly format: Excel.ChartLeaderLinesFormat;
|
|
46168
|
+
/**
|
|
46169
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
46170
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
46171
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
46172
|
+
*/
|
|
46173
|
+
set(properties: Interfaces.ChartLeaderLinesUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
46174
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
46175
|
+
set(properties: Excel.ChartLeaderLines): void;
|
|
46176
|
+
/**
|
|
46177
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
46178
|
+
*
|
|
46179
|
+
* @param options Provides options for which properties of the object to load.
|
|
46180
|
+
*/
|
|
46181
|
+
load(options?: Excel.Interfaces.ChartLeaderLinesLoadOptions): Excel.ChartLeaderLines;
|
|
46182
|
+
/**
|
|
46183
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
46184
|
+
*
|
|
46185
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
46186
|
+
*/
|
|
46187
|
+
load(propertyNames?: string | string[]): Excel.ChartLeaderLines;
|
|
46188
|
+
/**
|
|
46189
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
46190
|
+
*
|
|
46191
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
46192
|
+
*/
|
|
46193
|
+
load(propertyNamesAndPaths?: {
|
|
46194
|
+
select?: string;
|
|
46195
|
+
expand?: string;
|
|
46196
|
+
}): Excel.ChartLeaderLines;
|
|
46197
|
+
/**
|
|
46198
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
46199
|
+
* Whereas the original `Excel.ChartLeaderLines` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLeaderLinesData`) that contains shallow copies of any loaded child properties from the original object.
|
|
46200
|
+
*/
|
|
46201
|
+
toJSON(): Excel.Interfaces.ChartLeaderLinesData;
|
|
46202
|
+
}
|
|
46203
|
+
/**
|
|
46204
|
+
* Encapsulates the format properties for leader lines.
|
|
46205
|
+
*
|
|
46206
|
+
* @remarks
|
|
46207
|
+
* [Api set: ExcelApi 1.19]
|
|
46208
|
+
*/
|
|
46209
|
+
class ChartLeaderLinesFormat extends OfficeExtension.ClientObject {
|
|
46210
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
46211
|
+
context: RequestContext;
|
|
46212
|
+
/**
|
|
46213
|
+
* Gets an object that represents the line formatting of chart leader lines.
|
|
46214
|
+
*
|
|
46215
|
+
* @remarks
|
|
46216
|
+
* [Api set: ExcelApi 1.19]
|
|
46217
|
+
*/
|
|
46218
|
+
readonly line: Excel.ChartLineFormat;
|
|
46219
|
+
/**
|
|
46220
|
+
* Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
|
|
46221
|
+
* @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
|
|
46222
|
+
* @param options Provides an option to suppress errors if the properties object tries to set any read-only properties.
|
|
46223
|
+
*/
|
|
46224
|
+
set(properties: Interfaces.ChartLeaderLinesFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;
|
|
46225
|
+
/** Sets multiple properties on the object at the same time, based on an existing loaded object. */
|
|
46226
|
+
set(properties: Excel.ChartLeaderLinesFormat): void;
|
|
46227
|
+
/**
|
|
46228
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
46229
|
+
*
|
|
46230
|
+
* @param options Provides options for which properties of the object to load.
|
|
46231
|
+
*/
|
|
46232
|
+
load(options?: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions): Excel.ChartLeaderLinesFormat;
|
|
46233
|
+
/**
|
|
46234
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
46235
|
+
*
|
|
46236
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
46237
|
+
*/
|
|
46238
|
+
load(propertyNames?: string | string[]): Excel.ChartLeaderLinesFormat;
|
|
46239
|
+
/**
|
|
46240
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
46241
|
+
*
|
|
46242
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
46243
|
+
*/
|
|
46244
|
+
load(propertyNamesAndPaths?: {
|
|
46245
|
+
select?: string;
|
|
46246
|
+
expand?: string;
|
|
46247
|
+
}): Excel.ChartLeaderLinesFormat;
|
|
46248
|
+
/**
|
|
46249
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
46250
|
+
* Whereas the original `Excel.ChartLeaderLinesFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.ChartLeaderLinesFormatData`) that contains shallow copies of any loaded child properties from the original object.
|
|
46251
|
+
*/
|
|
46252
|
+
toJSON(): Excel.Interfaces.ChartLeaderLinesFormatData;
|
|
46253
|
+
}
|
|
45604
46254
|
/**
|
|
45605
46255
|
* Manages sorting operations on `Range` objects.
|
|
45606
46256
|
*
|
|
@@ -54735,6 +55385,505 @@ declare namespace Excel {
|
|
|
54735
55385
|
*/
|
|
54736
55386
|
toJSON(): Excel.Interfaces.SlicerItemCollectionData;
|
|
54737
55387
|
}
|
|
55388
|
+
/**
|
|
55389
|
+
* Represents a specific category or field of information that shares some common characteristics or attributes.
|
|
55390
|
+
A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook.
|
|
55391
|
+
A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.
|
|
55392
|
+
*
|
|
55393
|
+
* @remarks
|
|
55394
|
+
* [Api set: ExcelApi 1.19]
|
|
55395
|
+
*/
|
|
55396
|
+
class LinkedEntityDataDomain extends OfficeExtension.ClientObject {
|
|
55397
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
55398
|
+
context: RequestContext;
|
|
55399
|
+
/**
|
|
55400
|
+
* Gets the name of the data provider for the linked entity data domain.
|
|
55401
|
+
This name can change based on the information provided by the data provider.
|
|
55402
|
+
*
|
|
55403
|
+
* @remarks
|
|
55404
|
+
* [Api set: ExcelApi 1.19]
|
|
55405
|
+
*/
|
|
55406
|
+
readonly dataProvider: string;
|
|
55407
|
+
/**
|
|
55408
|
+
* Gets the ID of the linked entity data domain defined by Office Add-ins.
|
|
55409
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
55410
|
+
*
|
|
55411
|
+
* @remarks
|
|
55412
|
+
* [Api set: ExcelApi 1.19]
|
|
55413
|
+
*/
|
|
55414
|
+
readonly id: string;
|
|
55415
|
+
/**
|
|
55416
|
+
* Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
|
|
55417
|
+
Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
|
|
55418
|
+
*
|
|
55419
|
+
* @remarks
|
|
55420
|
+
* [Api set: ExcelApi 1.19]
|
|
55421
|
+
*/
|
|
55422
|
+
readonly lastRefreshed: Date;
|
|
55423
|
+
/**
|
|
55424
|
+
* Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.
|
|
55425
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
|
|
55426
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
55427
|
+
*
|
|
55428
|
+
* @remarks
|
|
55429
|
+
* [Api set: ExcelApi 1.19]
|
|
55430
|
+
*/
|
|
55431
|
+
readonly loadFunctionId: string;
|
|
55432
|
+
/**
|
|
55433
|
+
* Gets the name of the linked entity data domain.
|
|
55434
|
+
This name can change based on the information provided by the data provider.
|
|
55435
|
+
*
|
|
55436
|
+
* @remarks
|
|
55437
|
+
* [Api set: ExcelApi 1.19]
|
|
55438
|
+
*/
|
|
55439
|
+
readonly name: string;
|
|
55440
|
+
/**
|
|
55441
|
+
* Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
|
|
55442
|
+
The refresh interval only applies if the `refreshMode` is set to "Periodic".
|
|
55443
|
+
*
|
|
55444
|
+
* @remarks
|
|
55445
|
+
* [Api set: ExcelApi 1.19]
|
|
55446
|
+
*/
|
|
55447
|
+
readonly periodicRefreshInterval: number;
|
|
55448
|
+
/**
|
|
55449
|
+
* Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
|
|
55450
|
+
If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
|
|
55451
|
+
If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
|
|
55452
|
+
*
|
|
55453
|
+
* @remarks
|
|
55454
|
+
* [Api set: ExcelApi 1.19]
|
|
55455
|
+
*/
|
|
55456
|
+
refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
|
|
55457
|
+
/**
|
|
55458
|
+
* Gets the service ID of the linked entity data domain.
|
|
55459
|
+
This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
|
|
55460
|
+
This ID never changes across user sessions.
|
|
55461
|
+
*
|
|
55462
|
+
* @remarks
|
|
55463
|
+
* [Api set: ExcelApi 1.19]
|
|
55464
|
+
*/
|
|
55465
|
+
readonly serviceId: number;
|
|
55466
|
+
/**
|
|
55467
|
+
* Gets all the refresh modes supported by the linked entity data domain.
|
|
55468
|
+
This array can change based on the information provided by the data provider.
|
|
55469
|
+
*
|
|
55470
|
+
* @remarks
|
|
55471
|
+
* [Api set: ExcelApi 1.19]
|
|
55472
|
+
*/
|
|
55473
|
+
readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[];
|
|
55474
|
+
/**
|
|
55475
|
+
* Deletes this object from the `LinkedEntityDataDomainCollection`.
|
|
55476
|
+
Once the linked entity data domain is deleted, new `LinkedEntityCellValue` objects of this linked entity data domain can't be created and existing `LinkedEntityCellValue` objects can't be refreshed.
|
|
55477
|
+
An Office Add-in can only delete linked entity data domains that it created.
|
|
55478
|
+
*
|
|
55479
|
+
* @remarks
|
|
55480
|
+
* [Api set: ExcelApi 1.19]
|
|
55481
|
+
*/
|
|
55482
|
+
delete(): void;
|
|
55483
|
+
/**
|
|
55484
|
+
* Refreshes all `LinkedEntityCellValue` objects of this linked entity data domain.
|
|
55485
|
+
The refresh request can fail if the data provider is busy or temporarily inaccessible.
|
|
55486
|
+
*
|
|
55487
|
+
* @remarks
|
|
55488
|
+
* [Api set: ExcelApi 1.19]
|
|
55489
|
+
*/
|
|
55490
|
+
refresh(): void;
|
|
55491
|
+
/**
|
|
55492
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
55493
|
+
*
|
|
55494
|
+
* @param options Provides options for which properties of the object to load.
|
|
55495
|
+
*/
|
|
55496
|
+
load(options?: Excel.Interfaces.LinkedEntityDataDomainLoadOptions): Excel.LinkedEntityDataDomain;
|
|
55497
|
+
/**
|
|
55498
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
55499
|
+
*
|
|
55500
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
55501
|
+
*/
|
|
55502
|
+
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomain;
|
|
55503
|
+
/**
|
|
55504
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
55505
|
+
*
|
|
55506
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
55507
|
+
*/
|
|
55508
|
+
load(propertyNamesAndPaths?: {
|
|
55509
|
+
select?: string;
|
|
55510
|
+
expand?: string;
|
|
55511
|
+
}): Excel.LinkedEntityDataDomain;
|
|
55512
|
+
/**
|
|
55513
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
55514
|
+
* Whereas the original `Excel.LinkedEntityDataDomain` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.LinkedEntityDataDomainData`) that contains shallow copies of any loaded child properties from the original object.
|
|
55515
|
+
*/
|
|
55516
|
+
toJSON(): Excel.Interfaces.LinkedEntityDataDomainData;
|
|
55517
|
+
}
|
|
55518
|
+
/**
|
|
55519
|
+
* Provides information about the identity of the linked entity data domain that was just added to the workbook.
|
|
55520
|
+
*
|
|
55521
|
+
* @remarks
|
|
55522
|
+
* [Api set: ExcelApi 1.19]
|
|
55523
|
+
*/
|
|
55524
|
+
interface LinkedEntityDataDomainAddedEventArgs {
|
|
55525
|
+
/**
|
|
55526
|
+
* Gets the ID of the linked entity data domain that was just added to the workbook. This ID is defined by Office Add-ins.
|
|
55527
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
55528
|
+
*
|
|
55529
|
+
* @remarks
|
|
55530
|
+
* [Api set: ExcelApi 1.19]
|
|
55531
|
+
*/
|
|
55532
|
+
id?: string;
|
|
55533
|
+
/**
|
|
55534
|
+
* Gets the service ID of the linked entity data domain that was just added to the workbook.
|
|
55535
|
+
*
|
|
55536
|
+
* @remarks
|
|
55537
|
+
* [Api set: ExcelApi 1.19]
|
|
55538
|
+
*/
|
|
55539
|
+
serviceId: number;
|
|
55540
|
+
/**
|
|
55541
|
+
* Gets the source of the event. See `Excel.EventSource` for details.
|
|
55542
|
+
*
|
|
55543
|
+
* @remarks
|
|
55544
|
+
* [Api set: ExcelApi 1.19]
|
|
55545
|
+
*/
|
|
55546
|
+
source: Excel.EventSource | "Local" | "Remote";
|
|
55547
|
+
/**
|
|
55548
|
+
* Gets the type of the event. See `Excel.EventType` for details.
|
|
55549
|
+
*
|
|
55550
|
+
* @remarks
|
|
55551
|
+
* [Api set: ExcelApi 1.19]
|
|
55552
|
+
*/
|
|
55553
|
+
type: "LinkedEntityDataDomainLinkedEntityDataDomainAdded";
|
|
55554
|
+
}
|
|
55555
|
+
/**
|
|
55556
|
+
* Represents a collection of `LinkedEntityDataDomain` objects.
|
|
55557
|
+
The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.
|
|
55558
|
+
*
|
|
55559
|
+
* @remarks
|
|
55560
|
+
* [Api set: ExcelApi 1.19]
|
|
55561
|
+
*/
|
|
55562
|
+
class LinkedEntityDataDomainCollection extends OfficeExtension.ClientObject {
|
|
55563
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
55564
|
+
context: RequestContext;
|
|
55565
|
+
/** Gets the loaded child items in this collection. */
|
|
55566
|
+
readonly items: Excel.LinkedEntityDataDomain[];
|
|
55567
|
+
/**
|
|
55568
|
+
* Adds a linked entity data domain object defined by the Office Add-in to the collection.
|
|
55569
|
+
Once the linked entity data domain is added, it can be used to create `LinkedEntityCellValue` objects.
|
|
55570
|
+
*
|
|
55571
|
+
* @remarks
|
|
55572
|
+
* [Api set: ExcelApi 1.19]
|
|
55573
|
+
*
|
|
55574
|
+
* @param options Options that are used to create the linked entity data domain to be added.
|
|
55575
|
+
*/
|
|
55576
|
+
add(options: Excel.LinkedEntityDataDomainCreateOptions): void;
|
|
55577
|
+
/**
|
|
55578
|
+
* Gets the number of linked entity data domains in the collection.
|
|
55579
|
+
*
|
|
55580
|
+
* @remarks
|
|
55581
|
+
* [Api set: ExcelApi 1.19]
|
|
55582
|
+
*/
|
|
55583
|
+
getCount(): OfficeExtension.ClientResult<number>;
|
|
55584
|
+
/**
|
|
55585
|
+
* Gets a linked entity data domain by its `id`.
|
|
55586
|
+
*
|
|
55587
|
+
* @remarks
|
|
55588
|
+
* [Api set: ExcelApi 1.19]
|
|
55589
|
+
*
|
|
55590
|
+
* @param id The `id` of the `LinkedEntityDataDomain` object to be retrieved.
|
|
55591
|
+
* @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned.
|
|
55592
|
+
*/
|
|
55593
|
+
getItem(id: string): Excel.LinkedEntityDataDomain;
|
|
55594
|
+
/**
|
|
55595
|
+
* Gets a linked entity data domain by its index in the collection.
|
|
55596
|
+
*
|
|
55597
|
+
* @remarks
|
|
55598
|
+
* [Api set: ExcelApi 1.19]
|
|
55599
|
+
*
|
|
55600
|
+
* @param index The index of the linked entity data domain in the collection.
|
|
55601
|
+
* @returns The linked entity data domain at the given index.
|
|
55602
|
+
*/
|
|
55603
|
+
getItemAt(index: number): Excel.LinkedEntityDataDomain;
|
|
55604
|
+
/**
|
|
55605
|
+
* Gets a linked entity data domain by its `name`.
|
|
55606
|
+
*
|
|
55607
|
+
* @remarks
|
|
55608
|
+
* [Api set: ExcelApi 1.19]
|
|
55609
|
+
*
|
|
55610
|
+
* @param name The `name` of the `LinkedEntityDataDomain` object to be retrieved.
|
|
55611
|
+
* @returns The linked entity data domain with the given `name`. If there are multiple linked entity data domains with the same `name`, the one defined by this Office Add-in will be returned.
|
|
55612
|
+
*/
|
|
55613
|
+
getItemByName(name: string): Excel.LinkedEntityDataDomain;
|
|
55614
|
+
/**
|
|
55615
|
+
* Gets a linked entity data domain by its `name`.
|
|
55616
|
+
If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
|
|
55617
|
+
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}.
|
|
55618
|
+
*
|
|
55619
|
+
* @remarks
|
|
55620
|
+
* [Api set: ExcelApi 1.19]
|
|
55621
|
+
*
|
|
55622
|
+
* @param name The `name` of the `LinkedEntityDataDomain` object to be retrieved.
|
|
55623
|
+
* @returns The linked entity data domain with the given `name`. If there are multiple linked entity data domains with the same `name`, the one defined by this Office Add-in will be returned.
|
|
55624
|
+
*/
|
|
55625
|
+
getItemByNameOrNullObject(name: string): Excel.LinkedEntityDataDomain;
|
|
55626
|
+
/**
|
|
55627
|
+
* Gets a linked entity data domain by its `id`.
|
|
55628
|
+
If the linked entity data domain does not exist, then this function will return an object with its `isNullObject` property set to `true`.
|
|
55629
|
+
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}.
|
|
55630
|
+
*
|
|
55631
|
+
* @remarks
|
|
55632
|
+
* [Api set: ExcelApi 1.19]
|
|
55633
|
+
*
|
|
55634
|
+
* @param id The `id` of the `LinkedEntityDataDomain` object to be retrieved.
|
|
55635
|
+
* @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned.
|
|
55636
|
+
*/
|
|
55637
|
+
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;
|
|
55638
|
+
/**
|
|
55639
|
+
* Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.
|
|
55640
|
+
The refresh request can fail if the data providers are busy or temporarily inaccessible.
|
|
55641
|
+
*
|
|
55642
|
+
* @remarks
|
|
55643
|
+
* [Api set: ExcelApi 1.19]
|
|
55644
|
+
*/
|
|
55645
|
+
refreshAll(): void;
|
|
55646
|
+
/**
|
|
55647
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
55648
|
+
*
|
|
55649
|
+
* @param options Provides options for which properties of the object to load.
|
|
55650
|
+
*/
|
|
55651
|
+
load(options?: Excel.Interfaces.LinkedEntityDataDomainCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedEntityDataDomainCollection;
|
|
55652
|
+
/**
|
|
55653
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
55654
|
+
*
|
|
55655
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
55656
|
+
*/
|
|
55657
|
+
load(propertyNames?: string | string[]): Excel.LinkedEntityDataDomainCollection;
|
|
55658
|
+
/**
|
|
55659
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
55660
|
+
*
|
|
55661
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
55662
|
+
*/
|
|
55663
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;
|
|
55664
|
+
/**
|
|
55665
|
+
* Occurs when a new linked entity data domain is added to the workbook.
|
|
55666
|
+
*
|
|
55667
|
+
* @remarks
|
|
55668
|
+
* [Api set: ExcelApi 1.19]
|
|
55669
|
+
*
|
|
55670
|
+
* @eventproperty
|
|
55671
|
+
*/
|
|
55672
|
+
readonly onLinkedEntityDataDomainAdded: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainAddedEventArgs>;
|
|
55673
|
+
/**
|
|
55674
|
+
* Occurs when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed.
|
|
55675
|
+
*
|
|
55676
|
+
* @remarks
|
|
55677
|
+
* [Api set: ExcelApi 1.19]
|
|
55678
|
+
*
|
|
55679
|
+
* @eventproperty
|
|
55680
|
+
*/
|
|
55681
|
+
readonly onRefreshCompleted: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshCompletedEventArgs>;
|
|
55682
|
+
/**
|
|
55683
|
+
* Occurs when the `refreshMode` of a linked entity data domain is changed.
|
|
55684
|
+
*
|
|
55685
|
+
* @remarks
|
|
55686
|
+
* [Api set: ExcelApi 1.19]
|
|
55687
|
+
*
|
|
55688
|
+
* @eventproperty
|
|
55689
|
+
*/
|
|
55690
|
+
readonly onRefreshModeChanged: OfficeExtension.EventHandlers<Excel.LinkedEntityDataDomainRefreshModeChangedEventArgs>;
|
|
55691
|
+
/**
|
|
55692
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
55693
|
+
* Whereas the original `Excel.LinkedEntityDataDomainCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.LinkedEntityDataDomainCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
55694
|
+
*/
|
|
55695
|
+
toJSON(): Excel.Interfaces.LinkedEntityDataDomainCollectionData;
|
|
55696
|
+
}
|
|
55697
|
+
/**
|
|
55698
|
+
* Represents options that are used to create the `LinkedEntityDataDomain` object being added to the `LinkedEntityDataDomainCollection`.
|
|
55699
|
+
*
|
|
55700
|
+
* @remarks
|
|
55701
|
+
* [Api set: ExcelApi 1.19]
|
|
55702
|
+
*/
|
|
55703
|
+
interface LinkedEntityDataDomainCreateOptions {
|
|
55704
|
+
/**
|
|
55705
|
+
* Specifies the name of the data provider for the linked entity data domain.
|
|
55706
|
+
*
|
|
55707
|
+
* @remarks
|
|
55708
|
+
* [Api set: ExcelApi 1.19]
|
|
55709
|
+
*/
|
|
55710
|
+
dataProvider: string;
|
|
55711
|
+
/**
|
|
55712
|
+
* Specifies the ID of the linked entity data domain.
|
|
55713
|
+
This ID must be unique across all linked entity data domains defined by this Office Add-in.
|
|
55714
|
+
*
|
|
55715
|
+
* @remarks
|
|
55716
|
+
* [Api set: ExcelApi 1.19]
|
|
55717
|
+
*/
|
|
55718
|
+
id: string;
|
|
55719
|
+
/**
|
|
55720
|
+
* Specifies the ID of the custom function that will be called on demand to resolve or refresh the `LinkedEntityCellValue` objects of this linked entity data domain.
|
|
55721
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
|
|
55722
|
+
*
|
|
55723
|
+
* @remarks
|
|
55724
|
+
* [Api set: ExcelApi 1.19]
|
|
55725
|
+
*/
|
|
55726
|
+
loadFunctionId: string;
|
|
55727
|
+
/**
|
|
55728
|
+
* Specifies the name of the linked entity data domain.
|
|
55729
|
+
This name must be unique across all linked entity data domains defined by this Office Add-in.
|
|
55730
|
+
*
|
|
55731
|
+
* @remarks
|
|
55732
|
+
* [Api set: ExcelApi 1.19]
|
|
55733
|
+
*/
|
|
55734
|
+
name: string;
|
|
55735
|
+
/**
|
|
55736
|
+
* Specifies the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically. The minimum valid value is 300.
|
|
55737
|
+
This property is required if the `supportedRefreshModes` array contains the value "Periodic".
|
|
55738
|
+
This property only applies if the `refreshMode` of the linked entity data domain is set to "Periodic".
|
|
55739
|
+
*
|
|
55740
|
+
* @remarks
|
|
55741
|
+
* [Api set: ExcelApi 1.19]
|
|
55742
|
+
*/
|
|
55743
|
+
periodicRefreshInterval?: number;
|
|
55744
|
+
/**
|
|
55745
|
+
* Specifies all the refresh modes supported by the linked entity data domain.
|
|
55746
|
+
The default value is `["Manual"]`, which is always supported even if not specified.
|
|
55747
|
+
The refresh mode saved in the workbook is loaded as the default refresh mode of the linked entity data domain on the next workbook open.
|
|
55748
|
+
If the refresh mode was not saved in the workbook, the first value in the array is set as the default refresh mode of the linked entity data domain.
|
|
55749
|
+
If the array has the value "Periodic", the `periodicRefreshInterval` property must also be set for the linked entity data domain.
|
|
55750
|
+
*
|
|
55751
|
+
* @remarks
|
|
55752
|
+
* [Api set: ExcelApi 1.19]
|
|
55753
|
+
*/
|
|
55754
|
+
supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];
|
|
55755
|
+
}
|
|
55756
|
+
/**
|
|
55757
|
+
* Provides information about the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.
|
|
55758
|
+
*
|
|
55759
|
+
* @remarks
|
|
55760
|
+
* [Api set: ExcelApi 1.19]
|
|
55761
|
+
*/
|
|
55762
|
+
interface LinkedEntityDataDomainRefreshCompletedEventArgs {
|
|
55763
|
+
/**
|
|
55764
|
+
* Gets any errors encountered during the request to refresh `LinkedEntityCellValue` objects of the linked entity data domain.
|
|
55765
|
+
*
|
|
55766
|
+
* @remarks
|
|
55767
|
+
* [Api set: ExcelApi 1.19]
|
|
55768
|
+
*/
|
|
55769
|
+
errors?: string[];
|
|
55770
|
+
/**
|
|
55771
|
+
* Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed. This ID is defined by Office Add-ins.
|
|
55772
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
55773
|
+
*
|
|
55774
|
+
* @remarks
|
|
55775
|
+
* [Api set: ExcelApi 1.19]
|
|
55776
|
+
*/
|
|
55777
|
+
id?: string;
|
|
55778
|
+
/**
|
|
55779
|
+
* Returns `true` if the `LinkedEntityCellValue` objects of the linked entity data domain were refreshed successfully, otherwise returns `false`.
|
|
55780
|
+
*
|
|
55781
|
+
* @remarks
|
|
55782
|
+
* [Api set: ExcelApi 1.19]
|
|
55783
|
+
*/
|
|
55784
|
+
refreshed: boolean;
|
|
55785
|
+
/**
|
|
55786
|
+
* Gets the service ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.
|
|
55787
|
+
*
|
|
55788
|
+
* @remarks
|
|
55789
|
+
* [Api set: ExcelApi 1.19]
|
|
55790
|
+
*/
|
|
55791
|
+
serviceId: number;
|
|
55792
|
+
/**
|
|
55793
|
+
* Gets the source of the event. See `Excel.EventSource` for details.
|
|
55794
|
+
*
|
|
55795
|
+
* @remarks
|
|
55796
|
+
* [Api set: ExcelApi 1.19]
|
|
55797
|
+
*/
|
|
55798
|
+
source: Excel.EventSource | "Local" | "Remote";
|
|
55799
|
+
/**
|
|
55800
|
+
* Gets the type of the event. See `Excel.EventType` for details.
|
|
55801
|
+
*
|
|
55802
|
+
* @remarks
|
|
55803
|
+
* [Api set: ExcelApi 1.19]
|
|
55804
|
+
*/
|
|
55805
|
+
type: "LinkedEntityDataDomainRefreshCompleted";
|
|
55806
|
+
}
|
|
55807
|
+
/**
|
|
55808
|
+
* Represents the refresh mode setting for the `LinkedEntityCellValue` objects of a `LinkedEntityDataDomain`.
|
|
55809
|
+
*
|
|
55810
|
+
* @remarks
|
|
55811
|
+
* [Api set: ExcelApi 1.19]
|
|
55812
|
+
*/
|
|
55813
|
+
enum LinkedEntityDataDomainRefreshMode {
|
|
55814
|
+
/**
|
|
55815
|
+
* Refresh mode is unknown or unsupported.
|
|
55816
|
+
* @remarks
|
|
55817
|
+
* [Api set: ExcelApi 1.19]
|
|
55818
|
+
*/
|
|
55819
|
+
unknown = "Unknown",
|
|
55820
|
+
/**
|
|
55821
|
+
* Manual refresh by the user.
|
|
55822
|
+
Refresh is not triggered automatically.
|
|
55823
|
+
* @remarks
|
|
55824
|
+
* [Api set: ExcelApi 1.19]
|
|
55825
|
+
*/
|
|
55826
|
+
manual = "Manual",
|
|
55827
|
+
/**
|
|
55828
|
+
* Refresh on workbook load, applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
55829
|
+
Refresh on add-in load, applicable to linked entity data domains defined by Office Add-ins.
|
|
55830
|
+
* @remarks
|
|
55831
|
+
* [Api set: ExcelApi 1.19]
|
|
55832
|
+
*/
|
|
55833
|
+
onLoad = "OnLoad",
|
|
55834
|
+
/**
|
|
55835
|
+
* Refresh automatically based on the frequency, in seconds, specified by `periodicRefreshInterval`.
|
|
55836
|
+
For linked entity data domains defined by service data providers, such as Bing or Power BI, this value also initiates a refresh each time the workbook is opened.
|
|
55837
|
+
For linked entity data domains defined by Office Add-ins, this value also initiates a refresh each time the add-in loads.
|
|
55838
|
+
* @remarks
|
|
55839
|
+
* [Api set: ExcelApi 1.19]
|
|
55840
|
+
*/
|
|
55841
|
+
periodic = "Periodic"
|
|
55842
|
+
}
|
|
55843
|
+
/**
|
|
55844
|
+
* Provides information about the linked entity data domain whose refresh mode was changed.
|
|
55845
|
+
*
|
|
55846
|
+
* @remarks
|
|
55847
|
+
* [Api set: ExcelApi 1.19]
|
|
55848
|
+
*/
|
|
55849
|
+
interface LinkedEntityDataDomainRefreshModeChangedEventArgs {
|
|
55850
|
+
/**
|
|
55851
|
+
* Gets the ID of the linked entity data domain whose refresh mode was changed. This ID is defined by Office Add-ins.
|
|
55852
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
55853
|
+
*
|
|
55854
|
+
* @remarks
|
|
55855
|
+
* [Api set: ExcelApi 1.19]
|
|
55856
|
+
*/
|
|
55857
|
+
id?: string;
|
|
55858
|
+
/**
|
|
55859
|
+
* Gets the new refresh mode of the linked entity data domain.
|
|
55860
|
+
*
|
|
55861
|
+
* @remarks
|
|
55862
|
+
* [Api set: ExcelApi 1.19]
|
|
55863
|
+
*/
|
|
55864
|
+
refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
|
|
55865
|
+
/**
|
|
55866
|
+
* Gets the service ID of the linked entity data domain whose refresh mode was changed.
|
|
55867
|
+
*
|
|
55868
|
+
* @remarks
|
|
55869
|
+
* [Api set: ExcelApi 1.19]
|
|
55870
|
+
*/
|
|
55871
|
+
serviceId: number;
|
|
55872
|
+
/**
|
|
55873
|
+
* Gets the source of the event. See `Excel.EventSource` for details.
|
|
55874
|
+
*
|
|
55875
|
+
* @remarks
|
|
55876
|
+
* [Api set: ExcelApi 1.19]
|
|
55877
|
+
*/
|
|
55878
|
+
source: Excel.EventSource | "Local" | "Remote";
|
|
55879
|
+
/**
|
|
55880
|
+
* Gets the type of the event. See `Excel.EventType` for details.
|
|
55881
|
+
*
|
|
55882
|
+
* @remarks
|
|
55883
|
+
* [Api set: ExcelApi 1.19]
|
|
55884
|
+
*/
|
|
55885
|
+
type: "LinkedEntityDataDomainRefreshModeChanged";
|
|
55886
|
+
}
|
|
54738
55887
|
/**
|
|
54739
55888
|
* @remarks
|
|
54740
55889
|
* [Api set: ExcelApi 1.7]
|
|
@@ -59033,6 +60182,24 @@ declare namespace Excel {
|
|
|
59033
60182
|
* [Api set: ExcelApi 1.7]
|
|
59034
60183
|
*/
|
|
59035
60184
|
worksheetMoved = "WorksheetMoved",
|
|
60185
|
+
/**
|
|
60186
|
+
* LinkedEntityDataDomainAdded represents the type of event registered when a new linked entity data domain is added to the workbook.
|
|
60187
|
+
* @remarks
|
|
60188
|
+
* [Api set: ExcelApi 1.19]
|
|
60189
|
+
*/
|
|
60190
|
+
linkedEntityDataDomainLinkedEntityDataDomainAdded = "LinkedEntityDataDomainLinkedEntityDataDomainAdded",
|
|
60191
|
+
/**
|
|
60192
|
+
* LinkedEntityDataDomainRefreshCompleted represents the type of event registered when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed.
|
|
60193
|
+
* @remarks
|
|
60194
|
+
* [Api set: ExcelApi 1.19]
|
|
60195
|
+
*/
|
|
60196
|
+
linkedEntityDataDomainRefreshCompleted = "LinkedEntityDataDomainRefreshCompleted",
|
|
60197
|
+
/**
|
|
60198
|
+
* LinkedEntityDataDomainRefreshModeChanged represents the type of event registered when the `refreshMode` of a linked entity data domain is changed.
|
|
60199
|
+
* @remarks
|
|
60200
|
+
* [Api set: ExcelApi 1.19]
|
|
60201
|
+
*/
|
|
60202
|
+
linkedEntityDataDomainRefreshModeChanged = "LinkedEntityDataDomainRefreshModeChanged"
|
|
59036
60203
|
}
|
|
59037
60204
|
/**
|
|
59038
60205
|
* @remarks
|
|
@@ -66027,6 +67194,13 @@ declare namespace Excel {
|
|
|
66027
67194
|
* [Api set: ExcelApi 1.1]
|
|
66028
67195
|
*/
|
|
66029
67196
|
position?: number;
|
|
67197
|
+
/**
|
|
67198
|
+
* Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
|
|
67199
|
+
*
|
|
67200
|
+
* @remarks
|
|
67201
|
+
* [Api set: ExcelApi 1.19]
|
|
67202
|
+
*/
|
|
67203
|
+
showDataTypeIcons?: boolean;
|
|
66030
67204
|
/**
|
|
66031
67205
|
* Specifies if gridlines are visible to the user.
|
|
66032
67206
|
*
|
|
@@ -67738,6 +68912,13 @@ declare namespace Excel {
|
|
|
67738
68912
|
* [Api set: ExcelApi 1.1]
|
|
67739
68913
|
*/
|
|
67740
68914
|
format?: Excel.Interfaces.ChartDataLabelFormatUpdateData;
|
|
68915
|
+
/**
|
|
68916
|
+
* Gets an object that represents the leader lines of the data labels.
|
|
68917
|
+
*
|
|
68918
|
+
* @remarks
|
|
68919
|
+
* [Api set: ExcelApi 1.19]
|
|
68920
|
+
*/
|
|
68921
|
+
leaderLines?: Excel.Interfaces.ChartLeaderLinesUpdateData;
|
|
67741
68922
|
/**
|
|
67742
68923
|
* Specifies if data labels automatically generate appropriate text based on context.
|
|
67743
68924
|
*
|
|
@@ -67745,6 +68926,14 @@ declare namespace Excel {
|
|
|
67745
68926
|
* [Api set: ExcelApi 1.8]
|
|
67746
68927
|
*/
|
|
67747
68928
|
autoText?: boolean;
|
|
68929
|
+
/**
|
|
68930
|
+
* Specifies the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details.
|
|
68931
|
+
Value is `null` if the data labels are not geometric shapes.
|
|
68932
|
+
*
|
|
68933
|
+
* @remarks
|
|
68934
|
+
* [Api set: ExcelApi 1.19]
|
|
68935
|
+
*/
|
|
68936
|
+
geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
67748
68937
|
/**
|
|
67749
68938
|
* Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
|
|
67750
68939
|
This property is valid only when the `TextOrientation` of data label is 0.
|
|
@@ -67795,6 +68984,13 @@ declare namespace Excel {
|
|
|
67795
68984
|
* [Api set: ExcelApi 1.1]
|
|
67796
68985
|
*/
|
|
67797
68986
|
showCategoryName?: boolean;
|
|
68987
|
+
/**
|
|
68988
|
+
* Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
|
|
68989
|
+
*
|
|
68990
|
+
* @remarks
|
|
68991
|
+
* [Api set: ExcelApi 1.19]
|
|
68992
|
+
*/
|
|
68993
|
+
showLeaderLines?: boolean;
|
|
67798
68994
|
/**
|
|
67799
68995
|
* Specifies if the data label legend key is visible.
|
|
67800
68996
|
*
|
|
@@ -67862,6 +69058,14 @@ declare namespace Excel {
|
|
|
67862
69058
|
* [Api set: ExcelApi 1.8]
|
|
67863
69059
|
*/
|
|
67864
69060
|
formula?: string;
|
|
69061
|
+
/**
|
|
69062
|
+
* Specifies the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details.
|
|
69063
|
+
Value is `null` if the data label is not a geometric shape.
|
|
69064
|
+
*
|
|
69065
|
+
* @remarks
|
|
69066
|
+
* [Api set: ExcelApi 1.19]
|
|
69067
|
+
*/
|
|
69068
|
+
geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
67865
69069
|
/**
|
|
67866
69070
|
* Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
|
|
67867
69071
|
This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
|
|
@@ -67994,6 +69198,23 @@ declare namespace Excel {
|
|
|
67994
69198
|
*/
|
|
67995
69199
|
font?: Excel.Interfaces.ChartFontUpdateData;
|
|
67996
69200
|
}
|
|
69201
|
+
/** An interface for updating data on the `ChartDataLabelAnchor` object, for use in `chartDataLabelAnchor.set({ ... })`. */
|
|
69202
|
+
interface ChartDataLabelAnchorUpdateData {
|
|
69203
|
+
/**
|
|
69204
|
+
* Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
|
|
69205
|
+
*
|
|
69206
|
+
* @remarks
|
|
69207
|
+
* [Api set: ExcelApi 1.19]
|
|
69208
|
+
*/
|
|
69209
|
+
left?: number;
|
|
69210
|
+
/**
|
|
69211
|
+
* Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
|
|
69212
|
+
*
|
|
69213
|
+
* @remarks
|
|
69214
|
+
* [Api set: ExcelApi 1.19]
|
|
69215
|
+
*/
|
|
69216
|
+
top?: number;
|
|
69217
|
+
}
|
|
67997
69218
|
/** An interface for updating data on the `ChartDataTable` object, for use in `chartDataTable.set({ ... })`. */
|
|
67998
69219
|
interface ChartDataTableUpdateData {
|
|
67999
69220
|
/**
|
|
@@ -68818,6 +70039,26 @@ declare namespace Excel {
|
|
|
68818
70039
|
*/
|
|
68819
70040
|
border?: Excel.Interfaces.ChartBorderUpdateData;
|
|
68820
70041
|
}
|
|
70042
|
+
/** An interface for updating data on the `ChartLeaderLines` object, for use in `chartLeaderLines.set({ ... })`. */
|
|
70043
|
+
interface ChartLeaderLinesUpdateData {
|
|
70044
|
+
/**
|
|
70045
|
+
* Represents the formatting of leader lines of data labels in a series.
|
|
70046
|
+
*
|
|
70047
|
+
* @remarks
|
|
70048
|
+
* [Api set: ExcelApi 1.19]
|
|
70049
|
+
*/
|
|
70050
|
+
format?: Excel.Interfaces.ChartLeaderLinesFormatUpdateData;
|
|
70051
|
+
}
|
|
70052
|
+
/** An interface for updating data on the `ChartLeaderLinesFormat` object, for use in `chartLeaderLinesFormat.set({ ... })`. */
|
|
70053
|
+
interface ChartLeaderLinesFormatUpdateData {
|
|
70054
|
+
/**
|
|
70055
|
+
* Gets an object that represents the line formatting of chart leader lines.
|
|
70056
|
+
*
|
|
70057
|
+
* @remarks
|
|
70058
|
+
* [Api set: ExcelApi 1.19]
|
|
70059
|
+
*/
|
|
70060
|
+
line?: Excel.Interfaces.ChartLineFormatUpdateData;
|
|
70061
|
+
}
|
|
68821
70062
|
/** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */
|
|
68822
70063
|
interface CustomXmlPartScopedCollectionUpdateData {
|
|
68823
70064
|
items?: Excel.Interfaces.CustomXmlPartData[];
|
|
@@ -70735,6 +71976,22 @@ declare namespace Excel {
|
|
|
70735
71976
|
interface SlicerItemCollectionUpdateData {
|
|
70736
71977
|
items?: Excel.Interfaces.SlicerItemData[];
|
|
70737
71978
|
}
|
|
71979
|
+
/** An interface for updating data on the `LinkedEntityDataDomain` object, for use in `linkedEntityDataDomain.set({ ... })`. */
|
|
71980
|
+
interface LinkedEntityDataDomainUpdateData {
|
|
71981
|
+
/**
|
|
71982
|
+
* Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
|
|
71983
|
+
If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
|
|
71984
|
+
If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
|
|
71985
|
+
*
|
|
71986
|
+
* @remarks
|
|
71987
|
+
* [Api set: ExcelApi 1.19]
|
|
71988
|
+
*/
|
|
71989
|
+
refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
|
|
71990
|
+
}
|
|
71991
|
+
/** An interface for updating data on the `LinkedEntityDataDomainCollection` object, for use in `linkedEntityDataDomainCollection.set({ ... })`. */
|
|
71992
|
+
interface LinkedEntityDataDomainCollectionUpdateData {
|
|
71993
|
+
items?: Excel.Interfaces.LinkedEntityDataDomainData[];
|
|
71994
|
+
}
|
|
70738
71995
|
/** An interface for updating data on the `NamedSheetView` object, for use in `namedSheetView.set({ ... })`. */
|
|
70739
71996
|
interface NamedSheetViewUpdateData {
|
|
70740
71997
|
/**
|
|
@@ -71302,6 +72559,13 @@ declare namespace Excel {
|
|
|
71302
72559
|
* [Api set: ExcelApi 1.1]
|
|
71303
72560
|
*/
|
|
71304
72561
|
position?: number;
|
|
72562
|
+
/**
|
|
72563
|
+
* Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
|
|
72564
|
+
*
|
|
72565
|
+
* @remarks
|
|
72566
|
+
* [Api set: ExcelApi 1.19]
|
|
72567
|
+
*/
|
|
72568
|
+
showDataTypeIcons?: boolean;
|
|
71305
72569
|
/**
|
|
71306
72570
|
* Specifies if gridlines are visible to the user.
|
|
71307
72571
|
*
|
|
@@ -73667,6 +74931,13 @@ declare namespace Excel {
|
|
|
73667
74931
|
* [Api set: ExcelApi 1.1]
|
|
73668
74932
|
*/
|
|
73669
74933
|
format?: Excel.Interfaces.ChartDataLabelFormatData;
|
|
74934
|
+
/**
|
|
74935
|
+
* Gets an object that represents the leader lines of the data labels.
|
|
74936
|
+
*
|
|
74937
|
+
* @remarks
|
|
74938
|
+
* [Api set: ExcelApi 1.19]
|
|
74939
|
+
*/
|
|
74940
|
+
leaderLines?: Excel.Interfaces.ChartLeaderLinesData;
|
|
73670
74941
|
/**
|
|
73671
74942
|
* Specifies if data labels automatically generate appropriate text based on context.
|
|
73672
74943
|
*
|
|
@@ -73674,6 +74945,14 @@ declare namespace Excel {
|
|
|
73674
74945
|
* [Api set: ExcelApi 1.8]
|
|
73675
74946
|
*/
|
|
73676
74947
|
autoText?: boolean;
|
|
74948
|
+
/**
|
|
74949
|
+
* Specifies the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details.
|
|
74950
|
+
Value is `null` if the data labels are not geometric shapes.
|
|
74951
|
+
*
|
|
74952
|
+
* @remarks
|
|
74953
|
+
* [Api set: ExcelApi 1.19]
|
|
74954
|
+
*/
|
|
74955
|
+
geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
73677
74956
|
/**
|
|
73678
74957
|
* Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
|
|
73679
74958
|
This property is valid only when the `TextOrientation` of data label is 0.
|
|
@@ -73710,6 +74989,13 @@ declare namespace Excel {
|
|
|
73710
74989
|
* [Api set: ExcelApi 1.1]
|
|
73711
74990
|
*/
|
|
73712
74991
|
separator?: string;
|
|
74992
|
+
/**
|
|
74993
|
+
* Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
|
|
74994
|
+
*
|
|
74995
|
+
* @remarks
|
|
74996
|
+
* [Api set: ExcelApi 1.19]
|
|
74997
|
+
*/
|
|
74998
|
+
showAsStickyCallout?: boolean;
|
|
73713
74999
|
/**
|
|
73714
75000
|
* Specifies if the data label bubble size is visible.
|
|
73715
75001
|
*
|
|
@@ -73724,6 +75010,13 @@ declare namespace Excel {
|
|
|
73724
75010
|
* [Api set: ExcelApi 1.1]
|
|
73725
75011
|
*/
|
|
73726
75012
|
showCategoryName?: boolean;
|
|
75013
|
+
/**
|
|
75014
|
+
* Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
|
|
75015
|
+
*
|
|
75016
|
+
* @remarks
|
|
75017
|
+
* [Api set: ExcelApi 1.19]
|
|
75018
|
+
*/
|
|
75019
|
+
showLeaderLines?: boolean;
|
|
73727
75020
|
/**
|
|
73728
75021
|
* Specifies if the data label legend key is visible.
|
|
73729
75022
|
*
|
|
@@ -73791,6 +75084,14 @@ declare namespace Excel {
|
|
|
73791
75084
|
* [Api set: ExcelApi 1.8]
|
|
73792
75085
|
*/
|
|
73793
75086
|
formula?: string;
|
|
75087
|
+
/**
|
|
75088
|
+
* Specifies the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details.
|
|
75089
|
+
Value is `null` if the data label is not a geometric shape.
|
|
75090
|
+
*
|
|
75091
|
+
* @remarks
|
|
75092
|
+
* [Api set: ExcelApi 1.19]
|
|
75093
|
+
*/
|
|
75094
|
+
geometricShapeType?: Excel.GeometricShapeType | "LineInverse" | "Triangle" | "RightTriangle" | "Rectangle" | "Diamond" | "Parallelogram" | "Trapezoid" | "NonIsoscelesTrapezoid" | "Pentagon" | "Hexagon" | "Heptagon" | "Octagon" | "Decagon" | "Dodecagon" | "Star4" | "Star5" | "Star6" | "Star7" | "Star8" | "Star10" | "Star12" | "Star16" | "Star24" | "Star32" | "RoundRectangle" | "Round1Rectangle" | "Round2SameRectangle" | "Round2DiagonalRectangle" | "SnipRoundRectangle" | "Snip1Rectangle" | "Snip2SameRectangle" | "Snip2DiagonalRectangle" | "Plaque" | "Ellipse" | "Teardrop" | "HomePlate" | "Chevron" | "PieWedge" | "Pie" | "BlockArc" | "Donut" | "NoSmoking" | "RightArrow" | "LeftArrow" | "UpArrow" | "DownArrow" | "StripedRightArrow" | "NotchedRightArrow" | "BentUpArrow" | "LeftRightArrow" | "UpDownArrow" | "LeftUpArrow" | "LeftRightUpArrow" | "QuadArrow" | "LeftArrowCallout" | "RightArrowCallout" | "UpArrowCallout" | "DownArrowCallout" | "LeftRightArrowCallout" | "UpDownArrowCallout" | "QuadArrowCallout" | "BentArrow" | "UturnArrow" | "CircularArrow" | "LeftCircularArrow" | "LeftRightCircularArrow" | "CurvedRightArrow" | "CurvedLeftArrow" | "CurvedUpArrow" | "CurvedDownArrow" | "SwooshArrow" | "Cube" | "Can" | "LightningBolt" | "Heart" | "Sun" | "Moon" | "SmileyFace" | "IrregularSeal1" | "IrregularSeal2" | "FoldedCorner" | "Bevel" | "Frame" | "HalfFrame" | "Corner" | "DiagonalStripe" | "Chord" | "Arc" | "LeftBracket" | "RightBracket" | "LeftBrace" | "RightBrace" | "BracketPair" | "BracePair" | "Callout1" | "Callout2" | "Callout3" | "AccentCallout1" | "AccentCallout2" | "AccentCallout3" | "BorderCallout1" | "BorderCallout2" | "BorderCallout3" | "AccentBorderCallout1" | "AccentBorderCallout2" | "AccentBorderCallout3" | "WedgeRectCallout" | "WedgeRRectCallout" | "WedgeEllipseCallout" | "CloudCallout" | "Cloud" | "Ribbon" | "Ribbon2" | "EllipseRibbon" | "EllipseRibbon2" | "LeftRightRibbon" | "VerticalScroll" | "HorizontalScroll" | "Wave" | "DoubleWave" | "Plus" | "FlowChartProcess" | "FlowChartDecision" | "FlowChartInputOutput" | "FlowChartPredefinedProcess" | "FlowChartInternalStorage" | "FlowChartDocument" | "FlowChartMultidocument" | "FlowChartTerminator" | "FlowChartPreparation" | "FlowChartManualInput" | "FlowChartManualOperation" | "FlowChartConnector" | "FlowChartPunchedCard" | "FlowChartPunchedTape" | "FlowChartSummingJunction" | "FlowChartOr" | "FlowChartCollate" | "FlowChartSort" | "FlowChartExtract" | "FlowChartMerge" | "FlowChartOfflineStorage" | "FlowChartOnlineStorage" | "FlowChartMagneticTape" | "FlowChartMagneticDisk" | "FlowChartMagneticDrum" | "FlowChartDisplay" | "FlowChartDelay" | "FlowChartAlternateProcess" | "FlowChartOffpageConnector" | "ActionButtonBlank" | "ActionButtonHome" | "ActionButtonHelp" | "ActionButtonInformation" | "ActionButtonForwardNext" | "ActionButtonBackPrevious" | "ActionButtonEnd" | "ActionButtonBeginning" | "ActionButtonReturn" | "ActionButtonDocument" | "ActionButtonSound" | "ActionButtonMovie" | "Gear6" | "Gear9" | "Funnel" | "MathPlus" | "MathMinus" | "MathMultiply" | "MathDivide" | "MathEqual" | "MathNotEqual" | "CornerTabs" | "SquareTabs" | "PlaqueTabs" | "ChartX" | "ChartStar" | "ChartPlus";
|
|
73794
75095
|
/**
|
|
73795
75096
|
* Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
|
|
73796
75097
|
*
|
|
@@ -73841,6 +75142,13 @@ declare namespace Excel {
|
|
|
73841
75142
|
* [Api set: ExcelApi 1.7]
|
|
73842
75143
|
*/
|
|
73843
75144
|
separator?: string;
|
|
75145
|
+
/**
|
|
75146
|
+
* Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
|
|
75147
|
+
*
|
|
75148
|
+
* @remarks
|
|
75149
|
+
* [Api set: ExcelApi 1.19]
|
|
75150
|
+
*/
|
|
75151
|
+
showAsStickyCallout?: boolean;
|
|
73844
75152
|
/**
|
|
73845
75153
|
* Specifies if the data label bubble size is visible.
|
|
73846
75154
|
*
|
|
@@ -73937,6 +75245,23 @@ declare namespace Excel {
|
|
|
73937
75245
|
*/
|
|
73938
75246
|
font?: Excel.Interfaces.ChartFontData;
|
|
73939
75247
|
}
|
|
75248
|
+
/** An interface describing the data returned by calling `chartDataLabelAnchor.toJSON()`. */
|
|
75249
|
+
interface ChartDataLabelAnchorData {
|
|
75250
|
+
/**
|
|
75251
|
+
* Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
|
|
75252
|
+
*
|
|
75253
|
+
* @remarks
|
|
75254
|
+
* [Api set: ExcelApi 1.19]
|
|
75255
|
+
*/
|
|
75256
|
+
left?: number;
|
|
75257
|
+
/**
|
|
75258
|
+
* Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
|
|
75259
|
+
*
|
|
75260
|
+
* @remarks
|
|
75261
|
+
* [Api set: ExcelApi 1.19]
|
|
75262
|
+
*/
|
|
75263
|
+
top?: number;
|
|
75264
|
+
}
|
|
73940
75265
|
/** An interface describing the data returned by calling `chartDataTable.toJSON()`. */
|
|
73941
75266
|
interface ChartDataTableData {
|
|
73942
75267
|
/**
|
|
@@ -74831,6 +76156,26 @@ declare namespace Excel {
|
|
|
74831
76156
|
*/
|
|
74832
76157
|
border?: Excel.Interfaces.ChartBorderData;
|
|
74833
76158
|
}
|
|
76159
|
+
/** An interface describing the data returned by calling `chartLeaderLines.toJSON()`. */
|
|
76160
|
+
interface ChartLeaderLinesData {
|
|
76161
|
+
/**
|
|
76162
|
+
* Represents the formatting of leader lines of data labels in a series.
|
|
76163
|
+
*
|
|
76164
|
+
* @remarks
|
|
76165
|
+
* [Api set: ExcelApi 1.19]
|
|
76166
|
+
*/
|
|
76167
|
+
format?: Excel.Interfaces.ChartLeaderLinesFormatData;
|
|
76168
|
+
}
|
|
76169
|
+
/** An interface describing the data returned by calling `chartLeaderLinesFormat.toJSON()`. */
|
|
76170
|
+
interface ChartLeaderLinesFormatData {
|
|
76171
|
+
/**
|
|
76172
|
+
* Gets an object that represents the line formatting of chart leader lines.
|
|
76173
|
+
*
|
|
76174
|
+
* @remarks
|
|
76175
|
+
* [Api set: ExcelApi 1.19]
|
|
76176
|
+
*/
|
|
76177
|
+
line?: Excel.Interfaces.ChartLineFormatData;
|
|
76178
|
+
}
|
|
74834
76179
|
/** An interface describing the data returned by calling `tableSort.toJSON()`. */
|
|
74835
76180
|
interface TableSortData {
|
|
74836
76181
|
/**
|
|
@@ -77413,6 +78758,88 @@ declare namespace Excel {
|
|
|
77413
78758
|
interface SlicerItemCollectionData {
|
|
77414
78759
|
items?: Excel.Interfaces.SlicerItemData[];
|
|
77415
78760
|
}
|
|
78761
|
+
/** An interface describing the data returned by calling `linkedEntityDataDomain.toJSON()`. */
|
|
78762
|
+
interface LinkedEntityDataDomainData {
|
|
78763
|
+
/**
|
|
78764
|
+
* Gets the name of the data provider for the linked entity data domain.
|
|
78765
|
+
This name can change based on the information provided by the data provider.
|
|
78766
|
+
*
|
|
78767
|
+
* @remarks
|
|
78768
|
+
* [Api set: ExcelApi 1.19]
|
|
78769
|
+
*/
|
|
78770
|
+
dataProvider?: string;
|
|
78771
|
+
/**
|
|
78772
|
+
* Gets the ID of the linked entity data domain defined by Office Add-ins.
|
|
78773
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
78774
|
+
*
|
|
78775
|
+
* @remarks
|
|
78776
|
+
* [Api set: ExcelApi 1.19]
|
|
78777
|
+
*/
|
|
78778
|
+
id?: string;
|
|
78779
|
+
/**
|
|
78780
|
+
* Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
|
|
78781
|
+
Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
|
|
78782
|
+
*
|
|
78783
|
+
* @remarks
|
|
78784
|
+
* [Api set: ExcelApi 1.19]
|
|
78785
|
+
*/
|
|
78786
|
+
lastRefreshed?: Date;
|
|
78787
|
+
/**
|
|
78788
|
+
* Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.
|
|
78789
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
|
|
78790
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
78791
|
+
*
|
|
78792
|
+
* @remarks
|
|
78793
|
+
* [Api set: ExcelApi 1.19]
|
|
78794
|
+
*/
|
|
78795
|
+
loadFunctionId?: string;
|
|
78796
|
+
/**
|
|
78797
|
+
* Gets the name of the linked entity data domain.
|
|
78798
|
+
This name can change based on the information provided by the data provider.
|
|
78799
|
+
*
|
|
78800
|
+
* @remarks
|
|
78801
|
+
* [Api set: ExcelApi 1.19]
|
|
78802
|
+
*/
|
|
78803
|
+
name?: string;
|
|
78804
|
+
/**
|
|
78805
|
+
* Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
|
|
78806
|
+
The refresh interval only applies if the `refreshMode` is set to "Periodic".
|
|
78807
|
+
*
|
|
78808
|
+
* @remarks
|
|
78809
|
+
* [Api set: ExcelApi 1.19]
|
|
78810
|
+
*/
|
|
78811
|
+
periodicRefreshInterval?: number;
|
|
78812
|
+
/**
|
|
78813
|
+
* Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
|
|
78814
|
+
If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
|
|
78815
|
+
If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
|
|
78816
|
+
*
|
|
78817
|
+
* @remarks
|
|
78818
|
+
* [Api set: ExcelApi 1.19]
|
|
78819
|
+
*/
|
|
78820
|
+
refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic";
|
|
78821
|
+
/**
|
|
78822
|
+
* Gets the service ID of the linked entity data domain.
|
|
78823
|
+
This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
|
|
78824
|
+
This ID never changes across user sessions.
|
|
78825
|
+
*
|
|
78826
|
+
* @remarks
|
|
78827
|
+
* [Api set: ExcelApi 1.19]
|
|
78828
|
+
*/
|
|
78829
|
+
serviceId?: number;
|
|
78830
|
+
/**
|
|
78831
|
+
* Gets all the refresh modes supported by the linked entity data domain.
|
|
78832
|
+
This array can change based on the information provided by the data provider.
|
|
78833
|
+
*
|
|
78834
|
+
* @remarks
|
|
78835
|
+
* [Api set: ExcelApi 1.19]
|
|
78836
|
+
*/
|
|
78837
|
+
supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];
|
|
78838
|
+
}
|
|
78839
|
+
/** An interface describing the data returned by calling `linkedEntityDataDomainCollection.toJSON()`. */
|
|
78840
|
+
interface LinkedEntityDataDomainCollectionData {
|
|
78841
|
+
items?: Excel.Interfaces.LinkedEntityDataDomainData[];
|
|
78842
|
+
}
|
|
77416
78843
|
/** An interface describing the data returned by calling `namedSheetView.toJSON()`. */
|
|
77417
78844
|
interface NamedSheetViewData {
|
|
77418
78845
|
/**
|
|
@@ -78049,6 +79476,13 @@ declare namespace Excel {
|
|
|
78049
79476
|
* [Api set: ExcelApi 1.1]
|
|
78050
79477
|
*/
|
|
78051
79478
|
position?: boolean;
|
|
79479
|
+
/**
|
|
79480
|
+
* Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
|
|
79481
|
+
*
|
|
79482
|
+
* @remarks
|
|
79483
|
+
* [Api set: ExcelApi 1.19]
|
|
79484
|
+
*/
|
|
79485
|
+
showDataTypeIcons?: boolean;
|
|
78052
79486
|
/**
|
|
78053
79487
|
* Specifies if gridlines are visible to the user.
|
|
78054
79488
|
*
|
|
@@ -78177,6 +79611,13 @@ declare namespace Excel {
|
|
|
78177
79611
|
* [Api set: ExcelApi 1.1]
|
|
78178
79612
|
*/
|
|
78179
79613
|
position?: boolean;
|
|
79614
|
+
/**
|
|
79615
|
+
* For EACH ITEM in the collection: Specifies if data type icons are visible on the worksheet. By default, data type icons are visible.
|
|
79616
|
+
*
|
|
79617
|
+
* @remarks
|
|
79618
|
+
* [Api set: ExcelApi 1.19]
|
|
79619
|
+
*/
|
|
79620
|
+
showDataTypeIcons?: boolean;
|
|
78180
79621
|
/**
|
|
78181
79622
|
* For EACH ITEM in the collection: Specifies if gridlines are visible to the user.
|
|
78182
79623
|
*
|
|
@@ -82032,6 +83473,13 @@ declare namespace Excel {
|
|
|
82032
83473
|
* [Api set: ExcelApi 1.1]
|
|
82033
83474
|
*/
|
|
82034
83475
|
format?: Excel.Interfaces.ChartDataLabelFormatLoadOptions;
|
|
83476
|
+
/**
|
|
83477
|
+
* Gets an object that represents the leader lines of the data labels.
|
|
83478
|
+
*
|
|
83479
|
+
* @remarks
|
|
83480
|
+
* [Api set: ExcelApi 1.19]
|
|
83481
|
+
*/
|
|
83482
|
+
leaderLines?: Excel.Interfaces.ChartLeaderLinesLoadOptions;
|
|
82035
83483
|
/**
|
|
82036
83484
|
* Specifies if data labels automatically generate appropriate text based on context.
|
|
82037
83485
|
*
|
|
@@ -82039,6 +83487,14 @@ declare namespace Excel {
|
|
|
82039
83487
|
* [Api set: ExcelApi 1.8]
|
|
82040
83488
|
*/
|
|
82041
83489
|
autoText?: boolean;
|
|
83490
|
+
/**
|
|
83491
|
+
* Specifies the geometric shape type of the data labels. See `Excel.GeometricShapeType` for more details.
|
|
83492
|
+
Value is `null` if the data labels are not geometric shapes.
|
|
83493
|
+
*
|
|
83494
|
+
* @remarks
|
|
83495
|
+
* [Api set: ExcelApi 1.19]
|
|
83496
|
+
*/
|
|
83497
|
+
geometricShapeType?: boolean;
|
|
82042
83498
|
/**
|
|
82043
83499
|
* Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
|
|
82044
83500
|
This property is valid only when the `TextOrientation` of data label is 0.
|
|
@@ -82075,6 +83531,13 @@ declare namespace Excel {
|
|
|
82075
83531
|
* [Api set: ExcelApi 1.1]
|
|
82076
83532
|
*/
|
|
82077
83533
|
separator?: boolean;
|
|
83534
|
+
/**
|
|
83535
|
+
* Gets a value that indicates whether the data labels are shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
|
|
83536
|
+
*
|
|
83537
|
+
* @remarks
|
|
83538
|
+
* [Api set: ExcelApi 1.19]
|
|
83539
|
+
*/
|
|
83540
|
+
showAsStickyCallout?: boolean;
|
|
82078
83541
|
/**
|
|
82079
83542
|
* Specifies if the data label bubble size is visible.
|
|
82080
83543
|
*
|
|
@@ -82089,6 +83552,13 @@ declare namespace Excel {
|
|
|
82089
83552
|
* [Api set: ExcelApi 1.1]
|
|
82090
83553
|
*/
|
|
82091
83554
|
showCategoryName?: boolean;
|
|
83555
|
+
/**
|
|
83556
|
+
* Specifies a value that indicates whether leader lines are displayed for the data labels. `true` if leader lines are shown; otherwise, `false`.
|
|
83557
|
+
*
|
|
83558
|
+
* @remarks
|
|
83559
|
+
* [Api set: ExcelApi 1.19]
|
|
83560
|
+
*/
|
|
83561
|
+
showLeaderLines?: boolean;
|
|
82092
83562
|
/**
|
|
82093
83563
|
* Specifies if the data label legend key is visible.
|
|
82094
83564
|
*
|
|
@@ -82165,6 +83635,14 @@ declare namespace Excel {
|
|
|
82165
83635
|
* [Api set: ExcelApi 1.8]
|
|
82166
83636
|
*/
|
|
82167
83637
|
formula?: boolean;
|
|
83638
|
+
/**
|
|
83639
|
+
* Specifies the geometric shape type of the data label. See `Excel.GeometricShapeType` for more details.
|
|
83640
|
+
Value is `null` if the data label is not a geometric shape.
|
|
83641
|
+
*
|
|
83642
|
+
* @remarks
|
|
83643
|
+
* [Api set: ExcelApi 1.19]
|
|
83644
|
+
*/
|
|
83645
|
+
geometricShapeType?: boolean;
|
|
82168
83646
|
/**
|
|
82169
83647
|
* Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.
|
|
82170
83648
|
*
|
|
@@ -82215,6 +83693,13 @@ declare namespace Excel {
|
|
|
82215
83693
|
* [Api set: ExcelApi 1.7]
|
|
82216
83694
|
*/
|
|
82217
83695
|
separator?: boolean;
|
|
83696
|
+
/**
|
|
83697
|
+
* Gets a value that indicates whether the data label is shown as a callout with the tail anchor attached to the data point. If `true`, the callout is one of the following values: "AccentCallout1", "AccentCallout2", "BorderCallout1", "BorderCallout2", "WedgeRectCallout", "WedgeRRectCallout" or "WedgeEllipseCallout". See {@link Excel.GeometricShapeType | GeometricShapeType} for more details.
|
|
83698
|
+
*
|
|
83699
|
+
* @remarks
|
|
83700
|
+
* [Api set: ExcelApi 1.19]
|
|
83701
|
+
*/
|
|
83702
|
+
showAsStickyCallout?: boolean;
|
|
82218
83703
|
/**
|
|
82219
83704
|
* Specifies if the data label bubble size is visible.
|
|
82220
83705
|
*
|
|
@@ -82320,6 +83805,32 @@ declare namespace Excel {
|
|
|
82320
83805
|
*/
|
|
82321
83806
|
font?: Excel.Interfaces.ChartFontLoadOptions;
|
|
82322
83807
|
}
|
|
83808
|
+
/**
|
|
83809
|
+
* Represents the chart data label anchor.
|
|
83810
|
+
*
|
|
83811
|
+
* @remarks
|
|
83812
|
+
* [Api set: ExcelApi 1.19]
|
|
83813
|
+
*/
|
|
83814
|
+
interface ChartDataLabelAnchorLoadOptions {
|
|
83815
|
+
/**
|
|
83816
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
83817
|
+
*/
|
|
83818
|
+
$all?: boolean;
|
|
83819
|
+
/**
|
|
83820
|
+
* Represents the distance, in points, from the anchor to the left edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
|
|
83821
|
+
*
|
|
83822
|
+
* @remarks
|
|
83823
|
+
* [Api set: ExcelApi 1.19]
|
|
83824
|
+
*/
|
|
83825
|
+
left?: boolean;
|
|
83826
|
+
/**
|
|
83827
|
+
* Represents the distance, in points, from the anchor to the top edge of the chart data label. Note that when getting the value, it may differ slightly from the set value.
|
|
83828
|
+
*
|
|
83829
|
+
* @remarks
|
|
83830
|
+
* [Api set: ExcelApi 1.19]
|
|
83831
|
+
*/
|
|
83832
|
+
top?: boolean;
|
|
83833
|
+
}
|
|
82323
83834
|
/**
|
|
82324
83835
|
* Represents the data table object of a chart.
|
|
82325
83836
|
*
|
|
@@ -83558,6 +85069,44 @@ declare namespace Excel {
|
|
|
83558
85069
|
*/
|
|
83559
85070
|
border?: Excel.Interfaces.ChartBorderLoadOptions;
|
|
83560
85071
|
}
|
|
85072
|
+
/**
|
|
85073
|
+
* Gets an object that represents the formatting of chart leader lines.
|
|
85074
|
+
*
|
|
85075
|
+
* @remarks
|
|
85076
|
+
* [Api set: ExcelApi 1.19]
|
|
85077
|
+
*/
|
|
85078
|
+
interface ChartLeaderLinesLoadOptions {
|
|
85079
|
+
/**
|
|
85080
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
85081
|
+
*/
|
|
85082
|
+
$all?: boolean;
|
|
85083
|
+
/**
|
|
85084
|
+
* Represents the formatting of leader lines of data labels in a series.
|
|
85085
|
+
*
|
|
85086
|
+
* @remarks
|
|
85087
|
+
* [Api set: ExcelApi 1.19]
|
|
85088
|
+
*/
|
|
85089
|
+
format?: Excel.Interfaces.ChartLeaderLinesFormatLoadOptions;
|
|
85090
|
+
}
|
|
85091
|
+
/**
|
|
85092
|
+
* Encapsulates the format properties for leader lines.
|
|
85093
|
+
*
|
|
85094
|
+
* @remarks
|
|
85095
|
+
* [Api set: ExcelApi 1.19]
|
|
85096
|
+
*/
|
|
85097
|
+
interface ChartLeaderLinesFormatLoadOptions {
|
|
85098
|
+
/**
|
|
85099
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
85100
|
+
*/
|
|
85101
|
+
$all?: boolean;
|
|
85102
|
+
/**
|
|
85103
|
+
* Gets an object that represents the line formatting of chart leader lines.
|
|
85104
|
+
*
|
|
85105
|
+
* @remarks
|
|
85106
|
+
* [Api set: ExcelApi 1.19]
|
|
85107
|
+
*/
|
|
85108
|
+
line?: Excel.Interfaces.ChartLineFormatLoadOptions;
|
|
85109
|
+
}
|
|
83561
85110
|
/**
|
|
83562
85111
|
* Manages sorting operations on `Table` objects.
|
|
83563
85112
|
*
|
|
@@ -88582,6 +90131,183 @@ declare namespace Excel {
|
|
|
88582
90131
|
*/
|
|
88583
90132
|
name?: boolean;
|
|
88584
90133
|
}
|
|
90134
|
+
/**
|
|
90135
|
+
* Represents a specific category or field of information that shares some common characteristics or attributes.
|
|
90136
|
+
A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook.
|
|
90137
|
+
A data domain is a category of data, such as stocks, geography, or currencies. A data provider is a service, such as Bing, Power BI, or an Office Add-in.
|
|
90138
|
+
*
|
|
90139
|
+
* @remarks
|
|
90140
|
+
* [Api set: ExcelApi 1.19]
|
|
90141
|
+
*/
|
|
90142
|
+
interface LinkedEntityDataDomainLoadOptions {
|
|
90143
|
+
/**
|
|
90144
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
90145
|
+
*/
|
|
90146
|
+
$all?: boolean;
|
|
90147
|
+
/**
|
|
90148
|
+
* Gets the name of the data provider for the linked entity data domain.
|
|
90149
|
+
This name can change based on the information provided by the data provider.
|
|
90150
|
+
*
|
|
90151
|
+
* @remarks
|
|
90152
|
+
* [Api set: ExcelApi 1.19]
|
|
90153
|
+
*/
|
|
90154
|
+
dataProvider?: boolean;
|
|
90155
|
+
/**
|
|
90156
|
+
* Gets the ID of the linked entity data domain defined by Office Add-ins.
|
|
90157
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
90158
|
+
*
|
|
90159
|
+
* @remarks
|
|
90160
|
+
* [Api set: ExcelApi 1.19]
|
|
90161
|
+
*/
|
|
90162
|
+
id?: boolean;
|
|
90163
|
+
/**
|
|
90164
|
+
* Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
|
|
90165
|
+
Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
|
|
90166
|
+
*
|
|
90167
|
+
* @remarks
|
|
90168
|
+
* [Api set: ExcelApi 1.19]
|
|
90169
|
+
*/
|
|
90170
|
+
lastRefreshed?: boolean;
|
|
90171
|
+
/**
|
|
90172
|
+
* Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.
|
|
90173
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
|
|
90174
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
90175
|
+
*
|
|
90176
|
+
* @remarks
|
|
90177
|
+
* [Api set: ExcelApi 1.19]
|
|
90178
|
+
*/
|
|
90179
|
+
loadFunctionId?: boolean;
|
|
90180
|
+
/**
|
|
90181
|
+
* Gets the name of the linked entity data domain.
|
|
90182
|
+
This name can change based on the information provided by the data provider.
|
|
90183
|
+
*
|
|
90184
|
+
* @remarks
|
|
90185
|
+
* [Api set: ExcelApi 1.19]
|
|
90186
|
+
*/
|
|
90187
|
+
name?: boolean;
|
|
90188
|
+
/**
|
|
90189
|
+
* Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
|
|
90190
|
+
The refresh interval only applies if the `refreshMode` is set to "Periodic".
|
|
90191
|
+
*
|
|
90192
|
+
* @remarks
|
|
90193
|
+
* [Api set: ExcelApi 1.19]
|
|
90194
|
+
*/
|
|
90195
|
+
periodicRefreshInterval?: boolean;
|
|
90196
|
+
/**
|
|
90197
|
+
* Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
|
|
90198
|
+
If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
|
|
90199
|
+
If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
|
|
90200
|
+
*
|
|
90201
|
+
* @remarks
|
|
90202
|
+
* [Api set: ExcelApi 1.19]
|
|
90203
|
+
*/
|
|
90204
|
+
refreshMode?: boolean;
|
|
90205
|
+
/**
|
|
90206
|
+
* Gets the service ID of the linked entity data domain.
|
|
90207
|
+
This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
|
|
90208
|
+
This ID never changes across user sessions.
|
|
90209
|
+
*
|
|
90210
|
+
* @remarks
|
|
90211
|
+
* [Api set: ExcelApi 1.19]
|
|
90212
|
+
*/
|
|
90213
|
+
serviceId?: boolean;
|
|
90214
|
+
/**
|
|
90215
|
+
* Gets all the refresh modes supported by the linked entity data domain.
|
|
90216
|
+
This array can change based on the information provided by the data provider.
|
|
90217
|
+
*
|
|
90218
|
+
* @remarks
|
|
90219
|
+
* [Api set: ExcelApi 1.19]
|
|
90220
|
+
*/
|
|
90221
|
+
supportedRefreshModes?: boolean;
|
|
90222
|
+
}
|
|
90223
|
+
/**
|
|
90224
|
+
* Represents a collection of `LinkedEntityDataDomain` objects.
|
|
90225
|
+
The collection can contain linked entity data domains such as stocks, geography, or currencies defined by service data providers, such as Bing or Power BI, or linked entity data domains defined by Office Add-ins.
|
|
90226
|
+
*
|
|
90227
|
+
* @remarks
|
|
90228
|
+
* [Api set: ExcelApi 1.19]
|
|
90229
|
+
*/
|
|
90230
|
+
interface LinkedEntityDataDomainCollectionLoadOptions {
|
|
90231
|
+
/**
|
|
90232
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
90233
|
+
*/
|
|
90234
|
+
$all?: boolean;
|
|
90235
|
+
/**
|
|
90236
|
+
* For EACH ITEM in the collection: Gets the name of the data provider for the linked entity data domain.
|
|
90237
|
+
This name can change based on the information provided by the data provider.
|
|
90238
|
+
*
|
|
90239
|
+
* @remarks
|
|
90240
|
+
* [Api set: ExcelApi 1.19]
|
|
90241
|
+
*/
|
|
90242
|
+
dataProvider?: boolean;
|
|
90243
|
+
/**
|
|
90244
|
+
* For EACH ITEM in the collection: Gets the ID of the linked entity data domain defined by Office Add-ins.
|
|
90245
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
90246
|
+
*
|
|
90247
|
+
* @remarks
|
|
90248
|
+
* [Api set: ExcelApi 1.19]
|
|
90249
|
+
*/
|
|
90250
|
+
id?: boolean;
|
|
90251
|
+
/**
|
|
90252
|
+
* For EACH ITEM in the collection: Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.
|
|
90253
|
+
Returns `undefined` if `LinkedEntityCellValue` objects have not been refreshed since the workbook was opened.
|
|
90254
|
+
*
|
|
90255
|
+
* @remarks
|
|
90256
|
+
* [Api set: ExcelApi 1.19]
|
|
90257
|
+
*/
|
|
90258
|
+
lastRefreshed?: boolean;
|
|
90259
|
+
/**
|
|
90260
|
+
* For EACH ITEM in the collection: Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.
|
|
90261
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/excel/custom-functions-json-autogeneration#id | Autogenerate JSON metadata for custom functions: ID }.
|
|
90262
|
+
This ID is not applicable to linked entity data domains defined by service data providers, such as Bing or Power BI.
|
|
90263
|
+
*
|
|
90264
|
+
* @remarks
|
|
90265
|
+
* [Api set: ExcelApi 1.19]
|
|
90266
|
+
*/
|
|
90267
|
+
loadFunctionId?: boolean;
|
|
90268
|
+
/**
|
|
90269
|
+
* For EACH ITEM in the collection: Gets the name of the linked entity data domain.
|
|
90270
|
+
This name can change based on the information provided by the data provider.
|
|
90271
|
+
*
|
|
90272
|
+
* @remarks
|
|
90273
|
+
* [Api set: ExcelApi 1.19]
|
|
90274
|
+
*/
|
|
90275
|
+
name?: boolean;
|
|
90276
|
+
/**
|
|
90277
|
+
* For EACH ITEM in the collection: Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.
|
|
90278
|
+
The refresh interval only applies if the `refreshMode` is set to "Periodic".
|
|
90279
|
+
*
|
|
90280
|
+
* @remarks
|
|
90281
|
+
* [Api set: ExcelApi 1.19]
|
|
90282
|
+
*/
|
|
90283
|
+
periodicRefreshInterval?: boolean;
|
|
90284
|
+
/**
|
|
90285
|
+
* For EACH ITEM in the collection: Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.
|
|
90286
|
+
If the refresh mode being set is not supported by this linked entity data domain, then the current refresh mode is not changed.
|
|
90287
|
+
If the refresh mode is set to "Periodic", the refresh interval is set to the `periodicRefreshInterval` of this linked entity data domain.
|
|
90288
|
+
*
|
|
90289
|
+
* @remarks
|
|
90290
|
+
* [Api set: ExcelApi 1.19]
|
|
90291
|
+
*/
|
|
90292
|
+
refreshMode?: boolean;
|
|
90293
|
+
/**
|
|
90294
|
+
* For EACH ITEM in the collection: Gets the service ID of the linked entity data domain.
|
|
90295
|
+
This ID is a permanently reserved value for all linked entity data domains which are defined by service data providers, such as Bing or Power BI, or defined by Office Add-ins.
|
|
90296
|
+
This ID never changes across user sessions.
|
|
90297
|
+
*
|
|
90298
|
+
* @remarks
|
|
90299
|
+
* [Api set: ExcelApi 1.19]
|
|
90300
|
+
*/
|
|
90301
|
+
serviceId?: boolean;
|
|
90302
|
+
/**
|
|
90303
|
+
* For EACH ITEM in the collection: Gets all the refresh modes supported by the linked entity data domain.
|
|
90304
|
+
This array can change based on the information provided by the data provider.
|
|
90305
|
+
*
|
|
90306
|
+
* @remarks
|
|
90307
|
+
* [Api set: ExcelApi 1.19]
|
|
90308
|
+
*/
|
|
90309
|
+
supportedRefreshModes?: boolean;
|
|
90310
|
+
}
|
|
88585
90311
|
/**
|
|
88586
90312
|
* Represents a named sheet view of a worksheet. A sheet view stores the sort and filter rules for a particular worksheet.
|
|
88587
90313
|
Every sheet view (even a temporary sheet view) has a unique, worksheet-scoped name that is used to access the view.
|