@sapui5/ts-types-esm 1.131.0 → 1.132.0

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 (68) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +5 -0
  7. package/types/sap.esh.search.ui.d.ts +35 -1
  8. package/types/sap.f.d.ts +103 -197
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +1 -1
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +123 -94
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +1 -1
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +408 -56
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +7 -2
  28. package/types/sap.rules.ui.d.ts +86 -1
  29. package/types/sap.sac.df.d.ts +1245 -890
  30. package/types/sap.suite.ui.commons.d.ts +1 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +7 -7
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +66 -5
  37. package/types/sap.ui.core.d.ts +363 -282
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +7 -1
  41. package/types/sap.ui.generic.app.d.ts +5 -11
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +1 -1
  44. package/types/sap.ui.layout.d.ts +1 -1
  45. package/types/sap.ui.mdc.d.ts +439 -342
  46. package/types/sap.ui.richtexteditor.d.ts +1 -1
  47. package/types/sap.ui.rta.d.ts +3 -1
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +1 -1
  50. package/types/sap.ui.table.d.ts +13 -1
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +25 -15
  53. package/types/sap.ui.ux3.d.ts +1 -1
  54. package/types/sap.ui.vbm.d.ts +1 -1
  55. package/types/sap.ui.vk.d.ts +96 -1
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.ui.webc.common.d.ts +1 -1
  58. package/types/sap.ui.webc.fiori.d.ts +1 -1
  59. package/types/sap.ui.webc.main.d.ts +1 -1
  60. package/types/sap.uiext.inbox.d.ts +1 -1
  61. package/types/sap.ushell.d.ts +5 -1
  62. package/types/sap.ushell_abap.d.ts +1 -1
  63. package/types/sap.uxap.d.ts +1 -1
  64. package/types/sap.viz.d.ts +1 -1
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +1 -1
  67. package/types/sap.zen.crosstab.d.ts +1 -1
  68. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.131.0
1
+ // For Library Version: 1.132.0
2
2
 
3
3
  declare module "sap/sac/df/library" {}
4
4
 
@@ -79,6 +79,160 @@ declare module "sap/sac/df/changeHandler/MultiDimModelChangeHandler" {
79
79
  extends $ControlSettings {}
80
80
  }
81
81
 
