@sapui5/ts-types-esm 1.96.47 → 1.96.49

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.
Files changed (51) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +2 -2
  3. package/types/sap.chart.d.ts +1 -1
  4. package/types/sap.f.d.ts +1 -1
  5. package/types/sap.fe.common.d.ts +1 -1
  6. package/types/sap.fe.core.d.ts +1 -1
  7. package/types/sap.fe.navigation.d.ts +1 -1
  8. package/types/sap.fe.plugins.d.ts +1 -1
  9. package/types/sap.fe.semantics.d.ts +1 -1
  10. package/types/sap.fe.templates.d.ts +1 -1
  11. package/types/sap.fe.test.d.ts +1 -1
  12. package/types/sap.fe.tools.d.ts +1 -1
  13. package/types/sap.gantt.d.ts +1 -1
  14. package/types/sap.m.d.ts +1 -1
  15. package/types/sap.makit.d.ts +1 -1
  16. package/types/sap.me.d.ts +1 -1
  17. package/types/sap.ndc.d.ts +1 -1
  18. package/types/sap.ovp.d.ts +1 -1
  19. package/types/sap.sac.grid.d.ts +1 -1
  20. package/types/sap.suite.ui.commons.d.ts +1 -1
  21. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  22. package/types/sap.suite.ui.microchart.d.ts +1 -1
  23. package/types/sap.tnt.d.ts +1 -1
  24. package/types/sap.ui.codeeditor.d.ts +1 -1
  25. package/types/sap.ui.commons.d.ts +1 -1
  26. package/types/sap.ui.comp.d.ts +1 -1
  27. package/types/sap.ui.core.d.ts +1 -1
  28. package/types/sap.ui.dt.d.ts +1 -1
  29. package/types/sap.ui.export.d.ts +3 -3
  30. package/types/sap.ui.fl.d.ts +5 -1
  31. package/types/sap.ui.integration.d.ts +1 -1
  32. package/types/sap.ui.layout.d.ts +1 -1
  33. package/types/sap.ui.mdc.d.ts +1 -1
  34. package/types/sap.ui.richtexteditor.d.ts +1 -1
  35. package/types/sap.ui.rta.d.ts +1 -1
  36. package/types/sap.ui.suite.d.ts +1 -1
  37. package/types/sap.ui.support.d.ts +6 -6
  38. package/types/sap.ui.table.d.ts +1 -1
  39. package/types/sap.ui.testrecorder.d.ts +1 -1
  40. package/types/sap.ui.unified.d.ts +1 -1
  41. package/types/sap.ui.ux3.d.ts +1 -1
  42. package/types/sap.uiext.inbox.d.ts +1 -1
  43. package/types/sap.ushell.d.ts +1 -1
  44. package/types/sap.ushell_abap.d.ts +1 -1
  45. package/types/sap.uxap.d.ts +1 -1
  46. package/types/sap.viz.d.ts +1 -1
  47. package/types/sap.zen.commons.d.ts +19 -11
  48. package/types/sap.zen.crosstab.d.ts +3 -886
  49. package/types/sap.zen.dsh.d.ts +64 -2943
  50. /package/types/{sap.fe.macros.d.ts → sap.fe.macros-1.96.34-esm-d.ts} +0 -0
  51. /package/types/{sap.fe.placeholder.d.ts → sap.fe.placeholder-1.96.34-esm-d.ts} +0 -0
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.96.38
1
+ // For Library Version: 1.96.39
2
2
 
3
3
  declare module "sap/zen/dsh/library" {}
4
4
 
