@sapui5/ts-types 1.118.0 → 1.119.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.
- package/package.json +1 -1
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +16 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +35 -1
- package/types/sap.f.d.ts +117 -3
- package/types/sap.fe.core.d.ts +87 -61
- package/types/sap.fe.macros.d.ts +164 -21
- package/types/sap.fe.navigation.d.ts +92 -87
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +25 -21
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +67 -53
- package/types/sap.insights.d.ts +141 -40
- package/types/sap.landvisz.d.ts +1 -1
- package/types/sap.m.d.ts +458 -82
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +519 -272
- package/types/sap.suite.ui.commons.d.ts +50 -6
- package/types/sap.suite.ui.generic.template.d.ts +22 -17
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +17 -15
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +41 -62
- package/types/sap.ui.core.d.ts +504 -162
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +1 -54
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +11 -1
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +1023 -262
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +913 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +367 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +113 -115
- package/types/sap.ui.webc.main.d.ts +299 -306
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +534 -14
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.sac.df.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.119.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace sac {
|
|
@@ -10,10 +10,12 @@ declare namespace sap {
|
|
|
10
10
|
*/
|
|
11
11
|
namespace df {
|
|
12
12
|
namespace model {
|
|
13
|
+
interface MultiDimModel$DataProviderAddedEventParameters {}
|
|
14
|
+
|
|
13
15
|
interface MultiDimModel$DataProviderUpdatedEventParameters {}
|
|
14
16
|
|
|
15
17
|
/**
|
|
16
|
-
* @since 1.
|
|
18
|
+
* @since 1.119
|
|
17
19
|
* @experimental
|
|
18
20
|
*
|
|
19
21
|
* Axis Layout showing which dimensions are set on rows and which on columns.
|
|
@@ -25,11 +27,11 @@ declare namespace sap {
|
|
|
25
27
|
* }
|
|
26
28
|
* ```
|
|
27
29
|
*/
|
|
28
|
-
class
|
|
30
|
+
class AxesLayout extends sap.ui.base.Object {
|
|
29
31
|
constructor();
|
|
30
32
|
|
|
31
33
|
/**
|
|
32
|
-
* Creates a new subclass of class sap.sac.df.model.
|
|
34
|
+
* Creates a new subclass of class sap.sac.df.model.AxesLayout with name `sClassName` and enriches it with
|
|
33
35
|
* the information contained in `oClassInfo`.
|
|
34
36
|
*
|
|
35
37
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
@@ -44,7 +46,7 @@ declare namespace sap {
|
|
|
44
46
|
/**
|
|
45
47
|
* Object literal with information about the class
|
|
46
48
|
*/
|
|
47
|
-
oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.
|
|
49
|
+
oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.AxesLayout>,
|
|
48
50
|
/**
|
|
49
51
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
50
52
|
* used by this class
|
|
@@ -52,7 +54,7 @@ declare namespace sap {
|
|
|
52
54
|
FNMetaImpl?: Function
|
|
53
55
|
): Function;
|
|
54
56
|
/**
|
|
55
|
-
* Returns a metadata object for class sap.sac.df.model.
|
|
57
|
+
* Returns a metadata object for class sap.sac.df.model.AxesLayout.
|
|
56
58
|
*
|
|
57
59
|
* @returns Metadata object describing this class
|
|
58
60
|
*/
|
|
@@ -60,20 +62,327 @@ declare namespace sap {
|
|
|
60
62
|
/**
|
|
61
63
|
* Distribute the dimension among the rows and columns
|
|
62
64
|
*
|
|
63
|
-
* @returns resolving to the
|
|
64
|
-
* retrieved before the promise gets resolved.
|
|
65
|
+
* @returns resolving to the axes layout object to allow chaining
|
|
65
66
|
*/
|
|
66
67
|
setAxesLayout(
|
|
67
68
|
/**
|
|
68
|
-
* an
|
|
69
|
-
*
|
|
70
|
-
|
|
69
|
+
* an array containing a containing the names of the dimensions on rows. The order in the array control
|
|
70
|
+
* the position on the axis.
|
|
71
|
+
*/
|
|
72
|
+
aDimensionOnRowsAxis: string[],
|
|
73
|
+
/**
|
|
74
|
+
* an array containing a containing the names of the dimensions on columns. The order in the array control
|
|
75
|
+
* the position on the axis.
|
|
76
|
+
*/
|
|
77
|
+
aDimensionOnColumnsAxis: string[]
|
|
78
|
+
): sap.sac.df.model.AxesLayout;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* @experimental
|
|
82
|
+
*
|
|
83
|
+
* A `DataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol HANA
|
|
84
|
+
* - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
|
|
85
|
+
*
|
|
86
|
+
* Instances of this class should only be created by the {sap.sac.df.model.MultiDimModel}. The `MultiDimModel`
|
|
87
|
+
* populates it's exposed data via Binding to Controls. The structure of data exposed by a DataProvider
|
|
88
|
+
* is as follows:
|
|
89
|
+
*
|
|
90
|
+
* **Structure of Exposed Data**
|
|
91
|
+
* ```javascript
|
|
92
|
+
*
|
|
93
|
+
* "Name": "",
|
|
94
|
+
* "QueryInfo": { },
|
|
95
|
+
* "Variables": { }
|
|
96
|
+
* "Dimensions": { },
|
|
97
|
+
* "Measures": [ ],
|
|
98
|
+
* "AxesLayout": {
|
|
99
|
+
* "Columns": [],
|
|
100
|
+
* "Rows": []
|
|
101
|
+
* },
|
|
102
|
+
* "Grid": { },
|
|
103
|
+
* "Messages": [ ]
|
|
104
|
+
* ```
|
|
105
|
+
*/
|
|
106
|
+
class DataProvider extends sap.ui.base.Object {
|
|
107
|
+
/**
|
|
108
|
+
* Constructor for a new DataProvider.
|
|
109
|
+
*
|
|
110
|
+
* A DataProvider represents a navigable queryManager and allows to access and change data from servers
|
|
111
|
+
* providing the InA Protocol.
|
|
112
|
+
*/
|
|
113
|
+
constructor(
|
|
114
|
+
/**
|
|
115
|
+
* the model to which the DataProvider belongs
|
|
116
|
+
*/
|
|
117
|
+
oMultiDimModel: sap.sac.df.model.MultiDimModel,
|
|
118
|
+
/**
|
|
119
|
+
* name of the DataProvider
|
|
120
|
+
*/
|
|
121
|
+
sDataProviderName: string
|
|
122
|
+
);
|
|
123
|
+
/**
|
|
124
|
+
* AxesLayout
|
|
125
|
+
*/
|
|
126
|
+
AxesLayout: sap.sac.df.model.AxesLayout;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* Dimensions
|
|
130
|
+
*/
|
|
131
|
+
Dimensions: sap.sac.df.model.Dimension;
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Grid
|
|
135
|
+
*/
|
|
136
|
+
Grid: sap.sac.df.model.Grid;
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* Measures
|
|
140
|
+
*/
|
|
141
|
+
Measures: /* was: sap.sac.df.model.Measure */ any;
|
|
142
|
+
|
|
143
|
+
/**
|
|
144
|
+
* Variables
|
|
145
|
+
*/
|
|
146
|
+
Variables: sap.sac.df.model.Variable;
|
|
147
|
+
|
|
148
|
+
/**
|
|
149
|
+
* Creates a new subclass of class sap.sac.df.model.DataProvider with name `sClassName` and enriches it
|
|
150
|
+
* with the information contained in `oClassInfo`.
|
|
151
|
+
*
|
|
152
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
153
|
+
*
|
|
154
|
+
* @returns Created class / constructor function
|
|
155
|
+
*/
|
|
156
|
+
static extend<T extends Record<string, unknown>>(
|
|
157
|
+
/**
|
|
158
|
+
* Name of the class being created
|
|
159
|
+
*/
|
|
160
|
+
sClassName: string,
|
|
161
|
+
/**
|
|
162
|
+
* Object literal with information about the class
|
|
163
|
+
*/
|
|
164
|
+
oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.DataProvider>,
|
|
165
|
+
/**
|
|
166
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
167
|
+
* used by this class
|
|
168
|
+
*/
|
|
169
|
+
FNMetaImpl?: Function
|
|
170
|
+
): Function;
|
|
171
|
+
/**
|
|
172
|
+
* Returns a metadata object for class sap.sac.df.model.DataProvider.
|
|
173
|
+
*
|
|
174
|
+
* @returns Metadata object describing this class
|
|
175
|
+
*/
|
|
176
|
+
static getMetadata(): sap.ui.base.Metadata;
|
|
177
|
+
/**
|
|
178
|
+
* Updates the MultiDimModel from the given the model state including all aggregated `DataProvider`s
|
|
179
|
+
*
|
|
180
|
+
* @returns Promise Promise which resolves to the updated instance of the OlapModel.
|
|
181
|
+
*/
|
|
182
|
+
deserialize(
|
|
183
|
+
/**
|
|
184
|
+
* the JSON object containing the persisted state of th MultiDimModel to be applied.
|
|
185
|
+
*/
|
|
186
|
+
oModelState: object,
|
|
187
|
+
/**
|
|
188
|
+
* the format be the deserialized (INA_REPOSITORY_DELTA or INA_REPOSITORY).
|
|
189
|
+
*/
|
|
190
|
+
sFormat: string
|
|
191
|
+
): undefined;
|
|
192
|
+
/**
|
|
193
|
+
* Export Data
|
|
194
|
+
*/
|
|
195
|
+
exportData(
|
|
196
|
+
/**
|
|
197
|
+
* data export configuration
|
|
198
|
+
*/
|
|
199
|
+
oDataExportConfig: object
|
|
200
|
+
): void;
|
|
201
|
+
/**
|
|
202
|
+
* Get Axis Layout
|
|
203
|
+
*
|
|
204
|
+
* @returns axis layout
|
|
205
|
+
*/
|
|
206
|
+
getAxesLayout(): sap.sac.df.model.AxesLayout;
|
|
207
|
+
/**
|
|
208
|
+
* Gets the scaling factor of a measure or data cell
|
|
209
|
+
*
|
|
210
|
+
* @returns the current decimal places setting
|
|
211
|
+
*/
|
|
212
|
+
getDecimalPlaces(
|
|
213
|
+
/**
|
|
214
|
+
* the Member of the Measure Structure
|
|
215
|
+
*/
|
|
216
|
+
sMeasureMember: string,
|
|
217
|
+
/**
|
|
218
|
+
* the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
|
|
219
|
+
*/
|
|
220
|
+
sNonMeasureMember: string
|
|
221
|
+
): int;
|
|
222
|
+
/**
|
|
223
|
+
* Get Dimension
|
|
224
|
+
*
|
|
225
|
+
* @returns a dimension object
|
|
226
|
+
*/
|
|
227
|
+
getDimension(
|
|
228
|
+
/**
|
|
229
|
+
* dimension name
|
|
230
|
+
*/
|
|
231
|
+
sDimensionName: string
|
|
232
|
+
): sap.sac.df.model.Dimension;
|
|
233
|
+
/**
|
|
234
|
+
* Get Dimensions
|
|
235
|
+
*
|
|
236
|
+
* @returns a dimension object
|
|
237
|
+
*/
|
|
238
|
+
getDimensions(): Record<string, sap.sac.df.model.Dimension>;
|
|
239
|
+
/**
|
|
240
|
+
* Get Grid
|
|
241
|
+
*
|
|
242
|
+
* @returns grid
|
|
243
|
+
*/
|
|
244
|
+
getGrid(): sap.sac.df.model.Grid;
|
|
245
|
+
/**
|
|
246
|
+
* Get measure
|
|
247
|
+
*
|
|
248
|
+
* @returns a dimension object
|
|
249
|
+
*/
|
|
250
|
+
getMeasure(
|
|
251
|
+
/**
|
|
252
|
+
* measure name
|
|
253
|
+
*/
|
|
254
|
+
sMeasureName: string
|
|
255
|
+
): /* was: sap.sac.df.model.Measure */ any;
|
|
256
|
+
/**
|
|
257
|
+
* Get measures
|
|
258
|
+
*
|
|
259
|
+
* @returns a dimension object
|
|
260
|
+
*/
|
|
261
|
+
getMeasures(): /* was: sap.sac.df.model.Measure */ any;
|
|
262
|
+
/**
|
|
263
|
+
* Get Measure Structure Dimension
|
|
264
|
+
*
|
|
265
|
+
* @returns measure structure dimension
|
|
266
|
+
*/
|
|
267
|
+
getMeasureStructureDimension(): sap.sac.df.model.Dimension;
|
|
268
|
+
/**
|
|
269
|
+
* Get Query Information
|
|
270
|
+
*
|
|
271
|
+
* @returns query information
|
|
272
|
+
*/
|
|
273
|
+
getQueryInfo(): sap.sac.df.model.QueryInfo;
|
|
274
|
+
/**
|
|
275
|
+
* Get Result Set
|
|
276
|
+
*/
|
|
277
|
+
getResultSet(
|
|
278
|
+
/**
|
|
279
|
+
* enforce result set update
|
|
280
|
+
*/
|
|
281
|
+
bForceResultSetUpdate?: boolean
|
|
282
|
+
): void;
|
|
283
|
+
/**
|
|
284
|
+
* Gets the scaling factor of a measure
|
|
285
|
+
*
|
|
286
|
+
* @returns the exponent of the scaling factor in Base 10
|
|
287
|
+
*/
|
|
288
|
+
getScalingFactor(
|
|
289
|
+
/**
|
|
290
|
+
* the Member of the Measure Structure
|
|
291
|
+
*/
|
|
292
|
+
sMeasureMember: string,
|
|
293
|
+
/**
|
|
294
|
+
* the Member of the Non Measure Structure
|
|
295
|
+
*/
|
|
296
|
+
sNonMeasureMember: string
|
|
297
|
+
): int;
|
|
298
|
+
/**
|
|
299
|
+
* Get Non-Measure Structure Dimension
|
|
300
|
+
*
|
|
301
|
+
* @returns non-measure structure dimension
|
|
302
|
+
*/
|
|
303
|
+
getStructureDimension(): sap.sac.df.model.Dimension;
|
|
304
|
+
/**
|
|
305
|
+
* Get Variable
|
|
306
|
+
*
|
|
307
|
+
* @returns a variable object
|
|
308
|
+
*/
|
|
309
|
+
getVariable(
|
|
310
|
+
/**
|
|
311
|
+
* variable name
|
|
312
|
+
*/
|
|
313
|
+
sVariableName: string
|
|
314
|
+
): sap.sac.df.model.Variable;
|
|
315
|
+
/**
|
|
316
|
+
* Get Variables
|
|
317
|
+
*
|
|
318
|
+
* @returns a variable object
|
|
319
|
+
*/
|
|
320
|
+
getVariables(): Record<string, sap.sac.df.model.Variable>;
|
|
321
|
+
/**
|
|
322
|
+
* Serialize the Data Provider to a JSON representation
|
|
323
|
+
*
|
|
324
|
+
* @returns a javascript object which represents the `DataProvider`.
|
|
325
|
+
*/
|
|
326
|
+
serialize(
|
|
327
|
+
/**
|
|
328
|
+
* the format be the serialized (INA_REPOSITORY_DELTA or INA_REPOSITORY). The `DataProvider` to be serialized
|
|
329
|
+
* from an equivalent such Object.
|
|
330
|
+
*/
|
|
331
|
+
sFormat: string
|
|
332
|
+
): object;
|
|
333
|
+
/**
|
|
334
|
+
* Sets the number of decimal of a measure/query cell
|
|
335
|
+
*
|
|
336
|
+
* @returns the MultiDimDataProvider
|
|
337
|
+
*/
|
|
338
|
+
setDecimalPlaces(
|
|
339
|
+
/**
|
|
340
|
+
* number of the decimal palaces to be shown after the separator
|
|
341
|
+
*/
|
|
342
|
+
nNumberOfDecimalPlaces: int,
|
|
343
|
+
/**
|
|
344
|
+
* the Member of the Measure Structure
|
|
345
|
+
*/
|
|
346
|
+
sMeasureMember: string,
|
|
347
|
+
/**
|
|
348
|
+
* Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
|
|
349
|
+
*/
|
|
350
|
+
the: string
|
|
351
|
+
): this;
|
|
352
|
+
/**
|
|
353
|
+
* Sets the scaling factor of a measure/query cell
|
|
354
|
+
*
|
|
355
|
+
* @returns the MultiDimDataProvider
|
|
356
|
+
*/
|
|
357
|
+
setScalingFactor(
|
|
358
|
+
/**
|
|
359
|
+
* the exponential of the scaling factor
|
|
360
|
+
*/
|
|
361
|
+
nFactor: int,
|
|
362
|
+
/**
|
|
363
|
+
* the Member of the Measure Structure
|
|
364
|
+
*/
|
|
365
|
+
sMeasureMember: string,
|
|
366
|
+
/**
|
|
367
|
+
* the Member of the Non Measure Structure
|
|
71
368
|
*/
|
|
72
|
-
|
|
369
|
+
sNonMeasureMember: string
|
|
73
370
|
): this;
|
|
371
|
+
/**
|
|
372
|
+
* Checks whether an InA capability is supported by the backend. Throws an error for unhandled capabilities.
|
|
373
|
+
* List of handled capabilities can be seen in type sap.sac.df.model.Capability
|
|
374
|
+
*
|
|
375
|
+
* @returns returns true, if the capability is supported, else false
|
|
376
|
+
*/
|
|
377
|
+
supportsCapability(
|
|
378
|
+
/**
|
|
379
|
+
* the capability name
|
|
380
|
+
*/
|
|
381
|
+
sCapability: undefined
|
|
382
|
+
): boolean;
|
|
74
383
|
}
|
|
75
384
|
/**
|
|
76
|
-
* @since 1.
|
|
385
|
+
* @since 1.119
|
|
77
386
|
* @experimental
|
|
78
387
|
*
|
|
79
388
|
* Dimension
|
|
@@ -86,20 +395,7 @@ declare namespace sap {
|
|
|
86
395
|
* "Type": "",
|
|
87
396
|
* "HierarchyActive": "",
|
|
88
397
|
* "HasFilter": "",
|
|
89
|
-
* "MemberFilter": [
|
|
90
|
-
* {
|
|
91
|
-
* "Low": "",
|
|
92
|
-
* "LowDisplayKey": "",
|
|
93
|
-
* "LowText": "",
|
|
94
|
-
* "High": "",
|
|
95
|
-
* "HighDisplayKey": "",
|
|
96
|
-
* "HighText": "",
|
|
97
|
-
* "ComparisonOperator": "",
|
|
98
|
-
* "Text": "",
|
|
99
|
-
* "IsExcluding": "",
|
|
100
|
-
* "Hierarchy": { }
|
|
101
|
-
* }
|
|
102
|
-
* ],
|
|
398
|
+
* "MemberFilter": [],
|
|
103
399
|
* "SortDirection": "",
|
|
104
400
|
* "Position": "",
|
|
105
401
|
* "LastPosition": "",
|
|
@@ -171,10 +467,8 @@ declare namespace sap {
|
|
|
171
467
|
* get the list of filters of a dimension
|
|
172
468
|
*
|
|
173
469
|
* @returns list of a range with components
|
|
174
|
-
* `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
|
|
175
|
-
* EQ,LE,..,BT
|
|
176
470
|
*/
|
|
177
|
-
|
|
471
|
+
getMemberFilter(): sap.sac.df.model.MemberFilter;
|
|
178
472
|
/**
|
|
179
473
|
* Move a dimension one position down on it's axis
|
|
180
474
|
*
|
|
@@ -187,6 +481,19 @@ declare namespace sap {
|
|
|
187
481
|
* @returns the `Dimension` to allow chaining.
|
|
188
482
|
*/
|
|
189
483
|
moveUp(): sap.sac.df.model.Dimension;
|
|
484
|
+
/**
|
|
485
|
+
* Open a dialog to display and change the settings of a dimension of the `DataProvider`
|
|
486
|
+
*
|
|
487
|
+
* @returns indicator whether the dialog was confirmed or canceled
|
|
488
|
+
*/
|
|
489
|
+
openPropertyDialog(): Promise<boolean>;
|
|
490
|
+
/**
|
|
491
|
+
* Open a dialog to display and change the filter on a dimension of the `DataProvider`
|
|
492
|
+
*
|
|
493
|
+
* @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
|
|
494
|
+
* with Ok and dynamic filters of the given dimension are updated
|
|
495
|
+
*/
|
|
496
|
+
openValueHelpDialog(): Promise<any>;
|
|
190
497
|
/**
|
|
191
498
|
* Set Display Hierarchy
|
|
192
499
|
*
|
|
@@ -209,7 +516,7 @@ declare namespace sap {
|
|
|
209
516
|
*
|
|
210
517
|
* @returns resolving to the `Dimension` to allow chaining.
|
|
211
518
|
*/
|
|
212
|
-
|
|
519
|
+
removeMemberFilter(): sap.sac.df.model.Dimension;
|
|
213
520
|
/**
|
|
214
521
|
* Set Display Hierarchy
|
|
215
522
|
*
|
|
@@ -234,11 +541,11 @@ declare namespace sap {
|
|
|
234
541
|
*
|
|
235
542
|
* @returns resolving to the `Dimension` to allow chaining.
|
|
236
543
|
*/
|
|
237
|
-
|
|
544
|
+
setMemberFilter(
|
|
238
545
|
/**
|
|
239
546
|
* the filter
|
|
240
547
|
*/
|
|
241
|
-
oFilter:
|
|
548
|
+
oFilter: sap.sac.df.model.MemberFilter
|
|
242
549
|
): sap.sac.df.model.Dimension;
|
|
243
550
|
/**
|
|
244
551
|
* Sort the members of a dimension
|
|
@@ -273,7 +580,7 @@ declare namespace sap {
|
|
|
273
580
|
toRows(): sap.sac.df.model.Dimension;
|
|
274
581
|
}
|
|
275
582
|
/**
|
|
276
|
-
* @since 1.
|
|
583
|
+
* @since 1.119
|
|
277
584
|
* @experimental
|
|
278
585
|
*
|
|
279
586
|
* Document Object
|
|
@@ -430,13 +737,16 @@ declare namespace sap {
|
|
|
430
737
|
): Promise<boolean>;
|
|
431
738
|
}
|
|
432
739
|
/**
|
|
433
|
-
* @since 1.
|
|
434
|
-
* @experimental
|
|
740
|
+
* @experimental (since 1.119)
|
|
435
741
|
*
|
|
436
742
|
* Grid Object
|
|
437
743
|
*/
|
|
438
744
|
class Grid extends sap.ui.base.Object {
|
|
439
745
|
constructor();
|
|
746
|
+
/**
|
|
747
|
+
* Documents
|
|
748
|
+
*/
|
|
749
|
+
Documents: sap.sac.df.model.Document;
|
|
440
750
|
|
|
441
751
|
/**
|
|
442
752
|
* Creates a new subclass of class sap.sac.df.model.Grid with name `sClassName` and enriches it with the
|
|
@@ -482,119 +792,70 @@ declare namespace sap {
|
|
|
482
792
|
*/
|
|
483
793
|
iColumnIndex: int
|
|
484
794
|
): Promise<any>;
|
|
485
|
-
/**
|
|
486
|
-
* Open a dialog that allows to display and change the property of a `Query Cell` of the `MultiDimDataProvider`.
|
|
487
|
-
*
|
|
488
|
-
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
489
|
-
*/
|
|
490
|
-
openCellDialog(
|
|
491
|
-
/**
|
|
492
|
-
* the external name of the first structure
|
|
493
|
-
*/
|
|
494
|
-
sDim1?: string,
|
|
495
|
-
/**
|
|
496
|
-
* the external name of the member of the first structure
|
|
497
|
-
*/
|
|
498
|
-
sMember1?: string,
|
|
499
|
-
/**
|
|
500
|
-
* the external name of the second structure
|
|
501
|
-
*/
|
|
502
|
-
sDim2?: string,
|
|
503
|
-
/**
|
|
504
|
-
* the external name of the member of the second structure
|
|
505
|
-
*/
|
|
506
|
-
sMember2?: string
|
|
507
|
-
): Promise<this>;
|
|
508
795
|
}
|
|
509
796
|
/**
|
|
797
|
+
* @since 1.119
|
|
510
798
|
* @experimental
|
|
511
799
|
*
|
|
512
|
-
*
|
|
513
|
-
* HANA - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
|
|
514
|
-
*
|
|
515
|
-
* Instances of this class should only be created by the {sap.sac.df.model.MultiDimModel}. The `MultiDimModel`
|
|
516
|
-
* populates it's exposed data via Binding to Controls. The structure of data exposed by a MultiDimDataProvider
|
|
517
|
-
* is as follows:
|
|
518
|
-
*
|
|
519
|
-
* **Structure of Exposed Data**
|
|
520
|
-
*
|
|
521
|
-
*
|
|
522
|
-
* - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `MultiDimDataProvider`
|
|
523
|
-
* - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
|
|
524
|
-
* `Name`: the external name of the dimension `Description`: the language dependant description of
|
|
525
|
-
* the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
|
|
526
|
-
*
|
|
527
|
-
* - RowsDimensions: The list of all Dimensions lying on the Rows Axis
|
|
528
|
-
* Name: the external name of the dimension Description: the language dependant description of the
|
|
529
|
-
* dimension IsStructure: boolean flag indicating whether the dimension is a structure *
|
|
530
|
-
* - ColumnsDimensions: The list of all Dimensions lying on the Columns Axis
|
|
531
|
-
* Name: the external name of the dimension Description: the language dependant description of the
|
|
532
|
-
* dimension IsStructure: boolean flag indicating whether the dimension is a structure
|
|
533
|
-
* - Conditions: list of conditions (result set filters)
|
|
534
|
-
* - Exceptions: list of exceptions (conditional formats)
|
|
535
|
-
* - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
|
|
536
|
-
*
|
|
800
|
+
* Member Filter
|
|
537
801
|
* ```javascript
|
|
538
802
|
*
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
*
|
|
543
|
-
*
|
|
544
|
-
* "AxesLayout": {
|
|
545
|
-
* "Columns": [],
|
|
546
|
-
* "Rows": []
|
|
547
|
-
* },
|
|
548
|
-
* "Grid": { },
|
|
549
|
-
* "Messages": [ ]
|
|
803
|
+
* "Key": [],
|
|
804
|
+
* "InternalKey": [],
|
|
805
|
+
* "Text": [],
|
|
806
|
+
* "Operator": "",
|
|
807
|
+
* "Hierarchy": { }
|
|
550
808
|
* ```
|
|
551
809
|
*/
|
|
552
|
-
class
|
|
553
|
-
/**
|
|
554
|
-
* Constructor for a new MultiDimDataProvider.
|
|
555
|
-
*
|
|
556
|
-
* A MultiDimDataProvider represents a navigable queryManager and allows to access and change data from
|
|
557
|
-
* servers providing the InA
|
|
558
|
-
* Protocol.
|
|
559
|
-
*/
|
|
810
|
+
class MemberFilter extends sap.ui.base.Object {
|
|
560
811
|
constructor(
|
|
561
812
|
/**
|
|
562
|
-
*
|
|
813
|
+
* array of (display) keys
|
|
563
814
|
*/
|
|
564
|
-
|
|
815
|
+
aKey: string[],
|
|
565
816
|
/**
|
|
566
|
-
*
|
|
817
|
+
* array of internal keys
|
|
818
|
+
*/
|
|
819
|
+
aInternalKey: string[],
|
|
820
|
+
/**
|
|
821
|
+
* array of texts
|
|
822
|
+
*/
|
|
823
|
+
aText: string[],
|
|
824
|
+
/**
|
|
825
|
+
* filter operator
|
|
826
|
+
*/
|
|
827
|
+
sOperator?: sap.ui.model.FilterOperator,
|
|
828
|
+
/**
|
|
829
|
+
* hierarchy object
|
|
567
830
|
*/
|
|
568
|
-
|
|
831
|
+
oHierarchyInfo?: Object
|
|
569
832
|
);
|
|
570
|
-
/**
|
|
571
|
-
* AxisLayout
|
|
572
|
-
*/
|
|
573
|
-
AxisLayout: sap.sac.df.model.AxisLayout;
|
|
574
|
-
|
|
575
|
-
/**
|
|
576
|
-
* Dimensions
|
|
577
|
-
*/
|
|
578
|
-
Dimensions: Record<string, sap.sac.df.model.Dimension>;
|
|
579
833
|
|
|
580
834
|
/**
|
|
581
|
-
*
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
/**
|
|
586
|
-
* Measures
|
|
835
|
+
* Create a member filter object from firefly
|
|
836
|
+
*
|
|
837
|
+
* @returns a Member Filter object
|
|
587
838
|
*/
|
|
588
|
-
|
|
589
|
-
|
|
839
|
+
static createFromFFMemberFilter(
|
|
840
|
+
/**
|
|
841
|
+
* array of firefly member filters
|
|
842
|
+
*/
|
|
843
|
+
aFFMemberFilter: any[]
|
|
844
|
+
): sap.sac.df.model.MemberFilter[];
|
|
590
845
|
/**
|
|
591
|
-
*
|
|
846
|
+
* Create a member filter object from filter operation
|
|
847
|
+
*
|
|
848
|
+
* @returns a Member Filter object
|
|
592
849
|
*/
|
|
593
|
-
|
|
594
|
-
|
|
850
|
+
static createFromFilterOperation(
|
|
851
|
+
/**
|
|
852
|
+
* the name of the Variable to search
|
|
853
|
+
*/
|
|
854
|
+
filterOperation: object
|
|
855
|
+
): sap.sac.df.model.MemberFilter;
|
|
595
856
|
/**
|
|
596
|
-
* Creates a new subclass of class sap.sac.df.model.
|
|
597
|
-
*
|
|
857
|
+
* Creates a new subclass of class sap.sac.df.model.MemberFilter with name `sClassName` and enriches it
|
|
858
|
+
* with the information contained in `oClassInfo`.
|
|
598
859
|
*
|
|
599
860
|
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
600
861
|
*
|
|
@@ -608,10 +869,7 @@ declare namespace sap {
|
|
|
608
869
|
/**
|
|
609
870
|
* Object literal with information about the class
|
|
610
871
|
*/
|
|
611
|
-
oClassInfo?: sap.ClassInfo<
|
|
612
|
-
T,
|
|
613
|
-
sap.sac.df.model.MultiDimDataProvider
|
|
614
|
-
>,
|
|
872
|
+
oClassInfo?: sap.ClassInfo<T, sap.sac.df.model.MemberFilter>,
|
|
615
873
|
/**
|
|
616
874
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
617
875
|
* used by this class
|
|
@@ -619,85 +877,43 @@ declare namespace sap {
|
|
|
619
877
|
FNMetaImpl?: Function
|
|
620
878
|
): Function;
|
|
621
879
|
/**
|
|
622
|
-
* Returns a metadata object for class sap.sac.df.model.
|
|
880
|
+
* Returns a metadata object for class sap.sac.df.model.MemberFilter.
|
|
623
881
|
*
|
|
624
882
|
* @returns Metadata object describing this class
|
|
625
883
|
*/
|
|
626
884
|
static getMetadata(): sap.ui.base.Metadata;
|
|
627
885
|
/**
|
|
628
|
-
*
|
|
629
|
-
*
|
|
630
|
-
* @returns Promise Promise which resolves to the updated instance of the OlapModel.
|
|
631
|
-
*/
|
|
632
|
-
deserialize(
|
|
633
|
-
/**
|
|
634
|
-
* the JSON object containing the persisted state of th MultiDimModel to be applied.
|
|
635
|
-
*/
|
|
636
|
-
oModelState: object,
|
|
637
|
-
/**
|
|
638
|
-
* the format be the deserialized (INA_REPOSITORY_DELTA or INA_REPOSITORY).
|
|
639
|
-
*/
|
|
640
|
-
sFormat: string
|
|
641
|
-
): undefined;
|
|
642
|
-
/**
|
|
643
|
-
* Export Data
|
|
644
|
-
*/
|
|
645
|
-
exportData(
|
|
646
|
-
/**
|
|
647
|
-
* data export configuration
|
|
648
|
-
*/
|
|
649
|
-
oDataExportConfig: object
|
|
650
|
-
): void;
|
|
651
|
-
/**
|
|
652
|
-
* Get Dimension
|
|
886
|
+
* Create a member filter object from filter
|
|
653
887
|
*
|
|
654
|
-
* @returns a
|
|
888
|
+
* @returns a Member Filter object
|
|
655
889
|
*/
|
|
656
|
-
|
|
890
|
+
static transformFromFilterToMemberFilter(
|
|
657
891
|
/**
|
|
658
|
-
*
|
|
892
|
+
* object
|
|
659
893
|
*/
|
|
660
|
-
|
|
661
|
-
):
|
|
662
|
-
/**
|
|
663
|
-
* Get Dimensions
|
|
664
|
-
*
|
|
665
|
-
* @returns a dimension object
|
|
666
|
-
*/
|
|
667
|
-
getDimensions(): Record<string, sap.sac.df.model.Dimension>;
|
|
668
|
-
/**
|
|
669
|
-
* Retrieve the current result set
|
|
670
|
-
*/
|
|
671
|
-
getResultRequest(): void;
|
|
894
|
+
oFilter: sap.ui.model.Filter
|
|
895
|
+
): sap.sac.df.model.MemberFilter;
|
|
672
896
|
/**
|
|
673
|
-
*
|
|
897
|
+
* Create a member filter object from filter
|
|
674
898
|
*
|
|
675
|
-
* @returns a
|
|
899
|
+
* @returns a Member Filter object
|
|
676
900
|
*/
|
|
677
|
-
|
|
901
|
+
static transformFromMemberFilterToFilter(
|
|
678
902
|
/**
|
|
679
|
-
*
|
|
903
|
+
* object
|
|
680
904
|
*/
|
|
681
|
-
|
|
682
|
-
): /* was: sap.sac.df.Model.Variable */ any;
|
|
683
|
-
/**
|
|
684
|
-
* Serialize the Data Provider to a JSON representation
|
|
685
|
-
*
|
|
686
|
-
* @returns a javascript object which represents the `DataProvider`.
|
|
687
|
-
*/
|
|
688
|
-
serialize(
|
|
905
|
+
oFilter: sap.sac.df.model.MemberFilter,
|
|
689
906
|
/**
|
|
690
|
-
*
|
|
691
|
-
* from an equivalent such Object.
|
|
907
|
+
* path to object
|
|
692
908
|
*/
|
|
693
|
-
|
|
694
|
-
):
|
|
909
|
+
sPath: string
|
|
910
|
+
): sap.ui.model.Filter;
|
|
695
911
|
/**
|
|
696
|
-
*
|
|
912
|
+
* Return a member filter object as {@link sap.ui.model.Filter}
|
|
697
913
|
*
|
|
698
|
-
* @returns
|
|
914
|
+
* @returns filter object
|
|
699
915
|
*/
|
|
700
|
-
|
|
916
|
+
transformToFilter(): sap.ui.model.Filter;
|
|
701
917
|
}
|
|
702
918
|
/**
|
|
703
919
|
* @experimental
|
|
@@ -705,17 +921,7 @@ declare namespace sap {
|
|
|
705
921
|
* Model implementation for InA provider
|
|
706
922
|
*
|
|
707
923
|
* The MultiDimModel can populate it's exposed data via Binding to Controls. The structure of the exposed
|
|
708
|
-
* data
|
|
709
|
-
*
|
|
710
|
-
*
|
|
711
|
-
* ```javascript
|
|
712
|
-
*
|
|
713
|
-
* {
|
|
714
|
-
* "DataProvider": [],
|
|
715
|
-
* "VariableGroups": [],
|
|
716
|
-
* "Messages": []
|
|
717
|
-
* }
|
|
718
|
-
* ```
|
|
924
|
+
* data, mainly via the objects `DataProviders`, `VariableGroups` and `Messages`.
|
|
719
925
|
*/
|
|
720
926
|
class MultiDimModel extends sap.ui.model.Model {
|
|
721
927
|
/**
|
|
@@ -734,17 +940,14 @@ declare namespace sap {
|
|
|
734
940
|
mSettings?: object
|
|
735
941
|
);
|
|
736
942
|
/**
|
|
737
|
-
*
|
|
943
|
+
* Data Providers
|
|
738
944
|
*/
|
|
739
|
-
|
|
740
|
-
string,
|
|
741
|
-
/* was: sap.sac.df.model.DataProvider */ any
|
|
742
|
-
>;
|
|
945
|
+
DataProviders: sap.sac.df.model.DataProvider;
|
|
743
946
|
|
|
744
947
|
/**
|
|
745
948
|
* Variable Groups
|
|
746
949
|
*/
|
|
747
|
-
VariableGroups:
|
|
950
|
+
VariableGroups: sap.sac.df.model.VariableGroup;
|
|
748
951
|
|
|
749
952
|
/**
|
|
750
953
|
* Creates a new subclass of class sap.sac.df.model.MultiDimModel with name `sClassName` and enriches it
|
|
@@ -776,17 +979,17 @@ declare namespace sap {
|
|
|
776
979
|
*/
|
|
777
980
|
static getMetadata(): sap.ui.base.Metadata;
|
|
778
981
|
/**
|
|
779
|
-
* Adds a new query as a new
|
|
982
|
+
* Adds a new query as a new data provider
|
|
780
983
|
*
|
|
781
984
|
* @returns Promise which resolves the Data Provider that was created
|
|
782
985
|
*/
|
|
783
986
|
addDataProvider(
|
|
784
987
|
/**
|
|
785
|
-
* the name of the new
|
|
988
|
+
* the name of the new data provider
|
|
786
989
|
*/
|
|
787
990
|
sDataProviderName: string,
|
|
788
991
|
/**
|
|
789
|
-
* the name of the query which the
|
|
992
|
+
* the name of the query which the data provider is supposed to expose
|
|
790
993
|
*/
|
|
791
994
|
sQueryName: string,
|
|
792
995
|
/**
|
|
@@ -805,7 +1008,7 @@ declare namespace sap {
|
|
|
805
1008
|
* the name of the type of the datasource
|
|
806
1009
|
*/
|
|
807
1010
|
sType?: string
|
|
808
|
-
): Promise<sap.sac.df.model.
|
|
1011
|
+
): Promise<sap.sac.df.model.DataProvider>;
|
|
809
1012
|
/**
|
|
810
1013
|
* Adds a variable group to the model
|
|
811
1014
|
*
|
|
@@ -825,7 +1028,7 @@ declare namespace sap {
|
|
|
825
1028
|
/**
|
|
826
1029
|
* function returning a boolean
|
|
827
1030
|
*/
|
|
828
|
-
|
|
1031
|
+
fnRule: Function,
|
|
829
1032
|
/**
|
|
830
1033
|
* additional properties
|
|
831
1034
|
*/
|
|
@@ -843,7 +1046,7 @@ declare namespace sap {
|
|
|
843
1046
|
bUpdateBindings: undefined
|
|
844
1047
|
): sap.sac.df.model.MultiDimModel;
|
|
845
1048
|
/**
|
|
846
|
-
* Updates the MultiDimModel from the given the model state including all aggregated `
|
|
1049
|
+
* Updates the MultiDimModel from the given the model state including all aggregated `DataProvider`s
|
|
847
1050
|
*
|
|
848
1051
|
* @returns Promise Promise which resolves to the updated instance of the OlapModel.
|
|
849
1052
|
*/
|
|
@@ -857,6 +1060,17 @@ declare namespace sap {
|
|
|
857
1060
|
*/
|
|
858
1061
|
sFormat: string
|
|
859
1062
|
): undefined;
|
|
1063
|
+
/**
|
|
1064
|
+
* Fires event {@link #event:dataProviderAdded dataProviderAdded} to attached listeners.
|
|
1065
|
+
*
|
|
1066
|
+
* @returns the MultiDimModel
|
|
1067
|
+
*/
|
|
1068
|
+
fireDataProviderAdded(
|
|
1069
|
+
/**
|
|
1070
|
+
* Parameters to pass along with the event
|
|
1071
|
+
*/
|
|
1072
|
+
oParameters?: object
|
|
1073
|
+
): sap.sac.df.model.MultiDimModel;
|
|
860
1074
|
/**
|
|
861
1075
|
* Fires event {@link #event:dataProviderUpdated dataProviderUpdated} to attached listeners.
|
|
862
1076
|
*
|
|
@@ -871,23 +1085,20 @@ declare namespace sap {
|
|
|
871
1085
|
/**
|
|
872
1086
|
* Get a Data Provider
|
|
873
1087
|
*
|
|
874
|
-
* @returns DataProvider
|
|
1088
|
+
* @returns DataProvider
|
|
875
1089
|
*/
|
|
876
1090
|
getDataProvider(
|
|
877
1091
|
/**
|
|
878
|
-
* the name of the new DataProvider
|
|
1092
|
+
* the name of the new DataProvider
|
|
879
1093
|
*/
|
|
880
1094
|
sDataProviderName: string
|
|
881
|
-
): sap.sac.df.model.
|
|
1095
|
+
): sap.sac.df.model.DataProvider;
|
|
882
1096
|
/**
|
|
883
|
-
* Get all
|
|
1097
|
+
* Get all data providers
|
|
884
1098
|
*
|
|
885
|
-
* @returns object of all Data Providers
|
|
1099
|
+
* @returns object of all Data Providers
|
|
886
1100
|
*/
|
|
887
|
-
getDataProviders(): Record<
|
|
888
|
-
string,
|
|
889
|
-
sap.sac.df.model.MultiDimDataProvider
|
|
890
|
-
>;
|
|
1101
|
+
getDataProviders(): Record<string, sap.sac.df.model.DataProvider>;
|
|
891
1102
|
/**
|
|
892
1103
|
* Get a variable group
|
|
893
1104
|
*
|
|
@@ -964,7 +1175,7 @@ declare namespace sap {
|
|
|
964
1175
|
): Promise<sap.sac.df.model.MultiDimModel>;
|
|
965
1176
|
}
|
|
966
1177
|
/**
|
|
967
|
-
* @since 1.
|
|
1178
|
+
* @since 1.119
|
|
968
1179
|
* @experimental
|
|
969
1180
|
*
|
|
970
1181
|
* Query Info providing the following information
|
|
@@ -1020,7 +1231,7 @@ declare namespace sap {
|
|
|
1020
1231
|
static getMetadata(): sap.ui.base.Metadata;
|
|
1021
1232
|
}
|
|
1022
1233
|
/**
|
|
1023
|
-
* @since 1.
|
|
1234
|
+
* @since 1.119
|
|
1024
1235
|
* @experimental
|
|
1025
1236
|
*
|
|
1026
1237
|
* Variable
|
|
@@ -1038,20 +1249,7 @@ declare namespace sap {
|
|
|
1038
1249
|
* "Position": ""
|
|
1039
1250
|
* "SupportsValueHelp": "",
|
|
1040
1251
|
* "DataProviderName": "",
|
|
1041
|
-
* "MemberFilter": [
|
|
1042
|
-
* {
|
|
1043
|
-
* "Low": "",
|
|
1044
|
-
* "LowDisplayKey": "",
|
|
1045
|
-
* "LowText": "",
|
|
1046
|
-
* "High": ,
|
|
1047
|
-
* "HighDisplayKey": ,
|
|
1048
|
-
* "HighText": ,
|
|
1049
|
-
* "ComparisonOperator": "",
|
|
1050
|
-
* "Text": "",
|
|
1051
|
-
* "IsExcluding": ,
|
|
1052
|
-
* "Hierarchy": { }
|
|
1053
|
-
* }
|
|
1054
|
-
* ]
|
|
1252
|
+
* "MemberFilter": []
|
|
1055
1253
|
* ```
|
|
1056
1254
|
*/
|
|
1057
1255
|
class Variable extends sap.ui.base.Object {
|
|
@@ -1087,12 +1285,12 @@ declare namespace sap {
|
|
|
1087
1285
|
*/
|
|
1088
1286
|
static getMetadata(): sap.ui.base.Metadata;
|
|
1089
1287
|
/**
|
|
1090
|
-
* Open a dialog to display and change the filter on a dimension of the `
|
|
1288
|
+
* Open a dialog to display and change the filter on a dimension of the `DataProvider`
|
|
1091
1289
|
*
|
|
1092
1290
|
* @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
|
|
1093
1291
|
* with Ok and dynamic filters of the given dimension are updated
|
|
1094
1292
|
*/
|
|
1095
|
-
|
|
1293
|
+
openValueHelpDialog(
|
|
1096
1294
|
/**
|
|
1097
1295
|
* if the model update should be suppressed
|
|
1098
1296
|
*/
|
|
@@ -1101,13 +1299,9 @@ declare namespace sap {
|
|
|
1101
1299
|
/**
|
|
1102
1300
|
* Performs the search in values of a given Variable
|
|
1103
1301
|
*
|
|
1104
|
-
* @returns array
|
|
1302
|
+
* @returns array members found values
|
|
1105
1303
|
*/
|
|
1106
|
-
|
|
1107
|
-
/**
|
|
1108
|
-
* the name of the Variable to search
|
|
1109
|
-
*/
|
|
1110
|
-
sVariable: string,
|
|
1304
|
+
searchMember(
|
|
1111
1305
|
/**
|
|
1112
1306
|
* string to search for
|
|
1113
1307
|
*/
|
|
@@ -1123,27 +1317,31 @@ declare namespace sap {
|
|
|
1123
1317
|
/**
|
|
1124
1318
|
* if to search in key/id (default true)
|
|
1125
1319
|
*/
|
|
1126
|
-
bKey: boolean
|
|
1127
|
-
): Promise<object[]>;
|
|
1128
|
-
/**
|
|
1129
|
-
* Get Result Set
|
|
1130
|
-
*/
|
|
1131
|
-
setVariableValue(
|
|
1320
|
+
bKey: boolean,
|
|
1132
1321
|
/**
|
|
1133
|
-
*
|
|
1322
|
+
* maximal number of search results (default 1)
|
|
1134
1323
|
*/
|
|
1135
|
-
|
|
1136
|
-
|
|
1324
|
+
iMaxNumberOfResults: int,
|
|
1325
|
+
/**
|
|
1326
|
+
* if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
|
|
1327
|
+
* is set)
|
|
1328
|
+
*/
|
|
1329
|
+
bRequestParents: boolean
|
|
1330
|
+
): Promise</* was: sap.sac.df.MemberFilter */ any[]>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Set value of the variable
|
|
1333
|
+
*/
|
|
1334
|
+
setMemberFilter(oFilter: sap.ui.model.Filter): void;
|
|
1137
1335
|
}
|
|
1138
1336
|
/**
|
|
1139
|
-
* @since 1.
|
|
1337
|
+
* @since 1.119
|
|
1140
1338
|
* @experimental
|
|
1141
1339
|
*
|
|
1142
1340
|
* Variable Group
|
|
1143
1341
|
* ```javascript
|
|
1144
1342
|
*
|
|
1145
1343
|
* "Name": "string",
|
|
1146
|
-
* "MergedVariable":
|
|
1344
|
+
* "MergedVariable": { }
|
|
1147
1345
|
* ```
|
|
1148
1346
|
*/
|
|
1149
1347
|
class VariableGroup extends sap.ui.base.Object {
|
|
@@ -1189,18 +1387,18 @@ declare namespace sap {
|
|
|
1189
1387
|
static getMetadata(): sap.ui.base.Metadata;
|
|
1190
1388
|
/**
|
|
1191
1389
|
* Opens the value help dialog so the user choose a value for a VariableGroup After the value is selected
|
|
1192
|
-
* only teh VariableGroup.MergedVariable is updated. The variables of the aggregated
|
|
1193
|
-
*
|
|
1390
|
+
* only teh VariableGroup.MergedVariable is updated. The variables of the aggregated DataProviders are updated
|
|
1391
|
+
* with the next ResultSet fetch
|
|
1194
1392
|
*
|
|
1195
1393
|
* @returns to indicate if the VariableGroup has been updated
|
|
1196
1394
|
*/
|
|
1197
|
-
|
|
1395
|
+
openValueHelpDialog(): Promise<boolean>;
|
|
1198
1396
|
/**
|
|
1199
|
-
* Performs the search in values of a given
|
|
1397
|
+
* Performs the search in values of a given Variable
|
|
1200
1398
|
*
|
|
1201
1399
|
* @returns array with found values
|
|
1202
1400
|
*/
|
|
1203
|
-
|
|
1401
|
+
searchMember(
|
|
1204
1402
|
/**
|
|
1205
1403
|
* string to search for
|
|
1206
1404
|
*/
|
|
@@ -1208,21 +1406,43 @@ declare namespace sap {
|
|
|
1208
1406
|
/**
|
|
1209
1407
|
* if a fuzzy search is performed
|
|
1210
1408
|
*/
|
|
1211
|
-
bFuzzy: boolean
|
|
1212
|
-
|
|
1409
|
+
bFuzzy: boolean,
|
|
1410
|
+
/**
|
|
1411
|
+
* if to search in text/description (default true)
|
|
1412
|
+
*/
|
|
1413
|
+
bText: boolean,
|
|
1414
|
+
/**
|
|
1415
|
+
* if to search in key/id (default true)
|
|
1416
|
+
*/
|
|
1417
|
+
bKey: boolean,
|
|
1418
|
+
/**
|
|
1419
|
+
* maximal number of search results (default 1)
|
|
1420
|
+
*/
|
|
1421
|
+
iMaxNumberOfResults: int,
|
|
1422
|
+
/**
|
|
1423
|
+
* if to provide the parents of the search result for hierarchical variables (only relevant if iMaxNumberOfResults
|
|
1424
|
+
* is set)
|
|
1425
|
+
*/
|
|
1426
|
+
bRequestParents: boolean
|
|
1427
|
+
): Promise<sap.sac.df.model.MemberFilter[]>;
|
|
1213
1428
|
/**
|
|
1214
1429
|
* Sets new value
|
|
1215
1430
|
*
|
|
1216
1431
|
* @returns Promise which resolve when the value is set
|
|
1217
1432
|
*/
|
|
1218
|
-
|
|
1433
|
+
setMemberFilter(
|
|
1219
1434
|
/**
|
|
1220
|
-
*
|
|
1435
|
+
* filter object
|
|
1221
1436
|
*/
|
|
1222
|
-
|
|
1437
|
+
oFilter: sap.ui.model.Filter
|
|
1223
1438
|
): undefined;
|
|
1224
1439
|
}
|
|
1225
1440
|
|
|
1441
|
+
type MultiDimModel$DataProviderAddedEvent = sap.ui.base.Event<
|
|
1442
|
+
MultiDimModel$DataProviderAddedEventParameters,
|
|
1443
|
+
MultiDimModel
|
|
1444
|
+
>;
|
|
1445
|
+
|
|
1226
1446
|
type MultiDimModel$DataProviderUpdatedEvent = sap.ui.base.Event<
|
|
1227
1447
|
MultiDimModel$DataProviderUpdatedEventParameters,
|
|
1228
1448
|
MultiDimModel
|
|
@@ -1231,6 +1451,7 @@ declare namespace sap {
|
|
|
1231
1451
|
|
|
1232
1452
|
namespace olap {
|
|
1233
1453
|
/**
|
|
1454
|
+
* @deprecated (since 1.119) - Please use @link{sap.sac.df.model.DataProvider}.
|
|
1234
1455
|
* @experimental
|
|
1235
1456
|
*
|
|
1236
1457
|
* A `MultiDimDataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol
|
|
@@ -1645,6 +1866,7 @@ declare namespace sap {
|
|
|
1645
1866
|
): this;
|
|
1646
1867
|
}
|
|
1647
1868
|
/**
|
|
1869
|
+
* @deprecated (since 1.119) - Please use @link{sap.sac.df.model.MultiDimModel}.
|
|
1648
1870
|
* @experimental
|
|
1649
1871
|
*
|
|
1650
1872
|
* Model implementation for InA provider
|
|
@@ -1662,6 +1884,10 @@ declare namespace sap {
|
|
|
1662
1884
|
* Constructor for a new OlapMode.
|
|
1663
1885
|
*
|
|
1664
1886
|
* The Olap Model allows to access and change data from servers providing the InA Protocol.
|
|
1887
|
+
*
|
|
1888
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1889
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1890
|
+
* of the syntax of the settings object.
|
|
1665
1891
|
*/
|
|
1666
1892
|
constructor();
|
|
1667
1893
|
|
|
@@ -1694,6 +1920,25 @@ declare namespace sap {
|
|
|
1694
1920
|
* @returns Metadata object describing this class
|
|
1695
1921
|
*/
|
|
1696
1922
|
static getMetadata(): sap.ui.base.Metadata;
|
|
1923
|
+
/**
|
|
1924
|
+
* Gets current value of property {@link #getApi api}.
|
|
1925
|
+
*
|
|
1926
|
+
* @returns Value of property `api`
|
|
1927
|
+
*/
|
|
1928
|
+
getApi(): undefined;
|
|
1929
|
+
/**
|
|
1930
|
+
* Sets a new value for property {@link #getApi api}.
|
|
1931
|
+
*
|
|
1932
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1933
|
+
*
|
|
1934
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1935
|
+
*/
|
|
1936
|
+
setApi(
|
|
1937
|
+
/**
|
|
1938
|
+
* New value for property `api`
|
|
1939
|
+
*/
|
|
1940
|
+
sApi: undefined
|
|
1941
|
+
): this;
|
|
1697
1942
|
}
|
|
1698
1943
|
}
|
|
1699
1944
|
|
|
@@ -2941,7 +3186,9 @@ declare namespace sap {
|
|
|
2941
3186
|
|
|
2942
3187
|
"sap/sac/df/library": undefined;
|
|
2943
3188
|
|
|
2944
|
-
"sap/sac/df/model/
|
|
3189
|
+
"sap/sac/df/model/AxesLayout": undefined;
|
|
3190
|
+
|
|
3191
|
+
"sap/sac/df/model/DataProvider": undefined;
|
|
2945
3192
|
|
|
2946
3193
|
"sap/sac/df/model/Dimension": undefined;
|
|
2947
3194
|
|
|
@@ -2949,7 +3196,7 @@ declare namespace sap {
|
|
|
2949
3196
|
|
|
2950
3197
|
"sap/sac/df/model/Grid": undefined;
|
|
2951
3198
|
|
|
2952
|
-
"sap/sac/df/model/
|
|
3199
|
+
"sap/sac/df/model/MemberFilter": undefined;
|
|
2953
3200
|
|
|
2954
3201
|
"sap/sac/df/model/MultiDimModel": undefined;
|
|
2955
3202
|
|