@sapui5/types 1.141.4 → 1.142.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -0
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.cux.base.d.ts +3 -0
  8. package/types/sap.esh.search.ui.d.ts +159 -4
  9. package/types/sap.f.d.ts +1 -1
  10. package/types/sap.fe.ariba.d.ts +1 -1
  11. package/types/sap.fe.base.d.ts +1 -1
  12. package/types/sap.fe.controls.d.ts +1 -1
  13. package/types/sap.fe.core.d.ts +471 -32
  14. package/types/sap.fe.ina.d.ts +1 -1
  15. package/types/sap.fe.macros.d.ts +2616 -95
  16. package/types/sap.fe.navigation.d.ts +2 -2
  17. package/types/sap.fe.placeholder.d.ts +1 -1
  18. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  19. package/types/sap.fe.templates.d.ts +79 -11
  20. package/types/sap.fe.test.d.ts +8 -1
  21. package/types/sap.fe.tools.d.ts +1 -1
  22. package/types/sap.feedback.ui.d.ts +1 -1
  23. package/types/sap.gantt.d.ts +4 -1
  24. package/types/sap.insights.d.ts +1 -1
  25. package/types/sap.m.d.ts +401 -55
  26. package/types/sap.makit.d.ts +1 -1
  27. package/types/sap.me.d.ts +1 -1
  28. package/types/sap.ndc.d.ts +106 -2
  29. package/types/sap.ovp.d.ts +1 -1
  30. package/types/sap.rules.ui.d.ts +1 -1
  31. package/types/sap.sac.df.d.ts +13 -3735
  32. package/types/sap.suite.ui.commons.d.ts +1 -1
  33. package/types/sap.suite.ui.generic.template.d.ts +28 -1
  34. package/types/sap.suite.ui.microchart.d.ts +1 -1
  35. package/types/sap.tnt.d.ts +1 -1
  36. package/types/sap.ui.codeeditor.d.ts +1 -1
  37. package/types/sap.ui.commons.d.ts +1 -1
  38. package/types/sap.ui.comp.d.ts +77 -9
  39. package/types/sap.ui.core.d.ts +1160 -639
  40. package/types/sap.ui.dt.d.ts +1 -1
  41. package/types/sap.ui.export.d.ts +63 -1
  42. package/types/sap.ui.fl.d.ts +1 -1
  43. package/types/sap.ui.generic.app.d.ts +1 -1
  44. package/types/sap.ui.generic.template.d.ts +1 -1
  45. package/types/sap.ui.integration.d.ts +1 -1
  46. package/types/sap.ui.layout.d.ts +100 -94
  47. package/types/sap.ui.mdc.d.ts +1505 -167
  48. package/types/sap.ui.richtexteditor.d.ts +1 -1
  49. package/types/sap.ui.rta.d.ts +1 -1
  50. package/types/sap.ui.suite.d.ts +1 -1
  51. package/types/sap.ui.support.d.ts +1 -1
  52. package/types/sap.ui.table.d.ts +13 -41
  53. package/types/sap.ui.testrecorder.d.ts +1 -1
  54. package/types/sap.ui.unified.d.ts +34 -78
  55. package/types/sap.ui.ux3.d.ts +1 -1
  56. package/types/sap.ui.vbm.d.ts +1 -1
  57. package/types/sap.ui.vk.d.ts +1 -1
  58. package/types/sap.ui.vtm.d.ts +1 -1
  59. package/types/sap.ui.webc.common.d.ts +1 -1
  60. package/types/sap.ui.webc.fiori.d.ts +1 -1
  61. package/types/sap.ui.webc.main.d.ts +1 -1
  62. package/types/sap.uiext.inbox.d.ts +1 -1
  63. package/types/sap.ushell.d.ts +13 -1
  64. package/types/sap.ushell_abap.d.ts +1 -1
  65. package/types/sap.uxap.d.ts +1 -1
  66. package/types/sap.viz.d.ts +1 -1
  67. package/types/sap.webanalytics.core.d.ts +1 -1
  68. package/types/sap.zen.commons.d.ts +335 -1
  69. package/types/sap.zen.crosstab.d.ts +1 -1
  70. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,3738 +1,4 @@