@@ -15,7 +15,8 @@ declare module "sap/zen/dsh/AnalyticGrid" {
15
15
 
16
16
  /**
17
17
  * @SINCE 1.46
18
- * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
18
+ * @deprecated (since 1.89) - this library is deprecated and has been replaced by Web Dynpro-based apps
19
+ * in S/4HANA.
19
20
  * @EXPERIMENTAL (since 1.46)
20
21
  *
21
22
  * Control for embedding a Design Studio Analytic Grid in an S/4 HANA Fiori application
@@ -391,259 +392,6 @@ declare module "sap/zen/dsh/AnalyticGrid" {
391
392
  }
392
393
  }
393
394
 
394
- declare module "sap/zen/dsh/Axis" {
395
- /**
396
- * Axis of a multidimensional Result Set
397
- */
398
- enum Axis {
399
- /**
400
- * Columns axis (horizontal direction in a Grid)
401
- */
402
- Columns = "Columns",
403
- /**
404
- * Free axis (contains all dimensions that can be placed on the row/column axis)
405
- */
406
- Free = "Free",
407
- /**
408
- * Repository axis (contains all dimensions that cannot be placed on the row/column axis, but are used in
409
- * the variables/parameters of the query assigned to a dataprovider aggregated in the `sap.zen.dsh.OlapModel`)
410
- */
411
- Repository = "Repository",
412
- /**
413
- * Row axis (vertical direction in a Grid)
414
- */
415
- Rows = "Rows",
416
- }
417
- export default Axis;
418
- }
419
-
420
- declare module "sap/zen/dsh/ComparisonOperator" {
421
- /**
422
- * @EXPERIMENTAL (since 1.89)
423
- *
424
- * Comparison Operator used e.g. in the dynamic filter or in a varible value
425
- */
426
- enum ComparisonOperator {
427
- "NON-AGGREGATED" = "undefined",
428
- /**
429
- * Between Interval definition
430
- */
431
- BETWEEN = "undefined",
432
- /**
433
- * Between excluding, complement of an interval
434
- */
435
- BETWEEN_EXCLUDING = "undefined",
436
- /**
437
- * Equal
438
- */
439
- EQUAL = "undefined",
440
- /**
441
- * Fuzzy similar
442
- */
443
- FUZZY = "undefined",
444
- /**
445
- * Greater equal
446
- */
447
- GREATER_EQUAL = "undefined",
448
- /**
449
- * Greater than
450
- */
451
- GREATER_THAN = "undefined",
452
- /**
453
- * In
454
- */
455
- IN = "undefined",
456
- /**
457
- * Is null
458
- */
459
- IS_NULL = "undefined",
460
- /**
461
- * Less or Equal
462
- */
463
- LESS_EQUAL = "undefined",
464
- /**
465
- * Less than
466
- */
467
- LESS_THAN = "undefined",
468
- /**
469
- * Like (simple pattern matching)
470
- */
471
- LIKE = "undefined",
472
- /**
473
- * Match (pattern matching)
474
- */
475
- MATCH = "undefined",
476
- /**
477
- * Not Between
478
- */
479
- NOT_BETWEEN = "undefined",
480
- /**
481
- * Not between
482
- */
483
- NOT_BETWEEN_EXCLUDING = "undefined",
484
- /**
485
- * Not equal
486
- */
487
- NOT_EQUAL = "undefined",
488
- /**
489
- * Not match
490
- */
491
- NOT_MATCH = "undefined",
492
- /**
493
- * Search
494
- */
495
- SEARCH = "undefined",
496
- }
497
- export default ComparisonOperator;
498
- }
499
-
500
- declare module "sap/zen/dsh/DataSourceType" {
501
- /**
502
- * Type of a DataSource
503
- */
504
- enum DataSourceType {
505
- /**
506
- * cdsprojectionview
507
- */
508
- cdsprojectionview = "cdsprojectionview",
509
- /**
510
- * Ina Model
511
- */
512
- inamodel = "inamodel",
513
- /**
514
- * infoprovider
515
- */
516
- infoprovider = "infoprovider",
517
- /**
518
- * Query
519
- */
520
- query = "query",
521
- /**
522
- * View
523
- */
524
- view = "view",
525
- }
526
- export default DataSourceType;
527
- }
528
-
529
- declare module "sap/zen/dsh/DimensionType" {
530
- /**
531
- * Type of a Dimension
532
- */
533
- enum DimensionType {
534
- /**
535
- * Abstract Structure
536
- */
537
- AbstractStructure = "AbstractStructure",
538
- /**
539
- * Account Dimension
540
- */
541
- AccountDimension = "AccountDimension",
542
- /**
543
- * Attribute Dimension
544
- */
545
- AttributeDimension = "AttributeDimension",
546
- /**
547
- * Calculated Dimension
548
- */
549
- CalculatedDimension = "CalculatedDimension",
550
- /**
551
- * Container Dimension
552
- */
553
- ContainerDimension = "ContainerDimension",
554
- /**
555
- * Currency Dimension
556
- */
557
- CurrencyDimension = "CurrencyDimension",
558
- /**
559
- * Date Dimension
560
- */
561
- DateDimension = "DateDimension",
562
- /**
563
- * Dimension
564
- */
565
- Dimension = "Dimension",
566
- /**
567
- * Incomplete Dimension
568
- */
569
- DimensionIncomplete = "DimensionIncomplete",
570
- /**
571
- * Geo Dimension
572
- */
573
- GisDimension = "GisDimension",
574
- /**
575
- * Hierarchy Name Dimension
576
- */
577
- HierarchyNameDimension = "HierarchyNameDimension",
578
- /**
579
- * Hierarchy Version Dimension
580
- */
581
- HierarchyVersionDimension = "HierarchyVersionDimension",
582
- /**
583
- * Measure Dimension
584
- */
585
- MeasureStructure = "MeasureStructure",
586
- /**
587
- * Presentation Dimension
588
- */
589
- PresentationDimension = "PresentationDimension",
590
- /**
591
- * Search Dimension
592
- */
593
- SearchDimension = "SearchDimension",
594
- /**
595
- * Search Result Dimension
596
- */
597
- SearchResultDimension = "SearchResultDimension",
598
- /**
599
- * Non Measure Structure
600
- */
601
- SecondaryStructure = "SecondaryStructure",
602
- /**
603
- * Time Dimension
604
- */
605
- TimeDimension = "TimeDimension",
606
- /**
607
- * Unit Dimension
608
- */
609
- UnitDimension = "UnitDimension",
610
- /**
611
- * Version Dimension
612
- */
613
- VersionDimension = "VersionDimension",
614
- }
615
- export default DimensionType;
616
- }
617
-
618
- declare module "sap/zen/dsh/DisplayType" {
619
- /**
620
- * Display Type of a Dimension Member
621
- */
622
- enum DisplayType {
623
- /**
624
- * Display the key of the member
625
- */
626
- Key = "Key",
627
- /**
628
- * Display the key and then the text of the member
629
- */
630
- KeyText = "KeyText",
631
- /**
632
- * Do not display the member
633
- */
634
- None = "None",
635
- /**
636
- * Display the (possible language dependant) text of the member
637
- */
638
- Text = "Text",
639
- /**
640
- * Display the text and then the key of the member
641
- */
642
- TextKey = "TextKey",
643
- }
644
- export default DisplayType;
645
- }
646
-
647
395
  declare module "sap/zen/dsh/Dsh" {
648
396
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
649
397
 
@@ -655,7 +403,8 @@ declare module "sap/zen/dsh/Dsh" {
655
403
 
656
404
  /**
657
405
  * @SINCE 1.44
658
- * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
406
+ * @deprecated (since 1.89) - this library is deprecated and has been replaced by Web Dynpro-based apps
407
+ * in S/4HANA.
659
408
  *
660
409
  * Control for embedding a Design Studio application full-screen in an S/4 HANA Fiori application
661
410
  */
@@ -943,2458 +692,144 @@ declare module "sap/zen/dsh/Dsh" {
943
692
  /**
944
693
  * Sets a new value for property {@link #getLanguage language}.
945
694
  *
946
- * the language
947
- *
948
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
949
- */
950
- setLanguage(
951
- /**
952
- * New value for property `language`
953
- */
954
- sLanguage?: string
955
- ): this;
956
- /**
957
- * Sets a new value for property {@link #getProtocol protocol}.
958
- *
959
- * the protocol
960
- *
961
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
962
- */
963
- setProtocol(
964
- /**
965
- * New value for property `protocol`
966
- */
967
- sProtocol?: string
968
- ): this;
969
- /**
970
- * Sets a new value for property {@link #getRepoPath repoPath}.
971
- *
972
- * Path to application specified by dshAppName
973
- *
974
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
975
- */
976
- setRepoPath(
977
- /**
978
- * New value for property `repoPath`
979
- */
980
- sRepoPath?: string
981
- ): this;
982
- /**
983
- * Sets a new value for property {@link #getSemanticMappings semanticMappings}.
984
- *
985
- * the semantic mappings
986
- *
987
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
988
- */
989
- setSemanticMappings(
990
- /**
991
- * New value for property `semanticMappings`
992
- */
993
- oSemanticMappings?: object
994
- ): this;
995
- /**
996
- * Sets a new value for property {@link #getSystemAlias systemAlias}.
997
- *
998
- * the system alias
999
- *
1000
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1001
- */
1002
- setSystemAlias(
1003
- /**
1004
- * New value for property `systemAlias`
1005
- */
1006
- sSystemAlias?: string
1007
- ): this;
1008
- /**
1009
- * Sets a new value for property {@link #getWidth width}.
1010
- *
1011
- * Desired width of the Design Studio Control
1012
- *
1013
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1014
- */
1015
- setWidth(
1016
- /**
1017
- * New value for property `width`
1018
- */
1019
- sWidth?: CSSSize
1020
- ): this;
1021
- }
1022
-
1023
- export interface $DshSettings extends $ControlSettings {
1024
- /**
1025
- * Name of the Design Studio application to be opened.
1026
- */
1027
- dshAppName?: string | PropertyBindingInfo;
1028
-
1029
- /**
1030
- * Path to application specified by dshAppName
1031
- */
1032
- repoPath?: string | PropertyBindingInfo;
1033
-
1034
- /**
1035
- * Desired width of the Design Studio Control
1036
- */
1037
- width?: CSSSize | PropertyBindingInfo;
1038
-
1039
- /**
1040
- * Desired height of the Design Studio Control
1041
- */
1042
- height?: CSSSize | PropertyBindingInfo;
1043
-
1044
- /**
1045
- * the type of deployment
1046
- */
1047
- deployment?: string | PropertyBindingInfo;
1048
-
1049
- /**
1050
- * the protocol
1051
- */
1052
- protocol?: string | PropertyBindingInfo;
1053
-
1054
- /**
1055
- * the client
1056
- */
1057
- client?: string | PropertyBindingInfo;
1058
-
1059
- /**
1060
- * the language
1061
- */
1062
- language?: string | PropertyBindingInfo;
1063
-
1064
- /**
1065
- * the semantic mappings
1066
- */
1067
- semanticMappings?: object | PropertyBindingInfo;
1068
-
1069
- /**
1070
- * the application component
1071
- */
1072
- appComponent?: object | PropertyBindingInfo;
1073
-
1074
- /**
1075
- * whether to defer the creation
1076
- */
1077
- deferCreation?: boolean | PropertyBindingInfo;
1078
-
1079
- /**
1080
- * the system alias
1081
- */
1082
- systemAlias?: string | PropertyBindingInfo;
1083
- }
1084
- }
1085
-
1086
- declare module "sap/zen/dsh/InACard/Component" {
1087
- import {
1088
- default as UIComponent,
1089
- $UIComponentSettings,
1090
- } from "sap/ui/core/UIComponent";
1091
-
1092
- import ComponentMetadata from "sap/ui/core/ComponentMetadata";
1093
-
1094
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1095
-
1096
- /**
1097
- * @SINCE 1.91
1098
- * @EXPERIMENTAL
1099
- *
1100
- * Card Component.
1101
- */
1102
- export default class Component extends UIComponent {
1103
- /**
1104
- * Creates and initializes a new sap.zen.dsh.InACard component. Such a card component displays the resultset
1105
- * of a dataProvider in an overview page settings.
1106
- *
1107
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1108
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1109
- * of the syntax of the settings object.
1110
- */
1111
- constructor();
1112
-
1113
- /**
1114
- * Creates a new subclass of class sap.zen.dsh.InACard.Component with name `sClassName` and enriches it
1115
- * with the information contained in `oClassInfo`.
1116
- *
1117
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
1118
- */
1119
- static extend<T extends Record<string, unknown>>(
1120
- /**
1121
- * Name of the class being created
1122
- */
1123
- sClassName: string,
1124
- /**
1125
- * Object literal with information about the class
1126
- */
1127
- oClassInfo?: sap.ClassInfo<T, Component>,
1128
- /**
1129
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1130
- * used by this class
1131
- */
1132
- FNMetaImpl?: Function
1133
- ): Function;
1134
- /**
1135
- * Returns a metadata object for class sap.zen.dsh.InACard.Component.
1136
- */
1137
- static getMetadata(): ComponentMetadata;
1138
- /**
1139
- * Gets current value of property {@link #getContentFragment contentFragment}.
1140
- *
1141
- * fragment for the inner Card Control
1142
- *
1143
- * Default value is `"sap.zen.dsh.InACard.fragment.InACard"`.
1144
- */
1145
- getContentFragment(): string;
1146
- /**
1147
- * Gets current value of property {@link #getControllerName controllerName}.
1148
- *
1149
- * Controller of the Widget inside the Card
1150
- *
1151
- * Default value is `"sap.zen.dsh.InACard.controller.InACard"`.
1152
- */
1153
- getControllerName(): string;
1154
- /**
1155
- * Gets current value of property {@link #getDataProviderName dataProviderName}.
1156
- *
1157
- * Name of the Data Provider within {sap.zen.dsh.olap.OlapModel} with name `om`, which is displayed and
1158
- * available for interactions
1159
- */
1160
- getDataProviderName(): string;
1161
- /**
1162
- * Gets current value of property {@link #getFooterFragment footerFragment}.
1163
- *
1164
- * Fragment that is used for the footer of the Card
1165
- *
1166
- * Default value is `empty string`.
1167
- */
1168
- getFooterFragment(): string;
1169
- /**
1170
- * Gets current value of property {@link #getWidgetType widgetType}.
1171
- *
1172
- * Type of the Widget that is displayed in the Card
1173
- *
1174
- * Default value is `"pivot"`.
1175
- */
1176
- getWidgetType(): string;
1177
- /**
1178
- * Sets a new value for property {@link #getContentFragment contentFragment}.
1179
- *
1180
- * fragment for the inner Card Control
1181
- *
1182
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1183
- *
1184
- * Default value is `"sap.zen.dsh.InACard.fragment.InACard"`.
1185
- */
1186
- setContentFragment(
1187
- /**
1188
- * New value for property `contentFragment`
1189
- */
1190
- sContentFragment?: string
1191
- ): this;
1192
- /**
1193
- * Sets a new value for property {@link #getControllerName controllerName}.
1194
- *
1195
- * Controller of the Widget inside the Card
1196
- *
1197
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1198
- *
1199
- * Default value is `"sap.zen.dsh.InACard.controller.InACard"`.
1200
- */
1201
- setControllerName(
1202
- /**
1203
- * New value for property `controllerName`
1204
- */
1205
- sControllerName?: string
1206
- ): this;
1207
- /**
1208
- * Sets a new value for property {@link #getDataProviderName dataProviderName}.
1209
- *
1210
- * Name of the Data Provider within {sap.zen.dsh.olap.OlapModel} with name `om`, which is displayed and
1211
- * available for interactions
1212
- *
1213
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1214
- */
1215
- setDataProviderName(
1216
- /**
1217
- * New value for property `dataProviderName`
1218
- */
1219
- sDataProviderName: string
1220
- ): this;
1221
- /**
1222
- * Sets a new value for property {@link #getFooterFragment footerFragment}.
1223
- *
1224
- * Fragment that is used for the footer of the Card
1225
- *
1226
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1227
- *
1228
- * Default value is `empty string`.
1229
- */
1230
- setFooterFragment(
1231
- /**
1232
- * New value for property `footerFragment`
1233
- */
1234
- sFooterFragment?: string
1235
- ): this;
1236
- /**
1237
- * Sets a new value for property {@link #getWidgetType widgetType}.
1238
- *
1239
- * Type of the Widget that is displayed in the Card
1240
- *
1241
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1242
- *
1243
- * Default value is `"pivot"`.
1244
- */
1245
- setWidgetType(
1246
- /**
1247
- * New value for property `widgetType`
1248
- */
1249
- sWidgetType?: string
1250
- ): this;
1251
- }
1252
-
1253
- export interface $ComponentSettings extends $UIComponentSettings {
1254
- /**
1255
- * fragment for the inner Card Control
1256
- */
1257
- contentFragment?: string | PropertyBindingInfo;
1258
-
1259
- /**
1260
- * Controller of the Widget inside the Card
1261
- */
1262
- controllerName?: string | PropertyBindingInfo;
1263
-
1264
- /**
1265
- * Fragment that is used for the footer of the Card
1266
- */
1267
- footerFragment?: string | PropertyBindingInfo;
1268
-
1269
- /**
1270
- * Type of the Widget that is displayed in the Card
1271
- */
1272
- widgetType?: string | PropertyBindingInfo;
1273
-
1274
- /**
1275
- * Name of the Data Provider within {sap.zen.dsh.olap.OlapModel} with name `om`, which is displayed and
1276
- * available for interactions
1277
- */
1278
- dataProviderName?: string | PropertyBindingInfo;
1279
- }
1280
- }
1281
-
1282
- declare module "sap/zen/dsh/InATile" {
1283
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1284
-
1285
- import DataSourceType from "sap/zen/dsh/DataSourceType";
1286
-
1287
- import ElementMetadata from "sap/ui/core/ElementMetadata";
1288
-
1289
- import ProtocolType from "sap/zen/dsh/ProtocolType";
1290
-
1291
- import SystemType from "sap/zen/dsh/SystemType";
1292
-
1293
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1294
-
1295
- /**
1296
- * @EXPERIMENTAL (since 1.91)
1297
- *
1298
- * Launcher tile that displays the total of a Data Provider of an OlapModel
1299
- */
1300
- export default class InATile extends Control {
1301
- /**
1302
- * Constructor for a new `InATile`.
1303
- *
1304
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1305
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1306
- * of the syntax of the settings object.
1307
- */
1308
- constructor(
1309
- /**
1310
- * Initial settings for the new control
1311
- */
1312
- mSettings?: $InATileSettings
1313
- );
1314
- /**
1315
- * Constructor for a new `InATile`.
1316
- *
1317
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1318
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1319
- * of the syntax of the settings object.
1320
- */
1321
- constructor(
1322
- /**
1323
- * ID for the new control, generated automatically if no ID is given
1324
- */
1325
- sId?: string,
1326
- /**
1327
- * Initial settings for the new control
1328
- */
1329
- mSettings?: $InATileSettings
1330
- );
1331
-
1332
- /**
1333
- * Creates a new subclass of class sap.zen.dsh.InATile with name `sClassName` and enriches it with the information
1334
- * contained in `oClassInfo`.
1335
- *
1336
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1337
- */
1338
- static extend<T extends Record<string, unknown>>(
1339
- /**
1340
- * Name of the class being created
1341
- */
1342
- sClassName: string,
1343
- /**
1344
- * Object literal with information about the class
1345
- */
1346
- oClassInfo?: sap.ClassInfo<T, InATile>,
1347
- /**
1348
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1349
- * used by this class
1350
- */
1351
- FNMetaImpl?: Function
1352
- ): Function;
1353
- /**
1354
- * Returns a metadata object for class sap.zen.dsh.InATile.
1355
- */
1356
- static getMetadata(): ElementMetadata;
1357
- /**
1358
- * Gets current value of property {@link #getClient client}.
1359
- *
1360
- * the client of the service of the datasource (only relevant for abap based analytical engines)#ToDo: Make
1361
- * optional
1362
- */
1363
- getClient(): string;
1364
- /**
1365
- * Gets current value of property {@link #getDataSourceName dataSourceName}.
1366
- *
1367
- * the name of the datasource
1368
- */
1369
- getDataSourceName(): string;
1370
- /**
1371
- * Gets current value of property {@link #getDataSourceType dataSourceType}.
1372
- *
1373
- * the type of the datasource
1374
- */
1375
- getDataSourceType(): DataSourceType | keyof typeof DataSourceType;
1376
- /**
1377
- * Gets current value of property {@link #getHost host}.
1378
- *
1379
- * the host of the datasource, falsy means use the origin of the website as domain
1380
- */
1381
- getHost(): string;
1382
- /**
1383
- * Gets current value of property {@link #getPackageName packageName}.
1384
- *
1385
- * the package of the datasource #ToDo: Make optional
1386
- */
1387
- getPackageName(): string;
1388
- /**
1389
- * Gets current value of property {@link #getPath path}.
1390
- *
1391
- * the path to the service of the datasource
1392
- */
1393
- getPath(): string;
1394
- /**
1395
- * Gets current value of property {@link #getPort port}.
1396
- *
1397
- * the port of the service of the datasource
1398
- *
1399
- * Default value is `443`.
1400
- */
1401
- getPort(): int;
1402
- /**
1403
- * Gets current value of property {@link #getProtocolType protocolType}.
1404
- *
1405
- * the protocol type of the service of the datasource#ToDo: Make optional
1406
- */
1407
- getProtocolType(): ProtocolType | keyof typeof ProtocolType;
1408
- /**
1409
- * Gets current value of property {@link #getSchemaName schemaName}.
1410
- *
1411
- * the schema of the datasource
1412
- */
1413
- getSchemaName(): string;
1414
- /**
1415
- * Gets current value of property {@link #getSystemName systemName}.
1416
- *
1417
- * the system name of the service of the datasource
1418
- *
1419
- * Default value is `"localAbapAnalyticEngine"`.
1420
- */
1421
- getSystemName(): string;
1422
- /**
1423
- * Gets current value of property {@link #getSystemType systemType}.
1424
- *
1425
- * the system type of the service of the datasource
1426
- */
1427
- getSystemType(): SystemType | keyof typeof SystemType;
1428
- /**
1429
- * Gets current value of property {@link #getWidgetType widgetType}.
1430
- *
1431
- * Type of the Widget that is displayed in the Tile
1432
- *
1433
- * Default value is `"pivot"`.
1434
- */
1435
- getWidgetType(): string;
1436
- /**
1437
- * Sets a new value for property {@link #getClient client}.
1438
- *
1439
- * the client of the service of the datasource (only relevant for abap based analytical engines)#ToDo: Make
1440
- * optional
1441
- *
1442
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1443
- */
1444
- setClient(
1445
- /**
1446
- * New value for property `client`
1447
- */
1448
- sClient: string
1449
- ): this;
1450
- /**
1451
- * Sets a new value for property {@link #getDataSourceName dataSourceName}.
1452
- *
1453
- * the name of the datasource
1454
- *
1455
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1456
- */
1457
- setDataSourceName(
1458
- /**
1459
- * New value for property `dataSourceName`
1460
- */
1461
- sDataSourceName: string
1462
- ): this;
1463
- /**
1464
- * Sets a new value for property {@link #getDataSourceType dataSourceType}.
1465
- *
1466
- * the type of the datasource
1467
- *
1468
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1469
- */
1470
- setDataSourceType(
1471
- /**
1472
- * New value for property `dataSourceType`
1473
- */
1474
- sDataSourceType: DataSourceType | keyof typeof DataSourceType
1475
- ): this;
1476
- /**
1477
- * Sets a new value for property {@link #getHost host}.
1478
- *
1479
- * the host of the datasource, falsy means use the origin of the website as domain
1480
- *
1481
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1482
- */
1483
- setHost(
1484
- /**
1485
- * New value for property `host`
1486
- */
1487
- sHost: string
1488
- ): this;
1489
- /**
1490
- * Sets a new value for property {@link #getPackageName packageName}.
1491
- *
1492
- * the package of the datasource #ToDo: Make optional
1493
- *
1494
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1495
- */
1496
- setPackageName(
1497
- /**
1498
- * New value for property `packageName`
1499
- */
1500
- sPackageName: string
1501
- ): this;
1502
- /**
1503
- * Sets a new value for property {@link #getPath path}.
1504
- *
1505
- * the path to the service of the datasource
1506
- *
1507
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1508
- */
1509
- setPath(
1510
- /**
1511
- * New value for property `path`
1512
- */
1513
- sPath: string
1514
- ): this;
1515
- /**
1516
- * Sets a new value for property {@link #getPort port}.
1517
- *
1518
- * the port of the service of the datasource
1519
- *
1520
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1521
- *
1522
- * Default value is `443`.
1523
- */
1524
- setPort(
1525
- /**
1526
- * New value for property `port`
1527
- */
1528
- iPort?: int
1529
- ): this;
1530
- /**
1531
- * Sets a new value for property {@link #getProtocolType protocolType}.
1532
- *
1533
- * the protocol type of the service of the datasource#ToDo: Make optional
1534
- *
1535
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1536
- */
1537
- setProtocolType(
1538
- /**
1539
- * New value for property `protocolType`
1540
- */
1541
- sProtocolType: ProtocolType | keyof typeof ProtocolType
1542
- ): this;
1543
- /**
1544
- * Sets a new value for property {@link #getSchemaName schemaName}.
1545
- *
1546
- * the schema of the datasource
1547
- *
1548
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1549
- */
1550
- setSchemaName(
1551
- /**
1552
- * New value for property `schemaName`
1553
- */
1554
- sSchemaName: string
1555
- ): this;
1556
- /**
1557
- * Sets a new value for property {@link #getSystemName systemName}.
1558
- *
1559
- * the system name of the service of the datasource
1560
- *
1561
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1562
- *
1563
- * Default value is `"localAbapAnalyticEngine"`.
1564
- */
1565
- setSystemName(
1566
- /**
1567
- * New value for property `systemName`
1568
- */
1569
- sSystemName?: string
1570
- ): this;
1571
- /**
1572
- * Sets a new value for property {@link #getSystemType systemType}.
1573
- *
1574
- * the system type of the service of the datasource
1575
- *
1576
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1577
- */
1578
- setSystemType(
1579
- /**
1580
- * New value for property `systemType`
1581
- */
1582
- sSystemType: SystemType | keyof typeof SystemType
1583
- ): this;
1584
- /**
1585
- * Sets a new value for property {@link #getWidgetType widgetType}.
1586
- *
1587
- * Type of the Widget that is displayed in the Tile
1588
- *
1589
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1590
- *
1591
- * Default value is `"pivot"`.
1592
- */
1593
- setWidgetType(
1594
- /**
1595
- * New value for property `widgetType`
1596
- */
1597
- sWidgetType?: string
1598
- ): this;
1599
- }
1600
-
1601
- export interface $InATileSettings extends $ControlSettings {
1602
- /**
1603
- * the host of the datasource, falsy means use the origin of the website as domain
1604
- */
1605
- host?: string | PropertyBindingInfo;
1606
-
1607
- /**
1608
- * the port of the service of the datasource
1609
- */
1610
- port?: int | PropertyBindingInfo;
1611
-
1612
- /**
1613
- * the path to the service of the datasource
1614
- */
1615
- path?: string | PropertyBindingInfo;
1616
-
1617
- /**
1618
- * the system type of the service of the datasource
1619
- */
1620
- systemType?: (SystemType | keyof typeof SystemType) | PropertyBindingInfo;
1621
-
1622
- /**
1623
- * the system name of the service of the datasource
1624
- */
1625
- systemName?: string | PropertyBindingInfo;
1626
-
1627
- /**
1628
- * the protocol type of the service of the datasource#ToDo: Make optional
1629
- */
1630
- protocolType?:
1631
- | (ProtocolType | keyof typeof ProtocolType)
1632
- | PropertyBindingInfo;
1633
-
1634
- /**
1635
- * the client of the service of the datasource (only relevant for abap based analytical engines)#ToDo: Make
1636
- * optional
1637
- */
1638
- client?: string | PropertyBindingInfo;
1639
-
1640
- /**
1641
- * the name of the datasource
1642
- */
1643
- dataSourceName?: string | PropertyBindingInfo;
1644
-
1645
- /**
1646
- * the type of the datasource
1647
- */
1648
- dataSourceType?:
1649
- | (DataSourceType | keyof typeof DataSourceType)
1650
- | PropertyBindingInfo;
1651
-
1652
- /**
1653
- * the package of the datasource #ToDo: Make optional
1654
- */
1655
- packageName?: string | PropertyBindingInfo;
1656
-
1657
- /**
1658
- * the schema of the datasource
1659
- */
1660
- schemaName?: string | PropertyBindingInfo;
1661
-
1662
- /**
1663
- * Type of the Widget that is displayed in the Tile
1664
- */
1665
- widgetType?: string | PropertyBindingInfo;
1666
- }
1667
- }
1668
-
1669
- declare module "sap/zen/dsh/MemberType" {
1670
- /**
1671
- * Type of a Member
1672
- */
1673
- enum MemberType {
1674
- /**
1675
- * Basic Measure
1676
- */
1677
- BasicMeasure = "BasicMeasure",
1678
- /**
1679
- * Condition Others Result
1680
- */
1681
- ConditionOthersResult = "ConditionOthersResult",
1682
- /**
1683
- * Condition Result
1684
- */
1685
- ConditionResult = "ConditionResult",
1686
- /**
1687
- * Currency Measure
1688
- */
1689
- CurrencyMeasure = "CurrencyMeasure",
1690
- /**
1691
- * Drill Path Element
1692
- */
1693
- DrillPathElement = "DrillPathElement",
1694
- /**
1695
- * Exception Aggregation
1696
- */
1697
- ExceptionAggregation = "ExceptionAggregation",
1698
- /**
1699
- * Field Value
1700
- */
1701
- FieldValue = "FieldValue",
1702
- /**
1703
- * Formula Member
1704
- */
1705
- FormulaMember = "FormulaMember",
1706
- /**
1707
- * Hierarchy Node
1708
- */
1709
- HierarchyNode = "HierarchyNode",
1710
- /**
1711
- * Literal Member
1712
- */
1713
- LiteralMember = "LiteralMember",
1714
- /**
1715
- * Measure
1716
- */
1717
- Measure = "Measure",
1718
- /**
1719
- * Member
1720
- */
1721
- Member = "Member",
1722
- /**
1723
- * Members Exit
1724
- */
1725
- MembersExit = "MembersExit",
1726
- /**
1727
- * Restricted Measure
1728
- */
1729
- RestrictedMeasure = "RestrictedMeasure",
1730
- /**
1731
- * Result Member
1732
- */
1733
- ResultMember = "ResultMember",
1734
- /**
1735
- * Select Value
1736
- */
1737
- SelectValue = "SelectValue",
1738
- /**
1739
- * Server Based Formula
1740
- */
1741
- ServerBasedFormula = "ServerBasedFormula",
1742
- /**
1743
- * Single Member Exit
1744
- */
1745
- SingleMemberExit = "SingleMemberExit",
1746
- /**
1747
- * Tuple Element
1748
- */
1749
- TupleElement = "TupleElement",
1750
- /**
1751
- * Tuple Element as Member
1752
- */
1753
- TupleElementAsMember = "TupleElementAsMember",
1754
- /**
1755
- * Tuple Element as Node
1756
- */
1757
- TupleElementAsNode = "TupleElementAsNode",
1758
- /**
1759
- * Value Help Element
1760
- */
1761
- ValueHelpElement = "ValueHelpElement",
1762
- /**
1763
- * Value Help Leaf
1764
- */
1765
- ValueHelpLeaf = "ValueHelpLeaf",
1766
- /**
1767
- * Value Help Node
1768
- */
1769
- ValueHelpNode = "ValueHelpNode",
1770
- /**
1771
- * Value Help Root Node
1772
- */
1773
- ValueHelpRootNode = "ValueHelpRootNode",
1774
- /**
1775
- * Value Help Splitter Node
1776
- */
1777
- ValueHelpSplitterNode = "ValueHelpSplitterNode",
1778
- /**
1779
- * Value Help Window Splitter Node
1780
- */
1781
- ValueHelpWindowSplitterNode = "ValueHelpWindowSplitterNode",
1782
- /**
1783
- * Variance
1784
- */
1785
- Variance = "Variance",
1786
- }
1787
- export default MemberType;
1788
- }
1789
-
1790
- declare module "sap/zen/dsh/NavigationCommandType" {
1791
- /**
1792
- * Types of navigation commands.
1793
- */
1794
- enum NavigationCommandType {
1795
- /**
1796
- * Click on a cell
1797
- */
1798
- CellClick = "CellClick",
1799
- /**
1800
- * request for additional columns
1801
- */
1802
- ColumnRequest = "ColumnRequest",
1803
- /**
1804
- * Context menu entry
1805
- */
1806
- ContextMenuCmd = "ContextMenuCmd",
1807
- /**
1808
- * Hierachy drill operation
1809
- */
1810
- HierarchyNavigation = "HierarchyNavigation",
1811
- /**
1812
- * request for additional rows
1813
- */
1814
- RowRequest = "RowRequest",
1815
- }
1816
- export default NavigationCommandType;
1817
- }
1818
-
1819
- declare module "sap/zen/dsh/olap/DataProvider" {
1820
- import OlapModel from "sap/zen/dsh/olap/OlapModel";
1821
-
1822
- import Format from "sap/zen/commons/Format";
1823
-
1824
- import SortType from "sap/zen/dsh/SortType";
1825
-
1826
- import SortDirection from "sap/zen/dsh/SortDirection";
1827
-
1828
- /**
1829
- * A `DataProvider` is referencing a CDS view that is annotated as an AnalyitcQuery.
1830
- *
1831
- * Instances of this class should only be created by the {sap.zen.dsh.olap.OlapModel}. The `OlapModel` populates
1832
- * it's exposed data via Binding to Controls. The structure of data exposed by a DataProvider
1833
- * is as follows:
1834
- *
1835
- * **Structure of Exposed Data**
1836
- *
1837
- *
1838
- * - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `DataProvider`
1839
- * - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
1840
- * `Name`: the external name of the dimension `Description`: the language dependant description of
1841
- * the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
1842
- *
1843
- * - RowsDimensions: The list of all Dimensions lying on the Rows Axis
1844
- * Name: the external name of the dimension Description: the language dependant description of the
1845
- * dimension IsStructure: boolean flag indicating whether the dimension is a structure *
1846
- * - ColumnsDimensions: The list of all Dimensions lying on the Columns Axis
1847
- * Name: the external name of the dimension Description: the language dependant description of the
1848
- * dimension IsStructure: boolean flag indicating whether the dimension is a structure
1849
- * - Conditions: list of conditions (result set filters)
1850
- * - Exceptions: list of exceptions (conditional formats)
1851
- * - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
1852
- */
1853
- export default class DataProvider {
1854
- /**
1855
- * Constructor for a new DataProvider.
1856
- *
1857
- * A DataProvider represents a navigatable queryManager and allows to access and change data from servers
1858
- * providing the InA Protocol.
1859
- */
1860
- constructor(
1861
- /**
1862
- * the model to which the DataProvider belongs
1863
- */
1864
- oOlapModel: OlapModel,
1865
- /**
1866
- * name of the DataProvider
1867
- */
1868
- sDataProviderName: string,
1869
- /**
1870
- * Update function for the variable collection of the `OlapModel`
1871
- */
1872
- fVariableUpdater: Function,
1873
- /**
1874
- * update function for update state
1875
- */
1876
- fUndoUpdater: Function,
1877
- /**
1878
- * the firefly application associated to the `OlapModel`
1879
- */
1880
- oApplication: object,
1881
- /**
1882
- * the firefly queryManager that is wrapped by the `DataProvider`
1883
- */
1884
- oQueryManager: object
1885
- );
1886
-
1887
- /**
1888
- * add a new condition (aka resultset filter).
1889
- */
1890
- addCondition(
1891
- /**
1892
- * Condition Definiton
1893
- */
1894
- oData: object,
1895
- /**
1896
- * Target state of the condition
1897
- */
1898
- bActive: boolean
1899
- ): Promise<this>;
1900
- /**
1901
- * Do a drill operation on a dimension member on an Axis
1902
- */
1903
- drill(
1904
- /**
1905
- * the external name of the Dimension
1906
- */
1907
- sDim: string,
1908
- /**
1909
- * the Tuple Index of the member in the resultset.
1910
- */
1911
- nIndex: int
1912
- ): this;
1913
- /**
1914
- * Exchange the axis and position of two dimensions
1915
- */
1916
- exchange(
1917
- /**
1918
- * the external name of the first Dimension
1919
- */
1920
- sDim1: string,
1921
- /**
1922
- * the external name of the second Dimension
1923
- */
1924
- sDim2: string
1925
- ): Promise<this>;
1926
- /**
1927
- * Filter a dimension by one member and drillown another dimension
1928
- */
1929
- filterAndDrillDown(
1930
- /**
1931
- * the external name of the Dimension to be filtered
1932
- */
1933
- sDim1: string,
1934
- /**
1935
- * the filter
1936
- */
1937
- sMember: string,
1938
- /**
1939
- * the dimension to be drilled
1940
- */
1941
- sDim2: string
1942
- ): this;
1943
- /**
1944
- * Gets the scaling factor of a measure or data cell
1945
- */
1946
- getDecimalPlaces(
1947
- /**
1948
- * the Member of the Measure Structure
1949
- */
1950
- sMeasureMember: string,
1951
- /**
1952
- * the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
1953
- */
1954
- sNonMeasureMember: string
1955
- ): int;
1956
- /**
1957
- * get the list of filters of a dimension
1958
- */
1959
- getFilterOfDim(
1960
- /**
1961
- * the name of the dimension from which the filter is retrieved
1962
- */
1963
- sDim: string
1964
- ): object[];
1965
- /**
1966
- * get the current resultset from the InA Server
1967
- */
1968
- getResultSet(): Promise<this>;
1969
- /**
1970
- * get the list of the jump targets associated to a datacell defined via the report report interface.
1971
- */
1972
- getRRITargets(
1973
- /**
1974
- * Row of the data cell
1975
- */
1976
- nRow: int,
1977
- /**
1978
- * Column of the data cell
1979
- */
1980
- nColumn: int
1981
- ): Promise<this>;
1982
- /**
1983
- * Gets the scaling factor of a measure
1984
- */
1985
- getScalingFactor(
1986
- /**
1987
- * the Member of the Measure Structure
1988
- */
1989
- sMeasureMember: string,
1990
- /**
1991
- * the Member of the Non Measure Structure
1992
- */
1993
- sNonMeasureMember: string
1994
- ): int;
1995
- /**
1996
- * hasVariable Checks whether a Variable is influencing the DataProvider
1997
- */
1998
- hasVariable(
1999
- /**
2000
- * Name of the Variable
2001
- */
2002
- the: string
2003
- ): boolean;
2004
- /**
2005
- * move a dimension one position down on it's axis
2006
- */
2007
- moveDown(
2008
- /**
2009
- * name of the dimension
2010
- */
2011
- sName: string,
2012
- /**
2013
- * Target state of the condition
2014
- */
2015
- bActive: boolean
2016
- ): this;
2017
- /**
2018
- * move a dimension one position up on it's axis
2019
- */
2020
- moveUp(
2021
- /**
2022
- * name of the dimension
2023
- */
2024
- sName: string,
2025
- /**
2026
- * Target state of the condition
2027
- */
2028
- bActive: boolean
2029
- ): this;
2030
- /**
2031
- * Open a dialog that allows to display and change the property of an `Axis` of the `DataProvider`.
2032
- */
2033
- openAxisDialog(
2034
- /**
2035
- * the external name of the Dimension
2036
- */
2037
- sDim: string
2038
- ): Promise<boolean>;
2039
- /**
2040
- * Open a dialog that allows to display and change the property of a `Query Cell` of the `DataProvider`.
2041
- */
2042
- openCellDialog(
2043
- /**
2044
- * the external name of the first structure
2045
- */
2046
- sDim1?: string,
2047
- /**
2048
- * the external name of the member of the first structure
2049
- */
2050
- sMem1?: string,
2051
- /**
2052
- * the external name of the second structure
2053
- */
2054
- sDim2?: string,
2055
- /**
2056
- * the external name of the member of the second structure
2057
- */
2058
- sMem2?: string
2059
- ): Promise<this>;
2060
- /**
2061
- * Open a dialog that allows to create a new Condition. That is a criterium on measure values for result
2062
- * set filtering.
2063
- */
2064
- openConditionDialog(): Promise<this>;
2065
- /**
2066
- * open the dialog that allows to create a new Formula.
2067
- */
2068
- openCreateFormulaDialog(
2069
- /**
2070
- * the external name of the structure on which the new restriction is created
2071
- */
2072
- sDim: string
2073
- ): Promise<this>;
2074
- /**
2075
- * open the dialog that allows to create a new restriction.
2076
- */
2077
- openCreateRestrictionDialog(
2078
- /**
2079
- * the external name of the structure on which the new restriction is created
2080
- */
2081
- sDim: string,
2082
- /**
2083
- * the external name of the member that will be restricted
2084
- */
2085
- sMember: string
2086
- ): Promise<this>;
2087
- /**
2088
- * Open a dialog that allows to display and change the currency translation settings of the `DataProvider`.
2089
- */
2090
- openCurrencyTranslationDialog(): Promise<boolean>;
2091
- /**
2092
- * Open a dialog to display and change the settings of a dimension of the `DataProvider`
2093
- */
2094
- openDimDialog(
2095
- /**
2096
- * the external name of the Dimension
2097
- */
2098
- sDim: string
2099
- ): Promise<boolean>;
2100
- /**
2101
- * Open a dialog that allows to create a new Exception. That is a criterium for conditional formatting.
2102
- */
2103
- openExceptionDialog(): Promise<boolean>;
2104
- /**
2105
- * Open a dialog to display and change the filter on a dimension of the `DataProvider`
2106
- */
2107
- openSelector(
2108
- /**
2109
- * the external name of the Dimension
2110
- */
2111
- sDimensionName: string
2112
- ): Promise<any>;
2113
- /**
2114
- * Remove the filter of a dimension
2115
- */
2116
- removeFilter(
2117
- /**
2118
- * the external name
2119
- */
2120
- sDim: string
2121
- ): this;
2122
- /**
2123
- * Distribute the dimension among the rows and columns
2124
- */
2125
- setAxesLayout(
2126
- /**
2127
- * an Object containing a `rows` member referencing a string array containing the names of the dimensions
2128
- * and a `columns` member referencing a string array containing the dimension on the columns. The order
2129
- * in the array control the positon on the axis.
2130
- */
2131
- mLayout: object
2132
- ): this;
2133
- /**
2134
- * set the state of a condition (aka result set filter).
2135
- */
2136
- setConditionActive(
2137
- /**
2138
- * name of the condition
2139
- */
2140
- sName: string,
2141
- /**
2142
- * Target state of the condition
2143
- */
2144
- bActive: boolean
2145
- ): Promise<this>;
2146
- /**
2147
- * Sets the number of decimal of a measure/query cell
2148
- */
2149
- setDecimalPlaces(
2150
- /**
2151
- * number of the decimal palaces to be shown after the separator
2152
- */
2153
- nNumberOfDecimalPlaces: int,
2154
- /**
2155
- * the Member of the Measure Structure
2156
- */
2157
- sMeasureMember: string,
2158
- /**
2159
- * Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
2160
- */
2161
- the: string
2162
- ): this;
2163
- /**
2164
- * Set Display Hierachy
2165
- */
2166
- setDisplayHierarchy(
2167
- /**
2168
- * the external name of the structure on which the new restriction is created
2169
- */
2170
- sDim: string,
2171
- /**
2172
- * whether the hierarchy should be activated
2173
- */
2174
- bActive: boolean,
2175
- /**
2176
- * the name of the hierarchy (optional)
2177
- */
2178
- sHierachy: string,
2179
- /**
2180
- * the version of the hierarchy (optional)
2181
- */
2182
- sVersion: string
2183
- ): this;
2184
- /**
2185
- * set the state of an exception (aka conditional format).
2186
- */
2187
- setExceptionActive(
2188
- /**
2189
- * name of the exception
2190
- */
2191
- sName: string,
2192
- /**
2193
- * Target state of the exception
2194
- */
2195
- bActive: boolean
2196
- ): Promise<this>;
2197
- /**
2198
- * Set the filter for a dimension
2199
- */
2200
- setFilter(
2201
- /**
2202
- * the external name
2203
- */
2204
- sDim: string,
2205
- /**
2206
- * the filter
2207
- */
2208
- oFilter: object
2209
- ): undefined;
2210
- /**
2211
- * sets the format property of the dataprovider, this can influence the resultset that is aggregated in
2212
- * the `Grid.Cells` collection. Its main purpose is to influence the visualisation of a `sap.zen.dsh.PivotTable`
2213
- */
2214
- setFormat(
2215
- /**
2216
- * the format to be used
2217
- */
2218
- sFormat: Format | keyof typeof Format
2219
- ): void;
2220
- /**
2221
- * set a data value to an input entabled cell
2222
- */
2223
- setPlanValue(
2224
- /**
2225
- * Index of the data cell in the Grid aggregation of the `DataProvider`
2226
- */
2227
- nIndex: int,
2228
- /**
2229
- * the new value of the data cell
2230
- */
2231
- fValue: float
2232
- ): void;
2233
- /**
2234
- * Sets the scaling factor of a measure/query cell
2235
- */
2236
- setScalingFactor(
2237
- /**
2238
- * the exponential of the scaling factor
2239
- */
2240
- nFactor: int,
2241
- /**
2242
- * the Member of the Measure Structure
2243
- */
2244
- sMeasureMember: string,
2245
- /**
2246
- * the Member of the Non Measure Structure
2247
- */
2248
- sNonMeasureMember: string
2249
- ): this;
2250
- /**
2251
- * Sort the members of a dimension
2252
- */
2253
- sort(
2254
- /**
2255
- * the external name of the Dimension
2256
- */
2257
- sDim: string,
2258
- /**
2259
- * of sorting
2260
- */
2261
- type: SortType | keyof typeof SortType,
2262
- /**
2263
- * of sorting
2264
- */
2265
- direction: SortDirection | keyof typeof SortDirection,
2266
- /**
2267
- * in case of a structure the measure according to which is sorted
2268
- */
2269
- sMember?: string
2270
- ): Promise<this>;
2271
- /**
2272
- * submit the value of the input enabled queries to the InA Server
2273
- */
2274
- submitVariables(): Promise<this>;
2275
- /**
2276
- * suppress a unit/currency from being populated to the result cells
2277
- */
2278
- suppressUnit(
2279
- /**
2280
- * the key of the suppressed unit
2281
- */
2282
- sUnit: string
2283
- ): this;
2284
- /**
2285
- * retrieve the data of the current naviation state `DataProvider` from the InA Server.
2286
- */
2287
- synchronize(): Promise<this>;
2288
- /**
2289
- * Move a dimension to the columns axis
2290
- */
2291
- toColumns(
2292
- /**
2293
- * the external name of the Dimension
2294
- */
2295
- sDim: string
2296
- ): this;
2297
- /**
2298
- * Move a dimension to the rows axis
2299
- */
2300
- toRows(
2301
- /**
2302
- * the external name of the Dimension
2303
- */
2304
- sDim: string
2305
- ): this;
2306
- /**
2307
- * transfer the entered data values to the InA Server
2308
- */
2309
- transferValue(): Promise<this>;
2310
- }
2311
- }
2312
-
2313
- declare module "sap/zen/dsh/olap/OlapListBinding" {
2314
- import ListBinding from "sap/ui/model/ListBinding";
2315
-
2316
- import Metadata from "sap/ui/base/Metadata";
2317
-
2318
- /**
2319
- * List binding implementation for `OlapModel`.
2320
- */
2321
- export default class OlapListBinding extends ListBinding {
2322
- /**
2323
- * Creates a new OlapListBinding.
2324
- *
2325
- * This constructor should only be called by subclasses or model implementations, not by application or
2326
- * control code. Such code should use {@link sap.zen.dsh.olap.OlapModel#bindList OlapModel#bindList} on
2327
- * the corresponding model instance instead.
2328
- */
2329
- constructor();
2330
-
2331
- /**
2332
- * Creates a new subclass of class sap.zen.dsh.olap.OlapListBinding with name `sClassName` and enriches
2333
- * it with the information contained in `oClassInfo`.
2334
- *
2335
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
2336
- */
2337
- static extend<T extends Record<string, unknown>>(
2338
- /**
2339
- * Name of the class being created
2340
- */
2341
- sClassName: string,
2342
- /**
2343
- * Object literal with information about the class
2344
- */
2345
- oClassInfo?: sap.ClassInfo<T, OlapListBinding>,
2346
- /**
2347
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2348
- * used by this class
2349
- */
2350
- FNMetaImpl?: Function
2351
- ): Function;
2352
- /**
2353
- * Returns a metadata object for class sap.zen.dsh.olap.OlapListBinding.
2354
- */
2355
- static getMetadata(): Metadata;
2356
- }
2357
- }
2358
-
2359
- declare module "sap/zen/dsh/olap/OlapListGridBinding" {
2360
- import ListBinding from "sap/ui/model/ListBinding";
2361
-
2362
- /**
2363
- * List binding implementation for `OlapModel`.
2364
- */
2365
- export default class OlapListGridBinding extends ListBinding {
2366
- /**
2367
- * Creates a new OlapListGridBinding.
2368
- *
2369
- * This constructor should only be called by subclasses or model implementations, not by application or
2370
- * control code. Such code should use {@link sap.zen.dsh.OlapModel#bindList OlapModel#bindList} on the corresponding
2371
- * model instance instead.
2372
- */
2373
- constructor();
2374
- }
2375
- }
2376
-
2377
- declare module "sap/zen/dsh/olap/OlapModel" {
2378
- import Model from "sap/ui/model/Model";
2379
-
2380
- import DataProvider from "sap/zen/dsh/olap/DataProvider";
2381
-
2382
- import Event from "sap/ui/base/Event";
2383
-
2384
- import Metadata from "sap/ui/base/Metadata";
2385
-
2386
- /**
2387
- * Model implementation for InA provider
2388
- *
2389
- * The OlapModel can populate it's exposed data via Binding to Controls. The structure of the exposed data
2390
- * is as follows: **Structure of Exposed Data**
2391
- *
2392
- *
2393
- * - FlatVariables: The list of all input ready variables collected from all aggregated `DataProvider`
2394
- *
2395
- * - DataProvider: The associative array of all `DataProvider` aggregated by the semanticStyles:
2396
- * The associative array of all `SemanticStyle` for the `OlapModel` Messages: The list of all messages
2397
- * posted by the Analytical Engine
2398
- */
2399
- export default class OlapModel extends Model {
2400
- /**
2401
- * Constructor for a new OlapMode.
2402
- *
2403
- * The Olap Model allows to access and change data from servers providing the InA Protocol.
2404
- *
2405
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2406
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2407
- * of the syntax of the settings object.
2408
- */
2409
- constructor(
2410
- /**
2411
- * the settings for the new Olap Model.
2412
- * systemLandscape: The list of addressable Analytic Engines dataProvider: The associative array of
2413
- * all `DataProvider` aggregated by the
2414
- */
2415
- mSettings?: object
2416
- );
2417
-
2418
- /**
2419
- * Creates a new subclass of class sap.zen.dsh.olap.OlapModel with name `sClassName` and enriches it with
2420
- * the information contained in `oClassInfo`.
2421
- *
2422
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
2423
- */
2424
- static extend<T extends Record<string, unknown>>(
2425
- /**
2426
- * Name of the class being created
2427
- */
2428
- sClassName: string,
2429
- /**
2430
- * Object literal with information about the class
2431
- */
2432
- oClassInfo?: sap.ClassInfo<T, OlapModel>,
2433
- /**
2434
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2435
- * used by this class
2436
- */
2437
- FNMetaImpl?: Function
2438
- ): Function;
2439
- /**
2440
- * Returns a metadata object for class sap.zen.dsh.olap.OlapModel.
2441
- */
2442
- static getMetadata(): Metadata;
2443
-
2444
- addFunction(
2445
- /**
2446
- * the name of the data function
2447
- */
2448
- sName: string,
2449
- /**
2450
- * the description of the data function
2451
- */
2452
- sText: string
2453
- ): OlapModel;
2454
- /**
2455
- * adds a new query as a new `DataProvider` . The query is supposed to be defined as an analytical annotated
2456
- * CDS View the naem of the query is the name of the DDIC view, prefixed by "2C"
2457
- */
2458
- addQuery(
2459
- /**
2460
- * the name of the new `DataProvider`.
2461
- */
2462
- sDataProviderName: string,
2463
- /**
2464
- * the name of the query which the `DataProvider` is supposed to expose.
2465
- */
2466
- sQueryName: string,
2467
- /**
2468
- * the name of the system in the landscape
2469
- */
2470
- sSystem?: string,
2471
- /**
2472
- * the name of the package
2473
- */
2474
- sPackage?: string,
2475
- /**
2476
- * the name of the schema
2477
- */
2478
- sSchema?: string,
2479
- /**
2480
- * the name of the type of the datasource
2481
- */
2482
- sType?: string
2483
- ): Promise<DataProvider>;
2484
- /**
2485
- * adds a new query as a new System to the System Landscape . The parameter should have the following properties:
2486
- *
2487
- * - systemName <- the name of the system
2488
- * - systemType <- "BW" | "HANA" | "DWC"
2489
- * - host <- the host of the system
2490
- * - port <- the port protocol <- "HTTP" | "HTTPS" client <- the client of the ABAP system
2491
- */
2492
- addSystem(
2493
- /**
2494
- * The Definition of the system
2495
- */
2496
- mSystem: object
2497
- ): Promise<DataProvider>;
2498
- /**
2499
- * Attaches event handler `fnFunction` to the {@link #event:metadataFailed metadataFailed} event of this
2500
- * `sap.zen.dsh.olap.OlapModel`.
2501
- *
2502
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2503
- * otherwise it will be bound to this `sap.zen.dsh.olap.OlapModel` itself.
2504
- */
2505
- attachMetadataFailed(
2506
- /**
2507
- * An application-specific payload object that will be passed to the event handler along with the event
2508
- * object when firing the event
2509
- */
2510
- oData: object,
2511
- /**
2512
- * The function to be called when the event occurs
2513
- */
2514
- fnFunction: (p1: Event) => void,
2515
- /**
2516
- * Context object to call the event handler with. Defaults to this `sap.zen.dsh.olap.OlapModel` itself
2517
- */
2518
- oListener?: object
2519
- ): this;
2520
- /**
2521
- * Attaches event handler `fnFunction` to the {@link #event:metadataFailed metadataFailed} event of this
2522
- * `sap.zen.dsh.olap.OlapModel`.
2523
- *
2524
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2525
- * otherwise it will be bound to this `sap.zen.dsh.olap.OlapModel` itself.
2526
- */
2527
- attachMetadataFailed(
2528
- /**
2529
- * The function to be called when the event occurs
2530
- */
2531
- fnFunction: (p1: Event) => void,
2532
- /**
2533
- * Context object to call the event handler with. Defaults to this `sap.zen.dsh.olap.OlapModel` itself
2534
- */
2535
- oListener?: object
2536
- ): this;
2537
- /**
2538
- * deserialize the Model with all aggregated `DataProvider` The `OlapModel` be be deserialized from an equivalent
2539
- * such Object.
2540
- */
2541
- deserialize(): object;
2542
- /**
2543
- * Detaches event handler `fnFunction` from the {@link #event:metadataFailed metadataFailed} event of this
2544
- * `sap.zen.dsh.olap.OlapModel`.
2545
- *
2546
- * The passed function and listener object must match the ones used for event registration.
2547
- */
2548
- detachMetadataFailed(
2549
- /**
2550
- * The function to be called, when the event occurs
2551
- */
2552
- fnFunction: (p1: Event) => void,
2553
- /**
2554
- * Context object on which the given function had to be called
2555
- */
2556
- oListener?: object
2557
- ): this;
2558
- /**
2559
- * exports the Olap Model to excel
2560
- */
2561
- exportToExcel(
2562
- /**
2563
- * the Name of the exported Workbook
2564
- */
2565
- WorkbookName: string
2566
- ): Promise<this>;
2567
- /**
2568
- * Fires event {@link #event:metadataFailed metadataFailed} to attached listeners.
2569
- */
2570
- fireMetadataFailed(
2571
- /**
2572
- * Parameters to pass along with the event
2573
- */
2574
- mParameters?: object
2575
- ): this;
2576
- /**
2577
- * retrieves a `DataProvider` aggregated by the `OlapModel`. sQueryName, sSystem
2578
- */
2579
- getDataProvider(
2580
- /**
2581
- * the name of the `DataProvider`.
2582
- */
2583
- sDataProviderName: string
2584
- ): DataProvider;
2585
-
2586
- getLimit(): object;
2587
- /**
2588
- * retreive the list of data functions matching a given text
2589
- */
2590
- getPlanningFunctionCatalog(
2591
- /**
2592
- * the pattern that the description of the data function must match
2593
- */
2594
- sText: string
2595
- ): Promise<Object[]>;
2596
- /**
2597
- * Display a dialog to allow the user to select an Analytic Query, returns a Promise containing the name,
2598
- * if the user does not choose an Analytic Query, then the promise is rejected
2599
- */
2600
- openQueryDialog(): Promise<string>;
2601
- /**
2602
- * Display a dialog to allow the user to select a data function, returns a Promise containing the name,
2603
- * if the user does not choose a data function, then the promise is rejected
2604
- */
2605
- openSelectFunction(): Promise<string>;
2606
- /**
2607
- * Let the user choose a value for a variable in a dialog
2608
- */
2609
- openVariableSelector(
2610
- /**
2611
- * the name of the variable
2612
- */
2613
- sVar: string
2614
- ): Promise<string>;
2615
- /**
2616
- * Process a data function, in case the function requires additional values, prompt the use in a dialogue
2617
- */
2618
- processServiceFunction(
2619
- /**
2620
- * the name of the data function
2621
- */
2622
- sServiceName: string
2623
- ): Promise<this>;
2624
- /**
2625
- * Process a data sequence, in case the sequence requires additional values, prompt the use in a dialogue
2626
- */
2627
- processServiceSequence(
2628
- /**
2629
- * the name of the data function
2630
- */
2631
- sServiceName: string
2632
- ): Promise<this>;
2633
-
2634
- removeFunction(
2635
- /**
2636
- * the name of the data function
2637
- */
2638
- sName: string
2639
- ): OlapModel;
2640
- /**
2641
- * Reset the data buffer
2642
- */
2643
- resetBuffer(): Promise<this>;
2644
- /**
2645
- * Reset the Olap Model to the default query
2646
- */
2647
- resetModel(): void;
2648
- /**
2649
- * Save the data buffer
2650
- */
2651
- saveBuffer(): Promise<this>;
2652
- /**
2653
- * serialize the Model with all aggregated `DataProvider` The `OlapModel` be be deserialized from an equivalent
2654
- * such Object.
2655
- */
2656
- serialize(): object;
2657
-
2658
- setLimit(
2659
- /**
2660
- * the limit of the rows and columns that are exposed for bindings
2661
- */
2662
- oLimit: object
2663
- ): OlapModel;
2664
- /**
2665
- * Replace all input enabled variables with their entered values for all datat providers
2666
- */
2667
- submitVariables(): Promise<this>;
2668
- /**
2669
- * snychronize all aggregated dataproviders if the user does not choose an Analytic Query, then the promise
2670
- * is rejected
2671
- */
2672
- synchronize(
2673
- /**
2674
- * List of data provider that are to be synchronized (all if not supplied)
2675
- */
2676
- aDataProviderNames: string[]
2677
- ): Promise<OlapModel>;
2678
- /**
2679
- * undoes the last navigation step.
2680
- */
2681
- undo(): Promise<this>;
2682
- }
2683
- }
2684
-
2685
- declare module "sap/zen/dsh/olap/OlapPropertyBinding" {
2686
- import ListBinding from "sap/ui/model/ListBinding";
2687
-
2688
- /**
2689
- * Property binding implementation for `OlapModel`.
2690
- */
2691
- export default class OlapPropertyBinding extends ListBinding {
2692
- /**
2693
- * Creates a new OlapPropertyBinding.
2694
- *
2695
- * This constructor should only be called by subclasses or model implementations, not by application or
2696
- * control code. Such code should use {@link sap.zen.dsh.OlapModel#bindProperty OlapModel#bindProperty}
2697
- * on the corresponding model instance instead.
2698
- */
2699
- constructor();
2700
- }
2701
- }
2702
-
2703
- declare module "sap/zen/dsh/PivotTable" {
2704
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
2705
-
2706
- import Event from "sap/ui/base/Event";
2707
-
2708
- import NavigationCommandType from "sap/zen/dsh/NavigationCommandType";
2709
-
2710
- import Format from "sap/zen/commons/Format";
2711
-
2712
- import ElementMetadata from "sap/ui/core/ElementMetadata";
2713
-
2714
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2715
-
2716
- /**
2717
- * Enables users to view, navigate and change multidimensional data exposed via InA in a PivotTable.
2718
- *
2719
- * Overview:
2720
- *
2721
- * The user can view the data in the Pivot Table, navigate in the data via a context menu or enter data
2722
- * in input enables cells cells.
2723
- *
2724
- * Usage:
2725
- *
2726
- * The `PivotTable` is mimicked after the OData Smart Controls. Instead of OData they bind against an {sap.zen.dsh.olap.OlapModel}
2727
- * with the name "om". Each Analytical Query in the `Olap Model` is exposed as a DataProvider. The data
2728
- * provider that the PivotTable consumes needs to be provided as a property value.
2729
- */
2730
- export default class PivotTable extends Control {
2731
- /**
2732
- * Constructor for a new `PivotTable`.
2733
- *
2734
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2735
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2736
- * of the syntax of the settings object.
2737
- */
2738
- constructor(
2739
- /**
2740
- * Initial settings for the new control
2741
- */
2742
- mSettings?: $PivotTableSettings
2743
- );
2744
- /**
2745
- * Constructor for a new `PivotTable`.
2746
- *
2747
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2748
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2749
- * of the syntax of the settings object.
2750
- */
2751
- constructor(
2752
- /**
2753
- * ID for the new control, generated automatically if no ID is given
2754
- */
2755
- sId?: string,
2756
- /**
2757
- * Initial settings for the new control
2758
- */
2759
- mSettings?: $PivotTableSettings
2760
- );
2761
-
2762
- /**
2763
- * Creates a new subclass of class sap.zen.dsh.PivotTable with name `sClassName` and enriches it with the
2764
- * information contained in `oClassInfo`.
2765
- *
2766
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2767
- */
2768
- static extend<T extends Record<string, unknown>>(
2769
- /**
2770
- * Name of the class being created
2771
- */
2772
- sClassName: string,
2773
- /**
2774
- * Object literal with information about the class
2775
- */
2776
- oClassInfo?: sap.ClassInfo<T, PivotTable>,
2777
- /**
2778
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2779
- * used by this class
2780
- */
2781
- FNMetaImpl?: Function
2782
- ): Function;
2783
- /**
2784
- * Returns a metadata object for class sap.zen.dsh.PivotTable.
2785
- */
2786
- static getMetadata(): ElementMetadata;
2787
- /**
2788
- * Attaches event handler `fnFunction` to the {@link #event:navigationCmd navigationCmd} event of this `sap.zen.dsh.PivotTable`.
2789
- *
2790
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2791
- * otherwise it will be bound to this `sap.zen.dsh.PivotTable` itself.
2792
- *
2793
- * Fired when a user launches a navigation command
2794
- */
2795
- attachNavigationCmd(
2796
- /**
2797
- * An application-specific payload object that will be passed to the event handler along with the event
2798
- * object when firing the event
2799
- */
2800
- oData: object,
2801
- /**
2802
- * The function to be called when the event occurs
2803
- */
2804
- fnFunction: (p1: Event) => void,
2805
- /**
2806
- * Context object to call the event handler with. Defaults to this `sap.zen.dsh.PivotTable` itself
2807
- */
2808
- oListener?: object
2809
- ): this;
2810
- /**
2811
- * Attaches event handler `fnFunction` to the {@link #event:navigationCmd navigationCmd} event of this `sap.zen.dsh.PivotTable`.
2812
- *
2813
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2814
- * otherwise it will be bound to this `sap.zen.dsh.PivotTable` itself.
2815
- *
2816
- * Fired when a user launches a navigation command
2817
- */
2818
- attachNavigationCmd(
2819
- /**
2820
- * The function to be called when the event occurs
2821
- */
2822
- fnFunction: (p1: Event) => void,
2823
- /**
2824
- * Context object to call the event handler with. Defaults to this `sap.zen.dsh.PivotTable` itself
2825
- */
2826
- oListener?: object
2827
- ): this;
2828
- /**
2829
- * Detaches event handler `fnFunction` from the {@link #event:navigationCmd navigationCmd} event of this
2830
- * `sap.zen.dsh.PivotTable`.
2831
- *
2832
- * The passed function and listener object must match the ones used for event registration.
2833
- */
2834
- detachNavigationCmd(
2835
- /**
2836
- * The function to be called, when the event occurs
2837
- */
2838
- fnFunction: (p1: Event) => void,
2839
- /**
2840
- * Context object on which the given function had to be called
2841
- */
2842
- oListener?: object
2843
- ): this;
2844
- /**
2845
- * Fires event {@link #event:navigationCmd navigationCmd} to attached listeners.
2846
- */
2847
- fireNavigationCmd(
2848
- /**
2849
- * Parameters to pass along with the event
2850
- */
2851
- mParameters?: {
2852
- /**
2853
- * The control in the cell on which the command was initiated
2854
- */
2855
- anchor?: Control;
2856
- /**
2857
- * Type of the navigation command: Context Menu, Drill, Row/Col request, Data Entry
2858
- */
2859
- navigationCmdType?:
2860
- | NavigationCommandType
2861
- | keyof typeof NavigationCommandType;
2862
- /**
2863
- * The Row and Column Selection of the cell on which the command was initiated
2864
- */
2865
- selection?: object;
2866
- /**
2867
- * the function that executed the command. The function will return a Promise that resolves/rejects when
2868
- * the command execution finished.
2869
- */
2870
- cmd?: Function;
2871
- }
2872
- ): this;
2873
- /**
2874
- * Gets current value of property {@link #getDataProviderName dataProviderName}.
2875
- *
2876
- * Name of the Data Provider within {sap.zen.dsh.olap.OlapModel} with name `om`, which is displayed and
2877
- * available for interactions
2878
- *
2879
- * Default value is `"0"`.
2880
- */
2881
- getDataProviderName(): string;
2882
- /**
2883
- * Gets current value of property {@link #getFormat format}.
2884
- *
2885
- * Property for different table formats
2886
- *
2887
- * Default value is `ExcelStyle`.
2888
- */
2889
- getFormat(): Format | keyof typeof Format;
2890
- /**
2891
- * Sets a new value for property {@link #getDataProviderName dataProviderName}.
2892
- *
2893
- * Name of the Data Provider within {sap.zen.dsh.olap.OlapModel} with name `om`, which is displayed and
2894
- * available for interactions
2895
- *
2896
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2897
- *
2898
- * Default value is `"0"`.
2899
- */
2900
- setDataProviderName(
2901
- /**
2902
- * New value for property `dataProviderName`
2903
- */
2904
- sDataProviderName?: string
2905
- ): this;
2906
- /**
2907
- * Sets a new value for property {@link #getFormat format}.
2908
- *
2909
- * Property for different table formats
2910
- *
2911
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2912
- *
2913
- * Default value is `ExcelStyle`.
2914
- */
2915
- setFormat(
2916
- /**
2917
- * New value for property `format`
2918
- */
2919
- sFormat?: Format | keyof typeof Format
2920
- ): this;
2921
- }
2922
-
2923
- export interface $PivotTableSettings extends $ControlSettings {
2924
- /**
2925
- * Name of the Data Provider within {sap.zen.dsh.olap.OlapModel} with name `om`, which is displayed and
2926
- * available for interactions
2927
- */
2928
- dataProviderName?: string | PropertyBindingInfo;
2929
-
2930
- /**
2931
- * Property for different table formats
2932
- */
2933
- format?: (Format | keyof typeof Format) | PropertyBindingInfo;
2934
-
2935
- /**
2936
- * Fired when a user launches a navigation command
2937
- */
2938
- navigationCmd?: (oEvent: Event) => void;
2939
- }
2940
- }
2941
-
2942
- declare module "sap/zen/dsh/ProtocolType" {
2943
- /**
2944
- * Protocol Type
2945
- */
2946
- enum ProtocolType {
2947
- /**
2948
- * HTTP
2949
- */
2950
- HTTP = "HTTP",
2951
- /**
2952
- * HTTPS
2953
- */
2954
- HTTPS = "HTTPS",
2955
- /**
2956
- * WASABI
2957
- */
2958
- WASABI = "WASABI",
2959
- }
2960
- export default ProtocolType;
2961
- }
2962
-
2963
- declare module "sap/zen/dsh/rsrt/Component" {
2964
- import {
2965
- default as UIComponent,
2966
- $UIComponentSettings,
2967
- } from "sap/ui/core/UIComponent";
2968
-
2969
- import DataSourceType from "sap/zen/dsh/DataSourceType";
2970
-
2971
- import ComponentMetadata from "sap/ui/core/ComponentMetadata";
2972
-
2973
- import ProtocolType from "sap/zen/dsh/ProtocolType";
2974
-
2975
- import SystemType from "sap/zen/dsh/SystemType";
2976
-
2977
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
2978
-
2979
- export default class Component extends UIComponent {
2980
- /**
2981
- * RSRT Reporting Server Runtime Test.
2982
- *
2983
- * This `UIComponent` allows for testing navigation in multidimensional data provided by a server implementing
2984
- * the the InA Protocol.
2985
- * It roughly corresponds to the familiar transaction RSRT. Via the `startupParameters` of the `ComponentData the query` can
2986
- * be passed to the component. this query is then assigned to the {sap.zen.dsh.olap.DataProvider} with the
2987
- * name `0` of the {sap.zen.dsh.olap.OlapModel} with the name `om`
2988
- *
2989
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
2990
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2991
- * of the syntax of the settings object.
2992
- */
2993
- constructor();
2994
-
2995
- /**
2996
- * Creates a new subclass of class sap.zen.dsh.rsrt.Component with name `sClassName` and enriches it with
2997
- * the information contained in `oClassInfo`.
2998
- *
2999
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
3000
- */
3001
- static extend<T extends Record<string, unknown>>(
3002
- /**
3003
- * Name of the class being created
3004
- */
3005
- sClassName: string,
3006
- /**
3007
- * Object literal with information about the class
3008
- */
3009
- oClassInfo?: sap.ClassInfo<T, Component>,
3010
- /**
3011
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3012
- * used by this class
3013
- */
3014
- FNMetaImpl?: Function
3015
- ): Function;
3016
- /**
3017
- * Returns a metadata object for class sap.zen.dsh.rsrt.Component.
3018
- */
3019
- static getMetadata(): ComponentMetadata;
3020
- /**
3021
- * Gets current value of property {@link #getClient client}.
3022
- *
3023
- * the client of the service of the datasource (only relevant for abap based analytical engines)#ToDo: Make
3024
- * optional
3025
- */
3026
- getClient(): string;
3027
- /**
3028
- * Gets current value of property {@link #getDataSourceName dataSourceName}.
3029
- *
3030
- * the name of the datasource
3031
- */
3032
- getDataSourceName(): string;
3033
- /**
3034
- * Gets current value of property {@link #getDataSourceType dataSourceType}.
3035
- *
3036
- * the type of the datasource
3037
- */
3038
- getDataSourceType(): DataSourceType | keyof typeof DataSourceType;
3039
- /**
3040
- * Gets current value of property {@link #getHost host}.
3041
- *
3042
- * the host of the datasource, falsy means use the origin of the website as domain
3043
- */
3044
- getHost(): string;
3045
- /**
3046
- * Gets current value of property {@link #getPackageName packageName}.
3047
- *
3048
- * the package of the datasource #ToDo: Make optional
3049
- */
3050
- getPackageName(): string;
3051
- /**
3052
- * Gets current value of property {@link #getPath path}.
3053
- *
3054
- * the path to the service of the datasource
3055
- */
3056
- getPath(): string;
3057
- /**
3058
- * Gets current value of property {@link #getPort port}.
3059
- *
3060
- * the port of the service of the datasource
3061
- *
3062
- * Default value is `443`.
3063
- */
3064
- getPort(): int;
3065
- /**
3066
- * Gets current value of property {@link #getProtocolType protocolType}.
3067
- *
3068
- * the protocol type of the service of the datasource#ToDo: Make optional
3069
- */
3070
- getProtocolType(): ProtocolType | keyof typeof ProtocolType;
3071
- /**
3072
- * Gets current value of property {@link #getSchemaName schemaName}.
3073
- *
3074
- * the schema of the datasource
3075
- */
3076
- getSchemaName(): string;
3077
- /**
3078
- * Gets current value of property {@link #getSystemName systemName}.
3079
- *
3080
- * the system name of the service of the datasource
3081
- *
3082
- * Default value is `"localAbapAnalyticEngine"`.
3083
- */
3084
- getSystemName(): string;
3085
- /**
3086
- * Gets current value of property {@link #getSystemType systemType}.
3087
- *
3088
- * the system type of the service of the datasource
3089
- */
3090
- getSystemType(): SystemType | keyof typeof SystemType;
3091
- /**
3092
- * Sets a new value for property {@link #getClient client}.
3093
- *
3094
- * the client of the service of the datasource (only relevant for abap based analytical engines)#ToDo: Make
3095
- * optional
3096
- *
3097
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3098
- */
3099
- setClient(
3100
- /**
3101
- * New value for property `client`
3102
- */
3103
- sClient: string
3104
- ): this;
3105
- /**
3106
- * Sets a new value for property {@link #getDataSourceName dataSourceName}.
3107
- *
3108
- * the name of the datasource
3109
- *
3110
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3111
- */
3112
- setDataSourceName(
3113
- /**
3114
- * New value for property `dataSourceName`
3115
- */
3116
- sDataSourceName: string
3117
- ): this;
3118
- /**
3119
- * Sets a new value for property {@link #getDataSourceType dataSourceType}.
3120
- *
3121
- * the type of the datasource
3122
- *
3123
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3124
- */
3125
- setDataSourceType(
3126
- /**
3127
- * New value for property `dataSourceType`
3128
- */
3129
- sDataSourceType: DataSourceType | keyof typeof DataSourceType
3130
- ): this;
3131
- /**
3132
- * Sets a new value for property {@link #getHost host}.
3133
- *
3134
- * the host of the datasource, falsy means use the origin of the website as domain
3135
- *
3136
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3137
- */
3138
- setHost(
3139
- /**
3140
- * New value for property `host`
3141
- */
3142
- sHost: string
3143
- ): this;
3144
- /**
3145
- * Sets a new value for property {@link #getPackageName packageName}.
3146
- *
3147
- * the package of the datasource #ToDo: Make optional
3148
- *
3149
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3150
- */
3151
- setPackageName(
3152
- /**
3153
- * New value for property `packageName`
3154
- */
3155
- sPackageName: string
3156
- ): this;
3157
- /**
3158
- * Sets a new value for property {@link #getPath path}.
3159
- *
3160
- * the path to the service of the datasource
695
+ * the language
3161
696
  *
3162
697
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3163
698
  */
3164
- setPath(
699
+ setLanguage(
3165
700
  /**
3166
- * New value for property `path`
701
+ * New value for property `language`
3167
702
  */
3168
- sPath: string
703
+ sLanguage?: string
3169
704
  ): this;
3170
705
  /**
3171
- * Sets a new value for property {@link #getPort port}.
706
+ * Sets a new value for property {@link #getProtocol protocol}.
3172
707
  *
3173
- * the port of the service of the datasource
708
+ * the protocol
3174
709
  *
3175
710
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3176
- *
3177
- * Default value is `443`.
3178
711
  */
3179
- setPort(
712
+ setProtocol(
3180
713
  /**
3181
- * New value for property `port`
714
+ * New value for property `protocol`
3182
715
  */
3183
- iPort?: int
716
+ sProtocol?: string
3184
717
  ): this;
3185
718
  /**
3186
- * Sets a new value for property {@link #getProtocolType protocolType}.
719
+ * Sets a new value for property {@link #getRepoPath repoPath}.
3187
720
  *
3188
- * the protocol type of the service of the datasource#ToDo: Make optional
721
+ * Path to application specified by dshAppName
3189
722
  *
3190
723
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3191
724
  */
3192
- setProtocolType(
725
+ setRepoPath(
3193
726
  /**
3194
- * New value for property `protocolType`
727
+ * New value for property `repoPath`
3195
728
  */
3196
- sProtocolType: ProtocolType | keyof typeof ProtocolType
729
+ sRepoPath?: string
3197
730
  ): this;
3198
731
  /**
3199
- * Sets a new value for property {@link #getSchemaName schemaName}.
732
+ * Sets a new value for property {@link #getSemanticMappings semanticMappings}.
3200
733
  *
3201
- * the schema of the datasource
734
+ * the semantic mappings
3202
735
  *
3203
736
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3204
737
  */
3205
- setSchemaName(
738
+ setSemanticMappings(
3206
739
  /**
3207
- * New value for property `schemaName`
740
+ * New value for property `semanticMappings`
3208
741
  */
3209
- sSchemaName: string
742
+ oSemanticMappings?: object
3210
743
  ): this;
3211
744
  /**
3212
- * Sets a new value for property {@link #getSystemName systemName}.
745
+ * Sets a new value for property {@link #getSystemAlias systemAlias}.
3213
746
  *
3214
- * the system name of the service of the datasource
747
+ * the system alias
3215
748
  *
3216
749
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3217
- *
3218
- * Default value is `"localAbapAnalyticEngine"`.
3219
750
  */
3220
- setSystemName(
751
+ setSystemAlias(
3221
752
  /**
3222
- * New value for property `systemName`
753
+ * New value for property `systemAlias`
3223
754
  */
3224
- sSystemName?: string
755
+ sSystemAlias?: string
3225
756
  ): this;
3226
757
  /**
3227
- * Sets a new value for property {@link #getSystemType systemType}.
758
+ * Sets a new value for property {@link #getWidth width}.
3228
759
  *
3229
- * the system type of the service of the datasource
760
+ * Desired width of the Design Studio Control
3230
761
  *
3231
762
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3232
763
  */
3233
- setSystemType(
764
+ setWidth(
3234
765
  /**
3235
- * New value for property `systemType`
766
+ * New value for property `width`
3236
767
  */
3237
- sSystemType: SystemType | keyof typeof SystemType
768
+ sWidth?: CSSSize
3238
769
  ): this;
3239
770
  }
3240
771
 
3241
- export interface $ComponentSettings extends $UIComponentSettings {
772
+ export interface $DshSettings extends $ControlSettings {
3242
773
  /**
3243
- * the host of the datasource, falsy means use the origin of the website as domain
774
+ * Name of the Design Studio application to be opened.
3244
775
  */
3245
- host?: string | PropertyBindingInfo;
776
+ dshAppName?: string | PropertyBindingInfo;
3246
777
 
3247
778
  /**
3248
- * the port of the service of the datasource
779
+ * Path to application specified by dshAppName
3249
780
  */
3250
- port?: int | PropertyBindingInfo;
781
+ repoPath?: string | PropertyBindingInfo;
3251
782
 
3252
783
  /**
3253
- * the path to the service of the datasource
784
+ * Desired width of the Design Studio Control
3254
785
  */
3255
- path?: string | PropertyBindingInfo;
786
+ width?: CSSSize | PropertyBindingInfo;
3256
787
 
3257
788
  /**
3258
- * the system type of the service of the datasource
789
+ * Desired height of the Design Studio Control
3259
790
  */
3260
- systemType?: (SystemType | keyof typeof SystemType) | PropertyBindingInfo;
791
+ height?: CSSSize | PropertyBindingInfo;
3261
792
 
3262
793
  /**
3263
- * the system name of the service of the datasource
794
+ * the type of deployment
3264
795
  */
3265
- systemName?: string | PropertyBindingInfo;
796
+ deployment?: string | PropertyBindingInfo;
3266
797
 
3267
798
  /**
3268
- * the protocol type of the service of the datasource#ToDo: Make optional
799
+ * the protocol
3269
800
  */
3270
- protocolType?:
3271
- | (ProtocolType | keyof typeof ProtocolType)
3272
- | PropertyBindingInfo;
801
+ protocol?: string | PropertyBindingInfo;
3273
802
 
3274
803
  /**
3275
- * the client of the service of the datasource (only relevant for abap based analytical engines)#ToDo: Make
3276
- * optional
804
+ * the client
3277
805
  */
3278
806
  client?: string | PropertyBindingInfo;
3279
807
 
3280
808
  /**
3281
- * the name of the datasource
3282
- */
3283
- dataSourceName?: string | PropertyBindingInfo;
3284
-
3285
- /**
3286
- * the type of the datasource
3287
- */
3288
- dataSourceType?:
3289
- | (DataSourceType | keyof typeof DataSourceType)
3290
- | PropertyBindingInfo;
3291
-
3292
- /**
3293
- * the package of the datasource #ToDo: Make optional
3294
- */
3295
- packageName?: string | PropertyBindingInfo;
3296
-
3297
- /**
3298
- * the schema of the datasource
809
+ * the language
3299
810
  */
3300
- schemaName?: string | PropertyBindingInfo;
3301
- }
3302
- }
811
+ language?: string | PropertyBindingInfo;
3303
812
 
3304
- declare module "sap/zen/dsh/SemanticRole" {
3305
- /**
3306
- * Semanitc Role of a Dimension Member
3307
- */
3308
- enum SemanticRole {
3309
- /**
3310
- * Actual Data
3311
- */
3312
- Actual = "Actual",
3313
- /**
3314
- * Budget Data
3315
- */
3316
- Budget = "Budget",
3317
813
  /**
3318
- * Forecast Data
3319
- */
3320
- Forecast = "Forecast",
3321
- /**
3322
- * Previous Data
814
+ * the semantic mappings
3323
815
  */
3324
- Previous = "Previous",
3325
- }
3326
- export default SemanticRole;
3327
- }
816
+ semanticMappings?: object | PropertyBindingInfo;
3328
817
 
3329
- declare module "sap/zen/dsh/SortDirection" {
3330
- /**
3331
- * Sort Direction
3332
- */
3333
- enum SortDirection {
3334
818
  /**
3335
- * Ascending
3336
- */
3337
- ASCENDING = "ASCENDING",
3338
- /**
3339
- * Descending
3340
- */
3341
- DESCENDING = "DESCENDING",
3342
- /**
3343
- * No sorting
819
+ * the application component
3344
820
  */
3345
- NONE = "NONE",
3346
- }
3347
- export default SortDirection;
3348
- }
821
+ appComponent?: object | PropertyBindingInfo;
3349
822
 
3350
- declare module "sap/zen/dsh/SortType" {
3351
- /**
3352
- * Sort Type
3353
- */
3354
- enum SortType {
3355
- /**
3356
- * Sort according to Filter
3357
- */
3358
- Filter = "Filter",
3359
- /**
3360
- * Sort according to Key
3361
- */
3362
- MemberKey = "MemberKey",
3363
- /**
3364
- * Sort according to Text
3365
- */
3366
- MemberText = "MemberText",
3367
823
  /**
3368
- * No sorting
824
+ * whether to defer the creation
3369
825
  */
3370
- unset = "unset",
3371
- }
3372
- export default SortType;
3373
- }
826
+ deferCreation?: boolean | PropertyBindingInfo;
3374
827
 
3375
- declare module "sap/zen/dsh/SystemType" {
3376
- /**
3377
- * System Type of an InA System
3378
- */
3379
- enum SystemType {
3380
- /**
3381
- * The ABAP analytic engine
3382
- */
3383
- ABAP_MDS = "ABAP_MDS",
3384
- /**
3385
- * The BW analytic engine
3386
- */
3387
- BW = "BW",
3388
- /**
3389
- * The Data Warehouce Cloud analytic engine
3390
- */
3391
- DWC = "DWC",
3392
828
  /**
3393
- * The in place WASABI Engine
829
+ * the system alias
3394
830
  */
3395
- WASABI = "WASABI",
831
+ systemAlias?: string | PropertyBindingInfo;
3396
832
  }
3397
- export default SystemType;
3398
833
  }
3399
834
 
3400
835
  declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
@@ -3413,7 +848,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
3413
848
  import Control from "sap/ui/core/Control";
3414
849
 
3415
850
  /**
3416
- * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
851
+ * @deprecated (since 1.89) - this library is deprecated and has been replaced by Web Dynpro-based apps
852
+ * in S/4HANA.
3417
853
  *
3418
854
  * The ValueHelpDialog control can be used to implement a value help for an input field.
3419
855
  */
@@ -4390,7 +1826,8 @@ declare module "sap/zen/dsh/widgets/ValueHelpDialog" {
4390
1826
 
4391
1827
  declare module "sap/zen/dsh/ValueHelpRangeOperation" {
4392
1828
  /**
4393
- * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
1829
+ * @deprecated (since 1.89) - this library is deprecated and has been replaced by Web Dynpro-based apps
1830
+ * in S/4HANA.
4394
1831
  * @EXPERIMENTAL
4395
1832
  *
4396
1833
  * Sort Type
@@ -4436,214 +1873,14 @@ declare module "sap/zen/dsh/ValueHelpRangeOperation" {
4436
1873
  export default ValueHelpRangeOperation;
4437
1874
  }
4438
1875
 
4439
- declare module "sap/zen/dsh/ValueType" {
4440
- /**
4441
- * Sort Type
4442
- */
4443
- enum ValueType {
4444
- /**
4445
- * Amount
4446
- */
4447
- Amount = "Amount",
4448
- /**
4449
- * Array
4450
- */
4451
- Array = "Array",
4452
- /**
4453
- * Boolean
4454
- */
4455
- Boolean = "Boolean",
4456
- /**
4457
- * Byte Array
4458
- */
4459
- ByteArray = "ByteArray",
4460
- /**
4461
- * Calendar Date
4462
- */
4463
- CalendarDate = "CalendarDate",
4464
- /**
4465
- * Calendar Day
4466
- */
4467
- CalendarDay = "CalendarDay",
4468
- /**
4469
- * Character
4470
- */
4471
- Char = "Char",
4472
- /**
4473
- * Currency
4474
- */
4475
- Cuky = "Cuky",
4476
- /**
4477
- * Current Member
4478
- */
4479
- CurrentMember = "CurrentMember",
4480
- /**
4481
- * Date
4482
- */
4483
- Date = "Date",
4484
- /**
4485
- * Date Time
4486
- */
4487
- DateTime = "DateTime",
4488
- /**
4489
- * Decimal Float
4490
- */
4491
- DecimalFloat = "DecimalFloat",
4492
- /**
4493
- * Dimension Member
4494
- */
4495
- DimensionMember = "DimensionMember",
4496
- /**
4497
- * Double
4498
- */
4499
- Double = "Double",
4500
- /**
4501
- * Enum Constant
4502
- */
4503
- EnumConstant = "EnumConstant",
4504
- /**
4505
- * Integer
4506
- */
4507
- Integer = "Integer",
4508
- /**
4509
- * Key Value
4510
- */
4511
- KeyValue = "KeyValue",
4512
- /**
4513
- * Language
4514
- */
4515
- Language = "Language",
4516
- /**
4517
- * Line String
4518
- */
4519
- LineString = "LineString",
4520
- /**
4521
- * List
4522
- */
4523
- List = "List",
4524
- /**
4525
- * Long
4526
- */
4527
- Long = "Long",
4528
- /**
4529
- * Lower Case String
4530
- */
4531
- LowerCaseString = "LowerCaseString",
4532
- /**
4533
- * Multi Line String
4534
- */
4535
- MultiLineString = "MultiLineString",
4536
- /**
4537
- * Multi Point
4538
- */
4539
- MultiPoint = "MultiPoint",
4540
- /**
4541
- * Multi Polygon
4542
- */
4543
- MultiPolygon = "MultiPolygon",
4544
- /**
4545
- * Number
4546
- */
4547
- Number = "Number",
4548
- /**
4549
- * Numeric Character
4550
- */
4551
- Numc = "Numc",
4552
- /**
4553
- * Object
4554
- */
4555
- Object = "Object",
4556
- /**
4557
- * Option List
4558
- */
4559
- OptionList = "OptionList",
4560
- /**
4561
- * Option Value
4562
- */
4563
- OptionValue = "OptionValue",
4564
- /**
4565
- * Percent
4566
- */
4567
- Percent = "Percent",
4568
- /**
4569
- * Point
4570
- */
4571
- Point = "Point",
4572
- /**
4573
- * Polygon
4574
- */
4575
- Polygon = "Polygon",
4576
- /**
4577
- * Price
4578
- */
4579
- Price = "Price",
4580
- /**
4581
- * Properties
4582
- */
4583
- Properties = "Properties",
4584
- /**
4585
- * Quantitiy
4586
- */
4587
- Quantity = "Quantity",
4588
- /**
4589
- * String
4590
- */
4591
- String = "String",
4592
- /**
4593
- * Structure
4594
- */
4595
- Structure = "Structure",
4596
- /**
4597
- * Structure List
4598
- */
4599
- StructureList = "StructureList",
4600
- /**
4601
- * Time
4602
- */
4603
- Time = "Time",
4604
- /**
4605
- * Time Span
4606
- */
4607
- TimeSpan = "TimeSpan",
4608
- /**
4609
- * Color
4610
- */
4611
- UiColor = "UiColor",
4612
-
4613
- UiConstant = "UiConstant",
4614
-
4615
- UiControl = "UiControl",
4616
-
4617
- UiPosition = "UiPosition",
4618
-
4619
- UiSize = "UiSize",
4620
-
4621
- UiUnitValue = "UiUnitValue",
4622
- /**
4623
- * Unit
4624
- */
4625
- Unit = "Unit",
4626
-
4627
- Unsupported = "Unsupported",
4628
-
4629
- UpperCaseString = "UpperCaseString",
4630
- /**
4631
- * URI
4632
- */
4633
- Uri = "Uri",
4634
-
4635
- Variable = "Variable",
4636
- }
4637
- export default ValueType;
4638
- }
4639
-
4640
1876
  declare module "sap/zen/dsh/widgets/SDKModel" {
4641
1877
  import Model from "sap/ui/model/Model";
4642
1878
 
4643
1879
  import Metadata from "sap/ui/base/Metadata";
4644
1880
 
4645
1881
  /**
4646
- * @deprecated (since 1.89.0) - Please use the WD Grid control instead.
1882
+ * @deprecated (since 1.89) - this library is deprecated and has been replaced by Web Dynpro-based apps
1883
+ * in S/4HANA.
4647
1884
  *
4648
1885
  * Model implementation for JSON format
4649
1886
  */
@@ -4686,134 +1923,18 @@ declare module "sap/zen/dsh/widgets/SDKModel" {
4686
1923
  }
4687
1924
  }
4688
1925
 
4689
- declare module "sap/zen/dsh/WidgetType" {
4690
- /**
4691
- * Widget Type of an InACard
4692
- */
4693
- enum WidgetType {
4694
- /**
4695
- * Bar Chart
4696
- */
4697
- bar = "bar",
4698
- /**
4699
- * Column Chart
4700
- */
4701
- colum = "column",
4702
- /**
4703
- * Donut Chart
4704
- */
4705
- donut = "donut",
4706
- /**
4707
- * Line Chart
4708
- */
4709
- line = "line",
4710
- /**
4711
- * Pie Chart
4712
- */
4713
- pie = "pie",
4714
- /**
4715
- * Pivot Table
4716
- */
4717
- pivot = "pivot",
4718
- }
4719
- export default WidgetType;
4720
- }
4721
-
4722
- declare module "sap/zen/dsh/dialogs/Component" {
4723
- import { $UIComponentSettings } from "sap/ui/core/UIComponent";
4724
-
4725
- export interface $dialogsSettings extends $UIComponentSettings {}
4726
- }
4727
-
4728
1926
  declare namespace sap {
4729
- namespace zen {
4730
- /**
4731
- * Design Studio Runtime Library. Intended only to be used within S/4 HANA Fiori applications.
4732
- */
4733
- namespace dsh {
4734
- class dialogs /* was: sap.ui.core.UIComponent */ extends Object {
4735
- /**
4736
- * Dialogs for navigating the Data of a `sap.zen.dsh.olap.DataProvider`
4737
- *
4738
- * This `UIComponent` provides all the dialogs for navigating the data provided via a `DataProvider`. Don't
4739
- * use the this component directly, but call the corresponding methods of the `DataProvider` **List of dialogs**
4740
- *
4741
- * - `Condition` create a condition (aka result set filter)
4742
- * - `ContextMenu` create a context menu for a `Cell` in the cells collection of a `DataProvider`
4743
- * - `Exception` create an exception (aka conditional format)
4744
- * - `Formula` create a formula
4745
- * - `MessagePopup` display a list of Messages
4746
- * - `NewLines` Enter new lines in tabluar form
4747
- * - `AxisLayoutDialog` display/change settings of the query view
4748
- * - `Restriciton`create a restricted measure
4749
- * - `SelectPlanningFunction` Select a Data Function
4750
- * - `Selector` Define and Display the Dynamic filter (of a dimension)
4751
- * - `Spot`display information on a geographic spot
4752
- */
4753
- constructor();
4754
- }
4755
- }
4756
- }
4757
-
4758
1927
  interface IUI5DefineDependencyNames {
4759
1928
  "sap/zen/dsh/AnalyticGrid": undefined;
4760
1929
 
4761
- "sap/zen/dsh/Axis": undefined;
4762
-
4763
- "sap/zen/dsh/ComparisonOperator": undefined;
4764
-
4765
- "sap/zen/dsh/DataSourceType": undefined;
4766
-
4767
- "sap/zen/dsh/dialogs/Component": undefined;
4768
-
4769
- "sap/zen/dsh/DimensionType": undefined;
4770
-
4771
- "sap/zen/dsh/DisplayType": undefined;
4772
-
4773
1930
  "sap/zen/dsh/Dsh": undefined;
4774
1931
 
4775
- "sap/zen/dsh/InACard/Component": undefined;
4776
-
4777
- "sap/zen/dsh/InATile": undefined;
4778
-
4779
1932
  "sap/zen/dsh/library": undefined;
4780
1933
 
4781
- "sap/zen/dsh/MemberType": undefined;
4782
-
4783
- "sap/zen/dsh/NavigationCommandType": undefined;
4784
-
4785
- "sap/zen/dsh/olap/DataProvider": undefined;
4786
-
4787
- "sap/zen/dsh/olap/OlapListBinding": undefined;
4788
-
4789
- "sap/zen/dsh/olap/OlapListGridBinding": undefined;
4790
-
4791
- "sap/zen/dsh/olap/OlapModel": undefined;
4792
-
4793
- "sap/zen/dsh/olap/OlapPropertyBinding": undefined;
4794
-
4795
- "sap/zen/dsh/PivotTable": undefined;
4796
-
4797
- "sap/zen/dsh/ProtocolType": undefined;
4798
-
4799
- "sap/zen/dsh/rsrt/Component": undefined;
4800
-
4801
- "sap/zen/dsh/SemanticRole": undefined;
4802
-
4803
- "sap/zen/dsh/SortDirection": undefined;
4804
-
4805
- "sap/zen/dsh/SortType": undefined;
4806
-
4807
- "sap/zen/dsh/SystemType": undefined;
4808
-
4809
1934
  "sap/zen/dsh/ValueHelpRangeOperation": undefined;
4810
1935
 
4811
- "sap/zen/dsh/ValueType": undefined;
4812
-
4813
1936
  "sap/zen/dsh/widgets/SDKModel": undefined;
4814
1937
 
4815
1938
  "sap/zen/dsh/widgets/ValueHelpDialog": undefined;
4816
-
4817
- "sap/zen/dsh/WidgetType": undefined;
4818
1939
  }
4819
1940
  }