82
+ declare module "sap/sac/df/DataAnalyzer" {
83
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
84
+
85
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
86
+
87
+ import DataAnalyzerPanelName from "sap/sac/df/types/DataAnalyzerPanelName";
88
+
89
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
90
+
91
+ /**
92
+ * FlexAnalysis A control to display multi-dimensional data
93
+ *
94
+ * @experimental (since 1.132)
95
+ */
96
+ export default class DataAnalyzer extends Control {
97
+ /**
98
+ * Constructor for a new `DataAnalyzer` control.
99
+ *
100
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
101
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
102
+ * of the syntax of the settings object.
103
+ */
104
+ constructor();
105
+
106
+ /**
107
+ * Creates a new subclass of class sap.sac.df.DataAnalyzer with name `sClassName` and enriches it with the
108
+ * information contained in `oClassInfo`.
109
+ *
110
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
111
+ *
112
+ *
113
+ * @returns Created class / constructor function
114
+ */
115
+ static extend<T extends Record<string, unknown>>(
116
+ /**
117
+ * Name of the class being created
118
+ */
119
+ sClassName: string,
120
+ /**
121
+ * Object literal with information about the class
122
+ */
123
+ oClassInfo?: sap.ClassInfo<T, DataAnalyzer>,
124
+ /**
125
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
126
+ * used by this class
127
+ */
128
+ FNMetaImpl?: Function
129
+ ): Function;
130
+ /**
131
+ * Returns a metadata object for class sap.sac.df.DataAnalyzer.
132
+ *
133
+ *
134
+ * @returns Metadata object describing this class
135
+ */
136
+ static getMetadata(): ElementMetadata;
137
+ /**
138
+ * Gets current value of property {@link #getMetaPath metaPath}.
139
+ *
140
+ * Defines the relative path to the data provider in the multidimensional model.
141
+ *
142
+ *
143
+ * @returns Value of property `metaPath`
144
+ */
145
+ getMetaPath(): string;
146
+ /**
147
+ * Gets current value of property {@link #getSelectedPanel selectedPanel}.
148
+ *
149
+ * Selected panel item
150
+ *
151
+ *
152
+ * @returns Value of property `selectedPanel`
153
+ */
154
+ getSelectedPanel(): DataAnalyzerPanelName;
155
+ /**
156
+ * Gets current value of property {@link #getShowVisualizationType showVisualizationType}.
157
+ *
158
+ * Show visualization type
159
+ *
160
+ *
161
+ * @returns Value of property `showVisualizationType`
162
+ */
163
+ getShowVisualizationType(): boolean;
164
+ /**
165
+ * Sets a new value for property {@link #getMetaPath metaPath}.
166
+ *
167
+ * Defines the relative path to the data provider in the multidimensional model.
168
+ *
169
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
170
+ *
171
+ *
172
+ * @returns Reference to `this` in order to allow method chaining
173
+ */
174
+ setMetaPath(
175
+ /**
176
+ * New value for property `metaPath`
177
+ */
178
+ sMetaPath: string
179
+ ): this;
180
+ /**
181
+ * Sets a new value for property {@link #getSelectedPanel selectedPanel}.
182
+ *
183
+ * Selected panel item
184
+ *
185
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
186
+ *
187
+ *
188
+ * @returns Reference to `this` in order to allow method chaining
189
+ */
190
+ setSelectedPanel(
191
+ /**
192
+ * New value for property `selectedPanel`
193
+ */
194
+ sSelectedPanel: DataAnalyzerPanelName
195
+ ): this;
196
+ /**
197
+ * Sets a new value for property {@link #getShowVisualizationType showVisualizationType}.
198
+ *
199
+ * Show visualization type
200
+ *
201
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
202
+ *
203
+ *
204
+ * @returns Reference to `this` in order to allow method chaining
205
+ */
206
+ setShowVisualizationType(
207
+ /**
208
+ * New value for property `showVisualizationType`
209
+ */
210
+ bShowVisualizationType: boolean
211
+ ): this;
212
+ }
213
+ /**
214
+ * Describes the settings that can be provided to the DataAnalyzer constructor.
215
+ *
216
+ * @experimental (since 1.132)
217
+ */
218
+ export interface $DataAnalyzerSettings extends $ControlSettings {
219
+ /**
220
+ * Defines the relative path to the data provider in the multidimensional model.
221
+ */
222
+ metaPath?: string | PropertyBindingInfo;
223
+
224
+ /**
225
+ * Selected panel item
226
+ */
227
+ selectedPanel?: DataAnalyzerPanelName | PropertyBindingInfo | `{${string}}`;
228
+
229
+ /**
230
+ * Show visualization type
231
+ */
232
+ showVisualizationType?: boolean | PropertyBindingInfo | `{${string}}`;
233
+ }
234
+ }
235
+
82
236
  declare module "sap/sac/df/DesignerPanel" {
83
237
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
84
238
 
@@ -132,17 +286,6 @@ declare module "sap/sac/df/DesignerPanel" {
132
286
  * @returns Metadata object describing this class
133
287
  */
134
288
  static getMetadata(): ElementMetadata;
135
- /**
136
- * Gets current value of property {@link #getHideAvailableObjects hideAvailableObjects}.
137
- *
138
- * Hide 'Available Objects' pane upon initial load
139
- *
140
- * Default value is `false`.
141
- *
142
- *
143
- * @returns Value of property `hideAvailableObjects`
144
- */
145
- getHideAvailableObjects(): boolean;
146
289
  /**
147
290
  * Gets current value of property {@link #getMetaPath metaPath}.
148
291
  *
@@ -153,6 +296,17 @@ declare module "sap/sac/df/DesignerPanel" {
153
296
  * @returns Value of property `metaPath`
154
297
  */
155
298
  getMetaPath(): string;
299
+ /**
300
+ * Gets current value of property {@link #getShowAvailableObjects showAvailableObjects}.
301
+ *
302
+ * Show available objects panel
303
+ *
304
+ * Default value is `true`.
305
+ *
306
+ *
307
+ * @returns Value of property `showAvailableObjects`
308
+ */
309
+ getShowAvailableObjects(): boolean;
156
310
  /**
157
311
  * Gets current value of property {@link #getShowVisualizationType showVisualizationType}.
158
312
  *
@@ -165,39 +319,39 @@ declare module "sap/sac/df/DesignerPanel" {
165
319
  */
166
320
  getShowVisualizationType(): boolean;
167
321
  /**
168
- * Sets a new value for property {@link #getHideAvailableObjects hideAvailableObjects}.
322
+ * Sets a new value for property {@link #getMetaPath metaPath}.
169
323
  *
170
- * Hide 'Available Objects' pane upon initial load
324
+ * Defines the relative path to visualization of the corresponding data provider in the multidimensional
325
+ * model.
171
326
  *
172
327
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
173
328
  *
174
- * Default value is `false`.
175
- *
176
329
  *
177
330
  * @returns Reference to `this` in order to allow method chaining
178
331
  */
179
- setHideAvailableObjects(
332
+ setMetaPath(
180
333
  /**
181
- * New value for property `hideAvailableObjects`
334
+ * New value for property `metaPath`
182
335
  */
183
- bHideAvailableObjects?: boolean
336
+ sMetaPath: string
184
337
  ): this;
185
338
  /**
186
- * Sets a new value for property {@link #getMetaPath metaPath}.
339
+ * Sets a new value for property {@link #getShowAvailableObjects showAvailableObjects}.
187
340
  *
188
- * Defines the relative path to visualization of the corresponding data provider in the multidimensional
189
- * model.
341
+ * Show available objects panel
190
342
  *
191
343
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
192
344
  *
345
+ * Default value is `true`.
346
+ *
193
347
  *
194
348
  * @returns Reference to `this` in order to allow method chaining
195
349
  */
196
- setMetaPath(
350
+ setShowAvailableObjects(
197
351
  /**
198
- * New value for property `metaPath`
352
+ * New value for property `showAvailableObjects`
199
353
  */
200
- sMetaPath: string
354
+ bShowAvailableObjects?: boolean
201
355
  ): this;
202
356
  /**
203
357
  * Sets a new value for property {@link #getShowVisualizationType showVisualizationType}.
@@ -236,9 +390,9 @@ declare module "sap/sac/df/DesignerPanel" {
236
390
  showVisualizationType?: boolean | PropertyBindingInfo | `{${string}}`;
237
391
 
238
392
  /**
239
- * Hide 'Available Objects' pane upon initial load
393
+ * Show available objects panel
240
394
  */
241
- hideAvailableObjects?: boolean | PropertyBindingInfo | `{${string}}`;
395
+ showAvailableObjects?: boolean | PropertyBindingInfo | `{${string}}`;
242
396
  }
243
397
  }
244
398
 
@@ -565,8 +719,6 @@ declare module "sap/sac/df/FilterPanel" {
565
719
  declare module "sap/sac/df/FlexAnalysis" {
566
720
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
567
721
 
568
- import FlexAnalysisPanel from "sap/sac/df/FlexAnalysisPanel";
569
-
570
722
  import {
571
723
  PropertyBindingInfo,
572
724
  AggregationBindingInfo,
@@ -588,6 +740,7 @@ declare module "sap/sac/df/FlexAnalysis" {
588
740
  * The user can view the data in a Table, navigate in the data via a context menu or builder panels The
589
741
  * data source that the FlexAnalysis consumes or renders has to be provided as a property value.
590
742
  *
743
+ * @deprecated (since 1.132) - Replaced by {@link sap.sac.df.DataAnalyzer DataAnalyzer} or {@link sap.sac.df.Grid Grid}.
591
744
  * @experimental
592
745
  */
593
746
  export default class FlexAnalysis extends Control {
@@ -639,6 +792,8 @@ declare module "sap/sac/df/FlexAnalysis" {
639
792
  /**
640
793
  * Adds some customPanel to the aggregation {@link #getCustomPanels customPanels}.
641
794
  *
795
+ * @deprecated (since 1.132) - the concept has been discarded. Refreshing the data is handled by the data
796
+ * provider.
642
797
  *
643
798
  * @returns Reference to `this` in order to allow method chaining
644
799
  */
@@ -646,7 +801,7 @@ declare module "sap/sac/df/FlexAnalysis" {
646
801
  /**
647
802
  * The customPanel to add; if empty, nothing is inserted
648
803
  */
649
- oCustomPanel: FlexAnalysisPanel
804
+ oCustomPanel: Control
650
805
  ): this;
651
806
  /**
652
807
  * Attaches event handler `fnFunction` to the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.FlexAnalysis`.
@@ -714,6 +869,8 @@ declare module "sap/sac/df/FlexAnalysis" {
714
869
  /**
715
870
  * Destroys all the customPanels in the aggregation {@link #getCustomPanels customPanels}.
716
871
  *
872
+ * @deprecated (since 1.132) - the concept has been discarded. Refreshing the data is handled by the data
873
+ * provider.
717
874
  *
718
875
  * @returns Reference to `this` in order to allow method chaining
719
876
  */
@@ -803,8 +960,11 @@ declare module "sap/sac/df/FlexAnalysis" {
803
960
  * Gets content of aggregation {@link #getCustomPanels customPanels}.
804
961
  *
805
962
  * Custom panels for the flexible analysis control
963
+ *
964
+ * @deprecated (since 1.132) - the concept has been discarded. Refreshing the data is handled by the data
965
+ * provider.
806
966
  */
807
- getCustomPanels(): FlexAnalysisPanel[];
967
+ getCustomPanels(): Control[];
808
968
  /**
809
969
  * Gets current value of property {@link #getDataProvider dataProvider}.
810
970
  *
@@ -1034,9 +1194,11 @@ declare module "sap/sac/df/FlexAnalysis" {
1034
1194
  */
1035
1195
  getWidth(): CSSSize;
1036
1196
  /**
1037
- * Checks for the provided `sap.sac.df.FlexAnalysisPanel` in the aggregation {@link #getCustomPanels customPanels}.
1197
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getCustomPanels customPanels}.
1038
1198
  * and returns its index if found or -1 otherwise.
1039
1199
  *
1200
+ * @deprecated (since 1.132) - the concept has been discarded. Refreshing the data is handled by the data
1201
+ * provider.
1040
1202
  *
1041
1203
  * @returns The index of the provided control in the aggregation if found, or -1 otherwise
1042
1204
  */
@@ -1044,11 +1206,13 @@ declare module "sap/sac/df/FlexAnalysis" {
1044
1206
  /**
1045
1207
  * The customPanel whose index is looked for
1046
1208
  */
1047
- oCustomPanel: FlexAnalysisPanel
1209
+ oCustomPanel: Control
1048
1210
  ): int;
1049
1211
  /**
1050
1212
  * Inserts a customPanel into the aggregation {@link #getCustomPanels customPanels}.
1051
1213
  *
1214
+ * @deprecated (since 1.132) - the concept has been discarded. Refreshing the data is handled by the data
1215
+ * provider.
1052
1216
  *
1053
1217
  * @returns Reference to `this` in order to allow method chaining
1054
1218
  */
@@ -1056,7 +1220,7 @@ declare module "sap/sac/df/FlexAnalysis" {
1056
1220
  /**
1057
1221
  * The customPanel to insert; if empty, nothing is inserted
1058
1222
  */
1059
- oCustomPanel: FlexAnalysisPanel,
1223
+ oCustomPanel: Control,
1060
1224
  /**
1061
1225
  * The `0`-based index the customPanel should be inserted at; for a negative value of `iIndex`, the customPanel
1062
1226
  * is inserted at position 0; for a value greater than the current size of the aggregation, the customPanel
@@ -1069,13 +1233,17 @@ declare module "sap/sac/df/FlexAnalysis" {
1069
1233
  *
1070
1234
  * Additionally, it unregisters them from the hosting UIArea.
1071
1235
  *
1236
+ * @deprecated (since 1.132) - the concept has been discarded. Refreshing the data is handled by the data
1237
+ * provider.
1072
1238
  *
1073
1239
  * @returns An array of the removed elements (might be empty)
1074
1240
  */
1075
- removeAllCustomPanels(): FlexAnalysisPanel[];
1241
+ removeAllCustomPanels(): Control[];
1076
1242
  /**
1077
1243
  * Removes a customPanel from the aggregation {@link #getCustomPanels customPanels}.
1078
1244
  *
1245
+ * @deprecated (since 1.132) - the concept has been discarded. Refreshing the data is handled by the data
1246
+ * provider.
1079
1247
  *
1080
1248
  * @returns The removed customPanel or `null`
1081
1249
  */
@@ -1083,8 +1251,8 @@ declare module "sap/sac/df/FlexAnalysis" {
1083
1251
  /**
1084
1252
  * The customPanel to remove or its index or id
1085
1253
  */
1086
- vCustomPanel: int | string | FlexAnalysisPanel
1087
- ): FlexAnalysisPanel | null;
1254
+ vCustomPanel: int | string | Control
1255
+ ): Control | null;
1088
1256
  /**
1089
1257
  * Sets a new value for property {@link #getAutoUpdate autoUpdate}.
1090
1258
  *
@@ -1557,6 +1725,7 @@ declare module "sap/sac/df/FlexAnalysis" {
1557
1725
  /**
1558
1726
  * Describes the settings that can be provided to the FlexAnalysis constructor.
1559
1727
  *
1728
+ * @deprecated (since 1.132) - Replaced by {@link sap.sac.df.DataAnalyzer DataAnalyzer} or {@link sap.sac.df.Grid Grid}.
1560
1729
  * @experimental
1561
1730
  */
1562
1731
  export interface $FlexAnalysisSettings extends $ControlSettings {
@@ -1712,12 +1881,11 @@ declare module "sap/sac/df/FlexAnalysis" {
1712
1881
 
1713
1882
  /**
1714
1883
  * Custom panels for the flexible analysis control
1884
+ *
1885
+ * @deprecated (since 1.132) - the concept has been discarded. Refreshing the data is handled by the data
1886
+ * provider.
1715
1887
  */
1716
- customPanels?:
1717
- | FlexAnalysisPanel[]
1718
- | FlexAnalysisPanel
1719
- | AggregationBindingInfo
1720
- | `{${string}}`;
1888
+ customPanels?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
1721
1889
 
1722
1890
  /**
1723
1891
  * Fires on cell click event
@@ -1744,59 +1912,35 @@ declare module "sap/sac/df/FlexAnalysis" {
1744
1912
  >;
1745
1913
  }
1746
1914
 
1747
- declare module "sap/sac/df/FlexAnalysisPanel" {
1748
- import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
1749
-
1750
- import Control from "sap/ui/core/Control";
1751
-
1752
- import { URI } from "sap/ui/core/library";
1915
+ declare module "sap/sac/df/Grid" {
1916
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1753
1917
 
1754
1918
  import ElementMetadata from "sap/ui/core/ElementMetadata";
1755
1919
 
1756
1920
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1757
1921
 
1922
+ import Event from "sap/ui/base/Event";
1923
+
1758
1924
  /**
1759
- * A panel to be added into FlexAnalysis control
1925
+ * Grid A grid control for displaying multi-dimensional data
1760
1926
  *
1761
- * @experimental
1927
+ * @experimental (since 1.129)
1762
1928
  */
1763
- export default class FlexAnalysisPanel extends UI5Element {
1764
- /**
1765
- * Constructor for a new Flexible Analysis Panel.
1766
- *
1767
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1768
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1769
- * of the syntax of the settings object.
1770
- */
1771
- constructor(
1772
- /**
1773
- * initial settings for the new control
1774
- */
1775
- mSettings?: $FlexAnalysisPanelSettings
1776
- );
1929
+ export default class Grid extends Control {
1777
1930
  /**
1778
- * Constructor for a new Flexible Analysis Panel.
1931
+ * Constructor for a new `Grid` control.
1779
1932
  *
1780
1933
  * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1781
1934
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1782
1935
  * of the syntax of the settings object.
1783
1936
  */
1784
- constructor(
1785
- /**
1786
- * id for the new control, generated automatically if no id is given
1787
- */
1788
- sId?: string,
1789
- /**
1790
- * initial settings for the new control
1791
- */
1792
- mSettings?: $FlexAnalysisPanelSettings
1793
- );
1937
+ constructor();
1794
1938
 
1795
1939
  /**
1796
- * Creates a new subclass of class sap.sac.df.FlexAnalysisPanel with name `sClassName` and enriches it with
1797
- * the information contained in `oClassInfo`.
1940
+ * Creates a new subclass of class sap.sac.df.Grid with name `sClassName` and enriches it with the information
1941
+ * contained in `oClassInfo`.
1798
1942
  *
1799
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
1943
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
1800
1944
  *
1801
1945
  *
1802
1946
  * @returns Created class / constructor function
@@ -1809,7 +1953,7 @@ declare module "sap/sac/df/FlexAnalysisPanel" {
1809
1953
  /**
1810
1954
  * Object literal with information about the class
1811
1955
  */
1812
- oClassInfo?: sap.ClassInfo<T, FlexAnalysisPanel>,
1956
+ oClassInfo?: sap.ClassInfo<T, Grid>,
1813
1957
  /**
1814
1958
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1815
1959
  * used by this class
@@ -1817,194 +1961,90 @@ declare module "sap/sac/df/FlexAnalysisPanel" {
1817
1961
  FNMetaImpl?: Function
1818
1962
  ): Function;
1819
1963
  /**
1820
- * Returns a metadata object for class sap.sac.df.FlexAnalysisPanel.
1964
+ * Returns a metadata object for class sap.sac.df.Grid.
1821
1965
  *
1822
1966
  *
1823
1967
  * @returns Metadata object describing this class
1824
1968
  */
1825
1969
  static getMetadata(): ElementMetadata;
1826
1970
  /**
1827
- * Destroys the content in the aggregation {@link #getContent content}.
1828
- *
1829
- *
1830
- * @returns Reference to `this` in order to allow method chaining
1831
- */
1832
- destroyContent(): this;
1833
- /**
1834
- * Gets content of aggregation {@link #getContent content}.
1835
- *
1836
- * The content of this panel
1837
- */
1838
- getContent(): Control;
1839
- /**
1840
- * Gets current value of property {@link #getDescription description}.
1841
- *
1842
- * The description of the panel, displayed as tooltip on the side navigation item.
1843
- *
1844
- *
1845
- * @returns Value of property `description`
1846
- */
1847
- getDescription(): string;
1848
- /**
1849
- * Gets current value of property {@link #getIcon icon}.
1850
- *
1851
- * The icon of the panel, displayed on the side navigation item and the panel header.
1852
- *
1853
- *
1854
- * @returns Value of property `icon`
1855
- */
1856
- getIcon(): URI;
1857
- /**
1858
- * Gets current value of property {@link #getTitle title}.
1859
- *
1860
- * The title of the panel header.
1971
+ * Attaches event handler `fnFunction` to the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.Grid`.
1861
1972
  *
1973
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
1974
+ * otherwise it will be bound to this `sap.sac.df.Grid` itself.
1862
1975
  *
1863
- * @returns Value of property `title`
1864
- */
1865
- getTitle(): string;
1866
- /**
1867
- * Sets the aggregated {@link #getContent content}.
1976
+ * Fires on cell click event
1868
1977
  *
1869
1978
  *
1870
1979
  * @returns Reference to `this` in order to allow method chaining
1871
1980
  */
1872
- setContent(
1981
+ attachOnCellClick(
1982
+ /**
1983
+ * An application-specific payload object that will be passed to the event handler along with the event
1984
+ * object when firing the event
1985
+ */
1986
+ oData: object,
1987
+ /**
1988
+ * The function to be called when the event occurs
1989
+ */
1990
+ fnFunction: (p1: Grid$OnCellClickEvent) => void,
1873
1991
  /**
1874
- * The content to set
1992
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.Grid` itself
1875
1993
  */
1876
- oContent: Control
1994
+ oListener?: object
1877
1995
  ): this;
1878
1996
  /**
1879
- * Sets a new value for property {@link #getDescription description}.
1997
+ * Attaches event handler `fnFunction` to the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.Grid`.
1880
1998
  *
1881
- * The description of the panel, displayed as tooltip on the side navigation item.
1999
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
2000
+ * otherwise it will be bound to this `sap.sac.df.Grid` itself.
1882
2001
  *
1883
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2002
+ * Fires on cell click event
1884
2003
  *
1885
2004
  *
1886
2005
  * @returns Reference to `this` in order to allow method chaining
1887
2006
  */
1888
- setDescription(
2007
+ attachOnCellClick(
2008
+ /**
2009
+ * The function to be called when the event occurs
2010
+ */
2011
+ fnFunction: (p1: Grid$OnCellClickEvent) => void,
1889
2012
  /**
1890
- * New value for property `description`
2013
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.Grid` itself
1891
2014
  */
1892
- sDescription: string
2015
+ oListener?: object
1893
2016
  ): this;
1894
2017
  /**
1895
- * Sets a new value for property {@link #getIcon icon}.
1896
- *
1897
- * The icon of the panel, displayed on the side navigation item and the panel header.
2018
+ * Detaches event handler `fnFunction` from the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.Grid`.
1898
2019
  *
1899
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2020
+ * The passed function and listener object must match the ones used for event registration.
1900
2021
  *
1901
2022
  *
1902
2023
  * @returns Reference to `this` in order to allow method chaining
1903
2024
  */
1904
- setIcon(
2025
+ detachOnCellClick(
1905
2026
  /**
1906
- * New value for property `icon`
2027
+ * The function to be called, when the event occurs
1907
2028
  */
1908
- sIcon: URI
1909
- ): this;
1910
- /**
1911
- * Sets a new value for property {@link #getTitle title}.
1912
- *
1913
- * The title of the panel header.
1914
- *
1915
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1916
- *
1917
- *
1918
- * @returns Reference to `this` in order to allow method chaining
1919
- */
1920
- setTitle(
2029
+ fnFunction: (p1: Grid$OnCellClickEvent) => void,
1921
2030
  /**
1922
- * New value for property `title`
2031
+ * Context object on which the given function had to be called
1923
2032
  */
1924
- sTitle: string
2033
+ oListener?: object
1925
2034
  ): this;
1926
- }
1927
- /**
1928
- * Describes the settings that can be provided to the FlexAnalysisPanel constructor.
1929
- *
1930
- * @experimental
1931
- */
1932
- export interface $FlexAnalysisPanelSettings extends $ElementSettings {
1933
- /**
1934
- * The description of the panel, displayed as tooltip on the side navigation item.
1935
- */
1936
- description?: string | PropertyBindingInfo;
1937
-
1938
- /**
1939
- * The title of the panel header.
1940
- */
1941
- title?: string | PropertyBindingInfo;
1942
-
1943
- /**
1944
- * The icon of the panel, displayed on the side navigation item and the panel header.
1945
- */
1946
- icon?: URI | PropertyBindingInfo | `{${string}}`;
1947
-
1948
- /**
1949
- * The content of this panel
1950
- */
1951
- content?: Control;
1952
- }
1953
- }
1954
-
1955
- declare module "sap/sac/df/Grid" {
1956
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
1957
-
1958
- import ElementMetadata from "sap/ui/core/ElementMetadata";
1959
-
1960
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
1961
-
1962
- /**
1963
- * Grid A grid control for displaying multi-dimensional data
1964
- *
1965
- * @experimental (since 1.129)
1966
- */
1967
- export default class Grid extends Control {
1968
2035
  /**
1969
- * Constructor for a new `Grid` control.
1970
- *
1971
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
1972
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
1973
- * of the syntax of the settings object.
1974
- */
1975
- constructor();
1976
-
1977
- /**
1978
- * Creates a new subclass of class sap.sac.df.Grid with name `sClassName` and enriches it with the information
1979
- * contained in `oClassInfo`.
1980
- *
1981
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
2036
+ * Fires event {@link #event:onCellClick onCellClick} to attached listeners.
1982
2037
  *
2038
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1983
2039
  *
1984
- * @returns Created class / constructor function
2040
+ * @returns Reference to `this` in order to allow method chaining
1985
2041
  */
1986
- static extend<T extends Record<string, unknown>>(
1987
- /**
1988
- * Name of the class being created
1989
- */
1990
- sClassName: string,
1991
- /**
1992
- * Object literal with information about the class
1993
- */
1994
- oClassInfo?: sap.ClassInfo<T, Grid>,
2042
+ fireOnCellClick(
1995
2043
  /**
1996
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1997
- * used by this class
2044
+ * Parameters to pass along with the event
1998
2045
  */
1999
- FNMetaImpl?: Function
2000
- ): Function;
2001
- /**
2002
- * Returns a metadata object for class sap.sac.df.Grid.
2003
- *
2004
- *
2005
- * @returns Metadata object describing this class
2006
- */
2007
- static getMetadata(): ElementMetadata;
2046
+ mParameters?: Grid$OnCellClickEventParameters
2047
+ ): this;
2008
2048
  /**
2009
2049
  * Gets current value of property {@link #getMetaPath metaPath}.
2010
2050
  *
@@ -2120,6 +2160,11 @@ declare module "sap/sac/df/Grid" {
2120
2160
  * @experimental (since 1.129)
2121
2161
  */
2122
2162
  export interface $GridSettings extends $ControlSettings {
2163
+ /**
2164
+ * Defines the relative path to the data provider in the multidimensional model.
2165
+ */
2166
+ metaPath?: string | PropertyBindingInfo;
2167
+
2123
2168
  /**
2124
2169
  * Show / hide status bar
2125
2170
  */
@@ -2136,10 +2181,28 @@ declare module "sap/sac/df/Grid" {
2136
2181
  title?: string | PropertyBindingInfo;
2137
2182
 
2138
2183
  /**
2139
- * Defines the relative path to the data provider in the multidimensional model.
2184
+ * Fires on cell click event
2140
2185
  */
2141
- metaPath?: string | PropertyBindingInfo;
2186
+ onCellClick?: (oEvent: Grid$OnCellClickEvent) => void;
2142
2187
  }
2188
+
2189
+ /**
2190
+ * Parameters of the Grid#onCellClick event.
2191
+ */
2192
+ export interface Grid$OnCellClickEventParameters {
2193
+ /**
2194
+ * Cell context
2195
+ */
2196
+ cellContext?: object;
2197
+ }
2198
+
2199
+ /**
2200
+ * Event object of the Grid#onCellClick event.
2201
+ */
2202
+ export type Grid$OnCellClickEvent = Event<
2203
+ Grid$OnCellClickEventParameters,
2204
+ Grid
2205
+ >;
2143
2206
  }
2144
2207
 
2145
2208
  declare module "sap/sac/df/model/AxesLayout" {
@@ -2159,6 +2222,7 @@ declare module "sap/sac/df/model/AxesLayout" {
2159
2222
  *
2160
2223
  *
2161
2224
  * @since 1.119
2225
+ * @deprecated (since 1.132) - Replaced by {@link sap.sac.df.model.visualization.Grid Grid}.
2162
2226
  * @experimental (since 1.119)
2163
2227
  */
2164
2228
  export default class AxesLayout extends BaseObject {
@@ -2219,6 +2283,195 @@ declare module "sap/sac/df/model/AxesLayout" {
2219
2283
  }
2220
2284
  }
2221
2285
 
2286
+ declare module "sap/sac/df/model/Configuration" {
2287
+ import BaseObject from "sap/ui/base/Object";
2288
+
2289
+ import Metadata from "sap/ui/base/Metadata";
2290
+
2291
+ import StylingPanelItem from "sap/sac/df/types/configuration/StylingPanelItem";
2292
+
2293
+ /**
2294
+ * Configuration of the multidimensional model and its components
2295
+ *
2296
+ * @since 1.132
2297
+ * @experimental (since 1.132)
2298
+ */
2299
+ export default class Configuration extends BaseObject {
2300
+ /**
2301
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
2302
+ */
2303
+ protected constructor();
2304
+
2305
+ /**
2306
+ * Creates a new subclass of class sap.sac.df.model.Configuration with name `sClassName` and enriches it
2307
+ * with the information contained in `oClassInfo`.
2308
+ *
2309
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2310
+ *
2311
+ *
2312
+ * @returns Created class / constructor function
2313
+ */
2314
+ static extend<T extends Record<string, unknown>>(
2315
+ /**
2316
+ * Name of the class being created
2317
+ */
2318
+ sClassName: string,
2319
+ /**
2320
+ * Object literal with information about the class
2321
+ */
2322
+ oClassInfo?: sap.ClassInfo<T, Configuration>,
2323
+ /**
2324
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2325
+ * used by this class
2326
+ */
2327
+ FNMetaImpl?: Function
2328
+ ): Function;
2329
+ /**
2330
+ * Returns a metadata object for class sap.sac.df.model.Configuration.
2331
+ *
2332
+ *
2333
+ * @returns Metadata object describing this class
2334
+ */
2335
+ static getMetadata(): Metadata;
2336
+ /**
2337
+ * Gets current value of property {@link #getCalculations Calculations}.
2338
+ *
2339
+ * Calculations
2340
+ *
2341
+ * Default value is `true`.
2342
+ *
2343
+ * @since 1.132
2344
+ * @experimental (since 1.132)
2345
+ *
2346
+ * @returns Value of property `Calculations`
2347
+ */
2348
+ getCalculations(): boolean;
2349
+ /**
2350
+ * Gets current value of property {@link #getCommenting Commenting}.
2351
+ *
2352
+ * Commenting
2353
+ *
2354
+ * Default value is `false`.
2355
+ *
2356
+ * @since 1.132
2357
+ * @experimental (since 1.132)
2358
+ *
2359
+ * @returns Value of property `Commenting`
2360
+ */
2361
+ getCommenting(): boolean;
2362
+ /**
2363
+ * Gets current value of property {@link #getContextMenuVariant ContextMenuVariant}.
2364
+ *
2365
+ * Variant of context menu configuration
2366
+ *
2367
+ * Default value is `sapui5`.
2368
+ *
2369
+ * @since 1.132
2370
+ * @experimental (since 1.132)
2371
+ *
2372
+ * @returns Value of property `ContextMenuVariant`
2373
+ */
2374
+ getContextMenuVariant(): /* was: sap.sac.df.types.configuration.ContextMenuVariant */ any;
2375
+ /**
2376
+ * Gets current value of property {@link #getStylingPanelItems StylingPanelItems}.
2377
+ *
2378
+ * Styling Panel Items
2379
+ *
2380
+ * Default value is `[TableProperties, NumberFormatting]`.
2381
+ *
2382
+ * @since 1.132
2383
+ * @experimental (since 1.132)
2384
+ *
2385
+ * @returns Value of property `StylingPanelItems`
2386
+ */
2387
+ getStylingPanelItems(): Array<
2388
+ StylingPanelItem | keyof typeof StylingPanelItem
2389
+ >;
2390
+ /**
2391
+ * Sets a new value for property {@link #getCalculations Calculations}.
2392
+ *
2393
+ * Calculations
2394
+ *
2395
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2396
+ *
2397
+ * Default value is `true`.
2398
+ *
2399
+ * @since 1.132
2400
+ * @experimental (since 1.132)
2401
+ *
2402
+ * @returns Reference to `this` in order to allow method chaining
2403
+ */
2404
+ setCalculations(
2405
+ /**
2406
+ * New value for property `Calculations`
2407
+ */
2408
+ bCalculations?: boolean
2409
+ ): this;
2410
+ /**
2411
+ * Sets a new value for property {@link #getCommenting Commenting}.
2412
+ *
2413
+ * Commenting
2414
+ *
2415
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2416
+ *
2417
+ * Default value is `false`.
2418
+ *
2419
+ * @since 1.132
2420
+ * @experimental (since 1.132)
2421
+ *
2422
+ * @returns Reference to `this` in order to allow method chaining
2423
+ */
2424
+ setCommenting(
2425
+ /**
2426
+ * New value for property `Commenting`
2427
+ */
2428
+ bCommenting?: boolean
2429
+ ): this;
2430
+ /**
2431
+ * Sets a new value for property {@link #getContextMenuVariant ContextMenuVariant}.
2432
+ *
2433
+ * Variant of context menu configuration
2434
+ *
2435
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2436
+ *
2437
+ * Default value is `sapui5`.
2438
+ *
2439
+ * @since 1.132
2440
+ * @experimental (since 1.132)
2441
+ *
2442
+ * @returns Reference to `this` in order to allow method chaining
2443
+ */
2444
+ setContextMenuVariant(
2445
+ /**
2446
+ * New value for property `ContextMenuVariant`
2447
+ */
2448
+ sContextMenuVariant?: /* was: sap.sac.df.types.configuration.ContextMenuVariant */ any
2449
+ ): this;
2450
+ /**
2451
+ * Sets a new value for property {@link #getStylingPanelItems StylingPanelItems}.
2452
+ *
2453
+ * Styling Panel Items
2454
+ *
2455
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
2456
+ *
2457
+ * Default value is `[TableProperties, NumberFormatting]`.
2458
+ *
2459
+ * @since 1.132
2460
+ * @experimental (since 1.132)
2461
+ *
2462
+ * @returns Reference to `this` in order to allow method chaining
2463
+ */
2464
+ setStylingPanelItems(
2465
+ /**
2466
+ * New value for property `StylingPanelItems`
2467
+ */
2468
+ sStylingPanelItems?: Array<
2469
+ StylingPanelItem | keyof typeof StylingPanelItem
2470
+ >
2471
+ ): this;
2472
+ }
2473
+ }
2474
+
2222
2475
  declare module "sap/sac/df/model/DataProvider" {
2223
2476
  import JSONModel from "sap/ui/model/json/JSONModel";
2224
2477
 
@@ -2228,12 +2481,8 @@ declare module "sap/sac/df/model/DataProvider" {
2228
2481
 
2229
2482
  import Dimension from "sap/sac/df/model/Dimension";
2230
2483
 
2231
- import Grid from "sap/sac/df/model/Grid";
2232
-
2233
2484
  import Variable from "sap/sac/df/model/Variable";
2234
2485
 
2235
- import Visualization from "sap/sac/df/model/Visualization";
2236
-
2237
2486
  import Metadata from "sap/ui/base/Metadata";
2238
2487
 
2239
2488
  import Event from "sap/ui/base/Event";
@@ -2251,11 +2500,6 @@ declare module "sap/sac/df/model/DataProvider" {
2251
2500
  * "Variables": { }
2252
2501
  * "Dimensions": { },
2253
2502
  * "Measures": [ ],
2254
- * "AxesLayout": {
2255
- * "Columns": [],
2256
- * "Rows": []
2257
- * },
2258
- * "Grid": { },
2259
2503
  * "Messages": [ ]
2260
2504
  * "AutoFetchEnabled": ""
2261
2505
  * ```
@@ -2289,11 +2533,6 @@ declare module "sap/sac/df/model/DataProvider" {
2289
2533
  */
2290
2534
  Dimensions: Record<string, Dimension>;
2291
2535
 
2292
- /**
2293
- * Grid
2294
- */
2295
- Grid: Grid;
2296
-
2297
2536
  /**
2298
2537
  * Measures
2299
2538
  */
@@ -2307,7 +2546,10 @@ declare module "sap/sac/df/model/DataProvider" {
2307
2546
  /**
2308
2547
  * Visualizations
2309
2548
  */
2310
- Visualizations: Record<string, Visualization>;
2549
+ Visualizations: Record<
2550
+ string,
2551
+ /* was: sap.sac.df.model.Visualization */ any
2552
+ >;
2311
2553
 
2312
2554
  /**
2313
2555
  * Creates a new subclass of class sap.sac.df.model.DataProvider with name `sClassName` and enriches it
@@ -2736,45 +2978,78 @@ declare module "sap/sac/df/model/Dimension" {
2736
2978
  }
2737
2979
  }
2738
2980
 
2739
- declare module "sap/sac/df/model/Documents" {
2740
- import BaseObject from "sap/ui/base/Object";
2981
+ declare module "sap/sac/df/model/MultiDimModel" {
2982
+ import JSONModel from "sap/ui/model/json/JSONModel";
2741
2983
 
2742
- import DocumentsSupportType from "sap/sac/df/types/DocumentsSupportType";
2984
+ import Configuration from "sap/sac/df/model/Configuration";
2985
+
2986
+ import DataProvider from "sap/sac/df/model/DataProvider";
2987
+
2988
+ import Message from "sap/ui/core/message/Message";
2989
+
2990
+ import VariableGroup from "sap/sac/df/model/VariableGroup";
2991
+
2992
+ import DataSourceType from "sap/sac/df/types/DataSourceType";
2743
2993
 
2744
2994
  import Metadata from "sap/ui/base/Metadata";
2745
2995
 
2996
+ import Event from "sap/ui/base/Event";
2997
+
2746
2998
  /**
2747
- * Documents manager object
2999
+ * The multidimensional model allows to access and change data accessed via the InA Protocol. The multidimensional
3000
+ * model populate it's exposed data in JSON format via binding to controls.
2748
3001
  *
2749
3002
  * **Structure of Exposed Data:**
2750
3003
  * ```javascript
2751
3004
  *
2752
- * "ActiveDocumentsDirectory": "",
2753
- * "DocumentsSupportType": ""
2754
- * "IsBasedOnCDSView": ""
3005
+ * "DataProviders": { },
3006
+ * "VariableGroups": { },
3007
+ * "Messages": [ ]
2755
3008
  * ```
2756
3009
  *
2757
3010
  *
2758
3011
  * @since 1.119
2759
3012
  * @experimental (since 1.119)
2760
3013
  */
2761
- export default class Documents extends BaseObject {
3014
+ export default class MultiDimModel extends JSONModel {
2762
3015
  /**
2763
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3016
+ * Constructor for a new MultiDimModel. After model creation you need to wait for the event {@link #event:loaded loaded}.
2764
3017
  */
2765
- protected constructor();
3018
+ constructor(
3019
+ /**
3020
+ * ID for the new control, generated automatically if no ID is given
3021
+ */
3022
+ sId?: string,
3023
+ /**
3024
+ * Initial settings for the new control.
3025
+ */
3026
+ mSettings?: object
3027
+ );
3028
+ /**
3029
+ * Configuration
3030
+ */
3031
+ Configuration: Record<string, Configuration>;
2766
3032
 
2767
- ActiveDocumentsDirectory: undefined;
3033
+ /**
3034
+ * Data Providers
3035
+ */
3036
+ DataProviders: Record<string, DataProvider>;
2768
3037
 
2769
- DocumentsSupportType: undefined;
3038
+ /**
3039
+ * Messages
3040
+ */
3041
+ Messages: Message[];
2770
3042
 
2771
- IsBasedOnCDSView: undefined;
3043
+ /**
3044
+ * Variable Groups
3045
+ */
3046
+ VariableGroups: Record<string, VariableGroup>;
2772
3047
 
2773
3048
  /**
2774
- * Creates a new subclass of class sap.sac.df.model.Documents with name `sClassName` and enriches it with
2775
- * the information contained in `oClassInfo`.
3049
+ * Creates a new subclass of class sap.sac.df.model.MultiDimModel with name `sClassName` and enriches it
3050
+ * with the information contained in `oClassInfo`.
2776
3051
  *
2777
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3052
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.json.JSONModel.extend}.
2778
3053
  *
2779
3054
  *
2780
3055
  * @returns Created class / constructor function
@@ -2787,7 +3062,7 @@ declare module "sap/sac/df/model/Documents" {
2787
3062
  /**
2788
3063
  * Object literal with information about the class
2789
3064
  */
2790
- oClassInfo?: sap.ClassInfo<T, Documents>,
3065
+ oClassInfo?: sap.ClassInfo<T, MultiDimModel>,
2791
3066
  /**
2792
3067
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2793
3068
  * used by this class
@@ -2795,333 +3070,378 @@ declare module "sap/sac/df/model/Documents" {
2795
3070
  FNMetaImpl?: Function
2796
3071
  ): Function;
2797
3072
  /**
2798
- * Returns a metadata object for class sap.sac.df.model.Documents.
3073
+ * Returns a metadata object for class sap.sac.df.model.MultiDimModel.
2799
3074
  *
2800
3075
  *
2801
3076
  * @returns Metadata object describing this class
2802
3077
  */
2803
3078
  static getMetadata(): Metadata;
2804
3079
  /**
2805
- * Create and retrieve document in the document store
3080
+ * Creates a new data provider and attaches it to the model.
2806
3081
  *
2807
3082
  *
2808
- * @returns a promise which resolves with the newly created document.
3083
+ * @returns Promise which resolves the created data provider
2809
3084
  */
2810
- createAndRetrieveDocument(
3085
+ addDataProvider(
2811
3086
  /**
2812
- * the document ID
3087
+ * Data provider name
2813
3088
  */
2814
- sDocumentId: undefined,
3089
+ sDataProviderName: string,
2815
3090
  /**
2816
- * the content of the document
3091
+ * Datasource name which the data provider is supposed to expose
2817
3092
  */
2818
- sContent: undefined,
3093
+ sDataSourceName: string,
2819
3094
  /**
2820
- * properties (ideally as key-value-pair)
3095
+ * System name
2821
3096
  */
2822
- oProperties: undefined
2823
- ): Promise<object>;
3097
+ sSystem?: string,
3098
+ /**
3099
+ * Package name
3100
+ */
3101
+ sPackage?: string,
3102
+ /**
3103
+ * Schema name
3104
+ */
3105
+ sSchema?: string,
3106
+ /**
3107
+ * Data source type
3108
+ */
3109
+ sDataSourceType?: DataSourceType | keyof typeof DataSourceType,
3110
+ /**
3111
+ * if the data should be fetched automatically
3112
+ */
3113
+ bAutoFetchEnabled?: boolean
3114
+ ): Promise<DataProvider>;
2824
3115
  /**
2825
- * Create a document in the document store
3116
+ * Creates a new variable group and attaches it to the model.
3117
+ *
3118
+ * A variable group defines which variables of the underlying data providers should behave as the same variable.
3119
+ * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
2826
3120
  *
2827
3121
  *
2828
- * @returns a promise which resolves to true if create operation is successful, otherwise false.
3122
+ * @returns created variable group
2829
3123
  */
2830
- createDocument(
3124
+ createVariableGroup(
2831
3125
  /**
2832
- * the document ID
3126
+ * Variable group name
2833
3127
  */
2834
- sDocumentId: undefined,
3128
+ sVariableGroupName: string,
2835
3129
  /**
2836
- * the content of the document
3130
+ * Rule is a function which accept the variable definition and decides if the variable has to be part of
3131
+ * te group.
2837
3132
  */
2838
- sContent: undefined,
3133
+ fnRule: Function,
2839
3134
  /**
2840
- * properties (ideally as key-value-pair)
3135
+ * Additional properties
2841
3136
  */
2842
- oProperties: undefined
2843
- ): Promise<boolean>;
3137
+ oProperties: Object
3138
+ ): VariableGroup;
2844
3139
  /**
2845
- * Creates a document ID for a data cell in the result set
3140
+ * Updates the model from the given the model state including all aggregated data providers
2846
3141
  *
2847
3142
  *
2848
- * @returns a promise which resolves with the newly created document ID
3143
+ * @returns Promise with reference to this in order to allow method chaining
2849
3144
  */
2850
- createDocumentId(
3145
+ deserialize(
2851
3146
  /**
2852
- * the row index
3147
+ * A JSON object which represents the multidimensional model to be applied
2853
3148
  */
2854
- nRowIndex: int,
3149
+ oModelState: object,
2855
3150
  /**
2856
- * the column index
3151
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
2857
3152
  */
2858
- nColumnIndex: int
2859
- ): Promise<String>;
3153
+ sFormat?: string
3154
+ ): Promise<this>;
2860
3155
  /**
2861
- * Delete a document in the document store
3156
+ * Fires event {@link #event:dataProviderAdded dataProviderAdded} to attached listeners.
2862
3157
  *
2863
3158
  *
2864
- * @returns a promise which resolves to true if delete operation is successful, otherwise false.
3159
+ * @returns Reference to this in order to allow method chaining
2865
3160
  */
2866
- deleteDocument(
3161
+ fireDataProviderAdded(
2867
3162
  /**
2868
- * the document ID
3163
+ * Parameters to pass along with the event
2869
3164
  */
2870
- sDocumentId: undefined
2871
- ): Promise<boolean>;
3165
+ oParameters?: object
3166
+ ): this;
2872
3167
  /**
2873
- * Delete a document ID for a data cell in the result set
3168
+ * Fires event {@link #event:dataProviderRemoved dataProviderRemoved} to attached listeners.
2874
3169
  *
2875
3170
  *
2876
- * @returns a promise which resolves to true if the delete operation is successful, otherwise false.
3171
+ * @returns Reference to this in order to allow method chaining
2877
3172
  */
2878
- deleteDocumentId(
2879
- /**
2880
- * the row index
2881
- */
2882
- nRowIndex: int,
3173
+ fireDataProviderRemoved(
2883
3174
  /**
2884
- * the column index
3175
+ * Parameters to pass along with the event
2885
3176
  */
2886
- nColumnIndex: int
2887
- ): Promise<boolean>;
3177
+ oParameters?: object
3178
+ ): this;
2888
3179
  /**
2889
- * Get a document ID of a data cell in the result set
3180
+ * Fires event {@link #event:dataProviderUpdated dataProviderUpdated} to attached listeners.
2890
3181
  *
2891
3182
  *
2892
- * @returns a promise which resolves with the document ID
3183
+ * @returns Reference to this in order to allow method chaining
2893
3184
  */
2894
- getDocumentId(
3185
+ fireDataProviderUpdated(
2895
3186
  /**
2896
- * the row index
3187
+ * Parameters to pass along with the event
2897
3188
  */
2898
- nRowIndex: int,
3189
+ oParameters?: object
3190
+ ): this;
3191
+ /**
3192
+ * Fires event {@link #event:variableGroupsAdded variableGroupsAdded} to attached listeners.
3193
+ *
3194
+ *
3195
+ * @returns Reference to this in order to allow method chaining
3196
+ */
3197
+ fireVariableGroupsAdded(
2899
3198
  /**
2900
- * the column index
3199
+ * Parameters to pass along with the event
2901
3200
  */
2902
- nColumnIndex: int
2903
- ): Promise<String>;
3201
+ oParameters?: object
3202
+ ): this;
2904
3203
  /**
2905
- * Get the type of documents support.
3204
+ * Get context menu provider registry
2906
3205
  *
2907
3206
  *
2908
- * @returns documents support type
3207
+ * @returns sap.sac.df.model.extentsions.contextMenu.ContextMenuProviderRegistry
2909
3208
  */
2910
- getDocumentsSupportType(): DocumentsSupportType;
3209
+ getContextMenuProviderRegistry(): undefined;
2911
3210
  /**
2912
- * Retrieves a document from the document store
3211
+ * Get a data provider
2913
3212
  *
2914
3213
  *
2915
- * @returns a promise which resolves with the version(s) of the document.
3214
+ * @returns Data provider object if found
2916
3215
  */
2917
- retrieveDocument(
2918
- /**
2919
- * the document ID
2920
- */
2921
- sDocumentId: undefined,
3216
+ getDataProvider(
2922
3217
  /**
2923
- * the version of the document - if version is not supplied, returns all versions.
3218
+ * Data provider name
2924
3219
  */
2925
- sVersion: undefined
2926
- ): Promise<object>;
3220
+ sDataProviderName: string
3221
+ ): DataProvider;
2927
3222
  /**
2928
- * Retrieve multiple documents from the document store
3223
+ * Get all data providers
2929
3224
  *
2930
3225
  *
2931
- * @returns a promise which resolves with all documents and its versions.
3226
+ * @returns Object of all data providers
2932
3227
  */
2933
- retrieveMultipleDocuments(
2934
- /**
2935
- * the array of document IDs
2936
- */
2937
- aDocumentIds: undefined
2938
- ): Promise<object>;
3228
+ getDataProviders(): Record<string, DataProvider>;
2939
3229
  /**
2940
- * Is document storage supporting delete access
3230
+ * Get grid styling template registry
2941
3231
  *
2942
3232
  *
2943
- * @returns if delete access is supported
3233
+ * @returns sap.sac.df.model.extentsions.styling.GridStylingTemplateRegistry
2944
3234
  */
2945
- supportsDelete(): boolean;
3235
+ getGridStylingTemplateRegistry(): undefined;
2946
3236
  /**
2947
- * Is document storage supporting read access
3237
+ * Get all messages
2948
3238
  *
2949
3239
  *
2950
- * @returns if read access is supported
3240
+ * @returns Array of messages
2951
3241
  */
2952
- supportsRead(): boolean;
3242
+ getMessages(): Message[];
2953
3243
  /**
2954
- * Is document storage supporting write (create and change) access
3244
+ * Get a variable group
2955
3245
  *
2956
3246
  *
2957
- * @returns if write (create and change) access is supported
3247
+ * @returns Variable group object
2958
3248
  */
2959
- supportsWrite(): boolean;
2960
- }
2961
- }
2962
-
2963
- declare module "sap/sac/df/model/Grid" {
2964
- import BaseObject from "sap/ui/base/Object";
2965
-
2966
- import Documents from "sap/sac/df/model/Documents";
2967
-
2968
- import Metadata from "sap/ui/base/Metadata";
2969
-
2970
- /**
2971
- * Grid Object
2972
- *
2973
- * @since 1.119
2974
- * @experimental (since 1.119)
2975
- */
2976
- export default class Grid extends BaseObject {
3249
+ getVariableGroup(
3250
+ /**
3251
+ * Variable group name
3252
+ */
3253
+ sVariableGroupName: string
3254
+ ): VariableGroup;
2977
3255
  /**
2978
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3256
+ * Get all variable groups
3257
+ *
3258
+ *
3259
+ * @returns Object of all variable groups
2979
3260
  */
2980
- protected constructor();
3261
+ getVariableGroups(): Record<string, VariableGroup>;
2981
3262
  /**
2982
- * Documents
3263
+ * Ensures all aggregated DataProviders are logged off.
3264
+ *
3265
+ *
3266
+ * @returns Promise which resolves when logoff is finished.
2983
3267
  */
2984
- Documents: Documents;
2985
-
3268
+ logoff(): Promise<void>;
2986
3269
  /**
2987
- * Creates a new subclass of class sap.sac.df.model.Grid with name `sClassName` and enriches it with the
2988
- * information contained in `oClassInfo`.
2989
- *
2990
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3270
+ * Remove existing data provider from the model.
2991
3271
  *
2992
3272
  *
2993
- * @returns Created class / constructor function
3273
+ * @returns Promise which resolves when the removing s finished
2994
3274
  */
2995
- static extend<T extends Record<string, unknown>>(
2996
- /**
2997
- * Name of the class being created
2998
- */
2999
- sClassName: string,
3000
- /**
3001
- * Object literal with information about the class
3002
- */
3003
- oClassInfo?: sap.ClassInfo<T, Grid>,
3275
+ removeDataProvider(
3004
3276
  /**
3005
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3006
- * used by this class
3277
+ * Data provider name to be removed
3007
3278
  */
3008
- FNMetaImpl?: Function
3009
- ): Function;
3279
+ sDataProviderName: string
3280
+ ): Promise<void>;
3010
3281
  /**
3011
- * Returns a metadata object for class sap.sac.df.model.Grid.
3282
+ * Reset the model to the initial state
3012
3283
  *
3013
3284
  *
3014
- * @returns Metadata object describing this class
3285
+ * @returns Promise which resolves when reset is finished.
3015
3286
  */
3016
- static getMetadata(): Metadata;
3287
+ resetModel(): Promise<void>;
3017
3288
  /**
3018
- * Gets the cell context for a data cell in the result set
3289
+ * Serialize the model with all aggregated data providers to a JSON representation
3019
3290
  *
3020
3291
  *
3021
- * @returns a promise which resolves with the retrieved cell context
3292
+ * @returns A JSON object which represents the multidimensional model
3022
3293
  */
3023
- getCellContext(
3294
+ serialize(
3024
3295
  /**
3025
- * the row index
3296
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
3026
3297
  */
3027
- nRowIndex: int,
3298
+ sFormat?: string
3299
+ ): object;
3300
+ /**
3301
+ * Resets the messages
3302
+ */
3303
+ setMessages(
3028
3304
  /**
3029
- * the column index
3305
+ * The new messages for the model, mapping a binding path to an array of sap.ui.core.message.Message objects
3030
3306
  */
3031
- nColumnIndex: int
3032
- ): Promise<Object>;
3307
+ mMessages: Record<string, Message[]>
3308
+ ): void;
3033
3309
  /**
3034
- * Get the list of the jump targets associated to a cell defined via the Report-To-Report Interface.
3310
+ * Set variable groups.
3035
3311
  *
3312
+ * A variable group defines which variables of the underlying data providers should behave as the same variable.
3313
+ * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
3036
3314
  *
3037
- * @returns resolving to the List of jump targets.
3315
+ *
3316
+ * @returns Promise which resolves the created variable group
3038
3317
  */
3039
- getRRITargets(
3040
- /**
3041
- * Row of the data cell
3042
- */
3043
- iRowIndex: int,
3318
+ setVariableGroups(
3044
3319
  /**
3045
- * Column of the data cell
3320
+ * array of variable groups
3046
3321
  */
3047
- iColumnIndex: int
3048
- ): Promise<any>;
3322
+ aVariableGroups: VariableGroup[]
3323
+ ): Promise<VariableGroup[]>;
3049
3324
  }
3050
- }
3325
+ /**
3326
+ * Parameters of the MultiDimModel#dataLoaded event.
3327
+ */
3328
+ export interface MultiDimModel$DataLoadedEventParameters {}
3051
3329
 
3052
- declare module "sap/sac/df/model/MultiDimModel" {
3053
- import JSONModel from "sap/ui/model/json/JSONModel";
3330
+ /**
3331
+ * Event object of the MultiDimModel#dataLoaded event.
3332
+ */
3333
+ export type MultiDimModel$DataLoadedEvent = Event<
3334
+ MultiDimModel$DataLoadedEventParameters,
3335
+ MultiDimModel
3336
+ >;
3054
3337
 
3055
- import DataProvider from "sap/sac/df/model/DataProvider";
3338
+ /**
3339
+ * Parameters of the MultiDimModel#dataProviderAdded event.
3340
+ */
3341
+ export interface MultiDimModel$DataProviderAddedEventParameters {}
3056
3342
 
3057
- import Message from "sap/ui/core/message/Message";
3343
+ /**
3344
+ * Event object of the MultiDimModel#dataProviderAdded event.
3345
+ */
3346
+ export type MultiDimModel$DataProviderAddedEvent = Event<
3347
+ MultiDimModel$DataProviderAddedEventParameters,
3348
+ MultiDimModel
3349
+ >;
3058
3350
 
3059
- import VariableGroup from "sap/sac/df/model/VariableGroup";
3351
+ /**
3352
+ * Parameters of the MultiDimModel#dataProviderRemoved event.
3353
+ */
3354
+ export interface MultiDimModel$DataProviderRemovedEventParameters {}
3060
3355
 
3061
- import DataSourceType from "sap/sac/df/types/DataSourceType";
3356
+ /**
3357
+ * Event object of the MultiDimModel#dataProviderRemoved event.
3358
+ */
3359
+ export type MultiDimModel$DataProviderRemovedEvent = Event<
3360
+ MultiDimModel$DataProviderRemovedEventParameters,
3361
+ MultiDimModel
3362
+ >;
3062
3363
 
3063
- import Metadata from "sap/ui/base/Metadata";
3364
+ /**
3365
+ * Parameters of the MultiDimModel#dataProviderUpdated event.
3366
+ */
3367
+ export interface MultiDimModel$DataProviderUpdatedEventParameters {}
3064
3368
 
3065
- import Event from "sap/ui/base/Event";
3369
+ /**
3370
+ * Event object of the MultiDimModel#dataProviderUpdated event.
3371
+ */
3372
+ export type MultiDimModel$DataProviderUpdatedEvent = Event<
3373
+ MultiDimModel$DataProviderUpdatedEventParameters,
3374
+ MultiDimModel
3375
+ >;
3066
3376
 
3067
3377
  /**
3068
- * The multidimensional model allows to access and change data accessed via the InA Protocol. The multidimensional
3069
- * model populate it's exposed data in JSON format via binding to controls.
3378
+ * Parameters of the MultiDimModel#loaded event.
3379
+ */
3380
+ export interface MultiDimModel$LoadedEventParameters {}
3381
+
3382
+ /**
3383
+ * Event object of the MultiDimModel#loaded event.
3384
+ */
3385
+ export type MultiDimModel$LoadedEvent = Event<
3386
+ MultiDimModel$LoadedEventParameters,
3387
+ MultiDimModel
3388
+ >;
3389
+
3390
+ /**
3391
+ * Parameters of the MultiDimModel#variableGroupsAdded event.
3392
+ */
3393
+ export interface MultiDimModel$VariableGroupsAddedEventParameters {}
3394
+
3395
+ /**
3396
+ * Event object of the MultiDimModel#variableGroupsAdded event.
3397
+ */
3398
+ export type MultiDimModel$VariableGroupsAddedEvent = Event<
3399
+ MultiDimModel$VariableGroupsAddedEventParameters,
3400
+ MultiDimModel
3401
+ >;
3402
+ }
3403
+
3404
+ declare module "sap/sac/df/model/Variable" {
3405
+ import BaseObject from "sap/ui/base/Object";
3406
+
3407
+ import Metadata from "sap/ui/base/Metadata";
3408
+
3409
+ /**
3410
+ * Variable Object
3070
3411
  *
3071
3412
  * **Structure of Exposed Data:**
3072
3413
  * ```javascript
3073
3414
  *
3074
- * "DataProviders": { },
3075
- * "VariableGroups": { },
3076
- * "Messages": [ ]
3415
+ * "Name": "",
3416
+ * "Dimension": "",
3417
+ * "ValueType": "",
3418
+ * "VariableType": "",
3419
+ * "Description": "",
3420
+ * "Mandatory": "",
3421
+ * "SupportsMultipleValues": "",
3422
+ * "TechName": "",
3423
+ * "InputEnabled": "",
3424
+ * "Position": ""
3425
+ * "SupportsValueHelp": "",
3426
+ * "DataProviderName": "",
3427
+ * "MemberFilter": []
3077
3428
  * ```
3078
3429
  *
3079
3430
  *
3080
3431
  * @since 1.119
3081
3432
  * @experimental (since 1.119)
3082
3433
  */
3083
- export default class MultiDimModel extends JSONModel {
3084
- /**
3085
- * Constructor for a new MultiDimModel. After model creation you need to wait for the event {@link #event:loaded loaded}.
3086
- */
3087
- constructor(
3088
- /**
3089
- * ID for the new control, generated automatically if no ID is given
3090
- */
3091
- sId?: string,
3092
- /**
3093
- * Initial settings for the new control.
3094
- */
3095
- mSettings?: object
3096
- );
3097
- /**
3098
- * Configuration
3099
- */
3100
- Configuration: Record<
3101
- string,
3102
- /* was: sap.sac.df.model.Configuration */ any
3103
- >;
3104
-
3105
- /**
3106
- * Data Providers
3107
- */
3108
- DataProviders: Record<string, DataProvider>;
3109
-
3110
- /**
3111
- * Messages
3112
- */
3113
- Messages: Message[];
3114
-
3434
+ export default class Variable extends BaseObject {
3115
3435
  /**
3116
- * Variable Groups
3436
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3117
3437
  */
3118
- VariableGroups: Record<string, VariableGroup>;
3438
+ protected constructor();
3119
3439
 
3120
3440
  /**
3121
- * Creates a new subclass of class sap.sac.df.model.MultiDimModel with name `sClassName` and enriches it
3122
- * with the information contained in `oClassInfo`.
3441
+ * Creates a new subclass of class sap.sac.df.model.Variable with name `sClassName` and enriches it with
3442
+ * the information contained in `oClassInfo`.
3123
3443
  *
3124
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.json.JSONModel.extend}.
3444
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3125
3445
  *
3126
3446
  *
3127
3447
  * @returns Created class / constructor function
@@ -3134,7 +3454,7 @@ declare module "sap/sac/df/model/MultiDimModel" {
3134
3454
  /**
3135
3455
  * Object literal with information about the class
3136
3456
  */
3137
- oClassInfo?: sap.ClassInfo<T, MultiDimModel>,
3457
+ oClassInfo?: sap.ClassInfo<T, Variable>,
3138
3458
  /**
3139
3459
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3140
3460
  * used by this class
@@ -3142,411 +3462,312 @@ declare module "sap/sac/df/model/MultiDimModel" {
3142
3462
  FNMetaImpl?: Function
3143
3463
  ): Function;
3144
3464
  /**
3145
- * Returns a metadata object for class sap.sac.df.model.MultiDimModel.
3465
+ * Returns a metadata object for class sap.sac.df.model.Variable.
3146
3466
  *
3147
3467
  *
3148
3468
  * @returns Metadata object describing this class
3149
3469
  */
3150
3470
  static getMetadata(): Metadata;
3151
3471
  /**
3152
- * Creates a new data provider and attaches it to the model.
3472
+ * Add variable filters
3153
3473
  *
3154
3474
  *
3155
- * @returns Promise which resolves the created data provider
3475
+ * @returns Reference to this in order to allow method chaining
3156
3476
  */
3157
- addDataProvider(
3158
- /**
3159
- * Data provider name
3160
- */
3161
- sDataProviderName: string,
3162
- /**
3163
- * Datasource name which the data provider is supposed to expose
3164
- */
3165
- sDataSourceName: string,
3166
- /**
3167
- * System name
3168
- */
3169
- sSystem?: string,
3170
- /**
3171
- * Package name
3172
- */
3173
- sPackage?: string,
3174
- /**
3175
- * Schema name
3176
- */
3177
- sSchema?: string,
3178
- /**
3179
- * Data source type
3180
- */
3181
- sDataSourceType?: DataSourceType | keyof typeof DataSourceType,
3477
+ addMemberFilter(
3182
3478
  /**
3183
- * if the data should be fetched automatically
3479
+ * a member filter object
3184
3480
  */
3185
- bAutoFetchEnabled?: boolean
3186
- ): Promise<DataProvider>;
3481
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
3482
+ ): this;
3187
3483
  /**
3188
- * Creates a new variable group and attaches it to the model.
3189
- *
3190
- * A variable group defines which variables of the underlying data providers should behave as the same variable.
3191
- * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
3484
+ * Add a member filter by its (internal) key
3192
3485
  *
3193
- * @deprecated (since 1.124) - Replaced by {@link sap.sac.df.model.MultiDimModel#setVariableGroups setAutoFetchEnabled }
3194
- * API to set the variables.
3195
3486
  *
3196
- * @returns Promise which resolves the created variable group
3487
+ * @returns Reference to this in order to allow method chaining
3197
3488
  */
3198
- addVariableGroup(
3199
- /**
3200
- * Variable group name
3201
- */
3202
- sVariableGroupName: string,
3203
- /**
3204
- * Rule is a function which accept the variable definition and decides if the variable has to be part of
3205
- * te group.
3206
- */
3207
- fnRule: Function,
3489
+ addMemberFilterByKey(
3208
3490
  /**
3209
- * Additional properties
3491
+ * (internal) key of a dimension member
3210
3492
  */
3211
- oProperties: Object
3212
- ): Promise<VariableGroup>;
3493
+ sKey: string
3494
+ ): this;
3213
3495
  /**
3214
- * Creates a new variable group and attaches it to the model.
3496
+ * Clear variable filter
3215
3497
  *
3216
- * A variable group defines which variables of the underlying data providers should behave as the same variable.
3217
- * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
3218
3498
  *
3219
- * @deprecated (since 1.124) - Replaced by {@link sap.sac.df.model.MultiDimModel#setVariableGroups setAutoFetchEnabled }
3220
- * API to set the variables.
3499
+ * @returns Reference to this in order to allow method chaining
3500
+ */
3501
+ clearMemberFilter(): this;
3502
+ /**
3503
+ * Get effective variable filters
3221
3504
  *
3222
- * @returns created variable group
3505
+ *
3506
+ * @returns array of member filters
3223
3507
  */
3224
- createVariableGroup(
3225
- /**
3226
- * Variable group name
3227
- */
3228
- sVariableGroupName: string,
3229
- /**
3230
- * Rule is a function which accept the variable definition and decides if the variable has to be part of
3231
- * te group.
3232
- */
3233
- fnRule: Function,
3234
- /**
3235
- * Additional properties
3236
- */
3237
- oProperties: Object
3238
- ): VariableGroup;
3508
+ getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
3239
3509
  /**
3240
- * Updates the model from the given the model state including all aggregated data providers
3510
+ * Open a dialog to display and change the filter on a variable
3241
3511
  *
3242
3512
  *
3243
- * @returns Promise with reference to this in order to allow method chaining
3513
+ * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
3514
+ * with Ok and dynamic filters of the given dimension are updated
3244
3515
  */
3245
- deserialize(
3246
- /**
3247
- * A JSON object which represents the multidimensional model to be applied
3248
- */
3249
- oModelState: object,
3250
- /**
3251
- * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
3252
- */
3253
- sFormat?: string
3254
- ): Promise<this>;
3516
+ openValueHelpDialog(): Promise<any>;
3255
3517
  /**
3256
- * Fires event {@link #event:dataProviderAdded dataProviderAdded} to attached listeners.
3518
+ * Remove variable filter
3257
3519
  *
3258
3520
  *
3259
3521
  * @returns Reference to this in order to allow method chaining
3260
3522
  */
3261
- fireDataProviderAdded(
3523
+ removeMemberFilter(
3262
3524
  /**
3263
- * Parameters to pass along with the event
3525
+ * a member filter object
3264
3526
  */
3265
- oParameters?: object
3527
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
3266
3528
  ): this;
3267
3529
  /**
3268
- * Fires event {@link #event:dataProviderRemoved dataProviderRemoved} to attached listeners.
3530
+ * Remove a member filter by its (internal) key
3269
3531
  *
3270
3532
  *
3271
3533
  * @returns Reference to this in order to allow method chaining
3272
3534
  */
3273
- fireDataProviderRemoved(
3535
+ removeMemberFilterByKey(
3274
3536
  /**
3275
- * Parameters to pass along with the event
3537
+ * (internal) key of a dimension member
3276
3538
  */
3277
- oParameters?: object
3539
+ sKey: string
3278
3540
  ): this;
3279
3541
  /**
3280
- * Fires event {@link #event:dataProviderUpdated dataProviderUpdated} to attached listeners.
3542
+ * Set variable filters
3281
3543
  *
3282
3544
  *
3283
3545
  * @returns Reference to this in order to allow method chaining
3284
3546
  */
3285
- fireDataProviderUpdated(
3547
+ setMemberFilter(
3286
3548
  /**
3287
- * Parameters to pass along with the event
3549
+ * array of member filters
3288
3550
  */
3289
- oParameters?: object
3551
+ aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
3290
3552
  ): this;
3291
3553
  /**
3292
- * Fires event {@link #event:variableGroupsAdded variableGroupsAdded} to attached listeners.
3554
+ * Set a member filter by its (internal) key
3293
3555
  *
3294
3556
  *
3295
3557
  * @returns Reference to this in order to allow method chaining
3296
3558
  */
3297
- fireVariableGroupsAdded(
3559
+ setMemberFilterByKey(
3298
3560
  /**
3299
- * Parameters to pass along with the event
3561
+ * (internal) key of a dimension member
3300
3562
  */
3301
- oParameters?: object
3563
+ sKey: string
3302
3564
  ): this;
3565
+ }
3566
+ }
3567
+
3568
+ declare module "sap/sac/df/model/VariableGroup" {
3569
+ import BaseObject from "sap/ui/base/Object";
3570
+
3571
+ import Variable from "sap/sac/df/model/Variable";
3572
+
3573
+ import Metadata from "sap/ui/base/Metadata";
3574
+
3575
+ /**
3576
+ * Variable Group Object
3577
+ *
3578
+ * **Structure of Exposed Data:**
3579
+ * ```javascript
3580
+ *
3581
+ * "Name": "",
3582
+ * "MergedVariable": { },
3583
+ * "Rule": function () {}
3584
+ * ```
3585
+ *
3586
+ *
3587
+ * @since 1.119
3588
+ * @experimental (since 1.119)
3589
+ */
3590
+ export default class VariableGroup extends BaseObject {
3303
3591
  /**
3304
- * Get configuration
3305
- *
3306
- *
3307
- * @returns Configuration object
3592
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
3308
3593
  */
3309
- getConfiguration(): /* was: sap.sac.df.model.Configuration */ any;
3594
+ protected constructor();
3310
3595
  /**
3311
- * Get a data provider
3596
+ * Merged Variable
3597
+ */
3598
+ MergedVariable: Variable;
3599
+
3600
+ /**
3601
+ * Name
3602
+ */
3603
+ Name: string;
3604
+
3605
+ /**
3606
+ * Creates a new subclass of class sap.sac.df.model.VariableGroup with name `sClassName` and enriches it
3607
+ * with the information contained in `oClassInfo`.
3312
3608
  *
3609
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3313
3610
  *
3314
- * @returns Data provider object if found
3611
+ *
3612
+ * @returns Created class / constructor function
3315
3613
  */
3316
- getDataProvider(
3614
+ static extend<T extends Record<string, unknown>>(
3317
3615
  /**
3318
- * Data provider name
3616
+ * Name of the class being created
3319
3617
  */
3320
- sDataProviderName: string
3321
- ): DataProvider;
3618
+ sClassName: string,
3619
+ /**
3620
+ * Object literal with information about the class
3621
+ */
3622
+ oClassInfo?: sap.ClassInfo<T, VariableGroup>,
3623
+ /**
3624
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3625
+ * used by this class
3626
+ */
3627
+ FNMetaImpl?: Function
3628
+ ): Function;
3322
3629
  /**
3323
- * Get all data providers
3630
+ * Returns a metadata object for class sap.sac.df.model.VariableGroup.
3324
3631
  *
3325
3632
  *
3326
- * @returns Object of all data providers
3633
+ * @returns Metadata object describing this class
3327
3634
  */
3328
- getDataProviders(): Record<string, DataProvider>;
3635
+ static getMetadata(): Metadata;
3329
3636
  /**
3330
- * Get all messages
3637
+ * Add variable group filters
3331
3638
  *
3332
3639
  *
3333
- * @returns Array of messages
3640
+ * @returns Reference to this in order to allow method chaining
3334
3641
  */
3335
- getMessages(): Message[];
3642
+ addMemberFilter(
3643
+ /**
3644
+ * a member filter object
3645
+ */
3646
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
3647
+ ): this;
3336
3648
  /**
3337
- * Get a variable group
3649
+ * Add a member filter by its (internal) key
3338
3650
  *
3339
3651
  *
3340
- * @returns Variable group object
3652
+ * @returns Reference to this in order to allow method chaining
3341
3653
  */
3342
- getVariableGroup(
3654
+ addMemberFilterByKey(
3343
3655
  /**
3344
- * Variable group name
3656
+ * (internal) key of a dimension member
3345
3657
  */
3346
- sVariableGroupName: string
3347
- ): VariableGroup;
3658
+ sKey: string
3659
+ ): this;
3348
3660
  /**
3349
- * Get all variable groups
3661
+ * Clear variable group filter
3350
3662
  *
3351
3663
  *
3352
- * @returns Object of all variable groups
3664
+ * @returns Reference to this in order to allow method chaining
3353
3665
  */
3354
- getVariableGroups(): Record<string, VariableGroup>;
3666
+ clearMemberFilter(): this;
3355
3667
  /**
3356
- * Ensures all aggregated DataProviders are logged off.
3668
+ * Get effective variable group filters
3357
3669
  *
3358
3670
  *
3359
- * @returns Promise which resolves when logoff is finished.
3671
+ * @returns array of member filters
3360
3672
  */
3361
- logoff(): Promise<void>;
3673
+ getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
3362
3674
  /**
3363
- * Remove existing data provider from the model.
3675
+ * Opens the value help dialog so the user choose a value for a variable group After the value is selected
3676
+ * only teh VariableGroup.MergedVariable is updated. The variables of the aggregated DataProviders are updated
3677
+ * with the next ResultSet fetch
3364
3678
  *
3365
3679
  *
3366
- * @returns Promise which resolves when the removing s finished
3680
+ * @returns to indicate if the VariableGroup has been updated
3367
3681
  */
3368
- removeDataProvider(
3369
- /**
3370
- * Data provider name to be removed
3371
- */
3372
- sDataProviderName: string
3373
- ): Promise<void>;
3682
+ openValueHelpDialog(): Promise<boolean>;
3374
3683
  /**
3375
- * Remove a variable group from the model
3684
+ * Remove variable group filter
3376
3685
  *
3377
- * @deprecated (since 1.124) - Replaced by {@link sap.sac.df.model.MultiDimModel#setVariableGroups setAutoFetchEnabled }
3378
- * API to set the variables.
3379
3686
  *
3380
- * @returns Promise which resolves when the removing s finished
3687
+ * @returns Reference to this in order to allow method chaining
3381
3688
  */
3382
- removeVariableGroup(
3689
+ removeMemberFilter(
3383
3690
  /**
3384
- * Variable group name
3691
+ * a member filter object
3385
3692
  */
3386
- sVariableGroupName: string
3387
- ): Promise<void>;
3388
- /**
3389
- * Reset the model to the initial state
3390
- *
3391
- *
3392
- * @returns Promise which resolves when reset is finished.
3393
- */
3394
- resetModel(): Promise<void>;
3693
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
3694
+ ): this;
3395
3695
  /**
3396
- * Serialize the model with all aggregated data providers to a JSON representation
3696
+ * Remove a member filter by its (internal) key
3397
3697
  *
3398
3698
  *
3399
- * @returns A JSON object which represents the multidimensional model
3699
+ * @returns Reference to this in order to allow method chaining
3400
3700
  */
3401
- serialize(
3701
+ removeMemberFilterByKey(
3402
3702
  /**
3403
- * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
3703
+ * (internal) key of a dimension member
3404
3704
  */
3405
- sFormat?: string
3406
- ): object;
3705
+ sKey: string
3706
+ ): this;
3407
3707
  /**
3408
- * Resets the messages
3708
+ * Set variable group filters
3709
+ *
3710
+ *
3711
+ * @returns Promise which resolve when the value is set
3409
3712
  */
3410
- setMessages(
3713
+ setMemberFilter(
3411
3714
  /**
3412
- * The new messages for the model, mapping a binding path to an array of sap.ui.core.message.Message objects
3715
+ * array of member filters
3413
3716
  */
3414
- mMessages: Record<string, Message[]>
3415
- ): void;
3717
+ aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
3718
+ ): undefined;
3416
3719
  /**
3417
- * Set variable groups.
3418
- *
3419
- * A variable group defines which variables of the underlying data providers should behave as the same variable.
3420
- * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
3720
+ * Set a member filter by its (internal) key
3421
3721
  *
3422
3722
  *
3423
- * @returns Promise which resolves the created variable group
3723
+ * @returns Reference to this in order to allow method chaining
3424
3724
  */
3425
- setVariableGroups(
3725
+ setMemberFilterByKey(
3426
3726
  /**
3427
- * array of variable groups
3727
+ * (internal) ey of a dimension member
3428
3728
  */
3429
- aVariableGroups: VariableGroup[]
3430
- ): Promise<VariableGroup[]>;
3729
+ sKey: string
3730
+ ): this;
3431
3731
  }
3432
- /**
3433
- * Parameters of the MultiDimModel#dataLoaded event.
3434
- */
3435
- export interface MultiDimModel$DataLoadedEventParameters {}
3436
-
3437
- /**
3438
- * Event object of the MultiDimModel#dataLoaded event.
3439
- */
3440
- export type MultiDimModel$DataLoadedEvent = Event<
3441
- MultiDimModel$DataLoadedEventParameters,
3442
- MultiDimModel
3443
- >;
3444
-
3445
- /**
3446
- * Parameters of the MultiDimModel#dataProviderAdded event.
3447
- */
3448
- export interface MultiDimModel$DataProviderAddedEventParameters {}
3449
-
3450
- /**
3451
- * Event object of the MultiDimModel#dataProviderAdded event.
3452
- */
3453
- export type MultiDimModel$DataProviderAddedEvent = Event<
3454
- MultiDimModel$DataProviderAddedEventParameters,
3455
- MultiDimModel
3456
- >;
3457
-
3458
- /**
3459
- * Parameters of the MultiDimModel#dataProviderRemoved event.
3460
- */
3461
- export interface MultiDimModel$DataProviderRemovedEventParameters {}
3462
-
3463
- /**
3464
- * Event object of the MultiDimModel#dataProviderRemoved event.
3465
- */
3466
- export type MultiDimModel$DataProviderRemovedEvent = Event<
3467
- MultiDimModel$DataProviderRemovedEventParameters,
3468
- MultiDimModel
3469
- >;
3470
-
3471
- /**
3472
- * Parameters of the MultiDimModel#dataProviderUpdated event.
3473
- */
3474
- export interface MultiDimModel$DataProviderUpdatedEventParameters {}
3475
-
3476
- /**
3477
- * Event object of the MultiDimModel#dataProviderUpdated event.
3478
- */
3479
- export type MultiDimModel$DataProviderUpdatedEvent = Event<
3480
- MultiDimModel$DataProviderUpdatedEventParameters,
3481
- MultiDimModel
3482
- >;
3483
-
3484
- /**
3485
- * Parameters of the MultiDimModel#loaded event.
3486
- */
3487
- export interface MultiDimModel$LoadedEventParameters {}
3488
-
3489
- /**
3490
- * Event object of the MultiDimModel#loaded event.
3491
- */
3492
- export type MultiDimModel$LoadedEvent = Event<
3493
- MultiDimModel$LoadedEventParameters,
3494
- MultiDimModel
3495
- >;
3496
-
3497
- /**
3498
- * Parameters of the MultiDimModel#variableGroupsAdded event.
3499
- */
3500
- export interface MultiDimModel$VariableGroupsAddedEventParameters {}
3501
-
3502
- /**
3503
- * Event object of the MultiDimModel#variableGroupsAdded event.
3504
- */
3505
- export type MultiDimModel$VariableGroupsAddedEvent = Event<
3506
- MultiDimModel$VariableGroupsAddedEventParameters,
3507
- MultiDimModel
3508
- >;
3509
3732
  }
3510
3733
 
3511
- declare module "sap/sac/df/model/Variable" {
3734
+ declare module "sap/sac/df/model/visualization/Documents" {
3512
3735
  import BaseObject from "sap/ui/base/Object";
3513
3736
 
3737
+ import DocumentsSupportType from "sap/sac/df/types/DocumentsSupportType";
3738
+
3514
3739
  import Metadata from "sap/ui/base/Metadata";
3515
3740
 
3516
3741
  /**
3517
- * Variable Object
3742
+ * Documents manager object
3518
3743
  *
3519
3744
  * **Structure of Exposed Data:**
3520
3745
  * ```javascript
3521
3746
  *
3522
- * "Name": "",
3523
- * "Dimension": "",
3524
- * "ValueType": "",
3525
- * "VariableType": "",
3526
- * "Description": "",
3527
- * "Mandatory": "",
3528
- * "SupportsMultipleValues": "",
3529
- * "TechName": "",
3530
- * "InputEnabled": "",
3531
- * "Position": ""
3532
- * "SupportsValueHelp": "",
3533
- * "DataProviderName": "",
3534
- * "MemberFilter": []
3747
+ * "ActiveDocumentsDirectory": "",
3748
+ * "DocumentsSupportType": ""
3749
+ * "IsBasedOnCDSView": ""
3535
3750
  * ```
3536
3751
  *
3537
3752
  *
3538
3753
  * @since 1.119
3539
3754
  * @experimental (since 1.119)
3540
3755
  */
3541
- export default class Variable extends BaseObject {
3756
+ export default class Documents extends BaseObject {
3542
3757
  /**
3543
3758
  * @ui5-protected Do not call from applications (only from related classes in the framework)
3544
3759
  */
3545
3760
  protected constructor();
3546
3761
 
3762
+ ActiveDocumentsDirectory: undefined;
3763
+
3764
+ DocumentsSupportType: undefined;
3765
+
3766
+ IsBasedOnCDSView: undefined;
3767
+
3547
3768
  /**
3548
- * Creates a new subclass of class sap.sac.df.model.Variable with name `sClassName` and enriches it with
3549
- * the information contained in `oClassInfo`.
3769
+ * Creates a new subclass of class sap.sac.df.model.visualization.Documents with name `sClassName` and enriches
3770
+ * it with the information contained in `oClassInfo`.
3550
3771
  *
3551
3772
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3552
3773
  *
@@ -3561,7 +3782,7 @@ declare module "sap/sac/df/model/Variable" {
3561
3782
  /**
3562
3783
  * Object literal with information about the class
3563
3784
  */
3564
- oClassInfo?: sap.ClassInfo<T, Variable>,
3785
+ oClassInfo?: sap.ClassInfo<T, Documents>,
3565
3786
  /**
3566
3787
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3567
3788
  * used by this class
@@ -3569,149 +3790,191 @@ declare module "sap/sac/df/model/Variable" {
3569
3790
  FNMetaImpl?: Function
3570
3791
  ): Function;
3571
3792
  /**
3572
- * Returns a metadata object for class sap.sac.df.model.Variable.
3793
+ * Returns a metadata object for class sap.sac.df.model.visualization.Documents.
3573
3794
  *
3574
3795
  *
3575
3796
  * @returns Metadata object describing this class
3576
3797
  */
3577
3798
  static getMetadata(): Metadata;
3578
3799
  /**
3579
- * Add variable filters
3800
+ * Create and retrieve document in the document store
3580
3801
  *
3581
3802
  *
3582
- * @returns Reference to this in order to allow method chaining
3803
+ * @returns a promise which resolves with the newly created document.
3583
3804
  */
3584
- addMemberFilter(
3805
+ createAndRetrieveDocument(
3585
3806
  /**
3586
- * a member filter object
3807
+ * the document ID
3587
3808
  */
3588
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
3589
- ): this;
3809
+ sDocumentId: undefined,
3810
+ /**
3811
+ * the content of the document
3812
+ */
3813
+ sContent: undefined,
3814
+ /**
3815
+ * properties (ideally as key-value-pair)
3816
+ */
3817
+ oProperties: undefined
3818
+ ): Promise<object>;
3590
3819
  /**
3591
- * Add a member filter by its (internal) key
3820
+ * Create a document in the document store
3592
3821
  *
3593
3822
  *
3594
- * @returns Reference to this in order to allow method chaining
3823
+ * @returns a promise which resolves to true if create operation is successful, otherwise false.
3595
3824
  */
3596
- addMemberFilterByKey(
3825
+ createDocument(
3597
3826
  /**
3598
- * (internal) key of a dimension member
3827
+ * the document ID
3599
3828
  */
3600
- sKey: string
3601
- ): this;
3829
+ sDocumentId: undefined,
3830
+ /**
3831
+ * the content of the document
3832
+ */
3833
+ sContent: undefined,
3834
+ /**
3835
+ * properties (ideally as key-value-pair)
3836
+ */
3837
+ oProperties: undefined
3838
+ ): Promise<boolean>;
3602
3839
  /**
3603
- * Clear variable filter
3840
+ * Creates a document ID for a data cell in the result set
3604
3841
  *
3605
3842
  *
3606
- * @returns Reference to this in order to allow method chaining
3843
+ * @returns a promise which resolves with the newly created document ID
3607
3844
  */
3608
- clearMemberFilter(): this;
3845
+ createDocumentId(
3846
+ /**
3847
+ * the row index
3848
+ */
3849
+ nRowIndex: int,
3850
+ /**
3851
+ * the column index
3852
+ */
3853
+ nColumnIndex: int
3854
+ ): Promise<String>;
3609
3855
  /**
3610
- * Get effective variable filters
3856
+ * Delete a document in the document store
3611
3857
  *
3612
3858
  *
3613
- * @returns array of member filters
3859
+ * @returns a promise which resolves to true if delete operation is successful, otherwise false.
3614
3860
  */
3615
- getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
3861
+ deleteDocument(
3862
+ /**
3863
+ * the document ID
3864
+ */
3865
+ sDocumentId: undefined
3866
+ ): Promise<boolean>;
3616
3867
  /**
3617
- * Open a dialog to display and change the filter on a variable
3868
+ * Delete a document ID for a data cell in the result set
3618
3869
  *
3619
3870
  *
3620
- * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
3621
- * with Ok and dynamic filters of the given dimension are updated
3871
+ * @returns a promise which resolves to true if the delete operation is successful, otherwise false.
3622
3872
  */
3623
- openValueHelpDialog(): Promise<any>;
3873
+ deleteDocumentId(
3874
+ /**
3875
+ * the row index
3876
+ */
3877
+ nRowIndex: int,
3878
+ /**
3879
+ * the column index
3880
+ */
3881
+ nColumnIndex: int
3882
+ ): Promise<boolean>;
3883
+ /**
3884
+ * Get a document ID of a data cell in the result set
3885
+ *
3886
+ *
3887
+ * @returns a promise which resolves with the document ID
3888
+ */
3889
+ getDocumentId(
3890
+ /**
3891
+ * the row index
3892
+ */
3893
+ nRowIndex: int,
3894
+ /**
3895
+ * the column index
3896
+ */
3897
+ nColumnIndex: int
3898
+ ): Promise<String>;
3899
+ /**
3900
+ * Get the type of documents support.
3901
+ *
3902
+ *
3903
+ * @returns documents support type
3904
+ */
3905
+ getDocumentsSupportType(): DocumentsSupportType;
3906
+ /**
3907
+ * Retrieves a document from the document store
3908
+ *
3909
+ *
3910
+ * @returns a promise which resolves with the version(s) of the document.
3911
+ */
3912
+ retrieveDocument(
3913
+ /**
3914
+ * the document ID
3915
+ */
3916
+ sDocumentId: undefined,
3917
+ /**
3918
+ * the version of the document - if version is not supplied, returns all versions.
3919
+ */
3920
+ sVersion: undefined
3921
+ ): Promise<object>;
3624
3922
  /**
3625
- * Remove variable filter
3923
+ * Retrieve multiple documents from the document store
3626
3924
  *
3627
3925
  *
3628
- * @returns Reference to this in order to allow method chaining
3926
+ * @returns a promise which resolves with all documents and its versions.
3629
3927
  */
3630
- removeMemberFilter(
3928
+ retrieveMultipleDocuments(
3631
3929
  /**
3632
- * a member filter object
3930
+ * the array of document IDs
3633
3931
  */
3634
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
3635
- ): this;
3932
+ aDocumentIds: undefined
3933
+ ): Promise<object>;
3636
3934
  /**
3637
- * Remove a member filter by its (internal) key
3935
+ * Is document storage supporting delete access
3638
3936
  *
3639
3937
  *
3640
- * @returns Reference to this in order to allow method chaining
3938
+ * @returns if delete access is supported
3641
3939
  */
3642
- removeMemberFilterByKey(
3643
- /**
3644
- * (internal) key of a dimension member
3645
- */
3646
- sKey: string
3647
- ): this;
3940
+ supportsDelete(): boolean;
3648
3941
  /**
3649
- * Set variable filters
3942
+ * Is document storage supporting read access
3650
3943
  *
3651
3944
  *
3652
- * @returns Reference to this in order to allow method chaining
3945
+ * @returns if read access is supported
3653
3946
  */
3654
- setMemberFilter(
3655
- /**
3656
- * array of member filters
3657
- */
3658
- aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
3659
- ): this;
3947
+ supportsRead(): boolean;
3660
3948
  /**
3661
- * Set a member filter by its (internal) key
3949
+ * Is document storage supporting write (create and change) access
3662
3950
  *
3663
3951
  *
3664
- * @returns Reference to this in order to allow method chaining
3952
+ * @returns if write (create and change) access is supported
3665
3953
  */
3666
- setMemberFilterByKey(
3667
- /**
3668
- * (internal) key of a dimension member
3669
- */
3670
- sKey: string
3671
- ): this;
3954
+ supportsWrite(): boolean;
3672
3955
  }
3673
3956
  }
3674
3957
 
3675
- declare module "sap/sac/df/model/VariableGroup" {
3958
+ declare module "sap/sac/df/model/visualization/Grid" {
3676
3959
  import BaseObject from "sap/ui/base/Object";
3677
3960
 
3678
- import Variable from "sap/sac/df/model/Variable";
3679
-
3680
3961
  import Metadata from "sap/ui/base/Metadata";
3681
3962
 
3682
3963
  /**
3683
- * Variable Group Object
3684
- *
3685
- * **Structure of Exposed Data:**
3686
- * ```javascript
3687
- *
3688
- * "Name": "",
3689
- * "MergedVariable": { },
3690
- * "Rule": function () {}
3691
- * ```
3692
- *
3964
+ * Grid Visualization Object
3693
3965
  *
3694
- * @since 1.119
3695
- * @experimental (since 1.119)
3966
+ * @since 1.132
3967
+ * @experimental (since 1.132)
3696
3968
  */
3697
- export default class VariableGroup extends BaseObject {
3969
+ export default class Grid extends BaseObject {
3698
3970
  /**
3699
3971
  * @ui5-protected Do not call from applications (only from related classes in the framework)
3700
3972
  */
3701
3973
  protected constructor();
3702
- /**
3703
- * Merged Variable
3704
- */
3705
- MergedVariable: Variable;
3706
-
3707
- /**
3708
- * Name
3709
- */
3710
- Name: string;
3711
3974
 
3712
3975
  /**
3713
- * Creates a new subclass of class sap.sac.df.model.VariableGroup with name `sClassName` and enriches it
3714
- * with the information contained in `oClassInfo`.
3976
+ * Creates a new subclass of class sap.sac.df.model.visualization.Grid with name `sClassName` and enriches
3977
+ * it with the information contained in `oClassInfo`.
3715
3978
  *
3716
3979
  * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3717
3980
  *
@@ -3726,7 +3989,7 @@ declare module "sap/sac/df/model/VariableGroup" {
3726
3989
  /**
3727
3990
  * Object literal with information about the class
3728
3991
  */
3729
- oClassInfo?: sap.ClassInfo<T, VariableGroup>,
3992
+ oClassInfo?: sap.ClassInfo<T, Grid>,
3730
3993
  /**
3731
3994
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3732
3995
  * used by this class
@@ -3734,132 +3997,131 @@ declare module "sap/sac/df/model/VariableGroup" {
3734
3997
  FNMetaImpl?: Function
3735
3998
  ): Function;
3736
3999
  /**
3737
- * Returns a metadata object for class sap.sac.df.model.VariableGroup.
4000
+ * Returns a metadata object for class sap.sac.df.model.visualization.Grid.
3738
4001
  *
3739
4002
  *
3740
4003
  * @returns Metadata object describing this class
3741
4004
  */
3742
4005
  static getMetadata(): Metadata;
3743
4006
  /**
3744
- * Add variable group filters
4007
+ * Active styling template
3745
4008
  *
3746
4009
  *
3747
- * @returns Reference to this in order to allow method chaining
4010
+ * @returns resolving to the visualization object
3748
4011
  */
3749
- addMemberFilter(
4012
+ activateStylingTemplate(
3750
4013
  /**
3751
- * a member filter object
4014
+ * styling template name
3752
4015
  */
3753
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
3754
- ): this;
4016
+ sStylingTemplateName: string
4017
+ ): Promise<any>;
3755
4018
  /**
3756
- * Add a member filter by its (internal) key
4019
+ * Get the current axes layout for rows and columns
3757
4020
  *
3758
4021
  *
3759
- * @returns Reference to this in order to allow method chaining
4022
+ * @returns columns and rows axes layout object
3760
4023
  */
3761
- addMemberFilterByKey(
3762
- /**
3763
- * (internal) key of a dimension member
3764
- */
3765
- sKey: string
3766
- ): this;
4024
+ getAxesLayout(): AxesLayout;
3767
4025
  /**
3768
- * Clear variable group filter
4026
+ * Gets the cell context for a data cell in the result set
3769
4027
  *
3770
4028
  *
3771
- * @returns Reference to this in order to allow method chaining
4029
+ * @returns a promise which resolves with the retrieved cell context
3772
4030
  */
3773
- clearMemberFilter(): this;
4031
+ getCellContext(
4032
+ /**
4033
+ * the row index
4034
+ */
4035
+ nRowIndex: int,
4036
+ /**
4037
+ * the column index
4038
+ */
4039
+ nColumnIndex: int
4040
+ ): Promise<Object>;
3774
4041
  /**
3775
- * Get effective variable group filters
4042
+ * Get the list of the jump targets associated to a cell defined via the Report-To-Report Interface.
3776
4043
  *
3777
4044
  *
3778
- * @returns array of member filters
4045
+ * @returns resolving to the List of jump targets.
3779
4046
  */
3780
- getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
4047
+ getRRITargets(
4048
+ /**
4049
+ * Row of the data cell
4050
+ */
4051
+ iRowIndex: int,
4052
+ /**
4053
+ * Column of the data cell
4054
+ */
4055
+ iColumnIndex: int
4056
+ ): Promise<any>;
3781
4057
  /**
3782
- * Opens the value help dialog so the user choose a value for a variable group After the value is selected
3783
- * only teh VariableGroup.MergedVariable is updated. The variables of the aggregated DataProviders are updated
3784
- * with the next ResultSet fetch
4058
+ * Get the data of the visualization
4059
+ * ```javascript
3785
4060
  *
4061
+ * "Cells": [],
4062
+ * "TotalColumns": Integer,
4063
+ * "TotalRows": Integer
4064
+ * ```
3786
4065
  *
3787
- * @returns to indicate if the VariableGroup has been updated
3788
- */
3789
- openValueHelpDialog(): Promise<boolean>;
3790
- /**
3791
- * Remove variable group filter
3792
4066
  *
3793
4067
  *
3794
- * @returns Reference to this in order to allow method chaining
4068
+ * @returns a promise which resolves with the visualization data
3795
4069
  */
3796
- removeMemberFilter(
3797
- /**
3798
- * a member filter object
3799
- */
3800
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
3801
- ): this;
4070
+ getVisualizationData(): Promise<Object>;
3802
4071
  /**
3803
- * Remove a member filter by its (internal) key
4072
+ * Set the dimensions on row and column axis
3804
4073
  *
3805
4074
  *
3806
- * @returns Reference to this in order to allow method chaining
4075
+ * @returns resolving to the axes layout object to allow chaining
3807
4076
  */
3808
- removeMemberFilterByKey(
4077
+ setAxesLayout(
3809
4078
  /**
3810
- * (internal) key of a dimension member
4079
+ * an object containing the names of the dimensions on row and column axis. The order of the dimensions
4080
+ * control the position on the axis.
3811
4081
  */
3812
- sKey: string
3813
- ): this;
4082
+ oAxisLayout: AxesLayout
4083
+ ): Grid;
4084
+ }
4085
+ /**
4086
+ * AxesLayout object type.
4087
+ */
4088
+ export type AxesLayout = {
3814
4089
  /**
3815
- * Set variable group filters
3816
- *
3817
- *
3818
- * @returns Promise which resolve when the value is set
4090
+ * dimensions on column axis
3819
4091
  */
3820
- setMemberFilter(
3821
- /**
3822
- * array of member filters
3823
- */
3824
- aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
3825
- ): undefined;
4092
+ Columns: string[];
3826
4093
  /**
3827
- * Set a member filter by its (internal) key
3828
- *
3829
- *
3830
- * @returns Reference to this in order to allow method chaining
4094
+ * dimensions on row axis
3831
4095
  */
3832
- setMemberFilterByKey(
3833
- /**
3834
- * (internal) ey of a dimension member
3835
- */
3836
- sKey: string
3837
- ): this;
3838
- }
4096
+ Rows: string[];
4097
+ };
3839
4098
  }
3840
4099
 
3841
- declare module "sap/sac/df/model/Visualization" {
3842
- import BaseObject from "sap/ui/base/Object";
4100
+ declare module "sap/sac/df/StylingPanel" {
4101
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
3843
4102
 
3844
- import Metadata from "sap/ui/base/Metadata";
4103
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
4104
+
4105
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3845
4106
 
3846
4107
  /**
3847
- * Visualization Object
3848
- *
3849
- * @since 1.125
3850
- * @experimental (since 1.125)
4108
+ * StylingPanel A panel control to format the data being displayed.
3851
4109
  */
3852
- export default class Visualization extends BaseObject {
4110
+ export default class StylingPanel extends Control {
3853
4111
  /**
3854
- * @ui5-protected Do not call from applications (only from related classes in the framework)
4112
+ * Constructor for a new `StylingPanel` control.
4113
+ *
4114
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
4115
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
4116
+ * of the syntax of the settings object.
3855
4117
  */
3856
- protected constructor();
4118
+ constructor();
3857
4119
 
3858
4120
  /**
3859
- * Creates a new subclass of class sap.sac.df.model.Visualization with name `sClassName` and enriches it
3860
- * with the information contained in `oClassInfo`.
4121
+ * Creates a new subclass of class sap.sac.df.StylingPanel with name `sClassName` and enriches it with the
4122
+ * information contained in `oClassInfo`.
3861
4123
  *
3862
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
4124
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
3863
4125
  *
3864
4126
  *
3865
4127
  * @returns Created class / constructor function
@@ -3872,7 +4134,7 @@ declare module "sap/sac/df/model/Visualization" {
3872
4134
  /**
3873
4135
  * Object literal with information about the class
3874
4136
  */
3875
- oClassInfo?: sap.ClassInfo<T, Visualization>,
4137
+ oClassInfo?: sap.ClassInfo<T, StylingPanel>,
3876
4138
  /**
3877
4139
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3878
4140
  * used by this class
@@ -3880,13 +4142,98 @@ declare module "sap/sac/df/model/Visualization" {
3880
4142
  FNMetaImpl?: Function
3881
4143
  ): Function;
3882
4144
  /**
3883
- * Returns a metadata object for class sap.sac.df.model.Visualization.
4145
+ * Returns a metadata object for class sap.sac.df.StylingPanel.
3884
4146
  *
3885
4147
  *
3886
4148
  * @returns Metadata object describing this class
3887
4149
  */
3888
- static getMetadata(): Metadata;
4150
+ static getMetadata(): ElementMetadata;
4151
+ /**
4152
+ * Gets current value of property {@link #getMetaPath metaPath}.
4153
+ *
4154
+ * Defines the relative path to the data provider in the multidimensional model.
4155
+ *
4156
+ *
4157
+ * @returns Value of property `metaPath`
4158
+ */
4159
+ getMetaPath(): string;
4160
+ /**
4161
+ * Sets a new value for property {@link #getMetaPath metaPath}.
4162
+ *
4163
+ * Defines the relative path to the data provider in the multidimensional model.
4164
+ *
4165
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
4166
+ *
4167
+ *
4168
+ * @returns Reference to `this` in order to allow method chaining
4169
+ */
4170
+ setMetaPath(
4171
+ /**
4172
+ * New value for property `metaPath`
4173
+ */
4174
+ sMetaPath: string
4175
+ ): this;
4176
+ }
4177
+ /**
4178
+ * Describes the settings that can be provided to the StylingPanel constructor.
4179
+ */
4180
+ export interface $StylingPanelSettings extends $ControlSettings {
4181
+ /**
4182
+ * Defines the relative path to the data provider in the multidimensional model.
4183
+ */
4184
+ metaPath?: string | PropertyBindingInfo;
4185
+ }
4186
+ }
4187
+
4188
+ declare module "sap/sac/df/types/Axis" {
4189
+ /**
4190
+ * Axis of a multidimensional Result Set
4191
+ */
4192
+ enum Axis {
4193
+ /**
4194
+ * Columns axis (horizontal direction in a Grid)
4195
+ */
4196
+ Columns = "Columns",
4197
+ /**
4198
+ * Free axis (contains all dimensions that can be placed on the row/column axis)
4199
+ */
4200
+ Free = "Free",
4201
+ /**
4202
+ * Row axis (vertical direction in a Grid)
4203
+ */
4204
+ Rows = "Rows",
4205
+ }
4206
+ export default Axis;
4207
+ }
4208
+
4209
+ declare module "sap/sac/df/types/configuration/StylingPanelItem" {
4210
+ /**
4211
+ * Item of the styling panel
4212
+ *
4213
+ * @since 1.132
4214
+ * @experimental (since 1.132)
4215
+ */
4216
+ enum StylingPanelItem {}
4217
+ export default StylingPanelItem;
4218
+ }
4219
+
4220
+ declare module "sap/sac/df/types/DataAnalyzerPanelName" {
4221
+ /**
4222
+ * DataAnalyzer Panels
4223
+ *
4224
+ * @experimental (since 1.132)
4225
+ */
4226
+ enum DataAnalyzerPanelName {
4227
+ /**
4228
+ * Designer Panel
4229
+ */
4230
+ Designer = "OlapDesignerDocument",
4231
+ /**
4232
+ * Styling Panel
4233
+ */
4234
+ Styling = "StylingPanelDocument",
3889
4235
  }
4236
+ export default DataAnalyzerPanelName;
3890
4237
  }
3891
4238
 
3892
4239
  declare module "sap/sac/df/types/DataSourceType" {
@@ -4028,6 +4375,8 @@ declare namespace sap {
4028
4375
  interface IUI5DefineDependencyNames {
4029
4376
  "sap/sac/df/changeHandler/MultiDimModelChangeHandler": undefined;
4030
4377
 
4378
+ "sap/sac/df/DataAnalyzer": undefined;
4379
+
4031
4380
  "sap/sac/df/DesignerPanel": undefined;
4032
4381
 
4033
4382
  "sap/sac/df/FilterBar": undefined;
@@ -4038,31 +4387,37 @@ declare namespace sap {
4038
4387
 
4039
4388
  "sap/sac/df/FlexAnalysis": undefined;
4040
4389
 
4041
- "sap/sac/df/FlexAnalysisPanel": undefined;
4042
-
4043
4390
  "sap/sac/df/Grid": undefined;
4044
4391
 
4045
4392
  "sap/sac/df/library": undefined;
4046
4393
 
4047
4394
  "sap/sac/df/model/AxesLayout": undefined;
4048
4395
 
4396
+ "sap/sac/df/model/Configuration": undefined;
4397
+
4049
4398
  "sap/sac/df/model/DataProvider": undefined;
4050
4399
 
4051
4400
  "sap/sac/df/model/DataSourceInfo": undefined;
4052
4401
 
4053
4402
  "sap/sac/df/model/Dimension": undefined;
4054
4403
 
4055
- "sap/sac/df/model/Documents": undefined;
4056
-
4057
- "sap/sac/df/model/Grid": undefined;
4058
-
4059
4404
  "sap/sac/df/model/MultiDimModel": undefined;
4060
4405
 
4061
4406
  "sap/sac/df/model/Variable": undefined;
4062
4407
 
4063
4408
  "sap/sac/df/model/VariableGroup": undefined;
4064
4409
 
4065
- "sap/sac/df/model/Visualization": undefined;
4410
+ "sap/sac/df/model/visualization/Documents": undefined;
4411
+
4412
+ "sap/sac/df/model/visualization/Grid": undefined;
4413
+
4414
+ "sap/sac/df/StylingPanel": undefined;
4415
+
4416
+ "sap/sac/df/types/Axis": undefined;
4417
+
4418
+ "sap/sac/df/types/configuration/StylingPanelItem": undefined;
4419
+
4420
+ "sap/sac/df/types/DataAnalyzerPanelName": undefined;
4066
4421
 
4067
4422
  "sap/sac/df/types/DataSourceType": undefined;
4068
4423