@sapui5/ts-types 1.141.4 → 1.142.1

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