@sapui5/types 1.141.2 → 1.142.0

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