1
- // For Library Version: 1.141.1
2
-
3
- declare module "sap/sac/df/library" {}
4
-
5
- declare module "sap/sac/df/changeHandler/MultiDimModelChangeHandler" {
6
- import { default as Control, $ControlSettings } from "sap/ui/mdc/Control";
7
-
8
- import ElementMetadata from "sap/ui/core/ElementMetadata";
9
-
10
- import MultiDimModel from "sap/sac/df/model/MultiDimModel";
11
-
12
- /**
13
- * Control to handle changes of {@link sap.sac.df.model.MultiDimModel }. To store the changes in {@link sap.ui.fl.variants.VariantManagement }
14
- * you need to include this change handler control as a dependent somewhere in the view tree for which the
15
- * variant management is responsible. Each time new data is fetched and the event `dataLoaded` is fired
16
- * a new change will be created. The method `dataLoaded` needs to be called once to register the {@link sap.sac.df.model.MultiDimModel }
17
- * to the change handler.
18
- *
19
- * @experimental As of version 1.120.
20
- */
21
- export default class MultiDimModelChangeHandler extends Control {
22
- /**
23
- * Constructor for a new `MultiDimModelChangeHandler`.
24
- */
25
- constructor(
26
- /**
27
- * ID for the new control, generated automatically if no ID is given
28
- */
29
- sId?: string
30
- );
31
-
32
- /**
33
- * Creates a new subclass of class sap.sac.df.changeHandler.MultiDimModelChangeHandler with name `sClassName`
34
- * and enriches it with the information contained in `oClassInfo`.
35
- *
36
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.Control.extend}.
37
- *
38
- *
39
- * @returns Created class / constructor function
40
- */
41
- static extend<T extends Record<string, unknown>>(
42
- /**
43
- * Name of the class being created
44
- */
45
- sClassName: string,
46
- /**
47
- * Object literal with information about the class
48
- */
49
- oClassInfo?: sap.ClassInfo<T, MultiDimModelChangeHandler>,
50
- /**
51
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
52
- * used by this class
53
- */
54
- FNMetaImpl?: Function
55
- ): Function;
56
- /**
57
- * Returns a metadata object for class sap.sac.df.changeHandler.MultiDimModelChangeHandler.
58
- *
59
- *
60
- * @returns Metadata object describing this class
61
- */
62
- static getMetadata(): ElementMetadata;
63
- /**
64
- * Register {@link sap.sac.df.model.MultiDimModel} for handling changes
65
- */
66
- registerMultiDimModel(oMultiDimModel: MultiDimModel): void;
67
- /**
68
- * Skip the triggering of the event `apply` once
69
- */
70
- skipApplyModelChangeOnce(): void;
71
- }
72
- /**
73
- * Describes the settings that can be provided to the MultiDimModelChangeHandler constructor.
74
- *
75
- * @experimental As of version 1.120.
76
- */
77
- export interface $MultiDimModelChangeHandlerSettings
78
- extends $ControlSettings {}
79
- }
80
-
81
- declare module "sap/sac/df/DataAnalyzer" {
82
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
83
-
84
- import ElementMetadata from "sap/ui/core/ElementMetadata";
85
-
86
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
87
-
88
- /**
89
- * DataAnalyzer A control to display multi-dimensional data
90
- *
91
- * @experimental As of version 1.132.
92
- */
93
- export default class DataAnalyzer extends Control {
94
- /**
95
- * Constructor for a new `DataAnalyzer` control.
96
- *
97
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
98
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
99
- * of the syntax of the settings object.
100
- */
101
- constructor();
102
-
103
- /**
104
- * Creates a new subclass of class sap.sac.df.DataAnalyzer with name `sClassName` and enriches it with the
105
- * information contained in `oClassInfo`.
106
- *
107
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
108
- *
109
- *
110
- * @returns Created class / constructor function
111
- */
112
- static extend<T extends Record<string, unknown>>(
113
- /**
114
- * Name of the class being created
115
- */
116
- sClassName: string,
117
- /**
118
- * Object literal with information about the class
119
- */
120
- oClassInfo?: sap.ClassInfo<T, DataAnalyzer>,
121
- /**
122
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
123
- * used by this class
124
- */
125
- FNMetaImpl?: Function
126
- ): Function;
127
- /**
128
- * Returns a metadata object for class sap.sac.df.DataAnalyzer.
129
- *
130
- *
131
- * @returns Metadata object describing this class
132
- */
133
- static getMetadata(): ElementMetadata;
134
- /**
135
- * Gets current value of property {@link #getMetaPath metaPath}.
136
- *
137
- * Defines the relative path to the data provider in the multidimensional model.
138
- *
139
- *
140
- * @returns Value of property `metaPath`
141
- */
142
- getMetaPath(): string;
143
- /**
144
- * Gets current value of property {@link #getSelectedPanel selectedPanel}.
145
- *
146
- * Selected panel item of type {@link sap.sac.df.types.DataAnalyzerPanelName DataAnalyzerPanelName}
147
- *
148
- *
149
- * @returns Value of property `selectedPanel`
150
- */
151
- getSelectedPanel(): string;
152
- /**
153
- * Gets current value of property {@link #getShowTitle showTitle}.
154
- *
155
- * Show / hide title
156
- *
157
- * Default value is `false`.
158
- *
159
- *
160
- * @returns Value of property `showTitle`
161
- */
162
- getShowTitle(): boolean;
163
- /**
164
- * Gets current value of property {@link #getShowVisualizationType showVisualizationType}.
165
- *
166
- * Show visualization type
167
- *
168
- *
169
- * @returns Value of property `showVisualizationType`
170
- */
171
- getShowVisualizationType(): boolean;
172
- /**
173
- * Gets current value of property {@link #getTitle title}.
174
- *
175
- * Title
176
- *
177
- *
178
- * @returns Value of property `title`
179
- */
180
- getTitle(): string;
181
- /**
182
- * Sets a new value for property {@link #getMetaPath metaPath}.
183
- *
184
- * Defines the relative path to the data provider in the multidimensional model.
185
- *
186
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
187
- *
188
- *
189
- * @returns Reference to `this` in order to allow method chaining
190
- */
191
- setMetaPath(
192
- /**
193
- * New value for property `metaPath`
194
- */
195
- sMetaPath: string
196
- ): this;
197
- /**
198
- * Sets a new value for property {@link #getSelectedPanel selectedPanel}.
199
- *
200
- * Selected panel item of type {@link sap.sac.df.types.DataAnalyzerPanelName DataAnalyzerPanelName}
201
- *
202
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
203
- *
204
- *
205
- * @returns Reference to `this` in order to allow method chaining
206
- */
207
- setSelectedPanel(
208
- /**
209
- * New value for property `selectedPanel`
210
- */
211
- sSelectedPanel: string
212
- ): this;
213
- /**
214
- * Sets a new value for property {@link #getShowTitle showTitle}.
215
- *
216
- * Show / hide title
217
- *
218
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
219
- *
220
- * Default value is `false`.
221
- *
222
- *
223
- * @returns Reference to `this` in order to allow method chaining
224
- */
225
- setShowTitle(
226
- /**
227
- * New value for property `showTitle`
228
- */
229
- bShowTitle?: boolean
230
- ): this;
231
- /**
232
- * Sets a new value for property {@link #getShowVisualizationType showVisualizationType}.
233
- *
234
- * Show visualization type
235
- *
236
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
237
- *
238
- *
239
- * @returns Reference to `this` in order to allow method chaining
240
- */
241
- setShowVisualizationType(
242
- /**
243
- * New value for property `showVisualizationType`
244
- */
245
- bShowVisualizationType: boolean
246
- ): this;
247
- /**
248
- * Sets a new value for property {@link #getTitle title}.
249
- *
250
- * Title
251
- *
252
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
253
- *
254
- *
255
- * @returns Reference to `this` in order to allow method chaining
256
- */
257
- setTitle(
258
- /**
259
- * New value for property `title`
260
- */
261
- sTitle: string
262
- ): this;
263
- }
264
- /**
265
- * Describes the settings that can be provided to the DataAnalyzer constructor.
266
- *
267
- * @experimental As of version 1.132.
268
- */
269
- export interface $DataAnalyzerSettings extends $ControlSettings {
270
- /**
271
- * Defines the relative path to the data provider in the multidimensional model.
272
- */
273
- metaPath?: string | PropertyBindingInfo;
274
-
275
- /**
276
- * Selected panel item of type {@link sap.sac.df.types.DataAnalyzerPanelName DataAnalyzerPanelName}
277
- */
278
- selectedPanel?: string | PropertyBindingInfo;
279
-
280
- /**
281
- * Show visualization type
282
- */
283
- showVisualizationType?: boolean | PropertyBindingInfo | `{${string}}`;
284
-
285
- /**
286
- * Show / hide title
287
- */
288
- showTitle?: boolean | PropertyBindingInfo | `{${string}}`;
289
-
290
- /**
291
- * Title
292
- */
293
- title?: string | PropertyBindingInfo;
294
- }
295
- }
296
-
297
- declare module "sap/sac/df/DesignerPanel" {
298
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
299
-
300
- import ElementMetadata from "sap/ui/core/ElementMetadata";
301
-
302
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
303
-
304
- /**
305
- * DesignerPanel A panel control to design layouts / visualizations
306
- *
307
- * @experimental As of version 1.129.
308
- */
309
- export default class DesignerPanel extends Control {
310
- /**
311
- * Constructor for a new `MultiDimDesignerPanel` control.
312
- *
313
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
314
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
315
- * of the syntax of the settings object.
316
- */
317
- constructor();
318
-
319
- /**
320
- * Creates a new subclass of class sap.sac.df.DesignerPanel with name `sClassName` and enriches it with
321
- * the information contained in `oClassInfo`.
322
- *
323
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
324
- *
325
- *
326
- * @returns Created class / constructor function
327
- */
328
- static extend<T extends Record<string, unknown>>(
329
- /**
330
- * Name of the class being created
331
- */
332
- sClassName: string,
333
- /**
334
- * Object literal with information about the class
335
- */
336
- oClassInfo?: sap.ClassInfo<T, DesignerPanel>,
337
- /**
338
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
339
- * used by this class
340
- */
341
- FNMetaImpl?: Function
342
- ): Function;
343
- /**
344
- * Returns a metadata object for class sap.sac.df.DesignerPanel.
345
- *
346
- *
347
- * @returns Metadata object describing this class
348
- */
349
- static getMetadata(): ElementMetadata;
350
- /**
351
- * Gets current value of property {@link #getMetaPath metaPath}.
352
- *
353
- * Defines the relative path to visualization of the corresponding data provider in the multidimensional
354
- * model.
355
- *
356
- *
357
- * @returns Value of property `metaPath`
358
- */
359
- getMetaPath(): string;
360
- /**
361
- * Gets current value of property {@link #getShowAvailableObjects showAvailableObjects}.
362
- *
363
- * Show available objects panel
364
- *
365
- * Default value is `true`.
366
- *
367
- *
368
- * @returns Value of property `showAvailableObjects`
369
- */
370
- getShowAvailableObjects(): boolean;
371
- /**
372
- * Gets current value of property {@link #getShowVisualizationType showVisualizationType}.
373
- *
374
- * Show visualization type
375
- *
376
- * Default value is `false`.
377
- *
378
- *
379
- * @returns Value of property `showVisualizationType`
380
- */
381
- getShowVisualizationType(): boolean;
382
- /**
383
- * Sets a new value for property {@link #getMetaPath metaPath}.
384
- *
385
- * Defines the relative path to visualization of the corresponding data provider in the multidimensional
386
- * model.
387
- *
388
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
389
- *
390
- *
391
- * @returns Reference to `this` in order to allow method chaining
392
- */
393
- setMetaPath(
394
- /**
395
- * New value for property `metaPath`
396
- */
397
- sMetaPath: string
398
- ): this;
399
- /**
400
- * Sets a new value for property {@link #getShowAvailableObjects showAvailableObjects}.
401
- *
402
- * Show available objects panel
403
- *
404
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
405
- *
406
- * Default value is `true`.
407
- *
408
- *
409
- * @returns Reference to `this` in order to allow method chaining
410
- */
411
- setShowAvailableObjects(
412
- /**
413
- * New value for property `showAvailableObjects`
414
- */
415
- bShowAvailableObjects?: boolean
416
- ): this;
417
- /**
418
- * Sets a new value for property {@link #getShowVisualizationType showVisualizationType}.
419
- *
420
- * Show visualization type
421
- *
422
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
423
- *
424
- * Default value is `false`.
425
- *
426
- *
427
- * @returns Reference to `this` in order to allow method chaining
428
- */
429
- setShowVisualizationType(
430
- /**
431
- * New value for property `showVisualizationType`
432
- */
433
- bShowVisualizationType?: boolean
434
- ): this;
435
- }
436
- /**
437
- * Describes the settings that can be provided to the DesignerPanel constructor.
438
- *
439
- * @experimental As of version 1.129.
440
- */
441
- export interface $DesignerPanelSettings extends $ControlSettings {
442
- /**
443
- * Defines the relative path to visualization of the corresponding data provider in the multidimensional
444
- * model.
445
- */
446
- metaPath?: string | PropertyBindingInfo;
447
-
448
- /**
449
- * Show visualization type
450
- */
451
- showVisualizationType?: boolean | PropertyBindingInfo | `{${string}}`;
452
-
453
- /**
454
- * Show available objects panel
455
- */
456
- showAvailableObjects?: boolean | PropertyBindingInfo | `{${string}}`;
457
- }
458
- }
459
-
460
- declare module "sap/sac/df/FilterBar" {
461
- import {
462
- default as FilterBar1,
463
- $FilterBarSettings as $FilterBarSettings1,
464
- } from "sap/ui/mdc/FilterBar";
465
-
466
- import ElementMetadata from "sap/ui/core/ElementMetadata";
467
-
468
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
469
-
470
- /**
471
- * A Filter Bar based on Multidimensional Model
472
- *
473
- * @experimental As of version 1.119.
474
- */
475
- export default class FilterBar extends FilterBar1 {
476
- /**
477
- * Constructor for a new Filter Bar.
478
- */
479
- constructor();
480
-
481
- /**
482
- * Creates a new subclass of class sap.sac.df.FilterBar with name `sClassName` and enriches it with the
483
- * information contained in `oClassInfo`.
484
- *
485
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.FilterBar.extend}.
486
- *
487
- *
488
- * @returns Created class / constructor function
489
- */
490
- static extend<T extends Record<string, unknown>>(
491
- /**
492
- * Name of the class being created
493
- */
494
- sClassName: string,
495
- /**
496
- * Object literal with information about the class
497
- */
498
- oClassInfo?: sap.ClassInfo<T, FilterBar>,
499
- /**
500
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
501
- * used by this class
502
- */
503
- FNMetaImpl?: Function
504
- ): Function;
505
- /**
506
- * Returns a metadata object for class sap.sac.df.FilterBar.
507
- *
508
- *
509
- * @returns Metadata object describing this class
510
- */
511
- static getMetadata(): ElementMetadata;
512
- /**
513
- * Gets current value of property {@link #getMetaPath metaPath}.
514
- *
515
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
516
- *
517
- *
518
- * @returns Value of property `metaPath`
519
- */
520
- getMetaPath(): string;
521
- /**
522
- * Sets a new value for property {@link #getMetaPath metaPath}.
523
- *
524
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
525
- *
526
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
527
- *
528
- *
529
- * @returns Reference to `this` in order to allow method chaining
530
- */
531
- setMetaPath(
532
- /**
533
- * New value for property `metaPath`
534
- */
535
- sMetaPath: string
536
- ): this;
537
- }
538
- /**
539
- * Describes the settings that can be provided to the FilterBar constructor.
540
- *
541
- * @experimental As of version 1.119.
542
- */
543
- export interface $FilterBarSettings extends $FilterBarSettings1 {
544
- /**
545
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
546
- */
547
- metaPath?: string | PropertyBindingInfo;
548
- }
549
- }
550
-
551
- declare module "sap/sac/df/FilterField" {
552
- import {
553
- default as FilterField1,
554
- $FilterFieldSettings as $FilterFieldSettings1,
555
- } from "sap/ui/mdc/FilterField";
556
-
557
- import { IFormContent, ISemanticFormContent } from "sap/ui/core/library";
558
-
559
- import { IOverflowToolbarContent } from "sap/m/library";
560
-
561
- import ElementMetadata from "sap/ui/core/ElementMetadata";
562
-
563
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
564
-
565
- /**
566
- * The `FilterField` control is used to filter data based on the conditions. The conditions are managed
567
- * in the corresponding {@link sap.ui.mdc.condition.ConditionModel ConditionModel}.
568
- *
569
- * @experimental As of version 1.121.
570
- */
571
- export default class FilterField
572
- extends FilterField1
573
- implements IFormContent, ISemanticFormContent, IOverflowToolbarContent
574
- {
575
- __implements__sap_ui_core_IFormContent: boolean;
576
- __implements__sap_ui_core_ISemanticFormContent: boolean;
577
- __implements__sap_m_IOverflowToolbarContent: boolean;
578
- /**
579
- * Constructor for a new `FilterField`.
580
- */
581
- constructor(
582
- /**
583
- * Initial settings for the new control
584
- */
585
- mSettings?: $FilterFieldSettings
586
- );
587
- /**
588
- * Constructor for a new `FilterField`.
589
- */
590
- constructor(
591
- /**
592
- * ID for the new control, generated automatically if no ID is given
593
- */
594
- sId?: string,
595
- /**
596
- * Initial settings for the new control
597
- */
598
- mSettings?: $FilterFieldSettings
599
- );
600
-
601
- /**
602
- * Creates a new subclass of class sap.sac.df.FilterField with name `sClassName` and enriches it with the
603
- * information contained in `oClassInfo`.
604
- *
605
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.FilterField.extend}.
606
- *
607
- *
608
- * @returns Created class / constructor function
609
- */
610
- static extend<T extends Record<string, unknown>>(
611
- /**
612
- * Name of the class being created
613
- */
614
- sClassName: string,
615
- /**
616
- * Object literal with information about the class
617
- */
618
- oClassInfo?: sap.ClassInfo<T, FilterField>,
619
- /**
620
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
621
- * used by this class
622
- */
623
- FNMetaImpl?: Function
624
- ): Function;
625
- /**
626
- * Returns a metadata object for class sap.sac.df.FilterField.
627
- *
628
- *
629
- * @returns Metadata object describing this class
630
- */
631
- static getMetadata(): ElementMetadata;
632
- /**
633
- * Gets current value of property {@link #getMetaPath metaPath}.
634
- *
635
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
636
- *
637
- *
638
- * @returns Value of property `metaPath`
639
- */
640
- getMetaPath(): string;
641
- /**
642
- * Sets a new value for property {@link #getMetaPath metaPath}.
643
- *
644
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
645
- *
646
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
647
- *
648
- *
649
- * @returns Reference to `this` in order to allow method chaining
650
- */
651
- setMetaPath(
652
- /**
653
- * New value for property `metaPath`
654
- */
655
- sMetaPath: string
656
- ): this;
657
- }
658
- /**
659
- * Describes the settings that can be provided to the FilterField constructor.
660
- *
661
- * @experimental As of version 1.121.
662
- */
663
- export interface $FilterFieldSettings extends $FilterFieldSettings1 {
664
- /**
665
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
666
- */
667
- metaPath?: string | PropertyBindingInfo;
668
- }
669
- }
670
-
671
- declare module "sap/sac/df/FilterPanel" {
672
- import Metadata from "sap/ui/base/Metadata";
673
-
674
- /**
675
- * A Filter Panel based on Multidimensional Model
676
- *
677
- * @experimental As of version 1.128.
678
- */
679
- export default class FilterPanel
680
- extends /* was: sap.ui.mdc.p13n.panels.FilterPanel */ Object
681
- {
682
- /**
683
- * Constructor for a new Filter Panel.
684
- *
685
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
686
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
687
- * of the syntax of the settings object.
688
- */
689
- constructor();
690
-
691
- /**
692
- * Creates a new subclass of class sap.sac.df.FilterPanel with name `sClassName` and enriches it with the
693
- * information contained in `oClassInfo`.
694
- *
695
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.p13n.panels.FilterPanel.extend}.
696
- *
697
- *
698
- * @returns Created class / constructor function
699
- */
700
- static extend<T extends Record<string, unknown>>(
701
- /**
702
- * Name of the class being created
703
- */
704
- sClassName: string,
705
- /**
706
- * Object literal with information about the class
707
- */
708
- oClassInfo?: sap.ClassInfo<T, FilterPanel>,
709
- /**
710
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
711
- * used by this class
712
- */
713
- FNMetaImpl?: Function
714
- ): Function;
715
- /**
716
- * Returns a metadata object for class sap.sac.df.FilterPanel.
717
- *
718
- *
719
- * @returns Metadata object describing this class
720
- */
721
- static getMetadata(): Metadata;
722
- /**
723
- * Gets current value of property {@link #getEnableReorder enableReorder}.
724
- *
725
- * Determines whether the reordering of personalization items is enabled.
726
- *
727
- * Default value is `false`.
728
- *
729
- *
730
- * @returns Value of property `enableReorder`
731
- */
732
- getEnableReorder(): boolean;
733
- /**
734
- * Gets current value of property {@link #getMetaPath metaPath}.
735
- *
736
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
737
- *
738
- *
739
- * @returns Value of property `metaPath`
740
- */
741
- getMetaPath(): string;
742
- /**
743
- * Sets a new value for property {@link #getEnableReorder enableReorder}.
744
- *
745
- * Determines whether the reordering of personalization items is enabled.
746
- *
747
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
748
- *
749
- * Default value is `false`.
750
- *
751
- *
752
- * @returns Reference to `this` in order to allow method chaining
753
- */
754
- setEnableReorder(
755
- /**
756
- * New value for property `enableReorder`
757
- */
758
- bEnableReorder?: boolean
759
- ): this;
760
- /**
761
- * Sets a new value for property {@link #getMetaPath metaPath}.
762
- *
763
- * Defines the relative path of the property in the metamodel, based on the current contextPath.
764
- *
765
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
766
- *
767
- *
768
- * @returns Reference to `this` in order to allow method chaining
769
- */
770
- setMetaPath(
771
- /**
772
- * New value for property `metaPath`
773
- */
774
- sMetaPath: string
775
- ): this;
776
- }
777
- }
778
-
779
- declare module "sap/sac/df/Grid" {
780
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
781
-
782
- import ElementMetadata from "sap/ui/core/ElementMetadata";
783
-
784
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
785
-
786
- import Event from "sap/ui/base/Event";
787
-
788
- /**
789
- * Grid A grid control for displaying multi-dimensional data
790
- *
791
- * @experimental As of version 1.129.
792
- */
793
- export default class Grid extends Control {
794
- /**
795
- * Constructor for a new `Grid` control.
796
- *
797
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
798
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
799
- * of the syntax of the settings object.
800
- */
801
- constructor();
802
-
803
- /**
804
- * Creates a new subclass of class sap.sac.df.Grid with name `sClassName` and enriches it with the information
805
- * contained in `oClassInfo`.
806
- *
807
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
808
- *
809
- *
810
- * @returns Created class / constructor function
811
- */
812
- static extend<T extends Record<string, unknown>>(
813
- /**
814
- * Name of the class being created
815
- */
816
- sClassName: string,
817
- /**
818
- * Object literal with information about the class
819
- */
820
- oClassInfo?: sap.ClassInfo<T, Grid>,
821
- /**
822
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
823
- * used by this class
824
- */
825
- FNMetaImpl?: Function
826
- ): Function;
827
- /**
828
- * Returns a metadata object for class sap.sac.df.Grid.
829
- *
830
- *
831
- * @returns Metadata object describing this class
832
- */
833
- static getMetadata(): ElementMetadata;
834
- /**
835
- * Attaches event handler `fnFunction` to the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.Grid`.
836
- *
837
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
838
- * otherwise it will be bound to this `sap.sac.df.Grid` itself.
839
- *
840
- * Fires on cell click event
841
- *
842
- *
843
- * @returns Reference to `this` in order to allow method chaining
844
- */
845
- attachOnCellClick(
846
- /**
847
- * An application-specific payload object that will be passed to the event handler along with the event
848
- * object when firing the event
849
- */
850
- oData: object,
851
- /**
852
- * The function to be called when the event occurs
853
- */
854
- fnFunction: (p1: Grid$OnCellClickEvent) => void,
855
- /**
856
- * Context object to call the event handler with. Defaults to this `sap.sac.df.Grid` itself
857
- */
858
- oListener?: object
859
- ): this;
860
- /**
861
- * Attaches event handler `fnFunction` to the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.Grid`.
862
- *
863
- * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
864
- * otherwise it will be bound to this `sap.sac.df.Grid` itself.
865
- *
866
- * Fires on cell click event
867
- *
868
- *
869
- * @returns Reference to `this` in order to allow method chaining
870
- */
871
- attachOnCellClick(
872
- /**
873
- * The function to be called when the event occurs
874
- */
875
- fnFunction: (p1: Grid$OnCellClickEvent) => void,
876
- /**
877
- * Context object to call the event handler with. Defaults to this `sap.sac.df.Grid` itself
878
- */
879
- oListener?: object
880
- ): this;
881
- /**
882
- * Detaches event handler `fnFunction` from the {@link #event:onCellClick onCellClick} event of this `sap.sac.df.Grid`.
883
- *
884
- * The passed function and listener object must match the ones used for event registration.
885
- *
886
- *
887
- * @returns Reference to `this` in order to allow method chaining
888
- */
889
- detachOnCellClick(
890
- /**
891
- * The function to be called, when the event occurs
892
- */
893
- fnFunction: (p1: Grid$OnCellClickEvent) => void,
894
- /**
895
- * Context object on which the given function had to be called
896
- */
897
- oListener?: object
898
- ): this;
899
- /**
900
- * Fires event {@link #event:onCellClick onCellClick} to attached listeners.
901
- *
902
- * @ui5-protected Do not call from applications (only from related classes in the framework)
903
- *
904
- * @returns Reference to `this` in order to allow method chaining
905
- */
906
- fireOnCellClick(
907
- /**
908
- * Parameters to pass along with the event
909
- */
910
- mParameters?: Grid$OnCellClickEventParameters
911
- ): this;
912
- /**
913
- * Gets current value of property {@link #getMetaPath metaPath}.
914
- *
915
- * Defines the relative path to the data provider in the multidimensional model.
916
- *
917
- *
918
- * @returns Value of property `metaPath`
919
- */
920
- getMetaPath(): string;
921
- /**
922
- * Gets current value of property {@link #getShowStatusBar showStatusBar}.
923
- *
924
- * Show / hide status bar
925
- *
926
- * Default value is `false`.
927
- *
928
- *
929
- * @returns Value of property `showStatusBar`
930
- */
931
- getShowStatusBar(): boolean;
932
- /**
933
- * Gets current value of property {@link #getShowTitle showTitle}.
934
- *
935
- * Show / hide title
936
- *
937
- * Default value is `false`.
938
- *
939
- *
940
- * @returns Value of property `showTitle`
941
- */
942
- getShowTitle(): boolean;
943
- /**
944
- * Gets current value of property {@link #getTitle title}.
945
- *
946
- * Title
947
- *
948
- *
949
- * @returns Value of property `title`
950
- */
951
- getTitle(): string;
952
- /**
953
- * Sets a new value for property {@link #getMetaPath metaPath}.
954
- *
955
- * Defines the relative path to the data provider in the multidimensional model.
956
- *
957
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
958
- *
959
- *
960
- * @returns Reference to `this` in order to allow method chaining
961
- */
962
- setMetaPath(
963
- /**
964
- * New value for property `metaPath`
965
- */
966
- sMetaPath: string
967
- ): this;
968
- /**
969
- * Sets a new value for property {@link #getShowStatusBar showStatusBar}.
970
- *
971
- * Show / hide status bar
972
- *
973
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
974
- *
975
- * Default value is `false`.
976
- *
977
- *
978
- * @returns Reference to `this` in order to allow method chaining
979
- */
980
- setShowStatusBar(
981
- /**
982
- * New value for property `showStatusBar`
983
- */
984
- bShowStatusBar?: boolean
985
- ): this;
986
- /**
987
- * Sets a new value for property {@link #getShowTitle showTitle}.
988
- *
989
- * Show / hide title
990
- *
991
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
992
- *
993
- * Default value is `false`.
994
- *
995
- *
996
- * @returns Reference to `this` in order to allow method chaining
997
- */
998
- setShowTitle(
999
- /**
1000
- * New value for property `showTitle`
1001
- */
1002
- bShowTitle?: boolean
1003
- ): this;
1004
- /**
1005
- * Sets a new value for property {@link #getTitle title}.
1006
- *
1007
- * Title
1008
- *
1009
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1010
- *
1011
- *
1012
- * @returns Reference to `this` in order to allow method chaining
1013
- */
1014
- setTitle(
1015
- /**
1016
- * New value for property `title`
1017
- */
1018
- sTitle: string
1019
- ): this;
1020
- }
1021
- /**
1022
- * Describes the settings that can be provided to the Grid constructor.
1023
- *
1024
- * @experimental As of version 1.129.
1025
- */
1026
- export interface $GridSettings extends $ControlSettings {
1027
- /**
1028
- * Defines the relative path to the data provider in the multidimensional model.
1029
- */
1030
- metaPath?: string | PropertyBindingInfo;
1031
-
1032
- /**
1033
- * Show / hide status bar
1034
- */
1035
- showStatusBar?: boolean | PropertyBindingInfo | `{${string}}`;
1036
-
1037
- /**
1038
- * Show / hide title
1039
- */
1040
- showTitle?: boolean | PropertyBindingInfo | `{${string}}`;
1041
-
1042
- /**
1043
- * Title
1044
- */
1045
- title?: string | PropertyBindingInfo;
1046
-
1047
- /**
1048
- * Fires on cell click event
1049
- */
1050
- onCellClick?: (oEvent: Grid$OnCellClickEvent) => void;
1051
- }
1052
-
1053
- /**
1054
- * Parameters of the Grid#onCellClick event.
1055
- */
1056
- export interface Grid$OnCellClickEventParameters {
1057
- /**
1058
- * Cell context
1059
- */
1060
- cellContext?: object;
1061
- }
1062
-
1063
- /**
1064
- * Event object of the Grid#onCellClick event.
1065
- */
1066
- export type Grid$OnCellClickEvent = Event<
1067
- Grid$OnCellClickEventParameters,
1068
- Grid
1069
- >;
1070
- }
1071
-
1072
- declare module "sap/sac/df/model/Configuration" {
1073
- import BaseObject from "sap/ui/base/Object";
1074
-
1075
- import Metadata from "sap/ui/base/Metadata";
1076
-
1077
- import StylingPanelItem from "sap/sac/df/types/configuration/StylingPanelItem";
1078
-
1079
- import TableTemplate from "sap/sac/df/types/configuration/TableTemplate";
1080
-
1081
- /**
1082
- * Configuration of the multidimensional model and its components
1083
- *
1084
- * @experimental As of version 1.132.
1085
- */
1086
- export default class Configuration extends BaseObject {
1087
- /**
1088
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1089
- */
1090
- protected constructor();
1091
-
1092
- /**
1093
- * Creates a new subclass of class sap.sac.df.model.Configuration with name `sClassName` and enriches it
1094
- * with the information contained in `oClassInfo`.
1095
- *
1096
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1097
- *
1098
- *
1099
- * @returns Created class / constructor function
1100
- */
1101
- static extend<T extends Record<string, unknown>>(
1102
- /**
1103
- * Name of the class being created
1104
- */
1105
- sClassName: string,
1106
- /**
1107
- * Object literal with information about the class
1108
- */
1109
- oClassInfo?: sap.ClassInfo<T, Configuration>,
1110
- /**
1111
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1112
- * used by this class
1113
- */
1114
- FNMetaImpl?: Function
1115
- ): Function;
1116
- /**
1117
- * Returns a metadata object for class sap.sac.df.model.Configuration.
1118
- *
1119
- *
1120
- * @returns Metadata object describing this class
1121
- */
1122
- static getMetadata(): Metadata;
1123
- /**
1124
- * Gets current value of property {@link #getCalculations Calculations}.
1125
- *
1126
- * Calculations
1127
- *
1128
- * Default value is `true`.
1129
- *
1130
- * @experimental As of version 1.132.
1131
- *
1132
- * @returns Value of property `Calculations`
1133
- */
1134
- getCalculations(): boolean;
1135
- /**
1136
- * Gets current value of property {@link #getCommenting Commenting}.
1137
- *
1138
- * Commenting
1139
- *
1140
- * Default value is `false`.
1141
- *
1142
- * @experimental As of version 1.132.
1143
- *
1144
- * @returns Value of property `Commenting`
1145
- */
1146
- getCommenting(): boolean;
1147
- /**
1148
- * Gets current value of property {@link #getContextMenuVariant ContextMenuVariant}.
1149
- *
1150
- * Variant of context menu configuration
1151
- *
1152
- * Default value is `sapui5`.
1153
- *
1154
- * @experimental As of version 1.132.
1155
- *
1156
- * @returns Value of property `ContextMenuVariant`
1157
- */
1158
- getContextMenuVariant(): /* was: sap.sac.df.types.configuration.ContextMenuVariant */ any;
1159
- /**
1160
- * Gets current value of property {@link #getImplicitVariableHandling ImplicitVariableHandling}.
1161
- *
1162
- * Implicit variable handling
1163
- *
1164
- * Default value is `false`.
1165
- *
1166
- * @experimental As of version 1.136.
1167
- *
1168
- * @returns Value of property `ImplicitVariableHandling`
1169
- */
1170
- getImplicitVariableHandling(): boolean;
1171
- /**
1172
- * Gets current value of property {@link #getStylingPanelItems StylingPanelItems}.
1173
- *
1174
- * Styling Panel Items
1175
- *
1176
- * Default value is `[TableProperties, NumberFormatting]`.
1177
- *
1178
- * @experimental As of version 1.132.
1179
- *
1180
- * @returns Value of property `StylingPanelItems`
1181
- */
1182
- getStylingPanelItems(): StylingPanelItem[];
1183
- /**
1184
- * Gets current value of property {@link #getTableTemplates TableTemplates}.
1185
- *
1186
- * Available Table Templates
1187
- *
1188
- * Default value is `[Default, Basic]`.
1189
- *
1190
- * @experimental As of version 1.135.
1191
- *
1192
- * @returns Value of property `TableTemplates`
1193
- */
1194
- getTableTemplates(): TableTemplate[];
1195
- /**
1196
- * Gets current value of property {@link #getTableTemplateSelection TableTemplateSelection}.
1197
- *
1198
- * Default table template selection
1199
- *
1200
- * Default value is `TableTemplate.Default`.
1201
- *
1202
- * @experimental As of version 1.135.
1203
- *
1204
- * @returns Value of property `TableTemplateSelection`
1205
- */
1206
- getTableTemplateSelection(): String;
1207
- /**
1208
- * Sets a new value for property {@link #getCalculations Calculations}.
1209
- *
1210
- * Calculations
1211
- *
1212
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1213
- *
1214
- * Default value is `true`.
1215
- *
1216
- * @experimental As of version 1.132.
1217
- *
1218
- * @returns Reference to `this` in order to allow method chaining
1219
- */
1220
- setCalculations(
1221
- /**
1222
- * New value for property `Calculations`
1223
- */
1224
- bCalculations?: boolean
1225
- ): this;
1226
- /**
1227
- * Sets a new value for property {@link #getCommenting Commenting}.
1228
- *
1229
- * Commenting
1230
- *
1231
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1232
- *
1233
- * Default value is `false`.
1234
- *
1235
- * @experimental As of version 1.132.
1236
- *
1237
- * @returns Reference to `this` in order to allow method chaining
1238
- */
1239
- setCommenting(
1240
- /**
1241
- * New value for property `Commenting`
1242
- */
1243
- bCommenting?: boolean
1244
- ): this;
1245
- /**
1246
- * Sets a new value for property {@link #getContextMenuVariant ContextMenuVariant}.
1247
- *
1248
- * Variant of context menu configuration
1249
- *
1250
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1251
- *
1252
- * Default value is `sapui5`.
1253
- *
1254
- * @experimental As of version 1.132.
1255
- *
1256
- * @returns Reference to `this` in order to allow method chaining
1257
- */
1258
- setContextMenuVariant(
1259
- /**
1260
- * New value for property `ContextMenuVariant`
1261
- */
1262
- sContextMenuVariant?: /* was: sap.sac.df.types.configuration.ContextMenuVariant */ any
1263
- ): this;
1264
- /**
1265
- * Sets a new value for property {@link #getImplicitVariableHandling ImplicitVariableHandling}.
1266
- *
1267
- * Implicit variable handling
1268
- *
1269
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1270
- *
1271
- * Default value is `false`.
1272
- *
1273
- * @experimental As of version 1.136.
1274
- *
1275
- * @returns Reference to `this` in order to allow method chaining
1276
- */
1277
- setImplicitVariableHandling(
1278
- /**
1279
- * New value for property `ImplicitVariableHandling`
1280
- */
1281
- bImplicitVariableHandling?: boolean
1282
- ): this;
1283
- /**
1284
- * Sets a new value for property {@link #getStylingPanelItems StylingPanelItems}.
1285
- *
1286
- * Styling Panel Items
1287
- *
1288
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1289
- *
1290
- * Default value is `[TableProperties, NumberFormatting]`.
1291
- *
1292
- * @experimental As of version 1.132.
1293
- *
1294
- * @returns Reference to `this` in order to allow method chaining
1295
- */
1296
- setStylingPanelItems(
1297
- /**
1298
- * New value for property `StylingPanelItems`
1299
- */
1300
- sStylingPanelItems?: Array<
1301
- StylingPanelItem | keyof typeof StylingPanelItem
1302
- >
1303
- ): this;
1304
- /**
1305
- * Sets a new value for property {@link #getTableTemplates TableTemplates}.
1306
- *
1307
- * Available Table Templates
1308
- *
1309
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1310
- *
1311
- * Default value is `[Default, Basic]`.
1312
- *
1313
- * @experimental As of version 1.135.
1314
- *
1315
- * @returns Reference to `this` in order to allow method chaining
1316
- */
1317
- setTableTemplates(
1318
- /**
1319
- * New value for property `TableTemplates`
1320
- */
1321
- sTableTemplates?: Array<TableTemplate | keyof typeof TableTemplate>
1322
- ): this;
1323
- /**
1324
- * Sets a new value for property {@link #getTableTemplateSelection TableTemplateSelection}.
1325
- *
1326
- * Default table template selection
1327
- *
1328
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
1329
- *
1330
- * Default value is `TableTemplate.Default`.
1331
- *
1332
- * @experimental As of version 1.135.
1333
- *
1334
- * @returns Reference to `this` in order to allow method chaining
1335
- */
1336
- setTableTemplateSelection(
1337
- /**
1338
- * New value for property `TableTemplateSelection`
1339
- */
1340
- sTableTemplateSelection?: String
1341
- ): this;
1342
- }
1343
- }
1344
-
1345
- declare module "sap/sac/df/model/DataProvider" {
1346
- import JSONModel from "sap/ui/model/json/JSONModel";
1347
-
1348
- import DataSourceInfo from "sap/sac/df/model/DataSourceInfo";
1349
-
1350
- import Dimension from "sap/sac/df/model/Dimension";
1351
-
1352
- import Variable from "sap/sac/df/model/Variable";
1353
-
1354
- import Metadata from "sap/ui/base/Metadata";
1355
-
1356
- import Event from "sap/ui/base/Event";
1357
-
1358
- import DataSourceType from "sap/sac/df/types/DataSourceType";
1359
-
1360
- /**
1361
- * A data provider is an analytical query exposed via an analytical engine and accessed via InA protocol.
1362
- * It represents a navigable query manager and allows to access and change data. Instances of this class
1363
- * should only be created by the {@link sap.sac.df.model.MultiDimModel}.
1364
- *
1365
- * **Structure of Exposed Data:**
1366
- * ```javascript
1367
- *
1368
- * "Name": "",
1369
- * "DataSourceInfo": { },
1370
- * "Variables": { }
1371
- * "Dimensions": { },
1372
- * "Measures": [ ],
1373
- * "Messages": [ ]
1374
- * "AutoFetchEnabled": ""
1375
- * ```
1376
- *
1377
- *
1378
- * @experimental As of version 1.119.
1379
- */
1380
- export default class DataProvider extends JSONModel {
1381
- /**
1382
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1383
- */
1384
- protected constructor();
1385
- /**
1386
- * Indicator if the result set should be fetched automatically. The default value is true.
1387
- */
1388
- AutoFetchEnabled: boolean;
1389
-
1390
- /**
1391
- * DataSourceInfo
1392
- */
1393
- DataSourceInfo: DataSourceInfo;
1394
-
1395
- /**
1396
- * Dimensions
1397
- */
1398
- Dimensions: Record<string, Dimension>;
1399
-
1400
- /**
1401
- * Measures
1402
- */
1403
- Measures: Record<string, /* was: sap.sac.df.model.Measure */ any>;
1404
-
1405
- /**
1406
- * Variables
1407
- */
1408
- Variables: Record<string, Variable>;
1409
-
1410
- /**
1411
- * Visualizations
1412
- */
1413
- Visualizations: Record<
1414
- string,
1415
- /* was: sap.sac.df.model.Visualization */ any
1416
- >;
1417
-
1418
- /**
1419
- * Creates a new subclass of class sap.sac.df.model.DataProvider with name `sClassName` and enriches it
1420
- * with the information contained in `oClassInfo`.
1421
- *
1422
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.json.JSONModel.extend}.
1423
- *
1424
- *
1425
- * @returns Created class / constructor function
1426
- */
1427
- static extend<T extends Record<string, unknown>>(
1428
- /**
1429
- * Name of the class being created
1430
- */
1431
- sClassName: string,
1432
- /**
1433
- * Object literal with information about the class
1434
- */
1435
- oClassInfo?: sap.ClassInfo<T, DataProvider>,
1436
- /**
1437
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1438
- * used by this class
1439
- */
1440
- FNMetaImpl?: Function
1441
- ): Function;
1442
- /**
1443
- * Returns a metadata object for class sap.sac.df.model.DataProvider.
1444
- *
1445
- *
1446
- * @returns Metadata object describing this class
1447
- */
1448
- static getMetadata(): Metadata;
1449
- /**
1450
- * Add new visualization
1451
- *
1452
- *
1453
- * @returns Returns visualization
1454
- */
1455
- addVisualization(
1456
- /**
1457
- * visualization name
1458
- */
1459
- sName: string,
1460
- /**
1461
- * type of visualization
1462
- */
1463
- sType: /* was: sap.sac.df.types.VisualizationType */ any
1464
- ): /* was: sap.sac.df.model.Visualization */ any;
1465
- /**
1466
- * Execute scenario on data provider
1467
- *
1468
- * @experimental As of version 1.134.
1469
- *
1470
- * @returns Promise with reference to created scenario
1471
- */
1472
- createScenario(
1473
- /**
1474
- * scenario
1475
- */
1476
- sScenarioId: undefined
1477
- ): Promise</* was: sap.sac.df.Scenario */ any>;
1478
- /**
1479
- * Updates the multidimensional model from the given the state of a data provider
1480
- *
1481
- *
1482
- * @returns Promise with reference to this in order to allow method chaining
1483
- */
1484
- deserialize(
1485
- /**
1486
- * the JSON object containing the persisted state of a data provider to be applied.
1487
- */
1488
- oModelState: object,
1489
- /**
1490
- * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
1491
- */
1492
- sFormat?: string,
1493
- /**
1494
- * Indicator if the data provider updated should be suppressed after deserialization
1495
- */
1496
- bSuppressUpdate?: boolean
1497
- ): Promise<this>;
1498
- /**
1499
- * Export Data
1500
- */
1501
- exportData(
1502
- /**
1503
- * Data export configuration
1504
- */
1505
- oDataExportConfig: object
1506
- ): void;
1507
- /**
1508
- * Fires event {@link #event:dataUpdated dataUpdated} to attached listeners.
1509
- *
1510
- *
1511
- * @returns Reference to this in order to allow method chaining
1512
- */
1513
- fireDataUpdated(
1514
- /**
1515
- * Parameters to pass along with the event
1516
- */
1517
- oParameters?: object
1518
- ): this;
1519
- /**
1520
- * Fires event {@link #event:visualizationAdded visualizationAdded} to attached listeners.
1521
- *
1522
- *
1523
- * @returns Reference to this in order to allow method chaining
1524
- */
1525
- fireVisualizationAdded(
1526
- /**
1527
- * Parameters to pass along with the event
1528
- */
1529
- oParameters?: object
1530
- ): this;
1531
- /**
1532
- * Fires event {@link #event:visualizationRemoved visualizationRemoved} to attached listeners.
1533
- *
1534
- *
1535
- * @returns Reference to this in order to allow method chaining
1536
- */
1537
- fireVisualizationRemoved(
1538
- /**
1539
- * Parameters to pass along with the event
1540
- */
1541
- oParameters?: object
1542
- ): this;
1543
- /**
1544
- * Get the property AutoFetchEnabled
1545
- */
1546
- getAutoFetchEnabled(): boolean;
1547
- /**
1548
- * Get data source information
1549
- *
1550
- *
1551
- * @returns data source information object
1552
- */
1553
- getDataSourceInfo(): DataSourceInfo;
1554
- /**
1555
- * Get the scaling factor of a measure or cell
1556
- *
1557
- *
1558
- * @returns Number of decimal places
1559
- */
1560
- getDecimalPlaces(
1561
- /**
1562
- * Measure structure member
1563
- */
1564
- sMeasureStructureMember: string,
1565
- /**
1566
- * Structure (non-measure) member
1567
- */
1568
- sStructureMember: string
1569
- ): int;
1570
- /**
1571
- * Get Dimension
1572
- *
1573
- *
1574
- * @returns Dimension object
1575
- */
1576
- getDimension(
1577
- /**
1578
- * Dimension name
1579
- */
1580
- sDimensionName: string
1581
- ): Dimension;
1582
- /**
1583
- * Get all dimensions
1584
- *
1585
- *
1586
- * @returns Object of all dimensions
1587
- */
1588
- getDimensions(): Record<string, Dimension>;
1589
- /**
1590
- * Get grid visualization
1591
- *
1592
- *
1593
- * @returns visualization object if found
1594
- */
1595
- getGridVisualization(): /* was: sap.sac.df.model.Visualization */ any;
1596
- /**
1597
- * Get measure
1598
- *
1599
- *
1600
- * @returns Measure object
1601
- */
1602
- getMeasure(
1603
- /**
1604
- * Measure name
1605
- */
1606
- sMeasureName: string
1607
- ): /* was: sap.sac.df.model.Measure */ any;
1608
- /**
1609
- * Get all measures
1610
- *
1611
- *
1612
- * @returns Object of all measures
1613
- */
1614
- getMeasures(): Record<string, /* was: sap.sac.df.model.Measure */ any>;
1615
- /**
1616
- * Get Measure Structure Dimension
1617
- *
1618
- *
1619
- * @returns Measure structure dimension
1620
- */
1621
- getMeasureStructureDimension(): Dimension;
1622
- /**
1623
- * Get the scaling factor of a measure or cell
1624
- *
1625
- *
1626
- * @returns Scaling factor
1627
- */
1628
- getScalingFactor(
1629
- /**
1630
- * Measure structure member
1631
- */
1632
- sMeasureStructureMember: string,
1633
- /**
1634
- * Structure (non-measure) member
1635
- */
1636
- sStructureMember: string
1637
- ): int;
1638
- /**
1639
- * Get structure (non-measure) dimension
1640
- *
1641
- *
1642
- * @returns Structure dimension object
1643
- */
1644
- getStructureDimension(): Dimension;
1645
- /**
1646
- * Get Variable
1647
- *
1648
- *
1649
- * @returns Variable object
1650
- */
1651
- getVariable(
1652
- /**
1653
- * Variable Name
1654
- */
1655
- sVariableName: string
1656
- ): Variable;
1657
- /**
1658
- * Get all variables
1659
- *
1660
- *
1661
- * @returns Object of all variables
1662
- */
1663
- getVariables(): Record<string, Variable>;
1664
- /**
1665
- * Get visualization
1666
- *
1667
- *
1668
- * @returns visualization object if found
1669
- */
1670
- getVisualization(
1671
- /**
1672
- * visualization name
1673
- */
1674
- sName: String
1675
- ): /* was: sap.sac.df.model.Visualization */ any;
1676
- /**
1677
- * Get all visualizations
1678
- *
1679
- *
1680
- * @returns Object of all visualizations
1681
- */
1682
- getVisualizations(): Record<
1683
- string,
1684
- /* was: sap.sac.df.model.Visualization */ any
1685
- >;
1686
- /**
1687
- * Remove existing visualization from data provider
1688
- *
1689
- *
1690
- * @returns Promise which resolves when the removing s finished
1691
- */
1692
- removeVisualization(
1693
- /**
1694
- * visualization name
1695
- */
1696
- sName: string
1697
- ): Promise<void>;
1698
- /**
1699
- * Serialize the data provider state to a JSON representation
1700
- *
1701
- *
1702
- * @returns A JSON object which represents the data provider
1703
- */
1704
- serialize(
1705
- /**
1706
- * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
1707
- */
1708
- sFormat?: string
1709
- ): object;
1710
- /**
1711
- * Set the property `AutoFetchEnabled`, if the data should be automatically be refreshed on invalid.
1712
- */
1713
- setAutoFetchEnabled(bAutoFetchEnabled: boolean): void;
1714
- /**
1715
- * Set the number of decimal places of a measure or cell
1716
- *
1717
- *
1718
- * @returns Reference to this in order to allow method chaining
1719
- */
1720
- setDecimalPlaces(
1721
- /**
1722
- * Number of the decimal places
1723
- */
1724
- nNumberOfDecimalPlaces: int,
1725
- /**
1726
- * Measure structure member
1727
- */
1728
- sMeasureStructureMember: string,
1729
- /**
1730
- * Structure (non-measure) member
1731
- */
1732
- sStructureMember: string
1733
- ): this;
1734
- /**
1735
- * Set the scaling factor of a measure or cell
1736
- *
1737
- *
1738
- * @returns Reference to this in order to allow method chaining
1739
- */
1740
- setScalingFactor(
1741
- /**
1742
- * Scaling factor
1743
- */
1744
- nFactor: int,
1745
- /**
1746
- * Measure structure member
1747
- */
1748
- sMeasureStructureMember: string,
1749
- /**
1750
- * Structure (non-measure) member
1751
- */
1752
- sStructureMember: string
1753
- ): this;
1754
- /**
1755
- * Checks whether an InA capability is supported by the server. Throws an error for unhandled capabilities.
1756
- * List of handled capabilities can be seen in type {@link sap.sac.df.model.Capability}
1757
- *
1758
- *
1759
- * @returns Returns true, if the capability is supported, else false
1760
- */
1761
- supportsCapability(
1762
- /**
1763
- * Capability name
1764
- */
1765
- sCapability: undefined
1766
- ): boolean;
1767
- }
1768
- /**
1769
- * Data provider configuration object.
1770
- *
1771
- * @experimental As of version 1.135.
1772
- */
1773
- export type Configuration = {
1774
- /**
1775
- * name
1776
- */
1777
- Name: string;
1778
- /**
1779
- * data source
1780
- */
1781
- DataSource: Configuration.DataSource;
1782
- /**
1783
- * setup properties
1784
- */
1785
- SetupProperties: Configuration.SetupProperties;
1786
- /**
1787
- * semantic information
1788
- */
1789
- SemanticInfo: object;
1790
- };
1791
-
1792
- /**
1793
- * Parameters of the DataProvider#dataUpdated event.
1794
- */
1795
- export interface DataProvider$DataUpdatedEventParameters {}
1796
-
1797
- /**
1798
- * Event object of the DataProvider#dataUpdated event.
1799
- */
1800
- export type DataProvider$DataUpdatedEvent = Event<
1801
- DataProvider$DataUpdatedEventParameters,
1802
- DataProvider
1803
- >;
1804
-
1805
- /**
1806
- * Parameters of the DataProvider#visualizationAdded event.
1807
- */
1808
- export interface DataProvider$VisualizationAddedEventParameters {}
1809
-
1810
- /**
1811
- * Event object of the DataProvider#visualizationAdded event.
1812
- */
1813
- export type DataProvider$VisualizationAddedEvent = Event<
1814
- DataProvider$VisualizationAddedEventParameters,
1815
- DataProvider
1816
- >;
1817
-
1818
- /**
1819
- * Parameters of the DataProvider#visualizationRemoved event.
1820
- */
1821
- export interface DataProvider$VisualizationRemovedEventParameters {}
1822
-
1823
- /**
1824
- * Event object of the DataProvider#visualizationRemoved event.
1825
- */
1826
- export type DataProvider$VisualizationRemovedEvent = Event<
1827
- DataProvider$VisualizationRemovedEventParameters,
1828
- DataProvider
1829
- >;
1830
-
1831
- export namespace Configuration {
1832
- /**
1833
- * Data provider configuration data source.
1834
- *
1835
- * @experimental As of version 1.135.
1836
- */
1837
- type DataSource = {
1838
- /**
1839
- * name
1840
- */
1841
- Name: string;
1842
- /**
1843
- * type
1844
- */
1845
- Type: DataSourceType | keyof typeof DataSourceType;
1846
- /**
1847
- * system name
1848
- */
1849
- SystemName: string;
1850
- /**
1851
- * package
1852
- */
1853
- Package: string;
1854
- /**
1855
- * schema
1856
- */
1857
- Schema: string;
1858
- };
1859
-
1860
- /**
1861
- * Data provider configuration setup properties.
1862
- *
1863
- * @experimental As of version 1.135.
1864
- */
1865
- type SetupProperties = {
1866
- /**
1867
- * start with auto fetch
1868
- */
1869
- AutoFetch: boolean;
1870
- };
1871
- }
1872
- }
1873
-
1874
- declare module "sap/sac/df/model/DataSourceInfo" {
1875
- import BaseObject from "sap/ui/base/Object";
1876
-
1877
- import Metadata from "sap/ui/base/Metadata";
1878
-
1879
- /**
1880
- * Data source information.
1881
- *
1882
- * **Structure of Exposed Data:**
1883
- * ```javascript
1884
- *
1885
- * "QueryTitle": "",
1886
- * "QueryName": "",
1887
- * "QueryType": "",
1888
- * "SystemName": "",
1889
- * "CreatedBy": "",
1890
- * "CreatedOn": "",
1891
- * "QueryDueDateText": "",
1892
- * "CreatedOnText": "",
1893
- * "QueryDueDate": "",
1894
- * "ResultAlignmentRows": "",
1895
- * "ResultAlignmentColumns": "",
1896
- * "LastUpdated": "",
1897
- * "LastUpdatedBy": "",
1898
- * "LastUpdatedText": ""
1899
- * ```
1900
- *
1901
- *
1902
- * @experimental As of version 1.119.
1903
- */
1904
- export default class DataSourceInfo extends BaseObject {
1905
- /**
1906
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1907
- */
1908
- protected constructor();
1909
-
1910
- /**
1911
- * Creates a new subclass of class sap.sac.df.model.DataSourceInfo with name `sClassName` and enriches it
1912
- * with the information contained in `oClassInfo`.
1913
- *
1914
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1915
- *
1916
- *
1917
- * @returns Created class / constructor function
1918
- */
1919
- static extend<T extends Record<string, unknown>>(
1920
- /**
1921
- * Name of the class being created
1922
- */
1923
- sClassName: string,
1924
- /**
1925
- * Object literal with information about the class
1926
- */
1927
- oClassInfo?: sap.ClassInfo<T, DataSourceInfo>,
1928
- /**
1929
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
1930
- * used by this class
1931
- */
1932
- FNMetaImpl?: Function
1933
- ): Function;
1934
- /**
1935
- * Returns a metadata object for class sap.sac.df.model.DataSourceInfo.
1936
- *
1937
- *
1938
- * @returns Metadata object describing this class
1939
- */
1940
- static getMetadata(): Metadata;
1941
- }
1942
- }
1943
-
1944
- declare module "sap/sac/df/model/Dimension" {
1945
- import BaseObject from "sap/ui/base/Object";
1946
-
1947
- import Metadata from "sap/ui/base/Metadata";
1948
-
1949
- import SortDirection from "sap/sac/df/types/SortDirection";
1950
-
1951
- import SortType from "sap/sac/df/types/SortType";
1952
-
1953
- /**
1954
- * Dimension Object
1955
- *
1956
- * **Structure of Exposed Data:**
1957
- * ```javascript
1958
- *
1959
- * "Name": "",
1960
- * "TechName": "",
1961
- * "Description": "",
1962
- * "Axis": "",
1963
- * "Type": "",
1964
- * "HierarchyActive": "",
1965
- * "HasFilter": "",
1966
- * "MemberFilter": [],
1967
- * "SortDirection": "",
1968
- * "Position": "",
1969
- * "LastPosition": "",
1970
- * "IsStructure": "",
1971
- * "IsMeasureStructure": "",
1972
- * "ValueType": "",
1973
- * "SemanticObject": "",
1974
- * "Members": [{
1975
- * "Key": "",
1976
- * "Name": "",
1977
- * "TechName": "",
1978
- * "Description": "",
1979
- * "SemanticObject": "
1980
- * }],
1981
- * "SupportedOperators": ["EQ"]
1982
- * ```
1983
- *
1984
- *
1985
- * @experimental As of version 1.119.
1986
- */
1987
- export default class Dimension extends BaseObject {
1988
- /**
1989
- * @ui5-protected Do not call from applications (only from related classes in the framework)
1990
- */
1991
- protected constructor();
1992
-
1993
- /**
1994
- * Creates a new subclass of class sap.sac.df.model.Dimension with name `sClassName` and enriches it with
1995
- * the information contained in `oClassInfo`.
1996
- *
1997
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
1998
- *
1999
- *
2000
- * @returns Created class / constructor function
2001
- */
2002
- static extend<T extends Record<string, unknown>>(
2003
- /**
2004
- * Name of the class being created
2005
- */
2006
- sClassName: string,
2007
- /**
2008
- * Object literal with information about the class
2009
- */
2010
- oClassInfo?: sap.ClassInfo<T, Dimension>,
2011
- /**
2012
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2013
- * used by this class
2014
- */
2015
- FNMetaImpl?: Function
2016
- ): Function;
2017
- /**
2018
- * Returns a metadata object for class sap.sac.df.model.Dimension.
2019
- *
2020
- *
2021
- * @returns Metadata object describing this class
2022
- */
2023
- static getMetadata(): Metadata;
2024
- /**
2025
- * Add dimension filters
2026
- *
2027
- *
2028
- * @returns Reference to this in order to allow method chaining
2029
- */
2030
- addMemberFilter(
2031
- /**
2032
- * a member filter object
2033
- */
2034
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
2035
- ): this;
2036
- /**
2037
- * Add a member filter by its (internal) key
2038
- *
2039
- *
2040
- * @returns Reference to this in order to allow method chaining
2041
- */
2042
- addMemberFilterByKey(
2043
- /**
2044
- * (internal) key of a dimension member
2045
- */
2046
- sKey: string
2047
- ): this;
2048
- /**
2049
- * Clear the filter of a dimension
2050
- *
2051
- *
2052
- * @returns Reference to this in order to allow method chaining
2053
- */
2054
- clearMemberFilter(): this;
2055
- /**
2056
- * Get effective dimension filters
2057
- *
2058
- *
2059
- * @returns array of member filters
2060
- */
2061
- getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
2062
- /**
2063
- * Move dimension one position down on its axis
2064
- *
2065
- *
2066
- * @returns Reference to this in order to allow method chaining
2067
- */
2068
- moveDown(): this;
2069
- /**
2070
- * Move dimension one position up on it's axis
2071
- *
2072
- *
2073
- * @returns Reference to this in order to allow method chaining
2074
- */
2075
- moveUp(): this;
2076
- /**
2077
- * Open a dialog to display and change the settings of a dimension of the `DataProvider`
2078
- *
2079
- *
2080
- * @returns indicator whether the dialog was confirmed or canceled
2081
- */
2082
- openPropertyDialog(): Promise<boolean>;
2083
- /**
2084
- * Open a dialog to display and change the filter on a dimension
2085
- *
2086
- *
2087
- * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
2088
- * with Ok and dynamic filters of the given dimension are updated
2089
- */
2090
- openValueHelpDialog(
2091
- /**
2092
- * search string
2093
- */
2094
- sSearchString: String
2095
- ): Promise<any>;
2096
- /**
2097
- * Read hierarchy
2098
- *
2099
- *
2100
- * @returns resolving to the object of hierarchy nodes.
2101
- */
2102
- readHierarchy(
2103
- /**
2104
- * level
2105
- */
2106
- iLevel: int
2107
- ): Object;
2108
- /**
2109
- * Remove a drill operation on a dimension member
2110
- *
2111
- *
2112
- * @returns Reference to this in order to allow method chaining
2113
- */
2114
- removeDrilldown(): this;
2115
- /**
2116
- * Remove the filter of a dimension
2117
- *
2118
- *
2119
- * @returns Reference to this in order to allow method chaining
2120
- */
2121
- removeMemberFilter(
2122
- /**
2123
- * a member filter object
2124
- */
2125
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
2126
- ): this;
2127
- /**
2128
- * Remove a member filter by its (internal) key
2129
- *
2130
- *
2131
- * @returns Reference to this in order to allow method chaining
2132
- */
2133
- removeMemberFilterByKey(
2134
- /**
2135
- * (internal) key of a dimension member
2136
- */
2137
- sKey: string
2138
- ): this;
2139
- /**
2140
- * Set Display Type of Dimension
2141
- *
2142
- *
2143
- * @returns } resolving to the Dimension to allow chaining.
2144
- */
2145
- setDimensionDisplay(
2146
- /**
2147
- * level
2148
- */
2149
- sDisplayType: string
2150
- ): Dimension;
2151
- /**
2152
- * Set Display Hierarchy
2153
- *
2154
- *
2155
- * @returns resolving to the `Dimension` to allow chaining.
2156
- */
2157
- setDisplayHierarchy(
2158
- /**
2159
- * whether the hierarchy should be activated
2160
- */
2161
- bActive: boolean,
2162
- /**
2163
- * the name of the hierarchy (optional)
2164
- */
2165
- sHierarchyName: string,
2166
- /**
2167
- * the version of the hierarchy (optional)
2168
- */
2169
- sVersion: string
2170
- ): Dimension;
2171
- /**
2172
- * Set hierarchy drill level
2173
- *
2174
- *
2175
- * @returns resolving to the `Dimension` to allow chaining.
2176
- */
2177
- setHierarchyDrillLevel(
2178
- /**
2179
- * drill level (from root)
2180
- */
2181
- iDrillLevel: int
2182
- ): Dimension;
2183
- /**
2184
- * Set dimension filters
2185
- *
2186
- *
2187
- * @returns Reference to this in order to allow method chaining
2188
- */
2189
- setMemberFilter(
2190
- /**
2191
- * array of member filters
2192
- */
2193
- aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
2194
- ): this;
2195
- /**
2196
- * Set a member filter by its (internal) key
2197
- *
2198
- *
2199
- * @returns Reference to this in order to allow method chaining
2200
- */
2201
- setMemberFilterByKey(
2202
- /**
2203
- * (internal) key of a dimension member
2204
- */
2205
- sKey: string
2206
- ): this;
2207
- /**
2208
- * Sort the members of a dimension
2209
- *
2210
- *
2211
- * @returns Reference to this in order to allow method chaining
2212
- */
2213
- sort(
2214
- /**
2215
- * of sorting
2216
- */
2217
- direction: SortDirection,
2218
- /**
2219
- * of sorting
2220
- */
2221
- type: SortType,
2222
- /**
2223
- * in case of a measure structure the member according to which is sorted
2224
- */
2225
- sMeasureStructureMember: string,
2226
- /**
2227
- * in case of a secondary structure the member according to which is sorted
2228
- */
2229
- sStructureMember: string
2230
- ): this;
2231
- /**
2232
- * Move dimension to the columns axis
2233
- *
2234
- *
2235
- * @returns Reference to this in order to allow method chaining
2236
- */
2237
- toColumns(): this;
2238
- /**
2239
- * Move dimension to the rows axis
2240
- *
2241
- *
2242
- * @returns Reference to this in order to allow method chaining
2243
- */
2244
- toRows(): this;
2245
- }
2246
- }
2247
-
2248
- declare module "sap/sac/df/model/MultiDimModel" {
2249
- import JSONModel from "sap/ui/model/json/JSONModel";
2250
-
2251
- import Configuration from "sap/sac/df/model/Configuration";
2252
-
2253
- import {
2254
- default as DataProvider,
2255
- Configuration as Configuration1,
2256
- } from "sap/sac/df/model/DataProvider";
2257
-
2258
- import Message from "sap/ui/core/message/Message";
2259
-
2260
- import VariableGroup from "sap/sac/df/model/VariableGroup";
2261
-
2262
- import DataSourceType from "sap/sac/df/types/DataSourceType";
2263
-
2264
- import Metadata from "sap/ui/base/Metadata";
2265
-
2266
- import Event from "sap/ui/base/Event";
2267
-
2268
- /**
2269
- * The multidimensional model allows to access and change data accessed via the InA Protocol. The multidimensional
2270
- * model populate it's exposed data in JSON format via binding to controls.
2271
- *
2272
- * **Structure of Exposed Data:**
2273
- * ```javascript
2274
- *
2275
- * "DataProviders": { },
2276
- * "VariableGroups": { },
2277
- * "Messages": [ ]
2278
- * ```
2279
- *
2280
- *
2281
- * @experimental As of version 1.119.
2282
- */
2283
- export default class MultiDimModel extends JSONModel {
2284
- /**
2285
- * Constructor for a new MultiDimModel. After model creation you need to wait for the event {@link #event:loaded loaded}.
2286
- */
2287
- constructor(
2288
- /**
2289
- * ID for the new control, generated automatically if no ID is given
2290
- */
2291
- sId?: string,
2292
- /**
2293
- * Initial settings for the new control.
2294
- */
2295
- mSettings?: object
2296
- );
2297
- /**
2298
- * Configuration
2299
- */
2300
- Configuration: Record<string, Configuration>;
2301
-
2302
- /**
2303
- * Data Providers
2304
- */
2305
- DataProviders: Record<string, DataProvider>;
2306
-
2307
- /**
2308
- * Messages
2309
- */
2310
- Messages: Message[];
2311
-
2312
- /**
2313
- * Variable Groups
2314
- */
2315
- VariableGroups: Record<string, VariableGroup>;
2316
-
2317
- /**
2318
- * Creates a new subclass of class sap.sac.df.model.MultiDimModel with name `sClassName` and enriches it
2319
- * with the information contained in `oClassInfo`.
2320
- *
2321
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.json.JSONModel.extend}.
2322
- *
2323
- *
2324
- * @returns Created class / constructor function
2325
- */
2326
- static extend<T extends Record<string, unknown>>(
2327
- /**
2328
- * Name of the class being created
2329
- */
2330
- sClassName: string,
2331
- /**
2332
- * Object literal with information about the class
2333
- */
2334
- oClassInfo?: sap.ClassInfo<T, MultiDimModel>,
2335
- /**
2336
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2337
- * used by this class
2338
- */
2339
- FNMetaImpl?: Function
2340
- ): Function;
2341
- /**
2342
- * Returns a metadata object for class sap.sac.df.model.MultiDimModel.
2343
- *
2344
- *
2345
- * @returns Metadata object describing this class
2346
- */
2347
- static getMetadata(): Metadata;
2348
- /**
2349
- * Creates a new data provider and attaches it to the model.
2350
- *
2351
- *
2352
- * @returns Promise which resolves the created data provider
2353
- */
2354
- addDataProvider(
2355
- /**
2356
- * Data provider name
2357
- */
2358
- sDataProviderName: string,
2359
- /**
2360
- * Datasource name which the data provider is supposed to expose
2361
- */
2362
- sDataSourceName: Configuration1 | string,
2363
- /**
2364
- * System name
2365
- */
2366
- sSystem?: string,
2367
- /**
2368
- * Package name
2369
- */
2370
- sPackage?: string,
2371
- /**
2372
- * Schema name
2373
- */
2374
- sSchema?: string,
2375
- /**
2376
- * Data source type
2377
- */
2378
- sDataSourceType?: DataSourceType | keyof typeof DataSourceType,
2379
- /**
2380
- * if the data should be fetched automatically
2381
- */
2382
- bAutoFetchEnabled?: boolean
2383
- ): Promise<DataProvider>;
2384
- /**
2385
- * Creates a new variable group and attaches it to the model.
2386
- *
2387
- * A variable group defines which variables of the underlying data providers should behave as the same variable.
2388
- * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
2389
- *
2390
- *
2391
- * @returns created variable group
2392
- */
2393
- createVariableGroup(
2394
- /**
2395
- * Variable group name
2396
- */
2397
- sVariableGroupName: string,
2398
- /**
2399
- * Rule is a function which accept the variable definition and decides if the variable has to be part of
2400
- * te group.
2401
- */
2402
- fnRule: Function,
2403
- /**
2404
- * Additional properties
2405
- */
2406
- oProperties: Object
2407
- ): VariableGroup;
2408
- /**
2409
- * Updates the model from the given the model state including all aggregated data providers
2410
- *
2411
- *
2412
- * @returns Promise with reference to this in order to allow method chaining
2413
- */
2414
- deserialize(
2415
- /**
2416
- * A JSON object which represents the multidimensional model to be applied
2417
- */
2418
- oModelState: object,
2419
- /**
2420
- * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY).
2421
- */
2422
- sFormat?: string
2423
- ): Promise<this>;
2424
- /**
2425
- * Ensures all aggregated data providers are destroyed.
2426
- *
2427
- *
2428
- * @returns Promise which resolves when destroy is finished.
2429
- */
2430
- destroy(): Promise<any>;
2431
- /**
2432
- * Fires event {@link #event:dataProviderAdded dataProviderAdded} to attached listeners.
2433
- *
2434
- *
2435
- * @returns Reference to this in order to allow method chaining
2436
- */
2437
- fireDataProviderAdded(
2438
- /**
2439
- * Parameters to pass along with the event
2440
- */
2441
- oParameters?: object
2442
- ): this;
2443
- /**
2444
- * Fires event {@link #event:dataProviderRemoved dataProviderRemoved} to attached listeners.
2445
- *
2446
- *
2447
- * @returns Reference to this in order to allow method chaining
2448
- */
2449
- fireDataProviderRemoved(
2450
- /**
2451
- * Parameters to pass along with the event
2452
- */
2453
- oParameters?: object
2454
- ): this;
2455
- /**
2456
- * Fires event {@link #event:dataProviderUpdated dataProviderUpdated} to attached listeners.
2457
- *
2458
- *
2459
- * @returns Reference to this in order to allow method chaining
2460
- */
2461
- fireDataProviderUpdated(
2462
- /**
2463
- * Parameters to pass along with the event
2464
- */
2465
- oParameters?: object
2466
- ): this;
2467
- /**
2468
- * Fires event {@link #event:variableGroupsAdded variableGroupsAdded} to attached listeners.
2469
- *
2470
- *
2471
- * @returns Reference to this in order to allow method chaining
2472
- */
2473
- fireVariableGroupsAdded(
2474
- /**
2475
- * Parameters to pass along with the event
2476
- */
2477
- oParameters?: object
2478
- ): this;
2479
- /**
2480
- * Get context menu provider registry
2481
- *
2482
- *
2483
- * @returns sap.sac.df.model.extentsions.contextMenu.ContextMenuProviderRegistry
2484
- */
2485
- getContextMenuProviderRegistry(): undefined;
2486
- /**
2487
- * Get a data provider
2488
- *
2489
- *
2490
- * @returns Data provider object if found
2491
- */
2492
- getDataProvider(
2493
- /**
2494
- * Data provider name
2495
- */
2496
- sDataProviderName: string
2497
- ): DataProvider;
2498
- /**
2499
- * Get all data providers
2500
- *
2501
- *
2502
- * @returns Object of all data providers
2503
- */
2504
- getDataProviders(): Record<string, DataProvider>;
2505
- /**
2506
- * Get grid styling template registry
2507
- *
2508
- * @deprecated As of version 1.135. the concept has been discarded.
2509
- *
2510
- * @returns sap.sac.df.model.extentsions.styling.GridStylingTemplateRegistry
2511
- */
2512
- getGridStylingTemplateRegistry(): undefined;
2513
- /**
2514
- * Get all messages
2515
- *
2516
- *
2517
- * @returns Array of messages
2518
- */
2519
- getMessages(): Message[];
2520
- /**
2521
- * Get a variable group
2522
- *
2523
- *
2524
- * @returns Variable group object
2525
- */
2526
- getVariableGroup(
2527
- /**
2528
- * Variable group name
2529
- */
2530
- sVariableGroupName: string
2531
- ): VariableGroup;
2532
- /**
2533
- * Get all variable groups
2534
- *
2535
- *
2536
- * @returns Object of all variable groups
2537
- */
2538
- getVariableGroups(): Record<string, VariableGroup>;
2539
- /**
2540
- * Remove existing data provider from the model.
2541
- *
2542
- *
2543
- * @returns Promise which resolves when the removing s finished
2544
- */
2545
- removeDataProvider(
2546
- /**
2547
- * Data provider name to be removed
2548
- */
2549
- sDataProviderName: string
2550
- ): Promise<void>;
2551
- /**
2552
- * Reset the model to the initial state
2553
- *
2554
- *
2555
- * @returns Promise which resolves when reset is finished.
2556
- */
2557
- resetModel(): Promise<void>;
2558
- /**
2559
- * Serialize the model with all aggregated data providers to a JSON representation
2560
- *
2561
- *
2562
- * @returns A JSON object which represents the multidimensional model
2563
- */
2564
- serialize(
2565
- /**
2566
- * Format of the serialization (INA_REPOSITORY_DELTA or INA_REPOSITORY)
2567
- */
2568
- sFormat?: string
2569
- ): object;
2570
- /**
2571
- * Resets the messages
2572
- */
2573
- setMessages(
2574
- /**
2575
- * The new messages for the model, mapping a binding path to an array of sap.ui.core.message.Message objects
2576
- */
2577
- mMessages: Record<string, Message[]>
2578
- ): void;
2579
- /**
2580
- * Set variable groups.
2581
- *
2582
- * A variable group defines which variables of the underlying data providers should behave as the same variable.
2583
- * The group is defined by a name and a rule. The first added variable becomes automatically the `MergedVariable`.
2584
- *
2585
- *
2586
- * @returns Promise which resolves the created variable group
2587
- */
2588
- setVariableGroups(
2589
- /**
2590
- * array of variable groups
2591
- */
2592
- aVariableGroups: VariableGroup[]
2593
- ): Promise<VariableGroup[]>;
2594
- }
2595
- /**
2596
- * Parameters of the MultiDimModel#dataLoaded event.
2597
- */
2598
- export interface MultiDimModel$DataLoadedEventParameters {}
2599
-
2600
- /**
2601
- * Event object of the MultiDimModel#dataLoaded event.
2602
- */
2603
- export type MultiDimModel$DataLoadedEvent = Event<
2604
- MultiDimModel$DataLoadedEventParameters,
2605
- MultiDimModel
2606
- >;
2607
-
2608
- /**
2609
- * Parameters of the MultiDimModel#dataProviderAdded event.
2610
- */
2611
- export interface MultiDimModel$DataProviderAddedEventParameters {}
2612
-
2613
- /**
2614
- * Event object of the MultiDimModel#dataProviderAdded event.
2615
- */
2616
- export type MultiDimModel$DataProviderAddedEvent = Event<
2617
- MultiDimModel$DataProviderAddedEventParameters,
2618
- MultiDimModel
2619
- >;
2620
-
2621
- /**
2622
- * Parameters of the MultiDimModel#dataProviderRemoved event.
2623
- */
2624
- export interface MultiDimModel$DataProviderRemovedEventParameters {}
2625
-
2626
- /**
2627
- * Event object of the MultiDimModel#dataProviderRemoved event.
2628
- */
2629
- export type MultiDimModel$DataProviderRemovedEvent = Event<
2630
- MultiDimModel$DataProviderRemovedEventParameters,
2631
- MultiDimModel
2632
- >;
2633
-
2634
- /**
2635
- * Parameters of the MultiDimModel#dataProviderUpdated event.
2636
- */
2637
- export interface MultiDimModel$DataProviderUpdatedEventParameters {}
2638
-
2639
- /**
2640
- * Event object of the MultiDimModel#dataProviderUpdated event.
2641
- */
2642
- export type MultiDimModel$DataProviderUpdatedEvent = Event<
2643
- MultiDimModel$DataProviderUpdatedEventParameters,
2644
- MultiDimModel
2645
- >;
2646
-
2647
- /**
2648
- * Parameters of the MultiDimModel#loaded event.
2649
- */
2650
- export interface MultiDimModel$LoadedEventParameters {}
2651
-
2652
- /**
2653
- * Event object of the MultiDimModel#loaded event.
2654
- */
2655
- export type MultiDimModel$LoadedEvent = Event<
2656
- MultiDimModel$LoadedEventParameters,
2657
- MultiDimModel
2658
- >;
2659
-
2660
- /**
2661
- * Parameters of the MultiDimModel#variableGroupsAdded event.
2662
- */
2663
- export interface MultiDimModel$VariableGroupsAddedEventParameters {}
2664
-
2665
- /**
2666
- * Event object of the MultiDimModel#variableGroupsAdded event.
2667
- */
2668
- export type MultiDimModel$VariableGroupsAddedEvent = Event<
2669
- MultiDimModel$VariableGroupsAddedEventParameters,
2670
- MultiDimModel
2671
- >;
2672
- }
2673
-
2674
- declare module "sap/sac/df/model/Variable" {
2675
- import BaseObject from "sap/ui/base/Object";
2676
-
2677
- import Metadata from "sap/ui/base/Metadata";
2678
-
2679
- /**
2680
- * Variable Object
2681
- *
2682
- * **Structure of Exposed Data:**
2683
- * ```javascript
2684
- *
2685
- * "Name": "",
2686
- * "Dimension": "",
2687
- * "ValueType": "",
2688
- * "VariableType": "",
2689
- * "Description": "",
2690
- * "Mandatory": "",
2691
- * "SupportsMultipleValues": "",
2692
- * "TechName": "",
2693
- * "InputEnabled": "",
2694
- * "Position": ""
2695
- * "SupportsValueHelp": "",
2696
- * "DataProviderName": "",
2697
- * "MemberFilter": []
2698
- * ```
2699
- *
2700
- *
2701
- * @experimental As of version 1.119.
2702
- */
2703
- export default class Variable extends BaseObject {
2704
- /**
2705
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2706
- */
2707
- protected constructor();
2708
-
2709
- /**
2710
- * Creates a new subclass of class sap.sac.df.model.Variable with name `sClassName` and enriches it with
2711
- * the information contained in `oClassInfo`.
2712
- *
2713
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2714
- *
2715
- *
2716
- * @returns Created class / constructor function
2717
- */
2718
- static extend<T extends Record<string, unknown>>(
2719
- /**
2720
- * Name of the class being created
2721
- */
2722
- sClassName: string,
2723
- /**
2724
- * Object literal with information about the class
2725
- */
2726
- oClassInfo?: sap.ClassInfo<T, Variable>,
2727
- /**
2728
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2729
- * used by this class
2730
- */
2731
- FNMetaImpl?: Function
2732
- ): Function;
2733
- /**
2734
- * Returns a metadata object for class sap.sac.df.model.Variable.
2735
- *
2736
- *
2737
- * @returns Metadata object describing this class
2738
- */
2739
- static getMetadata(): Metadata;
2740
- /**
2741
- * Add variable filters
2742
- *
2743
- *
2744
- * @returns Reference to this in order to allow method chaining
2745
- */
2746
- addMemberFilter(
2747
- /**
2748
- * a member filter object
2749
- */
2750
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
2751
- ): this;
2752
- /**
2753
- * Add a member filter by its (internal) key
2754
- *
2755
- *
2756
- * @returns Reference to this in order to allow method chaining
2757
- */
2758
- addMemberFilterByKey(
2759
- /**
2760
- * (internal) key of a dimension member
2761
- */
2762
- sKey: string
2763
- ): this;
2764
- /**
2765
- * Clear variable filter
2766
- *
2767
- *
2768
- * @returns Reference to this in order to allow method chaining
2769
- */
2770
- clearMemberFilter(): this;
2771
- /**
2772
- * Get effective variable filters
2773
- *
2774
- *
2775
- * @returns array of member filters
2776
- */
2777
- getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
2778
- /**
2779
- * Open a dialog to display and change the filter on a variable
2780
- *
2781
- *
2782
- * @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
2783
- * with Ok and dynamic filters of the given dimension are updated
2784
- */
2785
- openValueHelpDialog(
2786
- /**
2787
- * search string
2788
- */
2789
- sSearchString: String
2790
- ): Promise<any>;
2791
- /**
2792
- * Remove variable filter
2793
- *
2794
- *
2795
- * @returns Reference to this in order to allow method chaining
2796
- */
2797
- removeMemberFilter(
2798
- /**
2799
- * a member filter object
2800
- */
2801
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
2802
- ): this;
2803
- /**
2804
- * Remove a member filter by its (internal) key
2805
- *
2806
- *
2807
- * @returns Reference to this in order to allow method chaining
2808
- */
2809
- removeMemberFilterByKey(
2810
- /**
2811
- * (internal) key of a dimension member
2812
- */
2813
- sKey: string
2814
- ): this;
2815
- /**
2816
- * Set variable filters
2817
- *
2818
- *
2819
- * @returns Reference to this in order to allow method chaining
2820
- */
2821
- setMemberFilter(
2822
- /**
2823
- * array of member filters
2824
- */
2825
- aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
2826
- ): this;
2827
- /**
2828
- * Set a member filter by its (internal) key
2829
- *
2830
- *
2831
- * @returns Reference to this in order to allow method chaining
2832
- */
2833
- setMemberFilterByKey(
2834
- /**
2835
- * (internal) key of a dimension member
2836
- */
2837
- sKey: string
2838
- ): this;
2839
- }
2840
- }
2841
-
2842
- declare module "sap/sac/df/model/VariableGroup" {
2843
- import BaseObject from "sap/ui/base/Object";
2844
-
2845
- import Variable from "sap/sac/df/model/Variable";
2846
-
2847
- import Metadata from "sap/ui/base/Metadata";
2848
-
2849
- /**
2850
- * Variable Group Object
2851
- *
2852
- * **Structure of Exposed Data:**
2853
- * ```javascript
2854
- *
2855
- * "Name": "",
2856
- * "MergedVariable": { },
2857
- * "Rule": function () {}
2858
- * ```
2859
- *
2860
- *
2861
- * @experimental As of version 1.119.
2862
- */
2863
- export default class VariableGroup extends BaseObject {
2864
- /**
2865
- * @ui5-protected Do not call from applications (only from related classes in the framework)
2866
- */
2867
- protected constructor();
2868
- /**
2869
- * Merged Variable
2870
- */
2871
- MergedVariable: Variable;
2872
-
2873
- /**
2874
- * Name
2875
- */
2876
- Name: string;
2877
-
2878
- /**
2879
- * Creates a new subclass of class sap.sac.df.model.VariableGroup with name `sClassName` and enriches it
2880
- * with the information contained in `oClassInfo`.
2881
- *
2882
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
2883
- *
2884
- *
2885
- * @returns Created class / constructor function
2886
- */
2887
- static extend<T extends Record<string, unknown>>(
2888
- /**
2889
- * Name of the class being created
2890
- */
2891
- sClassName: string,
2892
- /**
2893
- * Object literal with information about the class
2894
- */
2895
- oClassInfo?: sap.ClassInfo<T, VariableGroup>,
2896
- /**
2897
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2898
- * used by this class
2899
- */
2900
- FNMetaImpl?: Function
2901
- ): Function;
2902
- /**
2903
- * Returns a metadata object for class sap.sac.df.model.VariableGroup.
2904
- *
2905
- *
2906
- * @returns Metadata object describing this class
2907
- */
2908
- static getMetadata(): Metadata;
2909
- /**
2910
- * Add variable group filters
2911
- *
2912
- *
2913
- * @returns Reference to this in order to allow method chaining
2914
- */
2915
- addMemberFilter(
2916
- /**
2917
- * a member filter object
2918
- */
2919
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
2920
- ): this;
2921
- /**
2922
- * Add a member filter by its (internal) key
2923
- *
2924
- *
2925
- * @returns Reference to this in order to allow method chaining
2926
- */
2927
- addMemberFilterByKey(
2928
- /**
2929
- * (internal) key of a dimension member
2930
- */
2931
- sKey: string
2932
- ): this;
2933
- /**
2934
- * Clear variable group filter
2935
- *
2936
- *
2937
- * @returns Reference to this in order to allow method chaining
2938
- */
2939
- clearMemberFilter(): this;
2940
- /**
2941
- * Get effective variable group filters
2942
- *
2943
- *
2944
- * @returns array of member filters
2945
- */
2946
- getMemberFilter(): /* was: sap.sac.df.model.MemberFilter */ any[];
2947
- /**
2948
- * Opens the value help dialog so the user choose a value for a variable group After the value is selected
2949
- * only teh VariableGroup.MergedVariable is updated. The variables of the aggregated DataProviders are updated
2950
- * with the next ResultSet fetch
2951
- *
2952
- *
2953
- * @returns to indicate if the VariableGroup has been updated
2954
- */
2955
- openValueHelpDialog(
2956
- /**
2957
- * search string
2958
- */
2959
- sSearchString: String
2960
- ): Promise<boolean>;
2961
- /**
2962
- * Remove variable group filter
2963
- *
2964
- *
2965
- * @returns Reference to this in order to allow method chaining
2966
- */
2967
- removeMemberFilter(
2968
- /**
2969
- * a member filter object
2970
- */
2971
- oMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any
2972
- ): this;
2973
- /**
2974
- * Remove a member filter by its (internal) key
2975
- *
2976
- *
2977
- * @returns Reference to this in order to allow method chaining
2978
- */
2979
- removeMemberFilterByKey(
2980
- /**
2981
- * (internal) key of a dimension member
2982
- */
2983
- sKey: string
2984
- ): this;
2985
- /**
2986
- * Set variable group filters
2987
- *
2988
- *
2989
- * @returns Promise which resolve when the value is set
2990
- */
2991
- setMemberFilter(
2992
- /**
2993
- * array of member filters
2994
- */
2995
- aMemberFilter: /* was: sap.sac.df.model.MemberFilter */ any[]
2996
- ): undefined;
2997
- /**
2998
- * Set a member filter by its (internal) key
2999
- *
3000
- *
3001
- * @returns Reference to this in order to allow method chaining
3002
- */
3003
- setMemberFilterByKey(
3004
- /**
3005
- * (internal) ey of a dimension member
3006
- */
3007
- sKey: string
3008
- ): this;
3009
- }
3010
- }
3011
-
3012
- declare module "sap/sac/df/model/visualization/Documents" {
3013
- import BaseObject from "sap/ui/base/Object";
3014
-
3015
- import DocumentsSupportType from "sap/sac/df/types/DocumentsSupportType";
3016
-
3017
- import Metadata from "sap/ui/base/Metadata";
3018
-
3019
- /**
3020
- * Documents manager object
3021
- *
3022
- * **Structure of Exposed Data:**
3023
- * ```javascript
3024
- *
3025
- * "ActiveDocumentsDirectory": "",
3026
- * "DocumentsSupportType": ""
3027
- * "IsBasedOnCDSView": ""
3028
- * ```
3029
- *
3030
- *
3031
- * @experimental As of version 1.119.
3032
- */
3033
- export default class Documents extends BaseObject {
3034
- /**
3035
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3036
- */
3037
- protected constructor();
3038
-
3039
- ActiveDocumentsDirectory: undefined;
3040
-
3041
- DocumentsSupportType: undefined;
3042
-
3043
- IsBasedOnCDSView: undefined;
3044
-
3045
- /**
3046
- * Creates a new subclass of class sap.sac.df.model.visualization.Documents with name `sClassName` and enriches
3047
- * it with the information contained in `oClassInfo`.
3048
- *
3049
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3050
- *
3051
- *
3052
- * @returns Created class / constructor function
3053
- */
3054
- static extend<T extends Record<string, unknown>>(
3055
- /**
3056
- * Name of the class being created
3057
- */
3058
- sClassName: string,
3059
- /**
3060
- * Object literal with information about the class
3061
- */
3062
- oClassInfo?: sap.ClassInfo<T, Documents>,
3063
- /**
3064
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3065
- * used by this class
3066
- */
3067
- FNMetaImpl?: Function
3068
- ): Function;
3069
- /**
3070
- * Returns a metadata object for class sap.sac.df.model.visualization.Documents.
3071
- *
3072
- *
3073
- * @returns Metadata object describing this class
3074
- */
3075
- static getMetadata(): Metadata;
3076
- /**
3077
- * Create and retrieve document in the document store
3078
- *
3079
- *
3080
- * @returns a promise which resolves with the newly created document.
3081
- */
3082
- createAndRetrieveDocument(
3083
- /**
3084
- * the document ID
3085
- */
3086
- sDocumentId: undefined,
3087
- /**
3088
- * the content of the document
3089
- */
3090
- sContent: undefined,
3091
- /**
3092
- * properties (ideally as key-value-pair)
3093
- */
3094
- oProperties: undefined
3095
- ): Promise<object>;
3096
- /**
3097
- * Create a document in the document store
3098
- *
3099
- *
3100
- * @returns a promise which resolves to true if create operation is successful, otherwise false.
3101
- */
3102
- createDocument(
3103
- /**
3104
- * the document ID
3105
- */
3106
- sDocumentId: undefined,
3107
- /**
3108
- * the content of the document
3109
- */
3110
- sContent: undefined,
3111
- /**
3112
- * properties (ideally as key-value-pair)
3113
- */
3114
- oProperties: undefined
3115
- ): Promise<boolean>;
3116
- /**
3117
- * Creates a document ID for a data cell in the result set
3118
- *
3119
- *
3120
- * @returns a promise which resolves with the newly created document ID
3121
- */
3122
- createDocumentId(
3123
- /**
3124
- * the row index
3125
- */
3126
- nRowIndex: int,
3127
- /**
3128
- * the column index
3129
- */
3130
- nColumnIndex: int
3131
- ): Promise<String>;
3132
- /**
3133
- * Delete a document in the document store
3134
- *
3135
- *
3136
- * @returns a promise which resolves to true if delete operation is successful, otherwise false.
3137
- */
3138
- deleteDocument(
3139
- /**
3140
- * the document ID
3141
- */
3142
- sDocumentId: undefined
3143
- ): Promise<boolean>;
3144
- /**
3145
- * Delete a document ID for a data cell in the result set
3146
- *
3147
- *
3148
- * @returns a promise which resolves to true if the delete operation is successful, otherwise false.
3149
- */
3150
- deleteDocumentId(
3151
- /**
3152
- * the row index
3153
- */
3154
- nRowIndex: int,
3155
- /**
3156
- * the column index
3157
- */
3158
- nColumnIndex: int
3159
- ): Promise<boolean>;
3160
- /**
3161
- * Get a document ID of a data cell in the result set
3162
- *
3163
- *
3164
- * @returns a promise which resolves with the document ID
3165
- */
3166
- getDocumentId(
3167
- /**
3168
- * the row index
3169
- */
3170
- nRowIndex: int,
3171
- /**
3172
- * the column index
3173
- */
3174
- nColumnIndex: int
3175
- ): Promise<String>;
3176
- /**
3177
- * Get the type of documents support.
3178
- *
3179
- *
3180
- * @returns documents support type
3181
- */
3182
- getDocumentsSupportType(): DocumentsSupportType;
3183
- /**
3184
- * Retrieves a document from the document store
3185
- *
3186
- *
3187
- * @returns a promise which resolves with the version(s) of the document.
3188
- */
3189
- retrieveDocument(
3190
- /**
3191
- * the document ID
3192
- */
3193
- sDocumentId: undefined,
3194
- /**
3195
- * the version of the document - if version is not supplied, returns all versions.
3196
- */
3197
- sVersion: undefined
3198
- ): Promise<object>;
3199
- /**
3200
- * Retrieve multiple documents from the document store
3201
- *
3202
- *
3203
- * @returns a promise which resolves with all documents and its versions.
3204
- */
3205
- retrieveMultipleDocuments(
3206
- /**
3207
- * the array of document IDs
3208
- */
3209
- aDocumentIds: undefined
3210
- ): Promise<object>;
3211
- /**
3212
- * Is document storage supporting delete access
3213
- *
3214
- *
3215
- * @returns if delete access is supported
3216
- */
3217
- supportsDelete(): boolean;
3218
- /**
3219
- * Is document storage supporting read access
3220
- *
3221
- *
3222
- * @returns if read access is supported
3223
- */
3224
- supportsRead(): boolean;
3225
- /**
3226
- * Is document storage supporting write (create and change) access
3227
- *
3228
- *
3229
- * @returns if write (create and change) access is supported
3230
- */
3231
- supportsWrite(): boolean;
3232
- }
3233
- }
3234
-
3235
- declare module "sap/sac/df/model/visualization/Grid" {
3236
- import BaseObject from "sap/ui/base/Object";
3237
-
3238
- import TableTemplate from "sap/sac/df/types/configuration/TableTemplate";
3239
-
3240
- import Metadata from "sap/ui/base/Metadata";
3241
-
3242
- /**
3243
- * Grid Visualization Object
3244
- *
3245
- * @experimental As of version 1.132.
3246
- */
3247
- export default class Grid extends BaseObject {
3248
- /**
3249
- * @ui5-protected Do not call from applications (only from related classes in the framework)
3250
- */
3251
- protected constructor();
3252
-
3253
- /**
3254
- * Creates a new subclass of class sap.sac.df.model.visualization.Grid with name `sClassName` and enriches
3255
- * it with the information contained in `oClassInfo`.
3256
- *
3257
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
3258
- *
3259
- *
3260
- * @returns Created class / constructor function
3261
- */
3262
- static extend<T extends Record<string, unknown>>(
3263
- /**
3264
- * Name of the class being created
3265
- */
3266
- sClassName: string,
3267
- /**
3268
- * Object literal with information about the class
3269
- */
3270
- oClassInfo?: sap.ClassInfo<T, Grid>,
3271
- /**
3272
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3273
- * used by this class
3274
- */
3275
- FNMetaImpl?: Function
3276
- ): Function;
3277
- /**
3278
- * Returns a metadata object for class sap.sac.df.model.visualization.Grid.
3279
- *
3280
- *
3281
- * @returns Metadata object describing this class
3282
- */
3283
- static getMetadata(): Metadata;
3284
- /**
3285
- * Get active template
3286
- *
3287
- *
3288
- * @returns active template
3289
- */
3290
- getActiveTemplate(): TableTemplate;
3291
- /**
3292
- * Get the current axes layout for rows and columns
3293
- *
3294
- *
3295
- * @returns columns and rows axes layout object
3296
- */
3297
- getAxesLayout(): AxesLayout;
3298
- /**
3299
- * Gets the cell context for a cell in the result set
3300
- *
3301
- *
3302
- * @returns a promise which resolves with the retrieved cell context
3303
- */
3304
- getCellContext(
3305
- /**
3306
- * the row index of data cell
3307
- */
3308
- nRowIndex: int,
3309
- /**
3310
- * the column index of data cell
3311
- */
3312
- nColumnIndex: int
3313
- ): Promise<Object>;
3314
- /**
3315
- * Get the data of the visualization
3316
- * ```javascript
3317
- *
3318
- * "Cells": [],
3319
- * "TotalColumns": Integer,
3320
- * "TotalRows": Integer
3321
- * ```
3322
- *
3323
- *
3324
- *
3325
- * @returns a promise which resolves with the visualization data
3326
- */
3327
- getVisualizationData(): Promise<Object>;
3328
- /**
3329
- * Set active template
3330
- *
3331
- *
3332
- * @returns resolving to the axes layout object to allow chaining
3333
- */
3334
- setActiveTemplate(
3335
- /**
3336
- * styling template name
3337
- */
3338
- sTemplateName: string
3339
- ): Grid;
3340
- /**
3341
- * Set the dimensions on row and column axis
3342
- *
3343
- *
3344
- * @returns resolving to the axes layout object to allow chaining
3345
- */
3346
- setAxesLayout(
3347
- /**
3348
- * an object containing the names of the dimensions on row and column axis. The order of the dimensions
3349
- * control the position on the axis.
3350
- */
3351
- oAxisLayout: AxesLayout
3352
- ): Grid;
3353
- }
3354
- /**
3355
- * Axes Layout object type.
3356
- *
3357
- * @experimental As of version 1.132.
3358
- */
3359
- export type AxesLayout = {
3360
- /**
3361
- * dimensions on column axis
3362
- */
3363
- Columns: string[];
3364
- /**
3365
- * dimensions on row axis
3366
- */
3367
- Rows: string[];
3368
- /**
3369
- * members of measure structure dimension
3370
- */
3371
- MeasureStructureMembers: string[];
3372
- /**
3373
- * members of structure dimension
3374
- */
3375
- StructureMembers: string[];
3376
- };
3377
- }
3378
-
3379
- declare module "sap/sac/df/StylingPanel" {
3380
- import { default as Control, $ControlSettings } from "sap/ui/core/Control";
3381
-
3382
- import ElementMetadata from "sap/ui/core/ElementMetadata";
3383
-
3384
- import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
3385
-
3386
- /**
3387
- * StylingPanel A panel control to format the data being displayed.
3388
- *
3389
- * @experimental As of version 1.129.
3390
- */
3391
- export default class StylingPanel extends Control {
3392
- /**
3393
- * Constructor for a new `StylingPanel` control.
3394
- *
3395
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
3396
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
3397
- * of the syntax of the settings object.
3398
- */
3399
- constructor();
3400
-
3401
- /**
3402
- * Creates a new subclass of class sap.sac.df.StylingPanel with name `sClassName` and enriches it with the
3403
- * information contained in `oClassInfo`.
3404
- *
3405
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
3406
- *
3407
- *
3408
- * @returns Created class / constructor function
3409
- */
3410
- static extend<T extends Record<string, unknown>>(
3411
- /**
3412
- * Name of the class being created
3413
- */
3414
- sClassName: string,
3415
- /**
3416
- * Object literal with information about the class
3417
- */
3418
- oClassInfo?: sap.ClassInfo<T, StylingPanel>,
3419
- /**
3420
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
3421
- * used by this class
3422
- */
3423
- FNMetaImpl?: Function
3424
- ): Function;
3425
- /**
3426
- * Returns a metadata object for class sap.sac.df.StylingPanel.
3427
- *
3428
- *
3429
- * @returns Metadata object describing this class
3430
- */
3431
- static getMetadata(): ElementMetadata;
3432
- /**
3433
- * Gets current value of property {@link #getMetaPath metaPath}.
3434
- *
3435
- * Defines the relative path to the data provider in the multidimensional model.
3436
- *
3437
- *
3438
- * @returns Value of property `metaPath`
3439
- */
3440
- getMetaPath(): string;
3441
- /**
3442
- * Sets a new value for property {@link #getMetaPath metaPath}.
3443
- *
3444
- * Defines the relative path to the data provider in the multidimensional model.
3445
- *
3446
- * When called with a value of `null` or `undefined`, the default value of the property will be restored.
3447
- *
3448
- *
3449
- * @returns Reference to `this` in order to allow method chaining
3450
- */
3451
- setMetaPath(
3452
- /**
3453
- * New value for property `metaPath`
3454
- */
3455
- sMetaPath: string
3456
- ): this;
3457
- }
3458
- /**
3459
- * Describes the settings that can be provided to the StylingPanel constructor.
3460
- *
3461
- * @experimental As of version 1.129.
3462
- */
3463
- export interface $StylingPanelSettings extends $ControlSettings {
3464
- /**
3465
- * Defines the relative path to the data provider in the multidimensional model.
3466
- */
3467
- metaPath?: string | PropertyBindingInfo;
3468
- }
3469
- }
3470
-
3471
- declare module "sap/sac/df/types/Axis" {
3472
- /**
3473
- * Axis of a multidimensional Result Set
3474
- *
3475
- * @experimental As of version 1.119.
3476
- */
3477
- enum Axis {
3478
- /**
3479
- * Columns axis (horizontal direction in a Grid)
3480
- */
3481
- Columns = "Columns",
3482
- /**
3483
- * Free axis (contains all dimensions that can be placed on the row/column axis)
3484
- */
3485
- Free = "Free",
3486
- /**
3487
- * Row axis (vertical direction in a Grid)
3488
- */
3489
- Rows = "Rows",
3490
- }
3491
- export default Axis;
3492
- }
3493
-
3494
- declare module "sap/sac/df/types/configuration/StylingPanelItem" {
3495
- /**
3496
- * Item of the styling panel
3497
- *
3498
- * @experimental As of version 1.132.
3499
- */
3500
- enum StylingPanelItem {
3501
- /**
3502
- * Conditional Formatting
3503
- */
3504
- ConditionalFormatting = "ConditionalFormatting",
3505
- /**
3506
- * Number Formatting
3507
- */
3508
- NumberFormatting = "NumberFormatting",
3509
- /**
3510
- * Table Properties
3511
- */
3512
- TableProperties = "TableProperties",
3513
- }
3514
- export default StylingPanelItem;
3515
- }
3516
-
3517
- declare module "sap/sac/df/types/configuration/TableTemplate" {
3518
- /**
3519
- * Item of the styling panel
3520
- *
3521
- * @experimental As of version 1.135.
3522
- */
3523
- enum TableTemplate {
3524
- /**
3525
- * Basic
3526
- */
3527
- Basic = "Basic",
3528
- /**
3529
- * Default
3530
- */
3531
- Default = "Default",
3532
- /**
3533
- * Financial
3534
- */
3535
- Financial = "Financial",
3536
- /**
3537
- * Report
3538
- */
3539
- Report = "Report",
3540
- }
3541
- export default TableTemplate;
3542
- }
3543
-
3544
- declare module "sap/sac/df/types/DataAnalyzerPanelName" {
3545
- /**
3546
- * DataAnalyzer Panels
3547
- *
3548
- * @experimental As of version 1.132.
3549
- */
3550
- enum DataAnalyzerPanelName {
3551
- /**
3552
- * Designer Panel
3553
- */
3554
- Designer = "OlapDesignerDocument",
3555
- /**
3556
- * Styling Panel
3557
- */
3558
- Styling = "StylingPanelDocument",
3559
- }
3560
- export default DataAnalyzerPanelName;
3561
- }
3562
-
3563
- declare module "sap/sac/df/types/DataSourceType" {
3564
- /**
3565
- * Type of a data source
3566
- *
3567
- * @experimental As of version 1.89.
3568
- */
3569
- enum DataSourceType {
3570
- /**
3571
- * CDS Projection View
3572
- */
3573
- CDSProjectionView = "CDSProjectionView",
3574
- /**
3575
- * Cube
3576
- */
3577
- Cube = "Cube",
3578
- /**
3579
- * Ina Model
3580
- */
3581
- InAModel = "InAModel",
3582
- /**
3583
- * Insight (widget definition)
3584
- */
3585
- Insight = "Insight",
3586
- /**
3587
- * Query
3588
- */
3589
- Query = "Query",
3590
- /**
3591
- * View
3592
- */
3593
- View = "View",
3594
- }
3595
- export default DataSourceType;
3596
- }
3597
-
3598
- declare module "sap/sac/df/types/DocumentsSupportType" {
3599
- /**
3600
- * Documents support type
3601
- *
3602
- * @experimental As of version 1.120.
3603
- */
3604
- enum DocumentsSupportType {
3605
- /**
3606
- * Documents are not supported.
3607
- */
3608
- None = "NONE",
3609
- /**
3610
- * Read-only documents support.
3611
- */
3612
- Read = "READ",
3613
- /**
3614
- * Read, create, change documents support.
3615
- */
3616
- ReadCreateChange = "READ_CREATE_CHANGE",
3617
- /**
3618
- * Read, create, change, delete documents support.
3619
- */
3620
- ReadWrite = "READ_WRITE",
3621
- }
3622
- export default DocumentsSupportType;
3623
- }
3624
-
3625
- declare module "sap/sac/df/types/SemanticRole" {
3626
- /**
3627
- * Semantic Role of a dimension member
3628
- *
3629
- * @experimental As of version 1.135.
3630
- */
3631
- enum SemanticRole {
3632
- /**
3633
- * Absolute Variance
3634
- */
3635
- AbsoluteVariance = "AbsoluteVariance",
3636
- /**
3637
- * Actual Data
3638
- */
3639
- Actual = "Actual",
3640
- /**
3641
- * Budget Data
3642
- */
3643
- Budget = "Budget",
3644
- /**
3645
- * Forecast Data
3646
- */
3647
- Forecast = "Forecast",
3648
- /**
3649
- * Percentage Variance
3650
- */
3651
- PercentageVariance = "PercentageVariance",
3652
- /**
3653
- * Previous Data
3654
- */
3655
- Previous = "Previous",
3656
- }
3657
- export default SemanticRole;
3658
- }
3659
-
3660
- declare module "sap/sac/df/types/SortDirection" {
3661
- /**
3662
- * Sort Direction
3663
- *
3664
- * @experimental As of version 1.130.
3665
- */
3666
- enum SortDirection {
3667
- /**
3668
- * Ascending
3669
- */
3670
- Ascending = "ASCENDING",
3671
- /**
3672
- * Descending
3673
- */
3674
- Descending = "DESCENDING",
3675
- /**
3676
- * No sorting
3677
- */
3678
- None = "NONE",
3679
- }
3680
- export default SortDirection;
3681
- }
3682
-
3683
- declare module "sap/sac/df/types/SortType" {
3684
- /**
3685
- * Sort Type
3686
- *
3687
- * @experimental As of version 1.130.
3688
- */
3689
- enum SortType {
3690
- /**
3691
- * Sort according to Filter
3692
- */
3693
- Filter = "FILTER",
3694
- /**
3695
- * Sort according to Key
3696
- */
3697
- MemberKey = "MEMBER_KEY",
3698
- /**
3699
- * Sort according to Text
3700
- */
3701
- MemberText = "MEMBER_TEXT",
3702
- /**
3703
- * No sorting
3704
- */
3705
- unset = "unset",
3706
- }
3707
- export default SortType;
3708
- }
3709
-
3710
- declare module "sap/sac/df/types/SystemType" {
3711
- /**
3712
- * System Type of an InA System
3713
- *
3714
- * @experimental As of version 1.89.
3715
- */
3716
- enum SystemType {
3717
- /**
3718
- * The ABAP analytic engine
3719
- */
3720
- ABAP_MDS = "ABAP_MDS",
3721
- /**
3722
- * The BW analytic engine
3723
- */
3724
- BW = "BW",
3725
- /**
3726
- * The Data Warehouce Cloud analytic engine
3727
- */
3728
- DWC = "DWC",
3729
- /**
3730
- * The HANA/MDS analytic engine
3731
- */
3732
- HANA = "HANA",
3733
- }
3734
- export default SystemType;
3735
- }
1
+ // For Library Version: 1.142.3
3736
2
 
