@sapui5/types 1.119.1 → 1.120.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 (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +0 -1
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +58 -58
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +103 -1
  8. package/types/sap.f.d.ts +2 -2
  9. package/types/sap.fe.core.d.ts +10 -1
  10. package/types/sap.fe.macros.d.ts +84 -78
  11. package/types/sap.fe.navigation.d.ts +1 -1
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +11 -2
  14. package/types/sap.fe.test.d.ts +15 -7
  15. package/types/sap.fe.tools.d.ts +1 -1
  16. package/types/sap.feedback.ui.d.ts +1 -1
  17. package/types/sap.gantt.d.ts +951 -15
  18. package/types/sap.insights.d.ts +92 -12
  19. package/types/sap.m.d.ts +5723 -155
  20. package/types/sap.makit.d.ts +1 -1
  21. package/types/sap.me.d.ts +1 -1
  22. package/types/sap.ndc.d.ts +1 -1
  23. package/types/sap.ovp.d.ts +7 -3
  24. package/types/sap.rules.ui.d.ts +1 -1
  25. package/types/sap.sac.df.d.ts +870 -1007
  26. package/types/sap.suite.ui.commons.d.ts +34 -2
  27. package/types/sap.suite.ui.generic.template.d.ts +26 -1
  28. package/types/sap.suite.ui.microchart.d.ts +1 -1
  29. package/types/sap.tnt.d.ts +45 -2
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +1 -1
  32. package/types/sap.ui.comp.d.ts +567 -40
  33. package/types/sap.ui.core.d.ts +1744 -143
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +1 -1
  36. package/types/sap.ui.fl.d.ts +14 -4
  37. package/types/sap.ui.generic.app.d.ts +1 -1
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +1 -1
  40. package/types/sap.ui.layout.d.ts +125 -102
  41. package/types/sap.ui.mdc.d.ts +2142 -1439
  42. package/types/sap.ui.richtexteditor.d.ts +4 -12
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +1 -1
  45. package/types/sap.ui.support.d.ts +7 -1
  46. package/types/sap.ui.table.d.ts +121 -47
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +1 -1
  49. package/types/sap.ui.ux3.d.ts +1 -1
  50. package/types/sap.ui.vbm.d.ts +1 -1
  51. package/types/sap.ui.vk.d.ts +5 -11
  52. package/types/sap.ui.vtm.d.ts +1 -1
  53. package/types/sap.ui.webc.common.d.ts +1 -1
  54. package/types/sap.ui.webc.fiori.d.ts +454 -136
  55. package/types/sap.ui.webc.main.d.ts +3737 -1084
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +1996 -808
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +1 -1
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +1 -1
  65. package/types/sap.landvisz.d.ts +0 -8043
@@ -1,7 +1,354 @@
1
- // For Library Version: 1.119.0
1
+ // For Library Version: 1.120.0
2
2
 
3
3
  declare module "sap/sac/df/library" {}
4
4
 
5
+ declare module "sap/sac/df/FilterBar" {
6
+ import {
7
+ default as FilterBar1,
8
+ $FilterBarSettings as $FilterBarSettings1,
9
+ } from "sap/ui/mdc/FilterBar";
10
+
11
+ import Event from "sap/ui/base/Event";
12
+
13
+ import FieldDisplay from "sap/ui/mdc/enums/FieldDisplay";
14
+
15
+ import ElementMetadata from "sap/ui/core/ElementMetadata";
16
+
17
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
18
+
19
+ /**
20
+ * @experimental (since 1.119)
21
+ *
22
+ * A Filter Bar based on Multidimensional Model
23
+ */
24
+ export default class FilterBar extends FilterBar1 {
25
+ /**
26
+ * Constructor for a new Filter Bar.
27
+ *
28
+ * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
29
+ * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
30
+ * of the syntax of the settings object.
31
+ */
32
+ constructor();
33
+
34
+ /**
35
+ * Creates a new subclass of class sap.sac.df.FilterBar with name `sClassName` and enriches it with the
36
+ * information contained in `oClassInfo`.
37
+ *
38
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.FilterBar.extend}.
39
+ *
40
+ * @returns Created class / constructor function
41
+ */
42
+ static extend<T extends Record<string, unknown>>(
43
+ /**
44
+ * Name of the class being created
45
+ */
46
+ sClassName: string,
47
+ /**
48
+ * Object literal with information about the class
49
+ */
50
+ oClassInfo?: sap.ClassInfo<T, FilterBar>,
51
+ /**
52
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
53
+ * used by this class
54
+ */
55
+ FNMetaImpl?: Function
56
+ ): Function;
57
+ /**
58
+ * Returns a metadata object for class sap.sac.df.FilterBar.
59
+ *
60
+ * @returns Metadata object describing this class
61
+ */
62
+ static getMetadata(): ElementMetadata;
63
+ /**
64
+ * Attaches event handler `fnFunction` to the {@link #event:beforeFilterChange beforeFilterChange} event
65
+ * of this `sap.sac.df.FilterBar`.
66
+ *
67
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
68
+ * otherwise it will be bound to this `sap.sac.df.FilterBar` itself.
69
+ *
70
+ * Fires before update variable of multidimension model after input value or open value help of variable.
71
+ *
72
+ * @returns Reference to `this` in order to allow method chaining
73
+ */
74
+ attachBeforeFilterChange(
75
+ /**
76
+ * An application-specific payload object that will be passed to the event handler along with the event
77
+ * object when firing the event
78
+ */
79
+ oData: object,
80
+ /**
81
+ * The function to be called when the event occurs
82
+ */
83
+ fnFunction: (p1: FilterBar$BeforeFilterChangeEvent) => void,
84
+ /**
85
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
86
+ */
87
+ oListener?: object
88
+ ): this;
89
+ /**
90
+ * Attaches event handler `fnFunction` to the {@link #event:beforeFilterChange beforeFilterChange} event
91
+ * of this `sap.sac.df.FilterBar`.
92
+ *
93
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
94
+ * otherwise it will be bound to this `sap.sac.df.FilterBar` itself.
95
+ *
96
+ * Fires before update variable of multidimension model after input value or open value help of variable.
97
+ *
98
+ * @returns Reference to `this` in order to allow method chaining
99
+ */
100
+ attachBeforeFilterChange(
101
+ /**
102
+ * The function to be called when the event occurs
103
+ */
104
+ fnFunction: (p1: FilterBar$BeforeFilterChangeEvent) => void,
105
+ /**
106
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
107
+ */
108
+ oListener?: object
109
+ ): this;
110
+ /**
111
+ * Attaches event handler `fnFunction` to the {@link #event:cancelFilterChange cancelFilterChange} event
112
+ * of this `sap.sac.df.FilterBar`.
113
+ *
114
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
115
+ * otherwise it will be bound to this `sap.sac.df.FilterBar` itself.
116
+ *
117
+ * Fires when cancel change in the value help dialog.
118
+ *
119
+ * @returns Reference to `this` in order to allow method chaining
120
+ */
121
+ attachCancelFilterChange(
122
+ /**
123
+ * An application-specific payload object that will be passed to the event handler along with the event
124
+ * object when firing the event
125
+ */
126
+ oData: object,
127
+ /**
128
+ * The function to be called when the event occurs
129
+ */
130
+ fnFunction: (p1: Event) => void,
131
+ /**
132
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
133
+ */
134
+ oListener?: object
135
+ ): this;
136
+ /**
137
+ * Attaches event handler `fnFunction` to the {@link #event:cancelFilterChange cancelFilterChange} event
138
+ * of this `sap.sac.df.FilterBar`.
139
+ *
140
+ * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
141
+ * otherwise it will be bound to this `sap.sac.df.FilterBar` itself.
142
+ *
143
+ * Fires when cancel change in the value help dialog.
144
+ *
145
+ * @returns Reference to `this` in order to allow method chaining
146
+ */
147
+ attachCancelFilterChange(
148
+ /**
149
+ * The function to be called when the event occurs
150
+ */
151
+ fnFunction: (p1: Event) => void,
152
+ /**
153
+ * Context object to call the event handler with. Defaults to this `sap.sac.df.FilterBar` itself
154
+ */
155
+ oListener?: object
156
+ ): this;
157
+ /**
158
+ * Detaches event handler `fnFunction` from the {@link #event:beforeFilterChange beforeFilterChange} event
159
+ * of this `sap.sac.df.FilterBar`.
160
+ *
161
+ * The passed function and listener object must match the ones used for event registration.
162
+ *
163
+ * @returns Reference to `this` in order to allow method chaining
164
+ */
165
+ detachBeforeFilterChange(
166
+ /**
167
+ * The function to be called, when the event occurs
168
+ */
169
+ fnFunction: (p1: FilterBar$BeforeFilterChangeEvent) => void,
170
+ /**
171
+ * Context object on which the given function had to be called
172
+ */
173
+ oListener?: object
174
+ ): this;
175
+ /**
176
+ * Detaches event handler `fnFunction` from the {@link #event:cancelFilterChange cancelFilterChange} event
177
+ * of this `sap.sac.df.FilterBar`.
178
+ *
179
+ * The passed function and listener object must match the ones used for event registration.
180
+ *
181
+ * @returns Reference to `this` in order to allow method chaining
182
+ */
183
+ detachCancelFilterChange(
184
+ /**
185
+ * The function to be called, when the event occurs
186
+ */
187
+ fnFunction: (p1: Event) => void,
188
+ /**
189
+ * Context object on which the given function had to be called
190
+ */
191
+ oListener?: object
192
+ ): this;
193
+ /**
194
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
195
+ *
196
+ * Fires event {@link #event:beforeFilterChange beforeFilterChange} to attached listeners.
197
+ *
198
+ * @returns Reference to `this` in order to allow method chaining
199
+ */
200
+ fireBeforeFilterChange(
201
+ /**
202
+ * Parameters to pass along with the event
203
+ */
204
+ mParameters?: FilterBar$BeforeFilterChangeEventParameters
205
+ ): this;
206
+ /**
207
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
208
+ *
209
+ * Fires event {@link #event:cancelFilterChange cancelFilterChange} to attached listeners.
210
+ *
211
+ * @returns Reference to `this` in order to allow method chaining
212
+ */
213
+ fireCancelFilterChange(
214
+ /**
215
+ * Parameters to pass along with the event
216
+ */
217
+ mParameters?: object
218
+ ): this;
219
+ /**
220
+ * Gets current value of property {@link #getDisplay display}.
221
+ *
222
+ * Defines whether the value and/or description of the field is shown and in which order.
223
+ *
224
+ * Default value is `ValueDescription`.
225
+ *
226
+ * @returns Value of property `display`
227
+ */
228
+ getDisplay(): FieldDisplay | keyof typeof FieldDisplay;
229
+ /**
230
+ * Gets current value of property {@link #getMode mode}.
231
+ *
232
+ * Mode
233
+ *
234
+ * Default value is `"VariablesOfDataProvider"`.
235
+ *
236
+ * @returns Value of property `mode`
237
+ */
238
+ getMode(): string;
239
+ /**
240
+ * Gets current value of property {@link #getMultiDimModelId multiDimModelId}.
241
+ *
242
+ * ID of multiDimModel
243
+ *
244
+ * Default value is `"om"`.
245
+ *
246
+ * @returns Value of property `multiDimModelId`
247
+ */
248
+ getMultiDimModelId(): string;
249
+ /**
250
+ * Sets a new value for property {@link #getDisplay display}.
251
+ *
252
+ * Defines whether the value and/or description of the field is shown and in which order.
253
+ *
254
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
255
+ *
256
+ * Default value is `ValueDescription`.
257
+ *
258
+ * @returns Reference to `this` in order to allow method chaining
259
+ */
260
+ setDisplay(
261
+ /**
262
+ * New value for property `display`
263
+ */
264
+ sDisplay?: FieldDisplay | keyof typeof FieldDisplay
265
+ ): this;
266
+ /**
267
+ * Sets a new value for property {@link #getMode mode}.
268
+ *
269
+ * Mode
270
+ *
271
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
272
+ *
273
+ * Default value is `"VariablesOfDataProvider"`.
274
+ *
275
+ * @returns Reference to `this` in order to allow method chaining
276
+ */
277
+ setMode(
278
+ /**
279
+ * New value for property `mode`
280
+ */
281
+ sMode?: string
282
+ ): this;
283
+ /**
284
+ * Sets a new value for property {@link #getMultiDimModelId multiDimModelId}.
285
+ *
286
+ * ID of multiDimModel
287
+ *
288
+ * When called with a value of `null` or `undefined`, the default value of the property will be restored.
289
+ *
290
+ * Default value is `"om"`.
291
+ *
292
+ * @returns Reference to `this` in order to allow method chaining
293
+ */
294
+ setMultiDimModelId(
295
+ /**
296
+ * New value for property `multiDimModelId`
297
+ */
298
+ sMultiDimModelId?: string
299
+ ): this;
300
+ }
301
+
302
+ export interface $FilterBarSettings extends $FilterBarSettings1 {
303
+ /**
304
+ * ID of multiDimModel
305
+ */
306
+ multiDimModelId?: string | PropertyBindingInfo;
307
+
308
+ /**
309
+ * Mode
310
+ */
311
+ mode?: string | PropertyBindingInfo;
312
+
313
+ /**
314
+ * Defines whether the value and/or description of the field is shown and in which order.
315
+ */
316
+ display?:
317
+ | (FieldDisplay | keyof typeof FieldDisplay)
318
+ | PropertyBindingInfo
319
+ | `{${string}}`;
320
+
321
+ /**
322
+ * Fires before update variable of multidimension model after input value or open value help of variable.
323
+ */
324
+ beforeFilterChange?: (oEvent: FilterBar$BeforeFilterChangeEvent) => void;
325
+
326
+ /**
327
+ * Fires when cancel change in the value help dialog.
328
+ */
329
+ cancelFilterChange?: (oEvent: Event) => void;
330
+ }
331
+
332
+ export interface FilterBar$BeforeFilterChangeEventParameters {
333
+ /**
334
+ * Indicates whether value help dialog is going to open.
335
+ */
336
+ beforeValueHelpOpen?: boolean;
337
+ }
338
+
339
+ export type FilterBar$BeforeFilterChangeEvent = Event<
340
+ FilterBar$BeforeFilterChangeEventParameters,
341
+ FilterBar
342
+ >;
343
+
344
+ export interface FilterBar$CancelFilterChangeEventParameters {}
345
+
346
+ export type FilterBar$CancelFilterChangeEvent = Event<
347
+ FilterBar$CancelFilterChangeEventParameters,
348
+ FilterBar
349
+ >;
350
+ }
351
+
5
352
  declare module "sap/sac/df/FlexAnalysis" {
6
353
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
7
354
 
@@ -1187,15 +1534,13 @@ declare module "sap/sac/df/model/AxesLayout" {
1187
1534
 
1188
1535
  /**
1189
1536
  * @since 1.119
1190
- * @experimental
1537
+ * @experimental (since 1.119)
1191
1538
  *
1192
1539
  * Axis Layout showing which dimensions are set on rows and which on columns.
1193
1540
  * ```javascript
1194
1541
  *
1195
- * {
1196
- * "Rows": [],
1197
- * "Columns": []
1198
- * }
1542
+ * "Rows": [],
1543
+ * "Columns": []
1199
1544
  * ```
1200
1545
  */
1201
1546
  export default class AxesLayout extends BaseObject {
@@ -1237,8 +1582,8 @@ declare module "sap/sac/df/model/AxesLayout" {
1237
1582
  */
1238
1583
  setAxesLayout(
1239
1584
  /**
1240
- * an array containing a containing the names of the dimensions on rows. The order in the array control
1241
- * the position on the axis.
1585
+ * an array containing the names of the dimensions on rows. The order in the array control the position
1586
+ * on the axis.
1242
1587
  */
1243
1588
  aDimensionOnRowsAxis: string[],
1244
1589
  /**
@@ -1253,10 +1598,10 @@ declare module "sap/sac/df/model/AxesLayout" {
1253
1598
  declare module "sap/sac/df/model/DataProvider" {
1254
1599
  import BaseObject from "sap/ui/base/Object";
1255
1600
 
1256
- import MultiDimModel from "sap/sac/df/model/MultiDimModel";
1257
-
1258
1601
  import AxesLayout from "sap/sac/df/model/AxesLayout";
1259
1602
 
1603
+ import DataSourceInfo from "sap/sac/df/model/DataSourceInfo";
1604
+
1260
1605
  import Dimension from "sap/sac/df/model/Dimension";
1261
1606
 
1262
1607
  import Grid from "sap/sac/df/model/Grid";
@@ -1265,23 +1610,19 @@ declare module "sap/sac/df/model/DataProvider" {
1265
1610
 
1266
1611
  import Metadata from "sap/ui/base/Metadata";
1267
1612
 
1268
- import QueryInfo from "sap/sac/df/model/QueryInfo";
1269
-
1270
1613
  /**
1271
- * @experimental
1272
- *
1273
- * A `DataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol HANA
1274
- * - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
1614
+ * @since 1.119
1615
+ * @experimental (since 1.119)
1275
1616
  *
1276
- * Instances of this class should only be created by the {sap.sac.df.model.MultiDimModel}. The `MultiDimModel`
1277
- * populates it's exposed data via Binding to Controls. The structure of data exposed by a DataProvider
1278
- * is as follows:
1617
+ * A data provider is an analytical query exposed via an analytical engine and accessed via InA protocol.
1618
+ * It represents a navigable query manager and allows to access and change data. Instances of this class
1619
+ * should only be created by the {@link sap.sac.df.model.MultiDimModel}.
1279
1620
  *
1280
- * **Structure of Exposed Data**
1621
+ * **Structure of Exposed Data:**
1281
1622
  * ```javascript
1282
1623
  *
1283
1624
  * "Name": "",
1284
- * "QueryInfo": { },
1625
+ * "DataSourceInfo": { },
1285
1626
  * "Variables": { }
1286
1627
  * "Dimensions": { },
1287
1628
  * "Measures": [ ],
@@ -1294,31 +1635,21 @@ declare module "sap/sac/df/model/DataProvider" {
1294
1635
  * ```
1295
1636
  */
1296
1637
  export default class DataProvider extends BaseObject {
1297
- /**
1298
- * Constructor for a new DataProvider.
1299
- *
1300
- * A DataProvider represents a navigable queryManager and allows to access and change data from servers
1301
- * providing the InA Protocol.
1302
- */
1303
- constructor(
1304
- /**
1305
- * the model to which the DataProvider belongs
1306
- */
1307
- oMultiDimModel: MultiDimModel,
1308
- /**
1309
- * name of the DataProvider
1310
- */
1311
- sDataProviderName: string
1312
- );
1638
+ constructor();
1313
1639
  /**
1314
1640
  * AxesLayout
1315
1641
  */
1316
1642
  AxesLayout: AxesLayout;
1317
1643
 
1644
+ /**
1645
+ * DataSourceInfo
1646
+ */
1647
+ DataSourceInfo: DataSourceInfo;
1648
+
1318
1649
  /**
1319
1650
  * Dimensions
1320
1651
  */
1321
- Dimensions: Dimension;
1652
+ Dimensions: Record<string, Dimension>;
1322
1653
 
1323
1654
  /**
1324
1655
  * Grid
@@ -1328,12 +1659,12 @@ declare module "sap/sac/df/model/DataProvider" {
1328
1659
  /**
1329
1660
  * Measures
1330
1661
  */
1331
- Measures: /* was: sap.sac.df.model.Measure */ any;
1662
+ Measures: Record<string, /* was: sap.sac.df.model.Measure */ any>;
1332
1663
 
1333
1664
  /**
1334
1665
  * Variables
1335
1666
  */
1336
- Variables: Variable;
1667
+ Variables: Record<string, Variable>;
1337
1668
 
1338
1669
  /**
1339
1670
  * Creates a new subclass of class sap.sac.df.model.DataProvider with name `sClassName` and enriches it
@@ -1365,252 +1696,314 @@ declare module "sap/sac/df/model/DataProvider" {
1365
1696
  */
1366
1697
  static getMetadata(): Metadata;
1367
1698
  /**
1368
- * Updates the MultiDimModel from the given the model state including all aggregated `DataProvider`s
1699
+ * Updates the multidimensional model from the given the state of a data provider
1369
1700
  *
1370
- * @returns Promise Promise which resolves to the updated instance of the OlapModel.
1701
+ * @returns Promise with reference to this in order to allow method chaining
1371
1702
  */
1372
1703
  deserialize(
1373
1704
  /**
1374
- * the JSON object containing the persisted state of th MultiDimModel to be applied.
1705
+ * the JSON object containing the persisted state of a data provider to be applied.
1375
1706
  */
1376
1707
  oModelState: object,
1377
1708
  /**
1378
- * the format be the deserialized (INA_REPOSITORY_DELTA or INA_REPOSITORY).
1709
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
1710
+ */
1711
+ sFormat?: string,
1712
+ /**
1713
+ * Indicator if the data provider updated should be suppressed after deserialization
1379
1714
  */
1380
- sFormat: string
1381
- ): undefined;
1715
+ bSuppressUpdate?: boolean
1716
+ ): Promise<this>;
1382
1717
  /**
1383
1718
  * Export Data
1384
1719
  */
1385
1720
  exportData(
1386
1721
  /**
1387
- * data export configuration
1722
+ * Data export configuration
1388
1723
  */
1389
1724
  oDataExportConfig: object
1390
1725
  ): void;
1391
1726
  /**
1392
- * Get Axis Layout
1727
+ * Get axis Layout
1393
1728
  *
1394
- * @returns axis layout
1729
+ * @returns Axis layout object
1395
1730
  */
1396
1731
  getAxesLayout(): AxesLayout;
1397
1732
  /**
1398
- * Gets the scaling factor of a measure or data cell
1733
+ * Get data source information
1734
+ *
1735
+ * @returns data source information object
1736
+ */
1737
+ getDataSourceInfo(): DataSourceInfo;
1738
+ /**
1739
+ * Get the scaling factor of a measure or cell
1399
1740
  *
1400
- * @returns the current decimal places setting
1741
+ * @returns Number of decimal places
1401
1742
  */
1402
1743
  getDecimalPlaces(
1403
1744
  /**
1404
- * the Member of the Measure Structure
1745
+ * Measure structure member
1405
1746
  */
1406
- sMeasureMember: string,
1747
+ sMeasureStructureMember: string,
1407
1748
  /**
1408
- * the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
1749
+ * Structure (non-measure) member
1409
1750
  */
1410
- sNonMeasureMember: string
1751
+ sStructureMember: string
1411
1752
  ): int;
1412
1753
  /**
1413
1754
  * Get Dimension
1414
1755
  *
1415
- * @returns a dimension object
1756
+ * @returns Dimension object
1416
1757
  */
1417
1758
  getDimension(
1418
1759
  /**
1419
- * dimension name
1760
+ * Dimension name
1420
1761
  */
1421
1762
  sDimensionName: string
1422
1763
  ): Dimension;
1423
1764
  /**
1424
- * Get Dimensions
1765
+ * Get all dimensions
1425
1766
  *
1426
- * @returns a dimension object
1767
+ * @returns Object of all dimensions
1427
1768
  */
1428
1769
  getDimensions(): Record<string, Dimension>;
1429
1770
  /**
1430
1771
  * Get Grid
1431
1772
  *
1432
- * @returns grid
1773
+ * @returns Grid object
1433
1774
  */
1434
1775
  getGrid(): Grid;
1435
1776
  /**
1436
1777
  * Get measure
1437
1778
  *
1438
- * @returns a dimension object
1779
+ * @returns Measure object
1439
1780
  */
1440
1781
  getMeasure(
1441
1782
  /**
1442
- * measure name
1783
+ * Measure name
1443
1784
  */
1444
1785
  sMeasureName: string
1445
1786
  ): /* was: sap.sac.df.model.Measure */ any;
1446
1787
  /**
1447
- * Get measures
1788
+ * Get all measures
1448
1789
  *
1449
- * @returns a dimension object
1790
+ * @returns Object of all measures
1450
1791
  */
1451
1792
  getMeasures(): /* was: sap.sac.df.model.Measure */ any;
1452
1793
  /**
1453
1794
  * Get Measure Structure Dimension
1454
1795
  *
1455
- * @returns measure structure dimension
1796
+ * @returns Measure structure dimension
1456
1797
  */
1457
1798
  getMeasureStructureDimension(): Dimension;
1458
1799
  /**
1459
- * Get Query Information
1460
- *
1461
- * @returns query information
1462
- */
1463
- getQueryInfo(): QueryInfo;
1464
- /**
1465
- * Get Result Set
1800
+ * Get result set
1466
1801
  */
1467
1802
  getResultSet(
1468
1803
  /**
1469
- * enforce result set update
1804
+ * Enforce result set update
1470
1805
  */
1471
- bForceResultSetUpdate?: boolean
1806
+ bEnforceResultSetUpdate?: boolean
1472
1807
  ): void;
1473
1808
  /**
1474
- * Gets the scaling factor of a measure
1809
+ * Get the scaling factor of a measure or cell
1475
1810
  *
1476
- * @returns the exponent of the scaling factor in Base 10
1811
+ * @returns Scaling factor
1477
1812
  */
1478
1813
  getScalingFactor(
1479
1814
  /**
1480
- * the Member of the Measure Structure
1815
+ * Measure structure member
1481
1816
  */
1482
- sMeasureMember: string,
1817
+ sMeasureStructureMember: string,
1483
1818
  /**
1484
- * the Member of the Non Measure Structure
1819
+ * Structure (non-measure) member
1485
1820
  */
1486
- sNonMeasureMember: string
1821
+ sStructureMember: string
1487
1822
  ): int;
1488
1823
  /**
1489
- * Get Non-Measure Structure Dimension
1824
+ * Get structure (non-measure) dimension
1490
1825
  *
1491
- * @returns non-measure structure dimension
1826
+ * @returns Structure dimension object
1492
1827
  */
1493
1828
  getStructureDimension(): Dimension;
1494
1829
  /**
1495
1830
  * Get Variable
1496
1831
  *
1497
- * @returns a variable object
1832
+ * @returns Variable object
1498
1833
  */
1499
1834
  getVariable(
1500
1835
  /**
1501
- * variable name
1836
+ * Variable Name
1502
1837
  */
1503
1838
  sVariableName: string
1504
1839
  ): Variable;
1505
1840
  /**
1506
- * Get Variables
1841
+ * Get all variables
1507
1842
  *
1508
- * @returns a variable object
1843
+ * @returns Object of all variables
1509
1844
  */
1510
1845
  getVariables(): Record<string, Variable>;
1511
1846
  /**
1512
- * Serialize the Data Provider to a JSON representation
1847
+ * Serialize the data provider state to a JSON representation
1513
1848
  *
1514
- * @returns a javascript object which represents the `DataProvider`.
1849
+ * @returns A JSON object which represents the data provider
1515
1850
  */
1516
1851
  serialize(
1517
1852
  /**
1518
- * the format be the serialized (INA_REPOSITORY_DELTA or INA_REPOSITORY). The `DataProvider` to be serialized
1519
- * from an equivalent such Object.
1853
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
1520
1854
  */
1521
- sFormat: string
1855
+ sFormat?: string
1522
1856
  ): object;
1523
1857
  /**
1524
- * Sets the number of decimal of a measure/query cell
1858
+ * Set the number of decimal places of a measure or cell
1525
1859
  *
1526
- * @returns the MultiDimDataProvider
1860
+ * @returns Reference to this in order to allow method chaining
1527
1861
  */
1528
1862
  setDecimalPlaces(
1529
1863
  /**
1530
- * number of the decimal palaces to be shown after the separator
1864
+ * Number of the decimal places
1531
1865
  */
1532
1866
  nNumberOfDecimalPlaces: int,
1533
1867
  /**
1534
- * the Member of the Measure Structure
1868
+ * Measure structure member
1535
1869
  */
1536
- sMeasureMember: string,
1870
+ sMeasureStructureMember: string,
1537
1871
  /**
1538
- * Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
1872
+ * Structure (non-measure) member
1539
1873
  */
1540
- the: string
1874
+ sStructureMember: string
1541
1875
  ): this;
1542
1876
  /**
1543
- * Sets the scaling factor of a measure/query cell
1877
+ * Set the scaling factor of a measure or cell
1544
1878
  *
1545
- * @returns the MultiDimDataProvider
1879
+ * @returns Reference to this in order to allow method chaining
1546
1880
  */
1547
1881
  setScalingFactor(
1548
1882
  /**
1549
- * the exponential of the scaling factor
1883
+ * Scaling factor
1550
1884
  */
1551
1885
  nFactor: int,
1552
1886
  /**
1553
- * the Member of the Measure Structure
1887
+ * Measure structure member
1554
1888
  */
1555
- sMeasureMember: string,
1889
+ sMeasureStructureMember: string,
1556
1890
  /**
1557
- * the Member of the Non Measure Structure
1891
+ * Structure (non-measure) member
1558
1892
  */
1559
- sNonMeasureMember: string
1893
+ sStructureMember: string
1560
1894
  ): this;
1561
1895
  /**
1562
- * Checks whether an InA capability is supported by the backend. Throws an error for unhandled capabilities.
1563
- * List of handled capabilities can be seen in type sap.sac.df.model.Capability
1896
+ * Checks whether an InA capability is supported by the server. Throws an error for unhandled capabilities.
1897
+ * List of handled capabilities can be seen in type {@link sap.sac.df.model.Capability}
1564
1898
  *
1565
- * @returns returns true, if the capability is supported, else false
1899
+ * @returns Returns true, if the capability is supported, else false
1566
1900
  */
1567
1901
  supportsCapability(
1568
1902
  /**
1569
- * the capability name
1903
+ * Capability name
1570
1904
  */
1571
1905
  sCapability: undefined
1572
1906
  ): boolean;
1573
1907
  }
1574
1908
  }
1575
1909
 
1576
- declare module "sap/sac/df/model/Dimension" {
1910
+ declare module "sap/sac/df/model/DataSourceInfo" {
1577
1911
  import BaseObject from "sap/ui/base/Object";
1578
1912
 
1579
- import MemberFilter from "sap/sac/df/model/MemberFilter";
1913
+ import Metadata from "sap/ui/base/Metadata";
1914
+
1915
+ /**
1916
+ * @since 1.119
1917
+ * @experimental (since 1.119)
1918
+ *
1919
+ * Query Info providing the following information
1920
+ * ```javascript
1921
+ *
1922
+ * "QueryTitle": "",
1923
+ * "QueryName": "",
1924
+ * "QueryType": "",
1925
+ * "SystemName": "",
1926
+ * "CreatedBy": "",
1927
+ * "CreatedOn": "",
1928
+ * "QueryDueDateText": "",
1929
+ * "CreatedOnText": "",
1930
+ * "QueryDueDate": "",
1931
+ * "ResultAlignmentRows": "",
1932
+ * "ResultAlignmentColumns": "",
1933
+ * "LastUpdated": "",
1934
+ * "LastUpdatedBy": "",
1935
+ * "LastUpdatedText": ""
1936
+ * ```
1937
+ */
1938
+ export default class DataSourceInfo extends BaseObject {
1939
+ constructor();
1940
+
1941
+ /**
1942
+ * Creates a new subclass of class sap.sac.df.model.DataSourceInfo with name `sClassName` and enriches it
1943
+ * with the information contained in `oClassInfo`.
1944
+ *
1945
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1946
+ *
1947
+ * @returns Created class / constructor function
1948
+ */
1949
+ static extend<T extends Record<string, unknown>>(
1950
+ /**
1951
+ * Name of the class being created
1952
+ */
1953
+ sClassName: string,
1954
+ /**
1955
+ * Object literal with information about the class
1956
+ */
1957
+ oClassInfo?: sap.ClassInfo<T, DataSourceInfo>,
1958
+ /**
1959
+ * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1960
+ * used by this class
1961
+ */
1962
+ FNMetaImpl?: Function
1963
+ ): Function;
1964
+ /**
1965
+ * Returns a metadata object for class sap.sac.df.model.DataSourceInfo.
1966
+ *
1967
+ * @returns Metadata object describing this class
1968
+ */
1969
+ static getMetadata(): Metadata;
1970
+ }
1971
+ }
1972
+
1973
+ declare module "sap/sac/df/model/Dimension" {
1974
+ import BaseObject from "sap/ui/base/Object";
1580
1975
 
1581
1976
  import Metadata from "sap/ui/base/Metadata";
1582
1977
 
1583
1978
  /**
1584
1979
  * @since 1.119
1585
- * @experimental
1980
+ * @experimental (since 1.119)
1586
1981
  *
1587
1982
  * Dimension
1588
1983
  * ```javascript
1589
1984
  *
1590
- * "Name": "",
1591
- * "TechName": "",
1592
- * "Description": "",
1593
- * "Axis": "",
1594
- * "Type": "",
1595
- * "HierarchyActive": "",
1596
- * "HasFilter": "",
1597
- * "MemberFilter": [],
1598
- * "SortDirection": "",
1599
- * "Position": "",
1600
- * "LastPosition": "",
1601
- * "IsStructure": "",
1602
- * "IsMeasureStructure": "",
1603
- * "ValueType": "",
1604
- * "SemanticObject": "",
1605
- * "Members": [
1606
- * {
1607
- * "Key": "",
1608
- * "Name": "",
1609
- * "TechName": "",
1610
- * "Description": "",
1611
- * "SemanticObject": "
1612
- * }
1613
- * ]
1985
+ * "Name": "",
1986
+ * "TechName": "",
1987
+ * "Description": "",
1988
+ * "Axis": "",
1989
+ * "Type": "",
1990
+ * "HierarchyActive": "",
1991
+ * "HasFilter": "",
1992
+ * "MemberFilter": [],
1993
+ * "SortDirection": "",
1994
+ * "Position": "",
1995
+ * "LastPosition": "",
1996
+ * "IsStructure": "",
1997
+ * "IsMeasureStructure": "",
1998
+ * "ValueType": "",
1999
+ * "SemanticObject": "",
2000
+ * "Members": [{
2001
+ * "Key": "",
2002
+ * "Name": "",
2003
+ * "TechName": "",
2004
+ * "Description": "",
2005
+ * "SemanticObject": "
2006
+ * }]
1614
2007
  * ```
1615
2008
  */
1616
2009
  export default class Dimension extends BaseObject {
@@ -1645,12 +2038,6 @@ declare module "sap/sac/df/model/Dimension" {
1645
2038
  * @returns Metadata object describing this class
1646
2039
  */
1647
2040
  static getMetadata(): Metadata;
1648
- /**
1649
- * Get Structure Members
1650
- *
1651
- * @returns array of structure members
1652
- */
1653
- static getStructureMembers(): any[];
1654
2041
  /**
1655
2042
  * Set Display Type of Dimension
1656
2043
  *
@@ -1663,23 +2050,45 @@ declare module "sap/sac/df/model/Dimension" {
1663
2050
  sDisplayType: string
1664
2051
  ): Dimension;
1665
2052
  /**
1666
- * get the list of filters of a dimension
2053
+ * Add dimension filters
2054
+ *
2055
+ * @returns Reference to this in order to allow method chaining
2056
+ */
2057
+ addMemberFilter(
2058
+ /**
2059
+ * a member filter object
2060
+ */
2061
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
2062
+ ): this;
2063
+ /**
2064
+ * Add a member filter by its key
2065
+ *
2066
+ * @returns Reference to this in order to allow method chaining
2067
+ */
2068
+ addMemberFilterByKey(
2069
+ /**
2070
+ * (internal) key of a dimension member
2071
+ */
2072
+ sKey: string
2073
+ ): this;
2074
+ /**
2075
+ * Get effective dimension filters
1667
2076
  *
1668
- * @returns list of a range with components
2077
+ * @returns array of member filters
1669
2078
  */
1670
- getMemberFilter(): MemberFilter;
2079
+ getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
1671
2080
  /**
1672
- * Move a dimension one position down on it's axis
2081
+ * Move dimension one position down on it's axis
1673
2082
  *
1674
- * @returns the `Dimension` to allow chaining.
2083
+ * @returns Reference to this in order to allow method chaining
1675
2084
  */
1676
- moveDown(): Dimension;
2085
+ moveDown(): this;
1677
2086
  /**
1678
- * Move a dimension one position up on it's axis
2087
+ * Move dimension one position up on it's axis
1679
2088
  *
1680
- * @returns the `Dimension` to allow chaining.
2089
+ * @returns Reference to this in order to allow method chaining
1681
2090
  */
1682
- moveUp(): Dimension;
2091
+ moveUp(): this;
1683
2092
  /**
1684
2093
  * Open a dialog to display and change the settings of a dimension of the `DataProvider`
1685
2094
  *
@@ -1687,12 +2096,17 @@ declare module "sap/sac/df/model/Dimension" {
1687
2096
  */
1688
2097
  openPropertyDialog(): Promise<boolean>;
1689
2098
  /**
1690
- * Open a dialog to display and change the filter on a dimension of the `DataProvider`
2099
+ * Open a dialog to display and change the filter on a dimension
1691
2100
  *
1692
2101
  * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
1693
2102
  * with Ok and dynamic filters of the given dimension are updated
1694
2103
  */
1695
- openValueHelpDialog(): Promise<any>;
2104
+ openValueHelpDialog(
2105
+ /**
2106
+ * if the model update should be suppressed
2107
+ */
2108
+ bSuppressModelUpdate: boolean
2109
+ ): Promise<any>;
1696
2110
  /**
1697
2111
  * Set Display Hierarchy
1698
2112
  *
@@ -1707,15 +2121,58 @@ declare module "sap/sac/df/model/Dimension" {
1707
2121
  /**
1708
2122
  * Remove a drill operation on a dimension member
1709
2123
  *
1710
- * @returns resolving to the `Dimension` to allow chaining.
2124
+ * @returns Reference to this in order to allow method chaining
1711
2125
  */
1712
- removeDrilldown(): Dimension;
2126
+ removeDrilldown(): this;
1713
2127
  /**
1714
2128
  * Remove the filter of a dimension
1715
2129
  *
1716
- * @returns resolving to the `Dimension` to allow chaining.
2130
+ * @returns Reference to this in order to allow method chaining
2131
+ */
2132
+ removeMemberFilter(): this;
2133
+ /**
2134
+ * Remove a member filter by its key
2135
+ *
2136
+ * @returns Reference to this in order to allow method chaining
2137
+ */
2138
+ removeMemberFilterByKey(
2139
+ /**
2140
+ * (internal) key of a dimension member
2141
+ */
2142
+ sKey: string
2143
+ ): this;
2144
+ /**
2145
+ * Performs the search for a given value
2146
+ *
2147
+ * @returns array of found member filters
1717
2148
  */
1718
- removeMemberFilter(): Dimension;
2149
+ searchMember(
2150
+ /**
2151
+ * string to search for
2152
+ */
2153
+ sSearchString: string,
2154
+ /**
2155
+ * if a fuzzy search is performed
2156
+ */
2157
+ bFuzzy: boolean,
2158
+ /**
2159
+ * if to search in text/description (default true)
2160
+ */
2161
+ bText: boolean,
2162
+ /**
2163
+ * if to search in key/id (default true)
2164
+ */
2165
+ bKey: boolean,
2166
+ /**
2167
+ * maximal number of search results (default 1)
2168
+ */
2169
+ iMaxNumberOfResults: int,
2170
+ /**
2171
+ * if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
2172
+ * is set)
2173
+ */
2174
+ bRequestParents: boolean
2175
+ ): Promise</* was: sap.sac.df.MemberFilter */ any[]>;
1719
2176
  /**
1720
2177
  * Set Display Hierarchy
1721
2178
  *
@@ -1736,20 +2193,31 @@ declare module "sap/sac/df/model/Dimension" {
1736
2193
  sVersion: string
1737
2194
  ): Dimension;
1738
2195
  /**
1739
- * Set the filter for a dimension
2196
+ * Set dimension filters
1740
2197
  *
1741
- * @returns resolving to the `Dimension` to allow chaining.
2198
+ * @returns Reference to this in order to allow method chaining
1742
2199
  */
1743
2200
  setMemberFilter(
1744
2201
  /**
1745
- * the filter
2202
+ * array of member filters
1746
2203
  */
1747
- oFilter: MemberFilter
1748
- ): Dimension;
2204
+ aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
2205
+ ): this;
2206
+ /**
2207
+ * Set a member filter by its key
2208
+ *
2209
+ * @returns Reference to this in order to allow method chaining
2210
+ */
2211
+ setMemberFilterByKey(
2212
+ /**
2213
+ * (internal) key of a dimension member
2214
+ */
2215
+ sKey: string
2216
+ ): this;
1749
2217
  /**
1750
2218
  * Sort the members of a dimension
1751
2219
  *
1752
- * @returns resolving to the `Dimension` to allow chaining.
2220
+ * @returns Promise referencing to this in order to allow method chaining
1753
2221
  */
1754
2222
  sort(
1755
2223
  /**
@@ -1766,17 +2234,17 @@ declare module "sap/sac/df/model/Dimension" {
1766
2234
  sMember?: string
1767
2235
  ): Promise<Dimension>;
1768
2236
  /**
1769
- * Move the dimension to the columns axis
2237
+ * Move dimension to the columns axis
1770
2238
  *
1771
- * @returns resolving to the Dimension to allow chaining.
2239
+ * @returns Reference to this in order to allow method chaining
1772
2240
  */
1773
- toColumns(): Dimension;
2241
+ toColumns(): this;
1774
2242
  /**
1775
- * Move the dimension to the rows axis
2243
+ * Move dimension to the rows axis
1776
2244
  *
1777
- * @returns resolving to the Dimension to allow chaining.
2245
+ * @returns Reference to this in order to allow method chaining
1778
2246
  */
1779
- toRows(): Dimension;
2247
+ toRows(): this;
1780
2248
  }
1781
2249
  }
1782
2250
 
@@ -1787,7 +2255,7 @@ declare module "sap/sac/df/model/Document" {
1787
2255
 
1788
2256
  /**
1789
2257
  * @since 1.119
1790
- * @experimental
2258
+ * @experimental (since 1.119)
1791
2259
  *
1792
2260
  * Document Object
1793
2261
  */
@@ -1952,6 +2420,7 @@ declare module "sap/sac/df/model/Grid" {
1952
2420
  import Metadata from "sap/ui/base/Metadata";
1953
2421
 
1954
2422
  /**
2423
+ * @since 1.119
1955
2424
  * @experimental (since 1.119)
1956
2425
  *
1957
2426
  * Grid Object
@@ -2010,163 +2479,39 @@ declare module "sap/sac/df/model/Grid" {
2010
2479
  }
2011
2480
  }
2012
2481
 
2013
- declare module "sap/sac/df/model/MemberFilter" {
2014
- import BaseObject from "sap/ui/base/Object";
2015
-
2016
- import FilterOperator from "sap/ui/model/FilterOperator";
2017
-
2018
- import Metadata from "sap/ui/base/Metadata";
2019
-
2020
- import Filter from "sap/ui/model/Filter";
2021
-
2022
- /**
2023
- * @since 1.119
2024
- * @experimental
2025
- *
2026
- * Member Filter
2027
- * ```javascript
2028
- *
2029
- * "Key": [],
2030
- * "InternalKey": [],
2031
- * "Text": [],
2032
- * "Operator": "",
2033
- * "Hierarchy": { }
2034
- * ```
2035
- */
2036
- export default class MemberFilter extends BaseObject {
2037
- constructor(
2038
- /**
2039
- * array of (display) keys
2040
- */
2041
- aKey: string[],
2042
- /**
2043
- * array of internal keys
2044
- */
2045
- aInternalKey: string[],
2046
- /**
2047
- * array of texts
2048
- */
2049
- aText: string[],
2050
- /**
2051
- * filter operator
2052
- */
2053
- sOperator?: FilterOperator | keyof typeof FilterOperator,
2054
- /**
2055
- * hierarchy object
2056
- */
2057
- oHierarchyInfo?: Object
2058
- );
2059
-
2060
- /**
2061
- * Create a member filter object from firefly
2062
- *
2063
- * @returns a Member Filter object
2064
- */
2065
- static createFromFFMemberFilter(
2066
- /**
2067
- * array of firefly member filters
2068
- */
2069
- aFFMemberFilter: any[]
2070
- ): MemberFilter[];
2071
- /**
2072
- * Create a member filter object from filter operation
2073
- *
2074
- * @returns a Member Filter object
2075
- */
2076
- static createFromFilterOperation(
2077
- /**
2078
- * the name of the Variable to search
2079
- */
2080
- filterOperation: object
2081
- ): MemberFilter;
2082
- /**
2083
- * Creates a new subclass of class sap.sac.df.model.MemberFilter with name `sClassName` and enriches it
2084
- * with the information contained in `oClassInfo`.
2085
- *
2086
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2087
- *
2088
- * @returns Created class / constructor function
2089
- */
2090
- static extend<T extends Record<string, unknown>>(
2091
- /**
2092
- * Name of the class being created
2093
- */
2094
- sClassName: string,
2095
- /**
2096
- * Object literal with information about the class
2097
- */
2098
- oClassInfo?: sap.ClassInfo<T, MemberFilter>,
2099
- /**
2100
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2101
- * used by this class
2102
- */
2103
- FNMetaImpl?: Function
2104
- ): Function;
2105
- /**
2106
- * Returns a metadata object for class sap.sac.df.model.MemberFilter.
2107
- *
2108
- * @returns Metadata object describing this class
2109
- */
2110
- static getMetadata(): Metadata;
2111
- /**
2112
- * Create a member filter object from filter
2113
- *
2114
- * @returns a Member Filter object
2115
- */
2116
- static transformFromFilterToMemberFilter(
2117
- /**
2118
- * object
2119
- */
2120
- oFilter: Filter
2121
- ): MemberFilter;
2122
- /**
2123
- * Create a member filter object from filter
2124
- *
2125
- * @returns a Member Filter object
2126
- */
2127
- static transformFromMemberFilterToFilter(
2128
- /**
2129
- * object
2130
- */
2131
- oFilter: MemberFilter,
2132
- /**
2133
- * path to object
2134
- */
2135
- sPath: string
2136
- ): Filter;
2137
- /**
2138
- * Return a member filter object as {@link sap.ui.model.Filter}
2139
- *
2140
- * @returns filter object
2141
- */
2142
- transformToFilter(): Filter;
2143
- }
2144
- }
2145
-
2146
2482
  declare module "sap/sac/df/model/MultiDimModel" {
2147
- import Model from "sap/ui/model/Model";
2483
+ import JSONModel from "sap/ui/model/json/JSONModel";
2148
2484
 
2149
2485
  import DataProvider from "sap/sac/df/model/DataProvider";
2150
2486
 
2487
+ import Message from "sap/ui/core/message/Message";
2488
+
2151
2489
  import VariableGroup from "sap/sac/df/model/VariableGroup";
2152
2490
 
2491
+ import DataSourceType from "sap/sac/df/types/DataSourceType";
2492
+
2153
2493
  import Metadata from "sap/ui/base/Metadata";
2154
2494
 
2155
2495
  import Event from "sap/ui/base/Event";
2156
2496
 
2157
2497
  /**
2158
- * @experimental
2498
+ * @since 1.119
2499
+ * @experimental (since 1.119)
2159
2500
  *
2160
- * Model implementation for InA provider
2501
+ * The multidimensional model allows to access and change data accessed via the InA Protocol. The multidimensional
2502
+ * model populate it's exposed data in JSON format via binding to controls.
2503
+ *
2504
+ * **Structure of Exposed Data:**
2505
+ * ```javascript
2161
2506
  *
2162
- * The MultiDimModel can populate it's exposed data via Binding to Controls. The structure of the exposed
2163
- * data, mainly via the objects `DataProviders`, `VariableGroups` and `Messages`.
2507
+ * "DataProviders": { },
2508
+ * "VariableGroups": { },
2509
+ * "Messages": [ ]
2510
+ * ```
2164
2511
  */
2165
- export default class MultiDimModel extends Model {
2512
+ export default class MultiDimModel extends JSONModel {
2166
2513
  /**
2167
- * Constructor for a new MultiDimModel.
2168
- *
2169
- * The Olap Model allows to access and change data from servers providing the InA Protocol.
2514
+ * Constructor for a new MultiDimModel. After model creation you need to wait for the event {@link #event:loaded loaded}.
2170
2515
  */
2171
2516
  constructor(
2172
2517
  /**
@@ -2174,25 +2519,30 @@ declare module "sap/sac/df/model/MultiDimModel" {
2174
2519
  */
2175
2520
  sId?: string,
2176
2521
  /**
2177
- * Initial settings for the new control
2522
+ * Initial settings for the new control.
2178
2523
  */
2179
2524
  mSettings?: object
2180
2525
  );
2181
2526
  /**
2182
2527
  * Data Providers
2183
2528
  */
2184
- DataProviders: DataProvider;
2529
+ DataProviders: Record<string, DataProvider>;
2530
+
2531
+ /**
2532
+ * Messages
2533
+ */
2534
+ Messages: Message[];
2185
2535
 
2186
2536
  /**
2187
2537
  * Variable Groups
2188
2538
  */
2189
- VariableGroups: VariableGroup;
2539
+ VariableGroups: Record<string, VariableGroup>;
2190
2540
 
2191
2541
  /**
2192
2542
  * Creates a new subclass of class sap.sac.df.model.MultiDimModel with name `sClassName` and enriches it
2193
2543
  * with the information contained in `oClassInfo`.
2194
2544
  *
2195
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
2545
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.json.JSONModel.extend}.
2196
2546
  *
2197
2547
  * @returns Created class / constructor function
2198
2548
  */
@@ -2218,141 +2568,145 @@ declare module "sap/sac/df/model/MultiDimModel" {
2218
2568
  */
2219
2569
  static getMetadata(): Metadata;
2220
2570
  /**
2221
- * Adds a new query as a new data provider
2571
+ * Creates a new data provider and attaches it to the model.
2222
2572
  *
2223
- * @returns Promise which resolves the Data Provider that was created
2573
+ * @returns Promise which resolves the created data provider
2224
2574
  */
2225
2575
  addDataProvider(
2226
2576
  /**
2227
- * the name of the new data provider
2577
+ * Data provider name
2228
2578
  */
2229
2579
  sDataProviderName: string,
2230
2580
  /**
2231
- * the name of the query which the data provider is supposed to expose
2581
+ * Datasource name which the data provider is supposed to expose
2232
2582
  */
2233
- sQueryName: string,
2583
+ sDataSourceName: string,
2234
2584
  /**
2235
- * the name of the system in the landscape
2585
+ * System name
2236
2586
  */
2237
2587
  sSystem?: string,
2238
2588
  /**
2239
- * the name of the package
2589
+ * Package name
2240
2590
  */
2241
2591
  sPackage?: string,
2242
2592
  /**
2243
- * the name of the schema
2593
+ * Schema name
2244
2594
  */
2245
2595
  sSchema?: string,
2246
2596
  /**
2247
- * the name of the type of the datasource
2597
+ * Data source type
2248
2598
  */
2249
- sType?: string
2599
+ sDataSourceType?: DataSourceType | keyof typeof DataSourceType
2250
2600
  ): Promise<DataProvider>;
2251
2601
  /**
2252
- * Adds a variable group to the model
2602
+ * Creates a new variable group and attaches it to the model.
2253
2603
  *
2254
- * A Variable group defines what variables of teh underlying DataProvider behave in as one variable The
2255
- * group is defined by a name and a Rule. Rule is a function which accept the variable definition and decides
2256
- * if the variable has to be part of te group The first added variable becomes automatically the MergedVariable.
2604
+ * A variable group defines which variables of the underlying data providers should behave as the same variable.
2605
+ * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
2257
2606
  *
2258
- * The VariableGroup can be accessed/bound via the properties of MultiDimModel a
2259
- *
2260
- * @returns Promise which resolves the Variable Group that was created
2607
+ * @returns Promise which resolves the created variable group
2261
2608
  */
2262
2609
  addVariableGroup(
2263
2610
  /**
2264
- * the name of the variable
2611
+ * Variable group name
2265
2612
  */
2266
2613
  sVariableGroupName: string,
2267
2614
  /**
2268
- * function returning a boolean
2615
+ * Rule is a function which accept the variable definition and decides if the variable has to be part of
2616
+ * te group.
2269
2617
  */
2270
2618
  fnRule: Function,
2271
2619
  /**
2272
- * additional properties
2620
+ * Additional properties
2273
2621
  */
2274
2622
  oProperties: Object
2275
2623
  ): Promise<VariableGroup>;
2276
2624
  /**
2277
- * Resets the messages
2278
- *
2279
- * @returns for chaining
2280
- */
2281
- clearMessages(
2282
- /**
2283
- * if also property bindings have to be updated
2284
- */
2285
- bUpdateBindings: undefined
2286
- ): MultiDimModel;
2287
- /**
2288
- * Updates the MultiDimModel from the given the model state including all aggregated `DataProvider`s
2625
+ * Updates the model from the given the model state including all aggregated data providers
2289
2626
  *
2290
- * @returns Promise Promise which resolves to the updated instance of the OlapModel.
2627
+ * @returns Promise with reference to this in order to allow method chaining
2291
2628
  */
2292
2629
  deserialize(
2293
2630
  /**
2294
- * the JSON object containing the persisted state of th MultiDimModel to be applied.
2631
+ * A JSON object which represents the multidimensional model to be applied
2295
2632
  */
2296
2633
  oModelState: object,
2297
2634
  /**
2298
- * the format be the deserialized (INA_REPOSITORY_DELTA or INA_REPOSITORY).
2635
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
2299
2636
  */
2300
- sFormat: string
2301
- ): undefined;
2637
+ sFormat?: string
2638
+ ): Promise<this>;
2302
2639
  /**
2303
2640
  * Fires event {@link #event:dataProviderAdded dataProviderAdded} to attached listeners.
2304
2641
  *
2305
- * @returns the MultiDimModel
2642
+ * @returns Reference to this in order to allow method chaining
2306
2643
  */
2307
2644
  fireDataProviderAdded(
2308
2645
  /**
2309
2646
  * Parameters to pass along with the event
2310
2647
  */
2311
2648
  oParameters?: object
2312
- ): MultiDimModel;
2649
+ ): this;
2650
+ /**
2651
+ * Fires event {@link #event:dataProviderRemoved dataProviderRemoved} to attached listeners.
2652
+ *
2653
+ * @returns Reference to this in order to allow method chaining
2654
+ */
2655
+ fireDataProviderRemoved(
2656
+ /**
2657
+ * Parameters to pass along with the event
2658
+ */
2659
+ oParameters?: object
2660
+ ): this;
2313
2661
  /**
2314
2662
  * Fires event {@link #event:dataProviderUpdated dataProviderUpdated} to attached listeners.
2315
2663
  *
2316
- * @returns the MultiDimModel
2664
+ * @returns Reference to this in order to allow method chaining
2317
2665
  */
2318
2666
  fireDataProviderUpdated(
2319
2667
  /**
2320
2668
  * Parameters to pass along with the event
2321
2669
  */
2322
2670
  oParameters?: object
2323
- ): MultiDimModel;
2671
+ ): this;
2324
2672
  /**
2325
- * Get a Data Provider
2673
+ * Get a data provider
2326
2674
  *
2327
- * @returns DataProvider
2675
+ * @returns Data provider instance if found
2328
2676
  */
2329
2677
  getDataProvider(
2330
2678
  /**
2331
- * the name of the new DataProvider
2679
+ * Data provider name
2332
2680
  */
2333
2681
  sDataProviderName: string
2334
2682
  ): DataProvider;
2335
2683
  /**
2336
2684
  * Get all data providers
2337
2685
  *
2338
- * @returns object of all Data Providers
2686
+ * @returns Object of all data providers
2339
2687
  */
2340
2688
  getDataProviders(): Record<string, DataProvider>;
2689
+ /**
2690
+ * Get all messages
2691
+ *
2692
+ * @returns Array of messages
2693
+ */
2694
+ getMessages(): Message[];
2341
2695
  /**
2342
2696
  * Get a variable group
2343
2697
  *
2344
- * @returns variable group object
2698
+ * @returns Variable group object
2345
2699
  */
2346
2700
  getVariableGroup(
2347
2701
  /**
2348
- * the name of the variable
2702
+ * Variable group name
2349
2703
  */
2350
2704
  sVariableGroupName: string
2351
2705
  ): VariableGroup;
2352
2706
  /**
2353
2707
  * Get all variable groups
2354
2708
  *
2355
- * @returns variable group object
2709
+ * @returns Object of all variable groups
2356
2710
  */
2357
2711
  getVariableGroups(): Record<string, VariableGroup>;
2358
2712
  /**
@@ -2362,56 +2716,53 @@ declare module "sap/sac/df/model/MultiDimModel" {
2362
2716
  */
2363
2717
  logoff(): Promise<void>;
2364
2718
  /**
2365
- * Remove existing data provider from model.
2719
+ * Remove existing data provider from the model.
2366
2720
  *
2367
- * @returns Promise which resolves when the removing has been finished
2721
+ * @returns Promise which resolves when the removing s finished
2368
2722
  */
2369
2723
  removeDataProvider(
2370
2724
  /**
2371
- * the name of the DataProvider to be removed
2725
+ * Data provider name to be removed
2372
2726
  */
2373
2727
  sDataProviderName: string
2374
2728
  ): Promise<void>;
2375
2729
  /**
2376
2730
  * Remove a variable group from the model
2377
2731
  *
2378
- * @returns Promise which resolves when the removing has been finished
2732
+ * @returns Promise which resolves when the removing s finished
2379
2733
  */
2380
2734
  removeVariableGroup(
2381
2735
  /**
2382
- * the name of the variable
2736
+ * Variable group name
2383
2737
  */
2384
2738
  sVariableGroupName: string
2385
2739
  ): Promise<void>;
2386
2740
  /**
2387
- * Reset the Olap Model to the default query
2741
+ * Reset the model to the initial state
2742
+ *
2743
+ * @returns Promise which resolves when reset is finished.
2388
2744
  */
2389
- resetModel(): void;
2745
+ resetModel(): Promise<void>;
2390
2746
  /**
2391
- * Serialize the Model with all aggregated `DataProvider` to a JSON representation
2747
+ * Serialize the model with all aggregated data providers to a JSON representation
2392
2748
  *
2393
- * @returns a javascript object which represents the `MultiDimModel`.
2749
+ * @returns A JSON object which represents the multidimensional model
2394
2750
  */
2395
2751
  serialize(
2396
2752
  /**
2397
- * the format be the serialized (INA_REPOSITORY_DELTA or INA_REPOSITORY). The `MultiDimModel` to be serialized
2398
- * from an equivalent such Object.
2753
+ * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
2399
2754
  */
2400
- sFormat: string
2755
+ sFormat?: string
2401
2756
  ): object;
2402
2757
  /**
2403
- * Synchronizes all aggregated DataProviders by fetching their ResultSet.
2404
- *
2405
- * If the user does not choose an Analytic Query, then the promise is rejected
2406
- *
2407
- * @returns the MultiDimModel, to allow chaining
2758
+ * Resets the messages
2408
2759
  */
2409
- synchronize(
2760
+ setMessages(
2410
2761
  /**
2411
- * List of data provider that are to be synchronized (all if not supplied)
2762
+ * The new messages for the model, mapping a binding path to an array of sap.ui.core.message.Message objects
2412
2763
  */
2413
- aDataProviderNames: string[]
2414
- ): Promise<MultiDimModel>;
2764
+ mMessages: Record<string, Message[]>
2765
+ ): void;
2415
2766
  }
2416
2767
 
2417
2768
  export interface MultiDimModel$DataProviderAddedEventParameters {}
@@ -2421,75 +2772,26 @@ declare module "sap/sac/df/model/MultiDimModel" {
2421
2772
  MultiDimModel
2422
2773
  >;
2423
2774
 
2775
+ export interface MultiDimModel$DataProviderRemovedEventParameters {}
2776
+
2777
+ export type MultiDimModel$DataProviderRemovedEvent = Event<
2778
+ MultiDimModel$DataProviderRemovedEventParameters,
2779
+ MultiDimModel
2780
+ >;
2781
+
2424
2782
  export interface MultiDimModel$DataProviderUpdatedEventParameters {}
2425
2783
 
2426
2784
  export type MultiDimModel$DataProviderUpdatedEvent = Event<
2427
2785
  MultiDimModel$DataProviderUpdatedEventParameters,
2428
2786
  MultiDimModel
2429
2787
  >;
2430
- }
2431
-
2432
- declare module "sap/sac/df/model/QueryInfo" {
2433
- import BaseObject from "sap/ui/base/Object";
2434
2788
 
2435
- import Metadata from "sap/ui/base/Metadata";
2789
+ export interface MultiDimModel$LoadedEventParameters {}
2436
2790
 
2437
- /**
2438
- * @since 1.119
2439
- * @experimental
2440
- *
2441
- * Query Info providing the following information
2442
- * ```javascript
2443
- *
2444
- * "QueryTitle": "",
2445
- * "QueryName": "",
2446
- * "QueryType": "",
2447
- * "SystemName": "",
2448
- * "CreatedBy": "",
2449
- * "CreatedOn": "",
2450
- * "QueryDueDateText": "",
2451
- * "CreatedOnText": "",
2452
- * "QueryDueDate": "",
2453
- * "ResultAlignmentRows": "",
2454
- * "ResultAlignmentColumns": "",
2455
- * "LastUpdated": "",
2456
- * "LastUpdatedBy": "",
2457
- * "LastUpdatedText": ""
2458
- * ```
2459
- */
2460
- export default class QueryInfo extends BaseObject {
2461
- constructor();
2462
-
2463
- /**
2464
- * Creates a new subclass of class sap.sac.df.model.QueryInfo with name `sClassName` and enriches it with
2465
- * the information contained in `oClassInfo`.
2466
- *
2467
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2468
- *
2469
- * @returns Created class / constructor function
2470
- */
2471
- static extend<T extends Record<string, unknown>>(
2472
- /**
2473
- * Name of the class being created
2474
- */
2475
- sClassName: string,
2476
- /**
2477
- * Object literal with information about the class
2478
- */
2479
- oClassInfo?: sap.ClassInfo<T, QueryInfo>,
2480
- /**
2481
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2482
- * used by this class
2483
- */
2484
- FNMetaImpl?: Function
2485
- ): Function;
2486
- /**
2487
- * Returns a metadata object for class sap.sac.df.model.QueryInfo.
2488
- *
2489
- * @returns Metadata object describing this class
2490
- */
2491
- static getMetadata(): Metadata;
2492
- }
2791
+ export type MultiDimModel$LoadedEvent = Event<
2792
+ MultiDimModel$LoadedEventParameters,
2793
+ MultiDimModel
2794
+ >;
2493
2795
  }
2494
2796
 
2495
2797
  declare module "sap/sac/df/model/Variable" {
@@ -2497,11 +2799,9 @@ declare module "sap/sac/df/model/Variable" {
2497
2799
 
2498
2800
  import Metadata from "sap/ui/base/Metadata";
2499
2801
 
2500
- import Filter from "sap/ui/model/Filter";
2501
-
2502
2802
  /**
2503
2803
  * @since 1.119
2504
- * @experimental
2804
+ * @experimental (since 1.119)
2505
2805
  *
2506
2806
  * Variable
2507
2807
  * ```javascript
@@ -2554,629 +2854,184 @@ declare module "sap/sac/df/model/Variable" {
2554
2854
  */
2555
2855
  static getMetadata(): Metadata;
2556
2856
  /**
2557
- * Open a dialog to display and change the filter on a dimension of the `DataProvider`
2558
- *
2559
- * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
2560
- * with Ok and dynamic filters of the given dimension are updated
2561
- */
2562
- openValueHelpDialog(
2563
- /**
2564
- * if the model update should be suppressed
2565
- */
2566
- bSuppressModelUpdate: boolean
2567
- ): Promise<any>;
2568
- /**
2569
- * Performs the search in values of a given Variable
2570
- *
2571
- * @returns array members found values
2572
- */
2573
- searchMember(
2574
- /**
2575
- * string to search for
2576
- */
2577
- sSearchString: string,
2578
- /**
2579
- * if a fuzzy search is performed
2580
- */
2581
- bFuzzy: boolean,
2582
- /**
2583
- * if to search in text/description (default true)
2584
- */
2585
- bText: boolean,
2586
- /**
2587
- * if to search in key/id (default true)
2588
- */
2589
- bKey: boolean,
2590
- /**
2591
- * maximal number of search results (default 1)
2592
- */
2593
- iMaxNumberOfResults: int,
2594
- /**
2595
- * if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
2596
- * is set)
2597
- */
2598
- bRequestParents: boolean
2599
- ): Promise</* was: sap.sac.df.MemberFilter */ any[]>;
2600
- /**
2601
- * Set value of the variable
2602
- */
2603
- setMemberFilter(oFilter: Filter): void;
2604
- }
2605
- }
2606
-
2607
- declare module "sap/sac/df/model/VariableGroup" {
2608
- import BaseObject from "sap/ui/base/Object";
2609
-
2610
- import Variable from "sap/sac/df/model/Variable";
2611
-
2612
- import Metadata from "sap/ui/base/Metadata";
2613
-
2614
- import MemberFilter from "sap/sac/df/model/MemberFilter";
2615
-
2616
- import Filter from "sap/ui/model/Filter";
2617
-
2618
- /**
2619
- * @since 1.119
2620
- * @experimental
2621
- *
2622
- * Variable Group
2623
- * ```javascript
2624
- *
2625
- * "Name": "string",
2626
- * "MergedVariable": { }
2627
- * ```
2628
- */
2629
- export default class VariableGroup extends BaseObject {
2630
- constructor();
2631
- /**
2632
- * Merged Variable
2633
- */
2634
- MergedVariable: Variable;
2635
-
2636
- /**
2637
- * Name
2638
- */
2639
- Name: string;
2640
-
2641
- /**
2642
- * Creates a new subclass of class sap.sac.df.model.VariableGroup with name `sClassName` and enriches it
2643
- * with the information contained in `oClassInfo`.
2644
- *
2645
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2646
- *
2647
- * @returns Created class / constructor function
2648
- */
2649
- static extend<T extends Record<string, unknown>>(
2650
- /**
2651
- * Name of the class being created
2652
- */
2653
- sClassName: string,
2654
- /**
2655
- * Object literal with information about the class
2656
- */
2657
- oClassInfo?: sap.ClassInfo<T, VariableGroup>,
2658
- /**
2659
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2660
- * used by this class
2661
- */
2662
- FNMetaImpl?: Function
2663
- ): Function;
2664
- /**
2665
- * Returns a metadata object for class sap.sac.df.model.VariableGroup.
2666
- *
2667
- * @returns Metadata object describing this class
2668
- */
2669
- static getMetadata(): Metadata;
2670
- /**
2671
- * Opens the value help dialog so the user choose a value for a VariableGroup After the value is selected
2672
- * only teh VariableGroup.MergedVariable is updated. The variables of the aggregated DataProviders are updated
2673
- * with the next ResultSet fetch
2674
- *
2675
- * @returns to indicate if the VariableGroup has been updated
2676
- */
2677
- openValueHelpDialog(): Promise<boolean>;
2678
- /**
2679
- * Performs the search in values of a given Variable
2680
- *
2681
- * @returns array with found values
2682
- */
2683
- searchMember(
2684
- /**
2685
- * string to search for
2686
- */
2687
- sSearchString: string,
2688
- /**
2689
- * if a fuzzy search is performed
2690
- */
2691
- bFuzzy: boolean,
2692
- /**
2693
- * if to search in text/description (default true)
2694
- */
2695
- bText: boolean,
2696
- /**
2697
- * if to search in key/id (default true)
2698
- */
2699
- bKey: boolean,
2700
- /**
2701
- * maximal number of search results (default 1)
2702
- */
2703
- iMaxNumberOfResults: int,
2704
- /**
2705
- * if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
2706
- * is set)
2707
- */
2708
- bRequestParents: boolean
2709
- ): Promise<MemberFilter[]>;
2710
- /**
2711
- * Sets new value
2712
- *
2713
- * @returns Promise which resolve when the value is set
2714
- */
2715
- setMemberFilter(
2716
- /**
2717
- * filter object
2718
- */
2719
- oFilter: Filter
2720
- ): undefined;
2721
- }
2722
- }
2723
-
2724
- declare module "sap/sac/df/olap/MultiDimDataProvider" {
2725
- import MultiDimModel from "sap/sac/df/olap/MultiDimModel";
2726
-
2727
- /**
2728
- * @deprecated (since 1.119) - Please use @link{sap.sac.df.model.DataProvider}.
2729
- * @experimental
2730
- *
2731
- * A `MultiDimDataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol
2732
- * HANA - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
2733
- *
2734
- * Instances of this class should only be created by the {sap.sac.df.olap.MultiDimModel}. The `MultiDimModel`
2735
- * populates it's exposed data via Binding to Controls. The structure of data exposed by a MultiDimDataProvider
2736
- * is as follows:
2737
- *
2738
- * **Structure of Exposed Data**
2739
- *
2740
- *
2741
- * - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `MultiDimDataProvider`
2742
- * - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
2743
- * `Name`: the external name of the dimension `Description`: the language dependant description of
2744
- * the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
2745
- *
2746
- * - RowsDimensions: The list of all Dimensions lying on the Rows Axis
2747
- * Name: the external name of the dimension Description: the language dependant description of the
2748
- * dimension IsStructure: boolean flag indicating whether the dimension is a structure *
2749
- * - ColumnsDimensions: The list of all Dimensions lying on the Columns Axis
2750
- * Name: the external name of the dimension Description: the language dependant description of the
2751
- * dimension IsStructure: boolean flag indicating whether the dimension is a structure
2752
- * - Conditions: list of conditions (result set filters)
2753
- * - Exceptions: list of exceptions (conditional formats)
2754
- * - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
2755
- */
2756
- export default class MultiDimDataProvider {
2757
- /**
2758
- * Constructor for a new MultiDimDataProvider.
2759
- *
2760
- * A MultiDimDataProvider represents a navigable queryManager and allows to access and change data from
2761
- * servers providing the InA
2762
- * Protocol.
2763
- */
2764
- constructor(
2765
- /**
2766
- * the model to which the MultiDimDataProvider belongs
2767
- */
2768
- oMultiDimModel: MultiDimModel,
2769
- /**
2770
- * name of the MultiDimDataProvider
2771
- */
2772
- sMultiDimDataProviderName: string,
2773
- /**
2774
- * the firefly application associated to the `MultiDimModel`
2775
- */
2776
- oApplication: object,
2777
- /**
2778
- * the firefly queryManager that is wrapped by the `MultiDimDataProvider`
2779
- */
2780
- oQueryManager: object
2781
- );
2782
-
2783
- /**
2784
- * add a new condition (aka resultset filter).
2857
+ * Add variable filters
2785
2858
  *
2786
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
2859
+ * @returns Reference to this in order to allow method chaining
2787
2860
  */
2788
- addCondition(
2861
+ addMemberFilter(
2789
2862
  /**
2790
- * Condition Definiton
2863
+ * a member filter object
2791
2864
  */
2792
- oData: object,
2865
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any,
2793
2866
  /**
2794
- * Target state of the condition
2867
+ * If true, the result set is invalidated and must be refreshed
2795
2868
  */
2796
- bActive: boolean
2797
- ): Promise<this>;
2798
- /**
2799
- * Do a drill operation on a dimension member on an Axis
2800
- *
2801
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
2802
- */
2803
- drill(
2804
- /**
2805
- * the external name of the Dimension
2806
- */
2807
- sDim: string,
2808
- /**
2809
- * the Tuple Index of the member in the resultset.
2810
- */
2811
- nIndex: int
2869
+ bInvalidateDataProvider: boolean
2812
2870
  ): this;
2813
2871
  /**
2814
- * Gets the scaling factor of a measure or data cell
2872
+ * Add a member filter by its key
2815
2873
  *
2816
- * @returns the current decimal places setting
2874
+ * @returns Reference to this in order to allow method chaining
2817
2875
  */
2818
- getDecimalPlaces(
2876
+ addMemberFilterByKey(
2819
2877
  /**
2820
- * the Member of the Measure Structure
2878
+ * (internal) key of a dimension member
2821
2879
  */
2822
- sMeasureMember: string,
2823
- /**
2824
- * the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
2825
- */
2826
- sNonMeasureMember: string
2827
- ): int;
2828
- /**
2829
- * get the list of filters of a dimension
2830
- *
2831
- * @returns list of a range with components
2832
- * `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
2833
- * EQ,LE,..,BT
2834
- */
2835
- getFilterOfDim(
2880
+ sKey: string,
2836
2881
  /**
2837
- * the name of the dimension from which the filter is retrieved
2882
+ * If true, the result set is invalidated and must be refreshed
2838
2883
  */
2839
- sDim: string
2840
- ): object[];
2841
- /**
2842
- * get the current resultset from the InA Server
2843
- *
2844
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
2845
- */
2846
- getResultSet(): Promise<this>;
2847
- /**
2848
- * get the list of the jump targets associated to a datacell defined via the report report interface.
2849
- *
2850
- * @returns resolving to the List of jump targets.
2851
- */
2852
- getRRITargets(
2853
- /**
2854
- * Row of the data cell
2855
- */
2856
- nRow: int,
2857
- /**
2858
- * Column of the data cell
2859
- */
2860
- nColumn: int
2861
- ): Promise<this>;
2862
- /**
2863
- * Gets the scaling factor of a measure
2864
- *
2865
- * @returns the exponent of the scaling factor in Base 10
2866
- */
2867
- getScalingFactor(
2868
- /**
2869
- * the Member of the Measure Structure
2870
- */
2871
- sMeasureMember: string,
2872
- /**
2873
- * the Member of the Non Measure Structure
2874
- */
2875
- sNonMeasureMember: string
2876
- ): int;
2877
- /**
2878
- * hasVariable Checks whether a Variable is influencing the MultiDimDataProvider
2879
- *
2880
- * @returns Whether the vairable influences the MultiDimDataProvider
2881
- */
2882
- hasVariable(
2883
- /**
2884
- * Name of the Variable
2885
- */
2886
- the: string
2887
- ): boolean;
2888
- /**
2889
- * move a dimension one position down on it's axis
2890
- *
2891
- * @returns the `MultiDimDataProvider` to allow chaining.
2892
- */
2893
- moveDown(
2894
- /**
2895
- * name of the dimension
2896
- */
2897
- sName: string,
2898
- /**
2899
- * Target state of the condition
2900
- */
2901
- bActive: boolean
2902
- ): this;
2903
- /**
2904
- * move a dimension one position up on it's axis
2905
- *
2906
- * @returns the `MultiDimDataProvider` to allow chaining.
2907
- */
2908
- moveUp(
2909
- /**
2910
- * name of the dimension
2911
- */
2912
- sName: string,
2913
- /**
2914
- * Target state of the condition
2915
- */
2916
- bActive: boolean
2884
+ bInvalidateDataProvider: boolean
2917
2885
  ): this;
2918
2886
  /**
2919
- * Open a dialog that allows to display and change the property of an `Axis` of the `MultiDimDataProvider`.
2920
- *
2921
- * @returns indicator whether the dialog was confirmed or canceled
2922
- */
2923
- openAxisDialog(
2924
- /**
2925
- * the external name of the Dimension
2926
- */
2927
- sDim: string
2928
- ): Promise<boolean>;
2929
- /**
2930
- * Open a dialog that allows to display and change the property of a `Query Cell` of the `MultiDimDataProvider`.
2931
- *
2932
- * @returns resolving to the `MultiDimDataProvider` to allow chaining. In case that a the Currency Translation
2933
- * Settings have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
2934
- */
2935
- openCellDialog(
2936
- /**
2937
- * the external name of the first structure
2938
- */
2939
- sDim1?: string,
2940
- /**
2941
- * the external name of the member of the first structure
2942
- */
2943
- sMem1?: string,
2944
- /**
2945
- * the external name of the second structure
2946
- */
2947
- sDim2?: string,
2948
- /**
2949
- * the external name of the member of the second structure
2950
- */
2951
- sMem2?: string
2952
- ): Promise<this>;
2953
- /**
2954
- * Open a dialog that allows to display and change the currency translation settings of the `MultiDimDataProvider`.
2955
- *
2956
- * @returns indicator whether the dialog was confirmed or canceled in the dialog, the new resultset was
2957
- * retrieved before the promise gets resolved.
2958
- */
2959
- openCurrencyTranslationDialog(): Promise<boolean>;
2960
- /**
2961
- * Open a dialog to display and change the settings of a dimension of the `MultiDimDataProvider`
2887
+ * Get effective variable filters
2962
2888
  *
2963
- * @returns indicator whether the dialog was confirmed or canceled
2889
+ * @returns array of member filters
2964
2890
  */
2965
- openDimDialog(
2966
- /**
2967
- * the external name of the Dimension
2968
- */
2969
- sDim: string
2970
- ): Promise<boolean>;
2891
+ getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
2971
2892
  /**
2972
- * Open a dialog to display and change the filter on a dimension of the `MultiDimDataProvider`
2893
+ * Open a dialog to display and change the filter on a variable
2973
2894
  *
2974
2895
  * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
2975
2896
  * with Ok and dynamic filters of the given dimension are updated
2976
2897
  */
2977
- openSelector(
2898
+ openValueHelpDialog(
2978
2899
  /**
2979
- * the external name of the Dimension
2900
+ * If true, the result set is invalidated and must be refreshed
2980
2901
  */
2981
- sDimensionName: string
2902
+ bInvalidateDataProvider: boolean
2982
2903
  ): Promise<any>;
2983
2904
  /**
2984
- * Remove the filter of a dimension
2905
+ * Remove variable filter
2985
2906
  *
2986
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
2907
+ * @returns Reference to this in order to allow method chaining
2987
2908
  */
2988
- removeFilter(
2909
+ removeMemberFilter(
2989
2910
  /**
2990
- * the external name
2911
+ * a member filter object
2991
2912
  */
2992
- sDim: string
2993
- ): this;
2994
- /**
2995
- * Distribute the dimension among the rows and columns
2996
- *
2997
- * @returns resolving to the `MultiDimDataProvider` to allow chaining. In case that a the Currency Translation
2998
- * Settings have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
2999
- */
3000
- setAxesLayout(
2913
+ oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any,
3001
2914
  /**
3002
- * an Object containing a `rows` member referencing a string array containing the names of the dimensions
3003
- * and a `columns` member referencing a string array containing the dimension on the columns. The order
3004
- * in the array control the positon on the axis.
2915
+ * If true, the result set is invalidated and must be refreshed
3005
2916
  */
3006
- mLayout: object
2917
+ bInvalidateDataProvider: boolean
3007
2918
  ): this;
3008
2919
  /**
3009
- * Sets the number of decimal of a measure/query cell
2920
+ * Remove a member filter by its key
3010
2921
  *
3011
- * @returns the MultiDimDataProvider
2922
+ * @returns Reference to this in order to allow method chaining
3012
2923
  */
3013
- setDecimalPlaces(
2924
+ removeMemberFilterByKey(
3014
2925
  /**
3015
- * number of the decimal palaces to be shown after the separator
2926
+ * (internal) key of a dimension member
3016
2927
  */
3017
- nNumberOfDecimalPlaces: int,
3018
- /**
3019
- * the Member of the Measure Structure
3020
- */
3021
- sMeasureMember: string,
2928
+ sKey: string,
3022
2929
  /**
3023
- * Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
2930
+ * If true, the result set is invalidated and must be refreshed
3024
2931
  */
3025
- the: string
2932
+ bInvalidateDataProvider: boolean
3026
2933
  ): this;
3027
2934
  /**
3028
- * Set Display Hierachy
2935
+ * Performs the search for a given value
3029
2936
  *
3030
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
2937
+ * @returns array of found member filters
3031
2938
  */
3032
- setDisplayHierarchy(
2939
+ searchMember(
3033
2940
  /**
3034
- * the external name of the structure on which the new restriction is created
2941
+ * string to search for
3035
2942
  */
3036
- sDim: string,
2943
+ sSearchString: string,
3037
2944
  /**
3038
- * whether the hierarchy should be activated
2945
+ * if a fuzzy search is performed
3039
2946
  */
3040
- bActive: boolean,
2947
+ bFuzzy: boolean,
3041
2948
  /**
3042
- * the name of the hierarchy (optional)
2949
+ * if to search in text/description (default true)
3043
2950
  */
3044
- sHierachy: string,
2951
+ bText: boolean,
3045
2952
  /**
3046
- * the version of the hierarchy (optional)
2953
+ * if to search in key/id (default true)
3047
2954
  */
3048
- sVersion: string
3049
- ): this;
3050
- /**
3051
- * Set the filter for a dimension
3052
- *
3053
- * @returns {{this} resolving to the `MultiDimDataProvider` to allow chaining.
3054
- */
3055
- setFilter(
2955
+ bKey: boolean,
3056
2956
  /**
3057
- * the external name
2957
+ * maximal number of search results (default 1)
3058
2958
  */
3059
- sDim: string,
2959
+ iMaxNumberOfResults: int,
3060
2960
  /**
3061
- * the filter
2961
+ * if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
2962
+ * is set)
3062
2963
  */
3063
- oFilter: object
3064
- ): undefined;
2964
+ bRequestParents: boolean
2965
+ ): Promise</* was: sap.sac.df.MemberFilter */ any[]>;
3065
2966
  /**
3066
- * Sets the scaling factor of a measure/query cell
2967
+ * Set variable filters
3067
2968
  *
3068
- * @returns the MultiDimDataProvider
2969
+ * @returns Reference to this in order to allow method chaining
3069
2970
  */
3070
- setScalingFactor(
3071
- /**
3072
- * the exponential of the scaling factor
3073
- */
3074
- nFactor: int,
2971
+ setMemberFilter(
3075
2972
  /**
3076
- * the Member of the Measure Structure
2973
+ * array of member filters
3077
2974
  */
3078
- sMeasureMember: string,
2975
+ aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[],
3079
2976
  /**
3080
- * the Member of the Non Measure Structure
2977
+ * If true, the result set is invalidated and must be refreshed
3081
2978
  */
3082
- sNonMeasureMember: string
2979
+ bInvalidateDataProvider: boolean
3083
2980
  ): this;
3084
2981
  /**
3085
- * Sort the members of a dimension
2982
+ * Set a member filter by its key
3086
2983
  *
3087
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
2984
+ * @returns Reference to this in order to allow method chaining
3088
2985
  */
3089
- sort(
2986
+ setMemberFilterByKey(
3090
2987
  /**
3091
- * the external name of the Dimension
2988
+ * (internal) key of a dimension member
3092
2989
  */
3093
- sDim: string,
2990
+ sKey: string,
3094
2991
  /**
3095
- * of sorting
2992
+ * If true, the result set is invalidated and must be refreshed
3096
2993
  */
3097
- type: /* was: sap.sac.df.types.SortType */ any,
3098
- /**
3099
- * of sorting
3100
- */
3101
- direction: /* was: sap.sac.df.types.SortDirection */ any,
3102
- /**
3103
- * in case of a structure the measure according to which is sorted
3104
- */
3105
- sMember?: string
3106
- ): Promise<this>;
3107
- /**
3108
- * submit the value of the input enabled queries to the InA Server
3109
- *
3110
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
3111
- */
3112
- submitVariables(): Promise<this>;
3113
- /**
3114
- * retrieve the data of the current naviation state `MultiDimDataProvider` from the InA Server.
3115
- *
3116
- * @returns to allow chaining.
3117
- */
3118
- synchronize(): Promise<this>;
3119
- /**
3120
- * Move a dimension to the columns axis
3121
- *
3122
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
3123
- */
3124
- toColumns(
3125
- /**
3126
- * the external name of the Dimension
3127
- */
3128
- sDim: string
3129
- ): this;
3130
- /**
3131
- * Move a dimension to the rows axis
3132
- *
3133
- * @returns resolving to the `MultiDimDataProvider` to allow chaining.
3134
- */
3135
- toRows(
3136
- /**
3137
- * the external name of the Dimension
3138
- */
3139
- sDim: string
2994
+ bInvalidateDataProvider: boolean
3140
2995
  ): this;
3141
2996
  }
3142
2997
  }
3143
2998
 
3144
- declare module "sap/sac/df/olap/MultiDimModel" {
3145
- import Model from "sap/ui/model/Model";
2999
+ declare module "sap/sac/df/model/VariableGroup" {
3000
+ import BaseObject from "sap/ui/base/Object";
3001
+
3002
+ import Variable from "sap/sac/df/model/Variable";
3146
3003
 
3147
3004
  import Metadata from "sap/ui/base/Metadata";
3148
3005
 
3149
3006
  /**
3150
- * @deprecated (since 1.119) - Please use @link{sap.sac.df.model.MultiDimModel}.
3151
- * @experimental
3152
- *
3153
- * Model implementation for InA provider
3154
- *
3155
- * The MultiDimModel can populate it's exposed data via Binding to Controls. The structure of the exposed
3156
- * data is as follows: **Structure of Exposed Data**
3007
+ * @since 1.119
3008
+ * @experimental (since 1.119)
3157
3009
  *
3010
+ * Variable Group
3011
+ * ```javascript
3158
3012
  *
3159
- * - DataProvider: The associative array of all `DataProvider` aggregated by the VariableGroups:
3160
- * The associative array of registered Variable Groups Messages: The list of all messages posted by
3161
- * the Analytical Engine
3013
+ * "Name": "",
3014
+ * "MergedVariable": { },
3015
+ * "Rule: function () {}
3016
+ * ```
3162
3017
  */
3163
- export default class MultiDimModel extends Model {
3018
+ export default class VariableGroup extends BaseObject {
3019
+ constructor();
3164
3020
  /**
3165
- * Constructor for a new OlapMode.
3166
- *
3167
- * The Olap Model allows to access and change data from servers providing the InA Protocol.
3168
- *
3169
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3170
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3171
- * of the syntax of the settings object.
3021
+ * Merged Variable
3172
3022
  */
3173
- constructor();
3023
+ MergedVariable: Variable;
3174
3024
 
3175
3025
  /**
3176
- * Creates a new subclass of class sap.sac.df.olap.MultiDimModel with name `sClassName` and enriches it
3026
+ * Name
3027
+ */
3028
+ Name: string;
3029
+
3030
+ /**
3031
+ * Creates a new subclass of class sap.sac.df.model.VariableGroup with name `sClassName` and enriches it
3177
3032
  * with the information contained in `oClassInfo`.
3178
3033
  *
3179
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
3034
+ * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3180
3035
  *
3181
3036
  * @returns Created class / constructor function
3182
3037
  */
@@ -3188,7 +3043,7 @@ declare module "sap/sac/df/olap/MultiDimModel" {
3188
3043
  /**
3189
3044
  * Object literal with information about the class
3190
3045
  */
3191
- oClassInfo?: sap.ClassInfo<T, MultiDimModel>,
3046
+ oClassInfo?: sap.ClassInfo<T, VariableGroup>,
3192
3047
  /**
3193
3048
  * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3194
3049
  * used by this class
@@ -3196,31 +3051,41 @@ declare module "sap/sac/df/olap/MultiDimModel" {
3196
3051
  FNMetaImpl?: Function
3197
3052
  ): Function;
3198
3053
  /**
3199
- * Returns a metadata object for class sap.sac.df.olap.MultiDimModel.
3054
+ * Returns a metadata object for class sap.sac.df.model.VariableGroup.
3200
3055
  *
3201
3056
  * @returns Metadata object describing this class
3202
3057
  */
3203
3058
  static getMetadata(): Metadata;
3059
+ }
3060
+ }
3061
+
3062
+ declare module "sap/sac/df/types/DataSourceType" {
3063
+ /**
3064
+ * Type of a data source
3065
+ */
3066
+ enum DataSourceType {
3204
3067
  /**
3205
- * Gets current value of property {@link #getApi api}.
3206
- *
3207
- * @returns Value of property `api`
3068
+ * CDS Projection View
3208
3069
  */
3209
- getApi(): undefined;
3070
+ CDSProjectionView = "CDSProjectionView",
3210
3071
  /**
3211
- * Sets a new value for property {@link #getApi api}.
3212
- *
3213
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3214
- *
3215
- * @returns Reference to `this` in order to allow method chaining
3072
+ * Cube
3216
3073
  */
3217
- setApi(
3218
- /**
3219
- * New value for property `api`
3220
- */
3221
- sApi: undefined
3222
- ): this;
3074
+ Cube = "Cube",
3075
+ /**
3076
+ * Ina Model
3077
+ */
3078
+ InAModel = "InAModel",
3079
+ /**
3080
+ * Query
3081
+ */
3082
+ Query = "Query",
3083
+ /**
3084
+ * View
3085
+ */
3086
+ View = "View",
3223
3087
  }
3088
+ export default DataSourceType;
3224
3089
  }
3225
3090
 
3226
3091
  declare module "sap/sac/df/types/SystemType" {
@@ -3250,6 +3115,8 @@ declare module "sap/sac/df/types/SystemType" {
3250
3115
 
3251
3116
  declare namespace sap {
3252
3117
  interface IUI5DefineDependencyNames {
3118
+ "sap/sac/df/FilterBar": undefined;
3119
+
3253
3120
  "sap/sac/df/FlexAnalysis": undefined;
3254
3121
 
3255
3122
  "sap/sac/df/FlexAnalysisPanel": undefined;
@@ -3260,25 +3127,21 @@ declare namespace sap {
3260
3127
 
3261
3128
  "sap/sac/df/model/DataProvider": undefined;
3262
3129
 
3130
+ "sap/sac/df/model/DataSourceInfo": undefined;
3131
+
3263
3132
  "sap/sac/df/model/Dimension": undefined;
3264
3133
 
3265
3134
  "sap/sac/df/model/Document": undefined;
3266
3135
 
3267
3136
  "sap/sac/df/model/Grid": undefined;
3268
3137
 
3269
- "sap/sac/df/model/MemberFilter": undefined;
3270
-
3271
3138
  "sap/sac/df/model/MultiDimModel": undefined;
3272
3139
 
3273
- "sap/sac/df/model/QueryInfo": undefined;
3274
-
3275
3140
  "sap/sac/df/model/Variable": undefined;
3276
3141
 
3277
3142
  "sap/sac/df/model/VariableGroup": undefined;
3278
3143
 
3279
- "sap/sac/df/olap/MultiDimDataProvider": undefined;
3280
-
3281
- "sap/sac/df/olap/MultiDimModel": undefined;
3144
+ "sap/sac/df/types/DataSourceType": undefined;
3282
3145
 
3283
3146
  "sap/sac/df/types/SystemType": undefined;
3284
3147
  }