@sapui5/types 1.117.1 → 1.118.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/index.d.ts +0 -1
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.esh.search.ui.d.ts +1 -1
- package/types/sap.f.d.ts +416 -2
- package/types/sap.fe.core.d.ts +47 -48
- package/types/sap.fe.macros.d.ts +70 -10
- package/types/sap.fe.navigation.d.ts +109 -4
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +9 -5
- 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 +1 -1
- package/types/sap.insights.d.ts +20 -2
- package/types/sap.landvisz.d.ts +1 -1
- package/types/sap.m.d.ts +214 -90
- 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 +1426 -209
- package/types/sap.suite.ui.commons.d.ts +77 -23
- package/types/sap.suite.ui.generic.template.d.ts +64 -107
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +5 -2
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +150 -20
- package/types/sap.ui.core.d.ts +1026 -192
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +7 -1
- package/types/sap.ui.fl.d.ts +51 -4
- package/types/sap.ui.generic.app.d.ts +3 -3
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +68 -3
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +423 -141
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -4
- 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 +180 -39
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -20
- 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 +38 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +76 -35
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +1 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +116 -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.fe.plugins.optimisticBatch.d.ts +0 -3
package/types/sap.sac.df.d.ts
CHANGED
|
@@ -1,71 +1,7 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.118.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/sac/df/library" {}
|
|
4
4
|
|
|
5
|
-
declare module "sap/sac/df/controls/MultiDimControl" {
|
|
6
|
-
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
7
|
-
|
|
8
|
-
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* @experimental
|
|
12
|
-
*
|
|
13
|
-
* Enables users to view, navigate and change multidimensional data exposed via InA.
|
|
14
|
-
*
|
|
15
|
-
* Overview:
|
|
16
|
-
*
|
|
17
|
-
* The user can view the data in a Table, navigate in the data via a context menu or builder panels The
|
|
18
|
-
* data source that the FlexAnalysis consumes or renders has to be provided as a property value.
|
|
19
|
-
*/
|
|
20
|
-
export default class MultiDimControl extends Control {
|
|
21
|
-
/**
|
|
22
|
-
* Constructor for a new `MultiDimControl`.
|
|
23
|
-
*
|
|
24
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
25
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
26
|
-
* of the syntax of the settings object.
|
|
27
|
-
*/
|
|
28
|
-
constructor(
|
|
29
|
-
/**
|
|
30
|
-
* ID for the new control, generated automatically if no ID is given
|
|
31
|
-
*/
|
|
32
|
-
sId?: string
|
|
33
|
-
);
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* Creates a new subclass of class sap.sac.df.controls.MultiDimControl with name `sClassName` and enriches
|
|
37
|
-
* it with the information contained in `oClassInfo`.
|
|
38
|
-
*
|
|
39
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
40
|
-
*
|
|
41
|
-
* @returns Created class / constructor function
|
|
42
|
-
*/
|
|
43
|
-
static extend<T extends Record<string, unknown>>(
|
|
44
|
-
/**
|
|
45
|
-
* Name of the class being created
|
|
46
|
-
*/
|
|
47
|
-
sClassName: string,
|
|
48
|
-
/**
|
|
49
|
-
* Object literal with information about the class
|
|
50
|
-
*/
|
|
51
|
-
oClassInfo?: sap.ClassInfo<T, MultiDimControl>,
|
|
52
|
-
/**
|
|
53
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
54
|
-
* used by this class
|
|
55
|
-
*/
|
|
56
|
-
FNMetaImpl?: Function
|
|
57
|
-
): Function;
|
|
58
|
-
/**
|
|
59
|
-
* Returns a metadata object for class sap.sac.df.controls.MultiDimControl.
|
|
60
|
-
*
|
|
61
|
-
* @returns Metadata object describing this class
|
|
62
|
-
*/
|
|
63
|
-
static getMetadata(): ElementMetadata;
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
export interface $MultiDimControlSettings extends $ControlSettings {}
|
|
67
|
-
}
|
|
68
|
-
|
|
69
5
|
declare module "sap/sac/df/FlexAnalysis" {
|
|
70
6
|
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
71
7
|
|
|
@@ -1244,109 +1180,173 @@ declare module "sap/sac/df/FlexAnalysisPanel" {
|
|
|
1244
1180
|
}
|
|
1245
1181
|
}
|
|
1246
1182
|
|
|
1247
|
-
declare module "sap/sac/df/
|
|
1248
|
-
import
|
|
1183
|
+
declare module "sap/sac/df/model/AxisLayout" {
|
|
1184
|
+
import BaseObject from "sap/ui/base/Object";
|
|
1185
|
+
|
|
1186
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1249
1187
|
|
|
1250
1188
|
/**
|
|
1189
|
+
* @since 1.118
|
|
1251
1190
|
* @experimental
|
|
1252
1191
|
*
|
|
1253
|
-
*
|
|
1254
|
-
*
|
|
1255
|
-
*
|
|
1256
|
-
* Instances of this class should only be created by the {sap.sac.df.olap.MultiDimModel}. The `MultiDimModel`
|
|
1257
|
-
* populates it's exposed data via Binding to Controls. The structure of data exposed by a MultiDimDataProvider
|
|
1258
|
-
* is as follows:
|
|
1259
|
-
*
|
|
1260
|
-
* **Structure of Exposed Data**
|
|
1261
|
-
*
|
|
1262
|
-
*
|
|
1263
|
-
* - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `MultiDimDataProvider`
|
|
1264
|
-
* - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
|
|
1265
|
-
* `Name`: the external name of the dimension `Description`: the language dependant description of
|
|
1266
|
-
* the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
|
|
1192
|
+
* Axis Layout showing which dimensions are set on rows and which on columns.
|
|
1193
|
+
* ```javascript
|
|
1267
1194
|
*
|
|
1268
|
-
*
|
|
1269
|
-
*
|
|
1270
|
-
*
|
|
1271
|
-
*
|
|
1272
|
-
*
|
|
1273
|
-
* dimension IsStructure: boolean flag indicating whether the dimension is a structure
|
|
1274
|
-
* - Conditions: list of conditions (result set filters)
|
|
1275
|
-
* - Exceptions: list of exceptions (conditional formats)
|
|
1276
|
-
* - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
|
|
1195
|
+
* {
|
|
1196
|
+
* "Rows": [],
|
|
1197
|
+
* "Columns": []
|
|
1198
|
+
* }
|
|
1199
|
+
* ```
|
|
1277
1200
|
*/
|
|
1278
|
-
export default class
|
|
1201
|
+
export default class AxisLayout extends BaseObject {
|
|
1202
|
+
constructor();
|
|
1203
|
+
|
|
1279
1204
|
/**
|
|
1280
|
-
*
|
|
1205
|
+
* Creates a new subclass of class sap.sac.df.model.AxisLayout with name `sClassName` and enriches it with
|
|
1206
|
+
* the information contained in `oClassInfo`.
|
|
1281
1207
|
*
|
|
1282
|
-
*
|
|
1283
|
-
*
|
|
1284
|
-
*
|
|
1208
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
1209
|
+
*
|
|
1210
|
+
* @returns Created class / constructor function
|
|
1285
1211
|
*/
|
|
1286
|
-
|
|
1212
|
+
static extend<T extends Record<string, unknown>>(
|
|
1287
1213
|
/**
|
|
1288
|
-
*
|
|
1214
|
+
* Name of the class being created
|
|
1289
1215
|
*/
|
|
1290
|
-
|
|
1216
|
+
sClassName: string,
|
|
1291
1217
|
/**
|
|
1292
|
-
*
|
|
1218
|
+
* Object literal with information about the class
|
|
1293
1219
|
*/
|
|
1294
|
-
|
|
1220
|
+
oClassInfo?: sap.ClassInfo<T, AxisLayout>,
|
|
1295
1221
|
/**
|
|
1296
|
-
* the
|
|
1222
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1223
|
+
* used by this class
|
|
1297
1224
|
*/
|
|
1298
|
-
|
|
1225
|
+
FNMetaImpl?: Function
|
|
1226
|
+
): Function;
|
|
1227
|
+
/**
|
|
1228
|
+
* Returns a metadata object for class sap.sac.df.model.AxisLayout.
|
|
1229
|
+
*
|
|
1230
|
+
* @returns Metadata object describing this class
|
|
1231
|
+
*/
|
|
1232
|
+
static getMetadata(): Metadata;
|
|
1233
|
+
/**
|
|
1234
|
+
* Distribute the dimension among the rows and columns
|
|
1235
|
+
*
|
|
1236
|
+
* @returns resolving to the `DataProviderAPI` to allow chaining. in the dialog, the new result set was
|
|
1237
|
+
* retrieved before the promise gets resolved.
|
|
1238
|
+
*/
|
|
1239
|
+
setAxesLayout(
|
|
1299
1240
|
/**
|
|
1300
|
-
*
|
|
1241
|
+
* an Object containing a `rows` member referencing a string array containing the names of the dimensions
|
|
1242
|
+
* and a `columns` member referencing a string array containing the dimension on the columns. The order
|
|
1243
|
+
* in the array control the position on the axis.
|
|
1301
1244
|
*/
|
|
1302
|
-
|
|
1303
|
-
);
|
|
1245
|
+
oLayout: object
|
|
1246
|
+
): this;
|
|
1247
|
+
}
|
|
1248
|
+
}
|
|
1249
|
+
|
|
1250
|
+
declare module "sap/sac/df/model/Dimension" {
|
|
1251
|
+
import BaseObject from "sap/ui/base/Object";
|
|
1252
|
+
|
|
1253
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1254
|
+
|
|
1255
|
+
/**
|
|
1256
|
+
* @since 1.118
|
|
1257
|
+
* @experimental
|
|
1258
|
+
*
|
|
1259
|
+
* Dimension
|
|
1260
|
+
* ```javascript
|
|
1261
|
+
*
|
|
1262
|
+
* "Name": "",
|
|
1263
|
+
* "TechName": "",
|
|
1264
|
+
* "Description": "",
|
|
1265
|
+
* "Axis": "",
|
|
1266
|
+
* "Type": "",
|
|
1267
|
+
* "HierarchyActive": "",
|
|
1268
|
+
* "HasFilter": "",
|
|
1269
|
+
* "MemberFilter": [
|
|
1270
|
+
* {
|
|
1271
|
+
* "Low": "",
|
|
1272
|
+
* "LowDisplayKey": "",
|
|
1273
|
+
* "LowText": "",
|
|
1274
|
+
* "High": "",
|
|
1275
|
+
* "HighDisplayKey": "",
|
|
1276
|
+
* "HighText": "",
|
|
1277
|
+
* "ComparisonOperator": "",
|
|
1278
|
+
* "Text": "",
|
|
1279
|
+
* "IsExcluding": "",
|
|
1280
|
+
* "Hierarchy": { }
|
|
1281
|
+
* }
|
|
1282
|
+
* ],
|
|
1283
|
+
* "SortDirection": "",
|
|
1284
|
+
* "Position": "",
|
|
1285
|
+
* "LastPosition": "",
|
|
1286
|
+
* "IsStructure": "",
|
|
1287
|
+
* "IsMeasureStructure": "",
|
|
1288
|
+
* "ValueType": "",
|
|
1289
|
+
* "SemanticObject": "",
|
|
1290
|
+
* "Members": [
|
|
1291
|
+
* {
|
|
1292
|
+
* "Key": "",
|
|
1293
|
+
* "Name": "",
|
|
1294
|
+
* "TechName": "",
|
|
1295
|
+
* "Description": "",
|
|
1296
|
+
* "SemanticObject": "
|
|
1297
|
+
* }
|
|
1298
|
+
* ]
|
|
1299
|
+
* ```
|
|
1300
|
+
*/
|
|
1301
|
+
export default class Dimension extends BaseObject {
|
|
1302
|
+
constructor();
|
|
1304
1303
|
|
|
1305
1304
|
/**
|
|
1306
|
-
*
|
|
1305
|
+
* Creates a new subclass of class sap.sac.df.model.Dimension with name `sClassName` and enriches it with
|
|
1306
|
+
* the information contained in `oClassInfo`.
|
|
1307
1307
|
*
|
|
1308
|
-
*
|
|
1308
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
1309
|
+
*
|
|
1310
|
+
* @returns Created class / constructor function
|
|
1309
1311
|
*/
|
|
1310
|
-
|
|
1312
|
+
static extend<T extends Record<string, unknown>>(
|
|
1311
1313
|
/**
|
|
1312
|
-
*
|
|
1314
|
+
* Name of the class being created
|
|
1313
1315
|
*/
|
|
1314
|
-
|
|
1316
|
+
sClassName: string,
|
|
1315
1317
|
/**
|
|
1316
|
-
*
|
|
1318
|
+
* Object literal with information about the class
|
|
1317
1319
|
*/
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
+
oClassInfo?: sap.ClassInfo<T, Dimension>,
|
|
1321
|
+
/**
|
|
1322
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1323
|
+
* used by this class
|
|
1324
|
+
*/
|
|
1325
|
+
FNMetaImpl?: Function
|
|
1326
|
+
): Function;
|
|
1320
1327
|
/**
|
|
1321
|
-
*
|
|
1328
|
+
* Returns a metadata object for class sap.sac.df.model.Dimension.
|
|
1322
1329
|
*
|
|
1323
|
-
* @returns
|
|
1330
|
+
* @returns Metadata object describing this class
|
|
1324
1331
|
*/
|
|
1325
|
-
|
|
1326
|
-
/**
|
|
1327
|
-
* the external name of the Dimension
|
|
1328
|
-
*/
|
|
1329
|
-
sDim: string,
|
|
1330
|
-
/**
|
|
1331
|
-
* the Tuple Index of the member in the resultset.
|
|
1332
|
-
*/
|
|
1333
|
-
nIndex: int
|
|
1334
|
-
): this;
|
|
1332
|
+
static getMetadata(): Metadata;
|
|
1335
1333
|
/**
|
|
1336
|
-
*
|
|
1334
|
+
* Get Structure Members
|
|
1337
1335
|
*
|
|
1338
|
-
* @returns
|
|
1336
|
+
* @returns array of structure members
|
|
1339
1337
|
*/
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1338
|
+
static getStructureMembers(): any[];
|
|
1339
|
+
/**
|
|
1340
|
+
* Set Display Type of Dimension
|
|
1341
|
+
*
|
|
1342
|
+
* @returns } resolving to the Dimension to allow chaining.
|
|
1343
|
+
*/
|
|
1344
|
+
static setDimensionDisplay(
|
|
1345
1345
|
/**
|
|
1346
|
-
*
|
|
1346
|
+
* level
|
|
1347
1347
|
*/
|
|
1348
|
-
|
|
1349
|
-
):
|
|
1348
|
+
sDisplayType: string
|
|
1349
|
+
): Dimension;
|
|
1350
1350
|
/**
|
|
1351
1351
|
* get the list of filters of a dimension
|
|
1352
1352
|
*
|
|
@@ -1354,76 +1354,1299 @@ declare module "sap/sac/df/olap/MultiDimDataProvider" {
|
|
|
1354
1354
|
* `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
|
|
1355
1355
|
* EQ,LE,..,BT
|
|
1356
1356
|
*/
|
|
1357
|
-
|
|
1358
|
-
/**
|
|
1359
|
-
* the name of the dimension from which the filter is retrieved
|
|
1360
|
-
*/
|
|
1361
|
-
sDim: string
|
|
1362
|
-
): object[];
|
|
1357
|
+
getFilter(): object[];
|
|
1363
1358
|
/**
|
|
1364
|
-
*
|
|
1359
|
+
* Move a dimension one position down on it's axis
|
|
1365
1360
|
*
|
|
1366
|
-
* @returns
|
|
1361
|
+
* @returns the `Dimension` to allow chaining.
|
|
1367
1362
|
*/
|
|
1368
|
-
|
|
1363
|
+
moveDown(): Dimension;
|
|
1369
1364
|
/**
|
|
1370
|
-
*
|
|
1365
|
+
* Move a dimension one position up on it's axis
|
|
1371
1366
|
*
|
|
1372
|
-
* @returns
|
|
1367
|
+
* @returns the `Dimension` to allow chaining.
|
|
1373
1368
|
*/
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1369
|
+
moveUp(): Dimension;
|
|
1370
|
+
/**
|
|
1371
|
+
* Set Display Hierarchy
|
|
1372
|
+
*
|
|
1373
|
+
* @returns resolving to the `Dimension` to allow chaining.
|
|
1374
|
+
*/
|
|
1375
|
+
readHierarchy(
|
|
1379
1376
|
/**
|
|
1380
|
-
*
|
|
1377
|
+
* level
|
|
1381
1378
|
*/
|
|
1382
|
-
|
|
1383
|
-
):
|
|
1379
|
+
iLevel: int
|
|
1380
|
+
): Dimension;
|
|
1384
1381
|
/**
|
|
1385
|
-
*
|
|
1382
|
+
* Remove a drill operation on a dimension member
|
|
1386
1383
|
*
|
|
1387
|
-
* @returns
|
|
1384
|
+
* @returns resolving to the `Dimension` to allow chaining.
|
|
1388
1385
|
*/
|
|
1389
|
-
|
|
1386
|
+
removeDrilldown(): Dimension;
|
|
1387
|
+
/**
|
|
1388
|
+
* Remove the filter of a dimension
|
|
1389
|
+
*
|
|
1390
|
+
* @returns resolving to the `Dimension` to allow chaining.
|
|
1391
|
+
*/
|
|
1392
|
+
removeFilter(): Dimension;
|
|
1393
|
+
/**
|
|
1394
|
+
* Set Display Hierarchy
|
|
1395
|
+
*
|
|
1396
|
+
* @returns resolving to the `Dimension` to allow chaining.
|
|
1397
|
+
*/
|
|
1398
|
+
setDisplayHierarchy(
|
|
1390
1399
|
/**
|
|
1391
|
-
* the
|
|
1400
|
+
* whether the hierarchy should be activated
|
|
1392
1401
|
*/
|
|
1393
|
-
|
|
1402
|
+
bActive: boolean,
|
|
1394
1403
|
/**
|
|
1395
|
-
* the
|
|
1404
|
+
* the name of the hierarchy (optional)
|
|
1396
1405
|
*/
|
|
1397
|
-
|
|
1398
|
-
|
|
1406
|
+
sHierarchyName: string,
|
|
1407
|
+
/**
|
|
1408
|
+
* the version of the hierarchy (optional)
|
|
1409
|
+
*/
|
|
1410
|
+
sVersion: string
|
|
1411
|
+
): Dimension;
|
|
1399
1412
|
/**
|
|
1400
|
-
*
|
|
1413
|
+
* Set the filter for a dimension
|
|
1401
1414
|
*
|
|
1402
|
-
* @returns
|
|
1415
|
+
* @returns resolving to the `Dimension` to allow chaining.
|
|
1403
1416
|
*/
|
|
1404
|
-
|
|
1417
|
+
setFilter(
|
|
1405
1418
|
/**
|
|
1406
|
-
*
|
|
1419
|
+
* the filter
|
|
1407
1420
|
*/
|
|
1408
|
-
|
|
1409
|
-
):
|
|
1421
|
+
oFilter: object
|
|
1422
|
+
): Dimension;
|
|
1410
1423
|
/**
|
|
1411
|
-
*
|
|
1424
|
+
* Sort the members of a dimension
|
|
1412
1425
|
*
|
|
1413
|
-
* @returns the `
|
|
1426
|
+
* @returns resolving to the `Dimension` to allow chaining.
|
|
1414
1427
|
*/
|
|
1415
|
-
|
|
1428
|
+
sort(
|
|
1416
1429
|
/**
|
|
1417
|
-
*
|
|
1430
|
+
* of sorting
|
|
1418
1431
|
*/
|
|
1419
|
-
|
|
1432
|
+
type: /* was: sap.sac.df.types.SortType */ any,
|
|
1420
1433
|
/**
|
|
1421
|
-
*
|
|
1434
|
+
* of sorting
|
|
1422
1435
|
*/
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
|
|
1436
|
+
direction: /* was: sap.sac.df.types.SortDirection */ any,
|
|
1437
|
+
/**
|
|
1438
|
+
* in case of a structure the measure according to which is sorted
|
|
1439
|
+
*/
|
|
1440
|
+
sMember?: string
|
|
1441
|
+
): Promise<Dimension>;
|
|
1442
|
+
/**
|
|
1443
|
+
* Move the dimension to the columns axis
|
|
1444
|
+
*
|
|
1445
|
+
* @returns resolving to the Dimension to allow chaining.
|
|
1446
|
+
*/
|
|
1447
|
+
toColumns(): Dimension;
|
|
1448
|
+
/**
|
|
1449
|
+
* Move the dimension to the rows axis
|
|
1450
|
+
*
|
|
1451
|
+
* @returns resolving to the Dimension to allow chaining.
|
|
1452
|
+
*/
|
|
1453
|
+
toRows(): Dimension;
|
|
1454
|
+
}
|
|
1455
|
+
}
|
|
1456
|
+
|
|
1457
|
+
declare module "sap/sac/df/model/Document" {
|
|
1458
|
+
import BaseObject from "sap/ui/base/Object";
|
|
1459
|
+
|
|
1460
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1461
|
+
|
|
1462
|
+
/**
|
|
1463
|
+
* @since 1.118
|
|
1464
|
+
* @experimental
|
|
1465
|
+
*
|
|
1466
|
+
* Document Object
|
|
1467
|
+
*/
|
|
1468
|
+
export default class Document extends BaseObject {
|
|
1469
|
+
constructor();
|
|
1470
|
+
|
|
1471
|
+
/**
|
|
1472
|
+
* Creates a new subclass of class sap.sac.df.model.Document with name `sClassName` and enriches it with
|
|
1473
|
+
* the information contained in `oClassInfo`.
|
|
1474
|
+
*
|
|
1475
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
1476
|
+
*
|
|
1477
|
+
* @returns Created class / constructor function
|
|
1478
|
+
*/
|
|
1479
|
+
static extend<T extends Record<string, unknown>>(
|
|
1480
|
+
/**
|
|
1481
|
+
* Name of the class being created
|
|
1482
|
+
*/
|
|
1483
|
+
sClassName: string,
|
|
1484
|
+
/**
|
|
1485
|
+
* Object literal with information about the class
|
|
1486
|
+
*/
|
|
1487
|
+
oClassInfo?: sap.ClassInfo<T, Document>,
|
|
1488
|
+
/**
|
|
1489
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1490
|
+
* used by this class
|
|
1491
|
+
*/
|
|
1492
|
+
FNMetaImpl?: Function
|
|
1493
|
+
): Function;
|
|
1494
|
+
/**
|
|
1495
|
+
* Returns a metadata object for class sap.sac.df.model.Document.
|
|
1496
|
+
*
|
|
1497
|
+
* @returns Metadata object describing this class
|
|
1498
|
+
*/
|
|
1499
|
+
static getMetadata(): Metadata;
|
|
1500
|
+
/**
|
|
1501
|
+
* Creates a document in the document store
|
|
1502
|
+
*
|
|
1503
|
+
* @returns a promise which resolves to true if create operation is successful, otherwise false.
|
|
1504
|
+
*/
|
|
1505
|
+
createDocument(
|
|
1506
|
+
/**
|
|
1507
|
+
* the document ID
|
|
1508
|
+
*/
|
|
1509
|
+
sDocumentId: undefined,
|
|
1510
|
+
/**
|
|
1511
|
+
* the content of the document
|
|
1512
|
+
*/
|
|
1513
|
+
sContent: undefined
|
|
1514
|
+
): Promise<boolean>;
|
|
1515
|
+
/**
|
|
1516
|
+
* Creates a document ID for a data cell in the result set
|
|
1517
|
+
*
|
|
1518
|
+
* @returns a promise which resolves with the newly created document ID
|
|
1519
|
+
*/
|
|
1520
|
+
createDocumentId(
|
|
1521
|
+
/**
|
|
1522
|
+
* the row index
|
|
1523
|
+
*/
|
|
1524
|
+
nRowIndex: int,
|
|
1525
|
+
/**
|
|
1526
|
+
* the column index
|
|
1527
|
+
*/
|
|
1528
|
+
nColumnIndex: int
|
|
1529
|
+
): Promise<String>;
|
|
1530
|
+
/**
|
|
1531
|
+
* Deletes a document in the document store
|
|
1532
|
+
*
|
|
1533
|
+
* @returns a promise which resolves to true if delete operation is successful, otherwise false.
|
|
1534
|
+
*/
|
|
1535
|
+
deleteDocument(
|
|
1536
|
+
/**
|
|
1537
|
+
* the document ID
|
|
1538
|
+
*/
|
|
1539
|
+
sDocumentId: undefined
|
|
1540
|
+
): Promise<boolean>;
|
|
1541
|
+
/**
|
|
1542
|
+
* Deletes a document ID for a data cell in the result set
|
|
1543
|
+
*
|
|
1544
|
+
* @returns a promise which resolves to true if the delete operation is successful, otherwise false.
|
|
1545
|
+
*/
|
|
1546
|
+
deleteDocumentId(
|
|
1547
|
+
/**
|
|
1548
|
+
* the row index
|
|
1549
|
+
*/
|
|
1550
|
+
nRowIndex: int,
|
|
1551
|
+
/**
|
|
1552
|
+
* the column index
|
|
1553
|
+
*/
|
|
1554
|
+
nColumnIndex: int
|
|
1555
|
+
): Promise<boolean>;
|
|
1556
|
+
/**
|
|
1557
|
+
* Gets a document ID of a data cell in the result set
|
|
1558
|
+
*
|
|
1559
|
+
* @returns a promise which resolves with the document ID
|
|
1560
|
+
*/
|
|
1561
|
+
getDocumentId(
|
|
1562
|
+
/**
|
|
1563
|
+
* the row index
|
|
1564
|
+
*/
|
|
1565
|
+
nRowIndex: int,
|
|
1566
|
+
/**
|
|
1567
|
+
* the column index
|
|
1568
|
+
*/
|
|
1569
|
+
nColumnIndex: int
|
|
1570
|
+
): Promise<String>;
|
|
1571
|
+
/**
|
|
1572
|
+
* Gets the type of DocumentsSupport.
|
|
1573
|
+
*
|
|
1574
|
+
* @returns DocumentsSupport type
|
|
1575
|
+
*/
|
|
1576
|
+
getDocumentsSupportType(): string;
|
|
1577
|
+
/**
|
|
1578
|
+
* Retrieves a document from the document store
|
|
1579
|
+
*
|
|
1580
|
+
* @returns a promise which resolves with the version(s) of the document.
|
|
1581
|
+
*/
|
|
1582
|
+
retrieveDocument(
|
|
1583
|
+
/**
|
|
1584
|
+
* the document ID
|
|
1585
|
+
*/
|
|
1586
|
+
sDocumentId: undefined,
|
|
1587
|
+
/**
|
|
1588
|
+
* the version of the document - if version is not supplied, returns all versions.
|
|
1589
|
+
*/
|
|
1590
|
+
sVersion: undefined
|
|
1591
|
+
): Promise<object>;
|
|
1592
|
+
/**
|
|
1593
|
+
* Retrieves multiple documents from the document store
|
|
1594
|
+
*
|
|
1595
|
+
* @returns a promise which resolves with all documents and its versions.
|
|
1596
|
+
*/
|
|
1597
|
+
retrieveMultipleDocuments(
|
|
1598
|
+
/**
|
|
1599
|
+
* the array of document IDs
|
|
1600
|
+
*/
|
|
1601
|
+
aDocumentIds: undefined
|
|
1602
|
+
): Promise<object>;
|
|
1603
|
+
/**
|
|
1604
|
+
* Updates a document in the document store
|
|
1605
|
+
*
|
|
1606
|
+
* @returns a promise which resolves to true if update operation is successful, otherwise false.
|
|
1607
|
+
*/
|
|
1608
|
+
updateDocument(
|
|
1609
|
+
/**
|
|
1610
|
+
* the document ID
|
|
1611
|
+
*/
|
|
1612
|
+
sDocumentId: undefined,
|
|
1613
|
+
/**
|
|
1614
|
+
* the content of the document
|
|
1615
|
+
*/
|
|
1616
|
+
sContent: undefined
|
|
1617
|
+
): Promise<boolean>;
|
|
1618
|
+
}
|
|
1619
|
+
}
|
|
1620
|
+
|
|
1621
|
+
declare module "sap/sac/df/model/Grid" {
|
|
1622
|
+
import BaseObject from "sap/ui/base/Object";
|
|
1623
|
+
|
|
1624
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1625
|
+
|
|
1626
|
+
/**
|
|
1627
|
+
* @since 1.118
|
|
1628
|
+
* @experimental
|
|
1629
|
+
*
|
|
1630
|
+
* Grid Object
|
|
1631
|
+
*/
|
|
1632
|
+
export default class Grid extends BaseObject {
|
|
1633
|
+
constructor();
|
|
1634
|
+
|
|
1635
|
+
/**
|
|
1636
|
+
* Creates a new subclass of class sap.sac.df.model.Grid with name `sClassName` and enriches it with the
|
|
1637
|
+
* information contained in `oClassInfo`.
|
|
1638
|
+
*
|
|
1639
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
1640
|
+
*
|
|
1641
|
+
* @returns Created class / constructor function
|
|
1642
|
+
*/
|
|
1643
|
+
static extend<T extends Record<string, unknown>>(
|
|
1644
|
+
/**
|
|
1645
|
+
* Name of the class being created
|
|
1646
|
+
*/
|
|
1647
|
+
sClassName: string,
|
|
1648
|
+
/**
|
|
1649
|
+
* Object literal with information about the class
|
|
1650
|
+
*/
|
|
1651
|
+
oClassInfo?: sap.ClassInfo<T, Grid>,
|
|
1652
|
+
/**
|
|
1653
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1654
|
+
* used by this class
|
|
1655
|
+
*/
|
|
1656
|
+
FNMetaImpl?: Function
|
|
1657
|
+
): Function;
|
|
1658
|
+
/**
|
|
1659
|
+
* Returns a metadata object for class sap.sac.df.model.Grid.
|
|
1660
|
+
*
|
|
1661
|
+
* @returns Metadata object describing this class
|
|
1662
|
+
*/
|
|
1663
|
+
static getMetadata(): Metadata;
|
|
1664
|
+
/**
|
|
1665
|
+
* Get the list of the jump targets associated to a cell defined via the Report-To-Report Interface.
|
|
1666
|
+
*
|
|
1667
|
+
* @returns resolving to the List of jump targets.
|
|
1668
|
+
*/
|
|
1669
|
+
getRRITargets(
|
|
1670
|
+
/**
|
|
1671
|
+
* Row of the data cell
|
|
1672
|
+
*/
|
|
1673
|
+
iRowIndex: int,
|
|
1674
|
+
/**
|
|
1675
|
+
* Column of the data cell
|
|
1676
|
+
*/
|
|
1677
|
+
iColumnIndex: int
|
|
1678
|
+
): Promise<any>;
|
|
1679
|
+
/**
|
|
1680
|
+
* Open a dialog that allows to display and change the property of a `Query Cell` of the `MultiDimDataProvider`.
|
|
1681
|
+
*
|
|
1682
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1683
|
+
*/
|
|
1684
|
+
openCellDialog(
|
|
1685
|
+
/**
|
|
1686
|
+
* the external name of the first structure
|
|
1687
|
+
*/
|
|
1688
|
+
sDim1?: string,
|
|
1689
|
+
/**
|
|
1690
|
+
* the external name of the member of the first structure
|
|
1691
|
+
*/
|
|
1692
|
+
sMember1?: string,
|
|
1693
|
+
/**
|
|
1694
|
+
* the external name of the second structure
|
|
1695
|
+
*/
|
|
1696
|
+
sDim2?: string,
|
|
1697
|
+
/**
|
|
1698
|
+
* the external name of the member of the second structure
|
|
1699
|
+
*/
|
|
1700
|
+
sMember2?: string
|
|
1701
|
+
): Promise<this>;
|
|
1702
|
+
}
|
|
1703
|
+
}
|
|
1704
|
+
|
|
1705
|
+
declare module "sap/sac/df/model/MultiDimDataProvider" {
|
|
1706
|
+
import BaseObject from "sap/ui/base/Object";
|
|
1707
|
+
|
|
1708
|
+
import MultiDimModel from "sap/sac/df/model/MultiDimModel";
|
|
1709
|
+
|
|
1710
|
+
import AxisLayout from "sap/sac/df/model/AxisLayout";
|
|
1711
|
+
|
|
1712
|
+
import Dimension from "sap/sac/df/model/Dimension";
|
|
1713
|
+
|
|
1714
|
+
import Grid from "sap/sac/df/model/Grid";
|
|
1715
|
+
|
|
1716
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1717
|
+
|
|
1718
|
+
/**
|
|
1719
|
+
* @experimental
|
|
1720
|
+
*
|
|
1721
|
+
* A `MultiDimDataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol
|
|
1722
|
+
* HANA - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
|
|
1723
|
+
*
|
|
1724
|
+
* Instances of this class should only be created by the {sap.sac.df.model.MultiDimModel}. The `MultiDimModel`
|
|
1725
|
+
* populates it's exposed data via Binding to Controls. The structure of data exposed by a MultiDimDataProvider
|
|
1726
|
+
* is as follows:
|
|
1727
|
+
*
|
|
1728
|
+
* **Structure of Exposed Data**
|
|
1729
|
+
*
|
|
1730
|
+
*
|
|
1731
|
+
* - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `MultiDimDataProvider`
|
|
1732
|
+
* - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
|
|
1733
|
+
* `Name`: the external name of the dimension `Description`: the language dependant description of
|
|
1734
|
+
* the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
|
|
1735
|
+
*
|
|
1736
|
+
* - RowsDimensions: The list of all Dimensions lying on the Rows Axis
|
|
1737
|
+
* Name: the external name of the dimension Description: the language dependant description of the
|
|
1738
|
+
* dimension IsStructure: boolean flag indicating whether the dimension is a structure *
|
|
1739
|
+
* - ColumnsDimensions: The list of all Dimensions lying on the Columns Axis
|
|
1740
|
+
* Name: the external name of the dimension Description: the language dependant description of the
|
|
1741
|
+
* dimension IsStructure: boolean flag indicating whether the dimension is a structure
|
|
1742
|
+
* - Conditions: list of conditions (result set filters)
|
|
1743
|
+
* - Exceptions: list of exceptions (conditional formats)
|
|
1744
|
+
* - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
|
|
1745
|
+
*
|
|
1746
|
+
* ```javascript
|
|
1747
|
+
*
|
|
1748
|
+
* "Name": "",
|
|
1749
|
+
* "QueryInfo": { },
|
|
1750
|
+
* "Variables": { }
|
|
1751
|
+
* "Dimensions": { },
|
|
1752
|
+
* "Measures": [ ],
|
|
1753
|
+
* "AxesLayout": {
|
|
1754
|
+
* "Columns": [],
|
|
1755
|
+
* "Rows": []
|
|
1756
|
+
* },
|
|
1757
|
+
* "Grid": { },
|
|
1758
|
+
* "Messages": [ ]
|
|
1759
|
+
* ```
|
|
1760
|
+
*/
|
|
1761
|
+
export default class MultiDimDataProvider extends BaseObject {
|
|
1762
|
+
/**
|
|
1763
|
+
* Constructor for a new MultiDimDataProvider.
|
|
1764
|
+
*
|
|
1765
|
+
* A MultiDimDataProvider represents a navigable queryManager and allows to access and change data from
|
|
1766
|
+
* servers providing the InA
|
|
1767
|
+
* Protocol.
|
|
1768
|
+
*/
|
|
1769
|
+
constructor(
|
|
1770
|
+
/**
|
|
1771
|
+
* the model to which the MultiDimDataProvider belongs
|
|
1772
|
+
*/
|
|
1773
|
+
oMultiDimModel: MultiDimModel,
|
|
1774
|
+
/**
|
|
1775
|
+
* name of the MultiDimDataProvider
|
|
1776
|
+
*/
|
|
1777
|
+
sMultiDimDataProviderName: string
|
|
1778
|
+
);
|
|
1779
|
+
/**
|
|
1780
|
+
* AxisLayout
|
|
1781
|
+
*/
|
|
1782
|
+
AxisLayout: AxisLayout;
|
|
1783
|
+
|
|
1784
|
+
/**
|
|
1785
|
+
* Dimensions
|
|
1786
|
+
*/
|
|
1787
|
+
Dimensions: Record<string, Dimension>;
|
|
1788
|
+
|
|
1789
|
+
/**
|
|
1790
|
+
* Grid
|
|
1791
|
+
*/
|
|
1792
|
+
Grid: Grid;
|
|
1793
|
+
|
|
1794
|
+
/**
|
|
1795
|
+
* Measures
|
|
1796
|
+
*/
|
|
1797
|
+
Measures: /* was: sap.sac.df.model.Measures */ any[];
|
|
1798
|
+
|
|
1799
|
+
/**
|
|
1800
|
+
* Variables
|
|
1801
|
+
*/
|
|
1802
|
+
Variables: Record<string, /* was: sap.sac.df.model.Variables */ any>;
|
|
1803
|
+
|
|
1804
|
+
/**
|
|
1805
|
+
* Creates a new subclass of class sap.sac.df.model.MultiDimDataProvider with name `sClassName` and enriches
|
|
1806
|
+
* it with the information contained in `oClassInfo`.
|
|
1807
|
+
*
|
|
1808
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
1809
|
+
*
|
|
1810
|
+
* @returns Created class / constructor function
|
|
1811
|
+
*/
|
|
1812
|
+
static extend<T extends Record<string, unknown>>(
|
|
1813
|
+
/**
|
|
1814
|
+
* Name of the class being created
|
|
1815
|
+
*/
|
|
1816
|
+
sClassName: string,
|
|
1817
|
+
/**
|
|
1818
|
+
* Object literal with information about the class
|
|
1819
|
+
*/
|
|
1820
|
+
oClassInfo?: sap.ClassInfo<T, MultiDimDataProvider>,
|
|
1821
|
+
/**
|
|
1822
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1823
|
+
* used by this class
|
|
1824
|
+
*/
|
|
1825
|
+
FNMetaImpl?: Function
|
|
1826
|
+
): Function;
|
|
1827
|
+
/**
|
|
1828
|
+
* Returns a metadata object for class sap.sac.df.model.MultiDimDataProvider.
|
|
1829
|
+
*
|
|
1830
|
+
* @returns Metadata object describing this class
|
|
1831
|
+
*/
|
|
1832
|
+
static getMetadata(): Metadata;
|
|
1833
|
+
/**
|
|
1834
|
+
* Updates the MultiDimModel from the given the model state including all aggregated `MultiDimDataProvider`s
|
|
1835
|
+
*
|
|
1836
|
+
* @returns Promise Promise which resolves to the updated instance of the OlapModel.
|
|
1837
|
+
*/
|
|
1838
|
+
deserialize(
|
|
1839
|
+
/**
|
|
1840
|
+
* the JSON object containing the persisted state of th MultiDimModel to be applied.
|
|
1841
|
+
*/
|
|
1842
|
+
oModelState: object,
|
|
1843
|
+
/**
|
|
1844
|
+
* the format be the deserialized (INA_REPOSITORY_DELTA or INA_REPOSITORY).
|
|
1845
|
+
*/
|
|
1846
|
+
sFormat: string
|
|
1847
|
+
): undefined;
|
|
1848
|
+
/**
|
|
1849
|
+
* Export Data
|
|
1850
|
+
*/
|
|
1851
|
+
exportData(
|
|
1852
|
+
/**
|
|
1853
|
+
* data export configuration
|
|
1854
|
+
*/
|
|
1855
|
+
oDataExportConfig: object
|
|
1856
|
+
): void;
|
|
1857
|
+
/**
|
|
1858
|
+
* Get Dimension
|
|
1859
|
+
*
|
|
1860
|
+
* @returns a dimension object
|
|
1861
|
+
*/
|
|
1862
|
+
getDimension(
|
|
1863
|
+
/**
|
|
1864
|
+
* dimension name
|
|
1865
|
+
*/
|
|
1866
|
+
sDimensionName: string
|
|
1867
|
+
): /* was: sap.sac.df.Model.Dimension */ any;
|
|
1868
|
+
/**
|
|
1869
|
+
* Get Dimensions
|
|
1870
|
+
*
|
|
1871
|
+
* @returns a dimension object
|
|
1872
|
+
*/
|
|
1873
|
+
getDimensions(): Record<string, Dimension>;
|
|
1874
|
+
/**
|
|
1875
|
+
* Retrieve the current result set
|
|
1876
|
+
*/
|
|
1877
|
+
getResultRequest(): void;
|
|
1878
|
+
/**
|
|
1879
|
+
* Get Variable
|
|
1880
|
+
*
|
|
1881
|
+
* @returns a variable object
|
|
1882
|
+
*/
|
|
1883
|
+
getVariable(
|
|
1884
|
+
/**
|
|
1885
|
+
* variable name
|
|
1886
|
+
*/
|
|
1887
|
+
sVariableName: string
|
|
1888
|
+
): /* was: sap.sac.df.Model.Variable */ any;
|
|
1889
|
+
/**
|
|
1890
|
+
* Serialize the Data Provider to a JSON representation
|
|
1891
|
+
*
|
|
1892
|
+
* @returns a javascript object which represents the `DataProvider`.
|
|
1893
|
+
*/
|
|
1894
|
+
serialize(
|
|
1895
|
+
/**
|
|
1896
|
+
* the format be the serialized (INA_REPOSITORY_DELTA or INA_REPOSITORY). The `DataProvider` to be serialized
|
|
1897
|
+
* from an equivalent such Object.
|
|
1898
|
+
*/
|
|
1899
|
+
sFormat: string
|
|
1900
|
+
): object;
|
|
1901
|
+
/**
|
|
1902
|
+
* get the current result set from the InA Server
|
|
1903
|
+
*
|
|
1904
|
+
* @returns resolving to the `DataProviderAPI` to allow chaining.
|
|
1905
|
+
*/
|
|
1906
|
+
synchronize(): Promise<this>;
|
|
1907
|
+
}
|
|
1908
|
+
}
|
|
1909
|
+
|
|
1910
|
+
declare module "sap/sac/df/model/MultiDimModel" {
|
|
1911
|
+
import Model from "sap/ui/model/Model";
|
|
1912
|
+
|
|
1913
|
+
import VariableGroup from "sap/sac/df/model/VariableGroup";
|
|
1914
|
+
|
|
1915
|
+
import MultiDimDataProvider from "sap/sac/df/model/MultiDimDataProvider";
|
|
1916
|
+
|
|
1917
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1918
|
+
|
|
1919
|
+
import Event from "sap/ui/base/Event";
|
|
1920
|
+
|
|
1921
|
+
/**
|
|
1922
|
+
* @experimental
|
|
1923
|
+
*
|
|
1924
|
+
* Model implementation for InA provider
|
|
1925
|
+
*
|
|
1926
|
+
* The MultiDimModel can populate it's exposed data via Binding to Controls. The structure of the exposed
|
|
1927
|
+
* data is as follows: **Structure of Exposed Data**
|
|
1928
|
+
*
|
|
1929
|
+
*
|
|
1930
|
+
* ```javascript
|
|
1931
|
+
*
|
|
1932
|
+
* {
|
|
1933
|
+
* "DataProvider": [],
|
|
1934
|
+
* "VariableGroups": [],
|
|
1935
|
+
* "Messages": []
|
|
1936
|
+
* }
|
|
1937
|
+
* ```
|
|
1938
|
+
*/
|
|
1939
|
+
export default class MultiDimModel extends Model {
|
|
1940
|
+
/**
|
|
1941
|
+
* Constructor for a new MultiDimModel.
|
|
1942
|
+
*
|
|
1943
|
+
* The Olap Model allows to access and change data from servers providing the InA Protocol.
|
|
1944
|
+
*/
|
|
1945
|
+
constructor(
|
|
1946
|
+
/**
|
|
1947
|
+
* ID for the new control, generated automatically if no ID is given
|
|
1948
|
+
*/
|
|
1949
|
+
sId?: string,
|
|
1950
|
+
/**
|
|
1951
|
+
* Initial settings for the new control
|
|
1952
|
+
*/
|
|
1953
|
+
mSettings?: object
|
|
1954
|
+
);
|
|
1955
|
+
/**
|
|
1956
|
+
* DataProvider
|
|
1957
|
+
*/
|
|
1958
|
+
DataProvider: Record<string, /* was: sap.sac.df.model.DataProvider */ any>;
|
|
1959
|
+
|
|
1960
|
+
/**
|
|
1961
|
+
* Variable Groups
|
|
1962
|
+
*/
|
|
1963
|
+
VariableGroups: Record<string, VariableGroup>;
|
|
1964
|
+
|
|
1965
|
+
/**
|
|
1966
|
+
* Creates a new subclass of class sap.sac.df.model.MultiDimModel with name `sClassName` and enriches it
|
|
1967
|
+
* with the information contained in `oClassInfo`.
|
|
1968
|
+
*
|
|
1969
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
|
|
1970
|
+
*
|
|
1971
|
+
* @returns Created class / constructor function
|
|
1972
|
+
*/
|
|
1973
|
+
static extend<T extends Record<string, unknown>>(
|
|
1974
|
+
/**
|
|
1975
|
+
* Name of the class being created
|
|
1976
|
+
*/
|
|
1977
|
+
sClassName: string,
|
|
1978
|
+
/**
|
|
1979
|
+
* Object literal with information about the class
|
|
1980
|
+
*/
|
|
1981
|
+
oClassInfo?: sap.ClassInfo<T, MultiDimModel>,
|
|
1982
|
+
/**
|
|
1983
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1984
|
+
* used by this class
|
|
1985
|
+
*/
|
|
1986
|
+
FNMetaImpl?: Function
|
|
1987
|
+
): Function;
|
|
1988
|
+
/**
|
|
1989
|
+
* Returns a metadata object for class sap.sac.df.model.MultiDimModel.
|
|
1990
|
+
*
|
|
1991
|
+
* @returns Metadata object describing this class
|
|
1992
|
+
*/
|
|
1993
|
+
static getMetadata(): Metadata;
|
|
1994
|
+
/**
|
|
1995
|
+
* Adds a new query as a new `DataProvider` .
|
|
1996
|
+
*
|
|
1997
|
+
* @returns Promise which resolves the Data Provider that was created
|
|
1998
|
+
*/
|
|
1999
|
+
addDataProvider(
|
|
2000
|
+
/**
|
|
2001
|
+
* the name of the new `DataProvider`.
|
|
2002
|
+
*/
|
|
2003
|
+
sDataProviderName: string,
|
|
2004
|
+
/**
|
|
2005
|
+
* the name of the query which the `DataProvider` is supposed to expose.
|
|
2006
|
+
*/
|
|
2007
|
+
sQueryName: string,
|
|
2008
|
+
/**
|
|
2009
|
+
* the name of the system in the landscape
|
|
2010
|
+
*/
|
|
2011
|
+
sSystem?: string,
|
|
2012
|
+
/**
|
|
2013
|
+
* the name of the package
|
|
2014
|
+
*/
|
|
2015
|
+
sPackage?: string,
|
|
2016
|
+
/**
|
|
2017
|
+
* the name of the schema
|
|
2018
|
+
*/
|
|
2019
|
+
sSchema?: string,
|
|
2020
|
+
/**
|
|
2021
|
+
* the name of the type of the datasource
|
|
2022
|
+
*/
|
|
2023
|
+
sType?: string
|
|
2024
|
+
): Promise<MultiDimDataProvider>;
|
|
2025
|
+
/**
|
|
2026
|
+
* Adds a variable group to the model
|
|
2027
|
+
*
|
|
2028
|
+
* A Variable group defines what variables of teh underlying DataProvider behave in as one variable The
|
|
2029
|
+
* group is defined by a name and a Rule. Rule is a function which accept the variable definition and decides
|
|
2030
|
+
* if the variable has to be part of te group The first added variable becomes automatically the MergedVariable.
|
|
2031
|
+
*
|
|
2032
|
+
* The VariableGroup can be accessed/bound via the properties of MultiDimModel a
|
|
2033
|
+
*
|
|
2034
|
+
* @returns Promise which resolves the Variable Group that was created
|
|
2035
|
+
*/
|
|
2036
|
+
addVariableGroup(
|
|
2037
|
+
/**
|
|
2038
|
+
* the name of the variable
|
|
2039
|
+
*/
|
|
2040
|
+
sVariableGroupName: string,
|
|
2041
|
+
/**
|
|
2042
|
+
* function returning a boolean
|
|
2043
|
+
*/
|
|
2044
|
+
fRule: Function,
|
|
2045
|
+
/**
|
|
2046
|
+
* additional properties
|
|
2047
|
+
*/
|
|
2048
|
+
oProperties: Object
|
|
2049
|
+
): Promise<VariableGroup>;
|
|
2050
|
+
/**
|
|
2051
|
+
* Resets the messages
|
|
2052
|
+
*
|
|
2053
|
+
* @returns for chaining
|
|
2054
|
+
*/
|
|
2055
|
+
clearMessages(
|
|
2056
|
+
/**
|
|
2057
|
+
* if also property bindings have to be updated
|
|
2058
|
+
*/
|
|
2059
|
+
bUpdateBindings: undefined
|
|
2060
|
+
): MultiDimModel;
|
|
2061
|
+
/**
|
|
2062
|
+
* Updates the MultiDimModel from the given the model state including all aggregated `MultiDimDataProvider`s
|
|
2063
|
+
*
|
|
2064
|
+
* @returns Promise Promise which resolves to the updated instance of the OlapModel.
|
|
2065
|
+
*/
|
|
2066
|
+
deserialize(
|
|
2067
|
+
/**
|
|
2068
|
+
* the JSON object containing the persisted state of th MultiDimModel to be applied.
|
|
2069
|
+
*/
|
|
2070
|
+
oModelState: object,
|
|
2071
|
+
/**
|
|
2072
|
+
* the format be the deserialized (INA_REPOSITORY_DELTA or INA_REPOSITORY).
|
|
2073
|
+
*/
|
|
2074
|
+
sFormat: string
|
|
2075
|
+
): undefined;
|
|
2076
|
+
/**
|
|
2077
|
+
* Fires event {@link #event:dataProviderUpdated dataProviderUpdated} to attached listeners.
|
|
2078
|
+
*
|
|
2079
|
+
* @returns the MultiDimModel
|
|
2080
|
+
*/
|
|
2081
|
+
fireDataProviderUpdated(
|
|
2082
|
+
/**
|
|
2083
|
+
* Parameters to pass along with the event
|
|
2084
|
+
*/
|
|
2085
|
+
oParameters?: object
|
|
2086
|
+
): MultiDimModel;
|
|
2087
|
+
/**
|
|
2088
|
+
* Get a Data Provider
|
|
2089
|
+
*
|
|
2090
|
+
* @returns DataProvider.
|
|
2091
|
+
*/
|
|
2092
|
+
getDataProvider(
|
|
2093
|
+
/**
|
|
2094
|
+
* the name of the new DataProvider.
|
|
2095
|
+
*/
|
|
2096
|
+
sDataProviderName: string
|
|
2097
|
+
): MultiDimDataProvider;
|
|
2098
|
+
/**
|
|
2099
|
+
* Get all Data Providers
|
|
2100
|
+
*
|
|
2101
|
+
* @returns object of all Data Providers.
|
|
2102
|
+
*/
|
|
2103
|
+
getDataProviders(): Record<string, MultiDimDataProvider>;
|
|
2104
|
+
/**
|
|
2105
|
+
* Get a variable group
|
|
2106
|
+
*
|
|
2107
|
+
* @returns variable group object
|
|
2108
|
+
*/
|
|
2109
|
+
getVariableGroup(
|
|
2110
|
+
/**
|
|
2111
|
+
* the name of the variable
|
|
2112
|
+
*/
|
|
2113
|
+
sVariableGroupName: string
|
|
2114
|
+
): VariableGroup;
|
|
2115
|
+
/**
|
|
2116
|
+
* Get all variable groups
|
|
2117
|
+
*
|
|
2118
|
+
* @returns variable group object
|
|
2119
|
+
*/
|
|
2120
|
+
getVariableGroups(): Record<string, VariableGroup>;
|
|
2121
|
+
/**
|
|
2122
|
+
* Ensures all aggregated DataProviders are logged off.
|
|
2123
|
+
*
|
|
2124
|
+
* @returns Promise which resolves when logoff is finished.
|
|
2125
|
+
*/
|
|
2126
|
+
logoff(): Promise<void>;
|
|
2127
|
+
/**
|
|
2128
|
+
* Remove existing data provider from model.
|
|
2129
|
+
*
|
|
2130
|
+
* @returns Promise which resolves when the removing has been finished
|
|
2131
|
+
*/
|
|
2132
|
+
removeDataProvider(
|
|
2133
|
+
/**
|
|
2134
|
+
* the name of the DataProvider to be removed
|
|
2135
|
+
*/
|
|
2136
|
+
sDataProviderName: string
|
|
2137
|
+
): Promise<void>;
|
|
2138
|
+
/**
|
|
2139
|
+
* Remove a variable group from the model
|
|
2140
|
+
*
|
|
2141
|
+
* @returns Promise which resolves when the removing has been finished
|
|
2142
|
+
*/
|
|
2143
|
+
removeVariableGroup(
|
|
2144
|
+
/**
|
|
2145
|
+
* the name of the variable
|
|
2146
|
+
*/
|
|
2147
|
+
sVariableGroupName: string
|
|
2148
|
+
): Promise<void>;
|
|
2149
|
+
/**
|
|
2150
|
+
* Reset the Olap Model to the default query
|
|
2151
|
+
*/
|
|
2152
|
+
resetModel(): void;
|
|
2153
|
+
/**
|
|
2154
|
+
* Serialize the Model with all aggregated `DataProvider` to a JSON representation
|
|
2155
|
+
*
|
|
2156
|
+
* @returns a javascript object which represents the `MultiDimModel`.
|
|
2157
|
+
*/
|
|
2158
|
+
serialize(
|
|
2159
|
+
/**
|
|
2160
|
+
* the format be the serialized (INA_REPOSITORY_DELTA or INA_REPOSITORY). The `MultiDimModel` to be serialized
|
|
2161
|
+
* from an equivalent such Object.
|
|
2162
|
+
*/
|
|
2163
|
+
sFormat: string
|
|
2164
|
+
): object;
|
|
2165
|
+
/**
|
|
2166
|
+
* Synchronizes all aggregated DataProviders by fetching their ResultSet.
|
|
2167
|
+
*
|
|
2168
|
+
* If the user does not choose an Analytic Query, then the promise is rejected
|
|
2169
|
+
*
|
|
2170
|
+
* @returns the MultiDimModel, to allow chaining
|
|
2171
|
+
*/
|
|
2172
|
+
synchronize(
|
|
2173
|
+
/**
|
|
2174
|
+
* List of data provider that are to be synchronized (all if not supplied)
|
|
2175
|
+
*/
|
|
2176
|
+
aDataProviderNames: string[]
|
|
2177
|
+
): Promise<MultiDimModel>;
|
|
2178
|
+
}
|
|
2179
|
+
|
|
2180
|
+
export interface MultiDimModel$DataProviderUpdatedEventParameters {}
|
|
2181
|
+
|
|
2182
|
+
export type MultiDimModel$DataProviderUpdatedEvent = Event<
|
|
2183
|
+
MultiDimModel$DataProviderUpdatedEventParameters,
|
|
2184
|
+
MultiDimModel
|
|
2185
|
+
>;
|
|
2186
|
+
}
|
|
2187
|
+
|
|
2188
|
+
declare module "sap/sac/df/model/QueryInfo" {
|
|
2189
|
+
import BaseObject from "sap/ui/base/Object";
|
|
2190
|
+
|
|
2191
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
2192
|
+
|
|
2193
|
+
/**
|
|
2194
|
+
* @since 1.118
|
|
2195
|
+
* @experimental
|
|
2196
|
+
*
|
|
2197
|
+
* Query Info providing the following information
|
|
2198
|
+
* ```javascript
|
|
2199
|
+
*
|
|
2200
|
+
* "QueryTitle": "",
|
|
2201
|
+
* "QueryName": "",
|
|
2202
|
+
* "QueryType": "",
|
|
2203
|
+
* "SystemName": "",
|
|
2204
|
+
* "CreatedBy": "",
|
|
2205
|
+
* "CreatedOn": "",
|
|
2206
|
+
* "QueryDueDateText": "",
|
|
2207
|
+
* "CreatedOnText": "",
|
|
2208
|
+
* "QueryDueDate": "",
|
|
2209
|
+
* "ResultAlignmentRows": "",
|
|
2210
|
+
* "ResultAlignmentColumns": "",
|
|
2211
|
+
* "LastUpdated": "",
|
|
2212
|
+
* "LastUpdatedBy": "",
|
|
2213
|
+
* "LastUpdatedText": ""
|
|
2214
|
+
* ```
|
|
2215
|
+
*/
|
|
2216
|
+
export default class QueryInfo extends BaseObject {
|
|
2217
|
+
constructor();
|
|
2218
|
+
|
|
2219
|
+
/**
|
|
2220
|
+
* Creates a new subclass of class sap.sac.df.model.QueryInfo with name `sClassName` and enriches it with
|
|
2221
|
+
* the information contained in `oClassInfo`.
|
|
2222
|
+
*
|
|
2223
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
2224
|
+
*
|
|
2225
|
+
* @returns Created class / constructor function
|
|
2226
|
+
*/
|
|
2227
|
+
static extend<T extends Record<string, unknown>>(
|
|
2228
|
+
/**
|
|
2229
|
+
* Name of the class being created
|
|
2230
|
+
*/
|
|
2231
|
+
sClassName: string,
|
|
2232
|
+
/**
|
|
2233
|
+
* Object literal with information about the class
|
|
2234
|
+
*/
|
|
2235
|
+
oClassInfo?: sap.ClassInfo<T, QueryInfo>,
|
|
2236
|
+
/**
|
|
2237
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2238
|
+
* used by this class
|
|
2239
|
+
*/
|
|
2240
|
+
FNMetaImpl?: Function
|
|
2241
|
+
): Function;
|
|
2242
|
+
/**
|
|
2243
|
+
* Returns a metadata object for class sap.sac.df.model.QueryInfo.
|
|
2244
|
+
*
|
|
2245
|
+
* @returns Metadata object describing this class
|
|
2246
|
+
*/
|
|
2247
|
+
static getMetadata(): Metadata;
|
|
2248
|
+
}
|
|
2249
|
+
}
|
|
2250
|
+
|
|
2251
|
+
declare module "sap/sac/df/model/Variable" {
|
|
2252
|
+
import BaseObject from "sap/ui/base/Object";
|
|
2253
|
+
|
|
2254
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
2255
|
+
|
|
2256
|
+
/**
|
|
2257
|
+
* @since 1.118
|
|
2258
|
+
* @experimental
|
|
2259
|
+
*
|
|
2260
|
+
* Variable
|
|
2261
|
+
* ```javascript
|
|
2262
|
+
*
|
|
2263
|
+
* "Name": "",
|
|
2264
|
+
* "Dimension": "",
|
|
2265
|
+
* "ValueType": "",
|
|
2266
|
+
* "VariableType": "",
|
|
2267
|
+
* "Description": "",
|
|
2268
|
+
* "Mandatory": "",
|
|
2269
|
+
* "SupportsMultipleValues": "",
|
|
2270
|
+
* "TechName": "",
|
|
2271
|
+
* "InputEnabled": "",
|
|
2272
|
+
* "Position": ""
|
|
2273
|
+
* "SupportsValueHelp": "",
|
|
2274
|
+
* "DataProviderName": "",
|
|
2275
|
+
* "MemberFilter": [
|
|
2276
|
+
* {
|
|
2277
|
+
* "Low": "",
|
|
2278
|
+
* "LowDisplayKey": "",
|
|
2279
|
+
* "LowText": "",
|
|
2280
|
+
* "High": ,
|
|
2281
|
+
* "HighDisplayKey": ,
|
|
2282
|
+
* "HighText": ,
|
|
2283
|
+
* "ComparisonOperator": "",
|
|
2284
|
+
* "Text": "",
|
|
2285
|
+
* "IsExcluding": ,
|
|
2286
|
+
* "Hierarchy": { }
|
|
2287
|
+
* }
|
|
2288
|
+
* ]
|
|
2289
|
+
* ```
|
|
2290
|
+
*/
|
|
2291
|
+
export default class Variable extends BaseObject {
|
|
2292
|
+
constructor();
|
|
2293
|
+
|
|
2294
|
+
/**
|
|
2295
|
+
* Creates a new subclass of class sap.sac.df.model.Variable with name `sClassName` and enriches it with
|
|
2296
|
+
* the information contained in `oClassInfo`.
|
|
2297
|
+
*
|
|
2298
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
2299
|
+
*
|
|
2300
|
+
* @returns Created class / constructor function
|
|
2301
|
+
*/
|
|
2302
|
+
static extend<T extends Record<string, unknown>>(
|
|
2303
|
+
/**
|
|
2304
|
+
* Name of the class being created
|
|
2305
|
+
*/
|
|
2306
|
+
sClassName: string,
|
|
2307
|
+
/**
|
|
2308
|
+
* Object literal with information about the class
|
|
2309
|
+
*/
|
|
2310
|
+
oClassInfo?: sap.ClassInfo<T, Variable>,
|
|
2311
|
+
/**
|
|
2312
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2313
|
+
* used by this class
|
|
2314
|
+
*/
|
|
2315
|
+
FNMetaImpl?: Function
|
|
2316
|
+
): Function;
|
|
2317
|
+
/**
|
|
2318
|
+
* Returns a metadata object for class sap.sac.df.model.Variable.
|
|
2319
|
+
*
|
|
2320
|
+
* @returns Metadata object describing this class
|
|
2321
|
+
*/
|
|
2322
|
+
static getMetadata(): Metadata;
|
|
2323
|
+
/**
|
|
2324
|
+
* Open a dialog to display and change the filter on a dimension of the `MultiDimDataProvider`
|
|
2325
|
+
*
|
|
2326
|
+
* @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
|
|
2327
|
+
* with Ok and dynamic filters of the given dimension are updated
|
|
2328
|
+
*/
|
|
2329
|
+
openSelector(
|
|
2330
|
+
/**
|
|
2331
|
+
* if the model update should be suppressed
|
|
2332
|
+
*/
|
|
2333
|
+
bSuppressModelUpdate: boolean
|
|
2334
|
+
): Promise<any>;
|
|
2335
|
+
/**
|
|
2336
|
+
* Performs the search in values of a given Variable
|
|
2337
|
+
*
|
|
2338
|
+
* @returns array with found values
|
|
2339
|
+
*/
|
|
2340
|
+
searchVariableValues(
|
|
2341
|
+
/**
|
|
2342
|
+
* the name of the Variable to search
|
|
2343
|
+
*/
|
|
2344
|
+
sVariable: string,
|
|
2345
|
+
/**
|
|
2346
|
+
* string to search for
|
|
2347
|
+
*/
|
|
2348
|
+
sSearchString: string,
|
|
2349
|
+
/**
|
|
2350
|
+
* if a fuzzy search is performed
|
|
2351
|
+
*/
|
|
2352
|
+
bFuzzy: boolean,
|
|
2353
|
+
/**
|
|
2354
|
+
* if to search in text/description (default true)
|
|
2355
|
+
*/
|
|
2356
|
+
bText: boolean,
|
|
2357
|
+
/**
|
|
2358
|
+
* if to search in key/id (default true)
|
|
2359
|
+
*/
|
|
2360
|
+
bKey: boolean
|
|
2361
|
+
): Promise<object[]>;
|
|
2362
|
+
/**
|
|
2363
|
+
* Get Result Set
|
|
2364
|
+
*/
|
|
2365
|
+
setVariableValue(
|
|
2366
|
+
/**
|
|
2367
|
+
* keep offset
|
|
2368
|
+
*/
|
|
2369
|
+
aRange: object
|
|
2370
|
+
): void;
|
|
2371
|
+
}
|
|
2372
|
+
}
|
|
2373
|
+
|
|
2374
|
+
declare module "sap/sac/df/model/VariableGroup" {
|
|
2375
|
+
import BaseObject from "sap/ui/base/Object";
|
|
2376
|
+
|
|
2377
|
+
import Variable from "sap/sac/df/model/Variable";
|
|
2378
|
+
|
|
2379
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
2380
|
+
|
|
2381
|
+
/**
|
|
2382
|
+
* @since 1.118
|
|
2383
|
+
* @experimental
|
|
2384
|
+
*
|
|
2385
|
+
* Variable Group
|
|
2386
|
+
* ```javascript
|
|
2387
|
+
*
|
|
2388
|
+
* "Name": "string",
|
|
2389
|
+
* "MergedVariable": "sap.sac.df.model.Variable"
|
|
2390
|
+
* ```
|
|
2391
|
+
*/
|
|
2392
|
+
export default class VariableGroup extends BaseObject {
|
|
2393
|
+
constructor();
|
|
2394
|
+
/**
|
|
2395
|
+
* Merged Variable
|
|
2396
|
+
*/
|
|
2397
|
+
MergedVariable: Variable;
|
|
2398
|
+
|
|
2399
|
+
/**
|
|
2400
|
+
* Name
|
|
2401
|
+
*/
|
|
2402
|
+
Name: string;
|
|
2403
|
+
|
|
2404
|
+
/**
|
|
2405
|
+
* Creates a new subclass of class sap.sac.df.model.VariableGroup with name `sClassName` and enriches it
|
|
2406
|
+
* with the information contained in `oClassInfo`.
|
|
2407
|
+
*
|
|
2408
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
2409
|
+
*
|
|
2410
|
+
* @returns Created class / constructor function
|
|
2411
|
+
*/
|
|
2412
|
+
static extend<T extends Record<string, unknown>>(
|
|
2413
|
+
/**
|
|
2414
|
+
* Name of the class being created
|
|
2415
|
+
*/
|
|
2416
|
+
sClassName: string,
|
|
2417
|
+
/**
|
|
2418
|
+
* Object literal with information about the class
|
|
2419
|
+
*/
|
|
2420
|
+
oClassInfo?: sap.ClassInfo<T, VariableGroup>,
|
|
2421
|
+
/**
|
|
2422
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2423
|
+
* used by this class
|
|
2424
|
+
*/
|
|
2425
|
+
FNMetaImpl?: Function
|
|
2426
|
+
): Function;
|
|
2427
|
+
/**
|
|
2428
|
+
* Returns a metadata object for class sap.sac.df.model.VariableGroup.
|
|
2429
|
+
*
|
|
2430
|
+
* @returns Metadata object describing this class
|
|
2431
|
+
*/
|
|
2432
|
+
static getMetadata(): Metadata;
|
|
2433
|
+
/**
|
|
2434
|
+
* Opens the value help dialog so the user choose a value for a VariableGroup After the value is selected
|
|
2435
|
+
* only teh VariableGroup.MergedVariable is updated. The variables of the aggregated MultiDimDataProviders
|
|
2436
|
+
* are updated with the next ResultSet fetch
|
|
2437
|
+
*
|
|
2438
|
+
* @returns to indicate if the VariableGroup has been updated
|
|
2439
|
+
*/
|
|
2440
|
+
openSelector(): Promise<boolean>;
|
|
2441
|
+
/**
|
|
2442
|
+
* Performs the search in values of a given VariableGroup
|
|
2443
|
+
*
|
|
2444
|
+
* @returns array with found values
|
|
2445
|
+
*/
|
|
2446
|
+
searchValue(
|
|
2447
|
+
/**
|
|
2448
|
+
* string to search for
|
|
2449
|
+
*/
|
|
2450
|
+
sSearchString: string,
|
|
2451
|
+
/**
|
|
2452
|
+
* if a fuzzy search is performed
|
|
2453
|
+
*/
|
|
2454
|
+
bFuzzy: boolean
|
|
2455
|
+
): Promise<object[]>;
|
|
2456
|
+
/**
|
|
2457
|
+
* Sets new value
|
|
2458
|
+
*
|
|
2459
|
+
* @returns Promise which resolve when the value is set
|
|
2460
|
+
*/
|
|
2461
|
+
setValue(
|
|
2462
|
+
/**
|
|
2463
|
+
* the value of the variable
|
|
2464
|
+
*/
|
|
2465
|
+
variableValue: object
|
|
2466
|
+
): undefined;
|
|
2467
|
+
}
|
|
2468
|
+
}
|
|
2469
|
+
|
|
2470
|
+
declare module "sap/sac/df/olap/MultiDimDataProvider" {
|
|
2471
|
+
import MultiDimModel from "sap/sac/df/olap/MultiDimModel";
|
|
2472
|
+
|
|
2473
|
+
/**
|
|
2474
|
+
* @experimental
|
|
2475
|
+
*
|
|
2476
|
+
* A `MultiDimDataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol
|
|
2477
|
+
* HANA - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
|
|
2478
|
+
*
|
|
2479
|
+
* Instances of this class should only be created by the {sap.sac.df.olap.MultiDimModel}. The `MultiDimModel`
|
|
2480
|
+
* populates it's exposed data via Binding to Controls. The structure of data exposed by a MultiDimDataProvider
|
|
2481
|
+
* is as follows:
|
|
2482
|
+
*
|
|
2483
|
+
* **Structure of Exposed Data**
|
|
2484
|
+
*
|
|
2485
|
+
*
|
|
2486
|
+
* - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `MultiDimDataProvider`
|
|
2487
|
+
* - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
|
|
2488
|
+
* `Name`: the external name of the dimension `Description`: the language dependant description of
|
|
2489
|
+
* the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
|
|
2490
|
+
*
|
|
2491
|
+
* - RowsDimensions: The list of all Dimensions lying on the Rows Axis
|
|
2492
|
+
* Name: the external name of the dimension Description: the language dependant description of the
|
|
2493
|
+
* dimension IsStructure: boolean flag indicating whether the dimension is a structure *
|
|
2494
|
+
* - ColumnsDimensions: The list of all Dimensions lying on the Columns Axis
|
|
2495
|
+
* Name: the external name of the dimension Description: the language dependant description of the
|
|
2496
|
+
* dimension IsStructure: boolean flag indicating whether the dimension is a structure
|
|
2497
|
+
* - Conditions: list of conditions (result set filters)
|
|
2498
|
+
* - Exceptions: list of exceptions (conditional formats)
|
|
2499
|
+
* - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
|
|
2500
|
+
*/
|
|
2501
|
+
export default class MultiDimDataProvider {
|
|
2502
|
+
/**
|
|
2503
|
+
* Constructor for a new MultiDimDataProvider.
|
|
2504
|
+
*
|
|
2505
|
+
* A MultiDimDataProvider represents a navigable queryManager and allows to access and change data from
|
|
2506
|
+
* servers providing the InA
|
|
2507
|
+
* Protocol.
|
|
2508
|
+
*/
|
|
2509
|
+
constructor(
|
|
2510
|
+
/**
|
|
2511
|
+
* the model to which the MultiDimDataProvider belongs
|
|
2512
|
+
*/
|
|
2513
|
+
oMultiDimModel: MultiDimModel,
|
|
2514
|
+
/**
|
|
2515
|
+
* name of the MultiDimDataProvider
|
|
2516
|
+
*/
|
|
2517
|
+
sMultiDimDataProviderName: string,
|
|
2518
|
+
/**
|
|
2519
|
+
* the firefly application associated to the `MultiDimModel`
|
|
2520
|
+
*/
|
|
2521
|
+
oApplication: object,
|
|
2522
|
+
/**
|
|
2523
|
+
* the firefly queryManager that is wrapped by the `MultiDimDataProvider`
|
|
2524
|
+
*/
|
|
2525
|
+
oQueryManager: object
|
|
2526
|
+
);
|
|
2527
|
+
|
|
2528
|
+
/**
|
|
2529
|
+
* add a new condition (aka resultset filter).
|
|
2530
|
+
*
|
|
2531
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
2532
|
+
*/
|
|
2533
|
+
addCondition(
|
|
2534
|
+
/**
|
|
2535
|
+
* Condition Definiton
|
|
2536
|
+
*/
|
|
2537
|
+
oData: object,
|
|
2538
|
+
/**
|
|
2539
|
+
* Target state of the condition
|
|
2540
|
+
*/
|
|
2541
|
+
bActive: boolean
|
|
2542
|
+
): Promise<this>;
|
|
2543
|
+
/**
|
|
2544
|
+
* Do a drill operation on a dimension member on an Axis
|
|
2545
|
+
*
|
|
2546
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
2547
|
+
*/
|
|
2548
|
+
drill(
|
|
2549
|
+
/**
|
|
2550
|
+
* the external name of the Dimension
|
|
2551
|
+
*/
|
|
2552
|
+
sDim: string,
|
|
2553
|
+
/**
|
|
2554
|
+
* the Tuple Index of the member in the resultset.
|
|
2555
|
+
*/
|
|
2556
|
+
nIndex: int
|
|
2557
|
+
): this;
|
|
2558
|
+
/**
|
|
2559
|
+
* Gets the scaling factor of a measure or data cell
|
|
2560
|
+
*
|
|
2561
|
+
* @returns the current decimal places setting
|
|
2562
|
+
*/
|
|
2563
|
+
getDecimalPlaces(
|
|
2564
|
+
/**
|
|
2565
|
+
* the Member of the Measure Structure
|
|
2566
|
+
*/
|
|
2567
|
+
sMeasureMember: string,
|
|
2568
|
+
/**
|
|
2569
|
+
* the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
|
|
2570
|
+
*/
|
|
2571
|
+
sNonMeasureMember: string
|
|
2572
|
+
): int;
|
|
2573
|
+
/**
|
|
2574
|
+
* get the list of filters of a dimension
|
|
2575
|
+
*
|
|
2576
|
+
* @returns list of a range with components
|
|
2577
|
+
* `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
|
|
2578
|
+
* EQ,LE,..,BT
|
|
2579
|
+
*/
|
|
2580
|
+
getFilterOfDim(
|
|
2581
|
+
/**
|
|
2582
|
+
* the name of the dimension from which the filter is retrieved
|
|
2583
|
+
*/
|
|
2584
|
+
sDim: string
|
|
2585
|
+
): object[];
|
|
2586
|
+
/**
|
|
2587
|
+
* get the current resultset from the InA Server
|
|
2588
|
+
*
|
|
2589
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
2590
|
+
*/
|
|
2591
|
+
getResultSet(): Promise<this>;
|
|
2592
|
+
/**
|
|
2593
|
+
* get the list of the jump targets associated to a datacell defined via the report report interface.
|
|
2594
|
+
*
|
|
2595
|
+
* @returns resolving to the List of jump targets.
|
|
2596
|
+
*/
|
|
2597
|
+
getRRITargets(
|
|
2598
|
+
/**
|
|
2599
|
+
* Row of the data cell
|
|
2600
|
+
*/
|
|
2601
|
+
nRow: int,
|
|
2602
|
+
/**
|
|
2603
|
+
* Column of the data cell
|
|
2604
|
+
*/
|
|
2605
|
+
nColumn: int
|
|
2606
|
+
): Promise<this>;
|
|
2607
|
+
/**
|
|
2608
|
+
* Gets the scaling factor of a measure
|
|
2609
|
+
*
|
|
2610
|
+
* @returns the exponent of the scaling factor in Base 10
|
|
2611
|
+
*/
|
|
2612
|
+
getScalingFactor(
|
|
2613
|
+
/**
|
|
2614
|
+
* the Member of the Measure Structure
|
|
2615
|
+
*/
|
|
2616
|
+
sMeasureMember: string,
|
|
2617
|
+
/**
|
|
2618
|
+
* the Member of the Non Measure Structure
|
|
2619
|
+
*/
|
|
2620
|
+
sNonMeasureMember: string
|
|
2621
|
+
): int;
|
|
2622
|
+
/**
|
|
2623
|
+
* hasVariable Checks whether a Variable is influencing the MultiDimDataProvider
|
|
2624
|
+
*
|
|
2625
|
+
* @returns Whether the vairable influences the MultiDimDataProvider
|
|
2626
|
+
*/
|
|
2627
|
+
hasVariable(
|
|
2628
|
+
/**
|
|
2629
|
+
* Name of the Variable
|
|
2630
|
+
*/
|
|
2631
|
+
the: string
|
|
2632
|
+
): boolean;
|
|
2633
|
+
/**
|
|
2634
|
+
* move a dimension one position down on it's axis
|
|
2635
|
+
*
|
|
2636
|
+
* @returns the `MultiDimDataProvider` to allow chaining.
|
|
2637
|
+
*/
|
|
2638
|
+
moveDown(
|
|
2639
|
+
/**
|
|
2640
|
+
* name of the dimension
|
|
2641
|
+
*/
|
|
2642
|
+
sName: string,
|
|
2643
|
+
/**
|
|
2644
|
+
* Target state of the condition
|
|
2645
|
+
*/
|
|
2646
|
+
bActive: boolean
|
|
2647
|
+
): this;
|
|
2648
|
+
/**
|
|
2649
|
+
* move a dimension one position up on it's axis
|
|
1427
2650
|
*
|
|
1428
2651
|
* @returns the `MultiDimDataProvider` to allow chaining.
|
|
1429
2652
|
*/
|
|
@@ -1664,6 +2887,8 @@ declare module "sap/sac/df/olap/MultiDimDataProvider" {
|
|
|
1664
2887
|
}
|
|
1665
2888
|
|
|
1666
2889
|
declare module "sap/sac/df/olap/MultiDimModel" {
|
|
2890
|
+
import Model from "sap/ui/model/Model";
|
|
2891
|
+
|
|
1667
2892
|
import Metadata from "sap/ui/base/Metadata";
|
|
1668
2893
|
|
|
1669
2894
|
/**
|
|
@@ -1675,20 +2900,15 @@ declare module "sap/sac/df/olap/MultiDimModel" {
|
|
|
1675
2900
|
* data is as follows: **Structure of Exposed Data**
|
|
1676
2901
|
*
|
|
1677
2902
|
*
|
|
1678
|
-
* - DataProvider: The associative array of all `DataProvider` aggregated by the
|
|
1679
|
-
* The associative array of
|
|
1680
|
-
*
|
|
2903
|
+
* - DataProvider: The associative array of all `DataProvider` aggregated by the VariableGroups:
|
|
2904
|
+
* The associative array of registered Variable Groups Messages: The list of all messages posted by
|
|
2905
|
+
* the Analytical Engine
|
|
1681
2906
|
*/
|
|
1682
|
-
export default class MultiDimModel
|
|
1683
|
-
/* was: sap.sac.df.DFKernel */ extends Object {
|
|
2907
|
+
export default class MultiDimModel extends Model {
|
|
1684
2908
|
/**
|
|
1685
2909
|
* Constructor for a new OlapMode.
|
|
1686
2910
|
*
|
|
1687
2911
|
* The Olap Model allows to access and change data from servers providing the InA Protocol.
|
|
1688
|
-
*
|
|
1689
|
-
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1690
|
-
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1691
|
-
* of the syntax of the settings object.
|
|
1692
2912
|
*/
|
|
1693
2913
|
constructor();
|
|
1694
2914
|
|
|
@@ -1696,7 +2916,7 @@ declare module "sap/sac/df/olap/MultiDimModel" {
|
|
|
1696
2916
|
* Creates a new subclass of class sap.sac.df.olap.MultiDimModel with name `sClassName` and enriches it
|
|
1697
2917
|
* with the information contained in `oClassInfo`.
|
|
1698
2918
|
*
|
|
1699
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.
|
|
2919
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
|
|
1700
2920
|
*
|
|
1701
2921
|
* @returns Created class / constructor function
|
|
1702
2922
|
*/
|
|
@@ -1721,25 +2941,6 @@ declare module "sap/sac/df/olap/MultiDimModel" {
|
|
|
1721
2941
|
* @returns Metadata object describing this class
|
|
1722
2942
|
*/
|
|
1723
2943
|
static getMetadata(): Metadata;
|
|
1724
|
-
/**
|
|
1725
|
-
* Gets current value of property {@link #getApi api}.
|
|
1726
|
-
*
|
|
1727
|
-
* @returns Value of property `api`
|
|
1728
|
-
*/
|
|
1729
|
-
getApi(): undefined;
|
|
1730
|
-
/**
|
|
1731
|
-
* Sets a new value for property {@link #getApi api}.
|
|
1732
|
-
*
|
|
1733
|
-
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1734
|
-
*
|
|
1735
|
-
* @returns Reference to `this` in order to allow method chaining
|
|
1736
|
-
*/
|
|
1737
|
-
setApi(
|
|
1738
|
-
/**
|
|
1739
|
-
* New value for property `api`
|
|
1740
|
-
*/
|
|
1741
|
-
sApi: undefined
|
|
1742
|
-
): this;
|
|
1743
2944
|
}
|
|
1744
2945
|
}
|
|
1745
2946
|
|
|
@@ -1770,14 +2971,30 @@ declare module "sap/sac/df/types/SystemType" {
|
|
|
1770
2971
|
|
|
1771
2972
|
declare namespace sap {
|
|
1772
2973
|
interface IUI5DefineDependencyNames {
|
|
1773
|
-
"sap/sac/df/controls/MultiDimControl": undefined;
|
|
1774
|
-
|
|
1775
2974
|
"sap/sac/df/FlexAnalysis": undefined;
|
|
1776
2975
|
|
|
1777
2976
|
"sap/sac/df/FlexAnalysisPanel": undefined;
|
|
1778
2977
|
|
|
1779
2978
|
"sap/sac/df/library": undefined;
|
|
1780
2979
|
|
|
2980
|
+
"sap/sac/df/model/AxisLayout": undefined;
|
|
2981
|
+
|
|
2982
|
+
"sap/sac/df/model/Dimension": undefined;
|
|
2983
|
+
|
|
2984
|
+
"sap/sac/df/model/Document": undefined;
|
|
2985
|
+
|
|
2986
|
+
"sap/sac/df/model/Grid": undefined;
|
|
2987
|
+
|
|
2988
|
+
"sap/sac/df/model/MultiDimDataProvider": undefined;
|
|
2989
|
+
|
|
2990
|
+
"sap/sac/df/model/MultiDimModel": undefined;
|
|
2991
|
+
|
|
2992
|
+
"sap/sac/df/model/QueryInfo": undefined;
|
|
2993
|
+
|
|
2994
|
+
"sap/sac/df/model/Variable": undefined;
|
|
2995
|
+
|
|
2996
|
+
"sap/sac/df/model/VariableGroup": undefined;
|
|
2997
|
+
|
|
1781
2998
|
"sap/sac/df/olap/MultiDimDataProvider": undefined;
|
|
1782
2999
|
|
|
1783
3000
|
"sap/sac/df/olap/MultiDimModel": undefined;
|