3737
3
  declare namespace sap {
3738
4
  interface IUI5DefineDependencyNames {
@@ -3752,6 +18,8 @@ declare namespace sap {
3752
18
 
3753
19
  "sap/sac/df/library": undefined;
3754
20
 
21
+ "sap/sac/df/model/ConditionThreshold": undefined;
22
+
3755
23
  "sap/sac/df/model/Configuration": undefined;
3756
24
 
3757
25
  "sap/sac/df/model/DataProvider": undefined;
@@ -3764,10 +32,14 @@ declare namespace sap {
3764
32
 
3765
33
  "sap/sac/df/model/MultiDimModel": undefined;
3766
34
 
35
+ "sap/sac/df/model/Scenario": undefined;
36
+
3767
37
  "sap/sac/df/model/Variable": undefined;
3768
38
 
3769
39
  "sap/sac/df/model/VariableGroup": undefined;
3770
40
 
41
+ "sap/sac/df/model/Visualization": undefined;
42
+
3771
43
  "sap/sac/df/model/visualization/Documents": undefined;
3772
44
 
3773
45
  "sap/sac/df/model/visualization/Grid": undefined;
@@ -3776,6 +48,10 @@ declare namespace sap {
3776
48
 
3777
49
  "sap/sac/df/types/Axis": undefined;
3778
50
 
51
+ "sap/sac/df/types/ConditionComparisonOperator": undefined;
52
+
53
+ "sap/sac/df/types/ConditionEvaluationType": undefined;
54
+
3779
55
  "sap/sac/df/types/configuration/StylingPanelItem": undefined;
3780
56
 
3781
57
  "sap/sac/df/types/configuration/TableTemplate": undefined;
@@ -3793,5 +69,7 @@ declare namespace sap {
3793
69
  "sap/sac/df/types/SortType": undefined;
3794
70
 
3795
71
  "sap/sac/df/types/SystemType": undefined;
72
+
73
+ "sap/sac/df/Widget": undefined;
3796
74
  }
3797
75
  }