@sapui5/types 1.113.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +35 -0
- package/README.md +35 -0
- package/package.json +23 -0
- package/types/index.d.ts +67 -0
- package/types/sap.apf.d.ts +1026 -0
- package/types/sap.ca.ui.d.ts +14005 -0
- package/types/sap.chart.d.ts +4815 -0
- package/types/sap.collaboration.d.ts +2704 -0
- package/types/sap.esh.search.ui.d.ts +1595 -0
- package/types/sap.f.d.ts +20085 -0
- package/types/sap.fe.core.d.ts +1508 -0
- package/types/sap.fe.macros.d.ts +975 -0
- package/types/sap.fe.navigation.d.ts +917 -0
- package/types/sap.fe.templates.d.ts +522 -0
- package/types/sap.fe.test.d.ts +3533 -0
- package/types/sap.feedback.ui.d.ts +3 -0
- package/types/sap.gantt.d.ts +51684 -0
- package/types/sap.insights.d.ts +23 -0
- package/types/sap.landvisz.d.ts +7952 -0
- package/types/sap.m.d.ts +147796 -0
- package/types/sap.makit.d.ts +4533 -0
- package/types/sap.me.d.ts +3665 -0
- package/types/sap.ndc.d.ts +774 -0
- package/types/sap.ovp.d.ts +176 -0
- package/types/sap.rules.ui.d.ts +1471 -0
- package/types/sap.sac.df.d.ts +2292 -0
- package/types/sap.sac.grid.d.ts +774 -0
- package/types/sap.suite.ui.commons.d.ts +46971 -0
- package/types/sap.suite.ui.generic.template.d.ts +3431 -0
- package/types/sap.suite.ui.microchart.d.ts +12652 -0
- package/types/sap.tnt.d.ts +2227 -0
- package/types/sap.ui.codeeditor.d.ts +693 -0
- package/types/sap.ui.commons.d.ts +30235 -0
- package/types/sap.ui.comp.d.ts +37411 -0
- package/types/sap.ui.core.d.ts +78872 -0
- package/types/sap.ui.dt.d.ts +3 -0
- package/types/sap.ui.export.d.ts +843 -0
- package/types/sap.ui.fl.d.ts +1663 -0
- package/types/sap.ui.generic.app.d.ts +2683 -0
- package/types/sap.ui.generic.template.d.ts +3 -0
- package/types/sap.ui.integration.d.ts +4032 -0
- package/types/sap.ui.layout.d.ts +14472 -0
- package/types/sap.ui.mdc.d.ts +476 -0
- package/types/sap.ui.richtexteditor.d.ts +1666 -0
- package/types/sap.ui.rta.d.ts +124 -0
- package/types/sap.ui.suite.d.ts +685 -0
- package/types/sap.ui.support.d.ts +453 -0
- package/types/sap.ui.table.d.ts +9325 -0
- package/types/sap.ui.testrecorder.d.ts +9 -0
- package/types/sap.ui.unified.d.ts +20640 -0
- package/types/sap.ui.ux3.d.ts +18288 -0
- package/types/sap.ui.vbm.d.ts +17251 -0
- package/types/sap.ui.vk.d.ts +42381 -0
- package/types/sap.ui.vtm.d.ts +10547 -0
- package/types/sap.ui.webc.common.d.ts +113 -0
- package/types/sap.ui.webc.fiori.d.ts +13850 -0
- package/types/sap.ui.webc.main.d.ts +40833 -0
- package/types/sap.uiext.inbox.d.ts +4079 -0
- package/types/sap.ushell.d.ts +10255 -0
- package/types/sap.ushell_abap.d.ts +9 -0
- package/types/sap.uxap.d.ts +7636 -0
- package/types/sap.viz.d.ts +51209 -0
- package/types/sap.webanalytics.core.d.ts +3 -0
- package/types/sap.zen.commons.d.ts +1542 -0
- package/types/sap.zen.crosstab.d.ts +1159 -0
- package/types/sap.zen.dsh.d.ts +2132 -0
|
@@ -0,0 +1,2292 @@
|
|
|
1
|
+
// For Library Version: 1.113.0
|
|
2
|
+
|
|
3
|
+
declare module "sap/sac/df/library" {}
|
|
4
|
+
|
|
5
|
+
declare module "sap/sac/df/FilterBar" {
|
|
6
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
7
|
+
|
|
8
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* @EXPERIMENTAL
|
|
12
|
+
*
|
|
13
|
+
* A FilterBar control based on Multidimensional Model
|
|
14
|
+
*/
|
|
15
|
+
export default class FilterBar
|
|
16
|
+
/* was: sap.ui.mdc.FilterBar */ extends Object {
|
|
17
|
+
/**
|
|
18
|
+
* Constructor for a new Filter Bar.
|
|
19
|
+
*
|
|
20
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
21
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
22
|
+
* of the syntax of the settings object.
|
|
23
|
+
*/
|
|
24
|
+
constructor();
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* Creates a new subclass of class sap.sac.df.FilterBar with name `sClassName` and enriches it with the
|
|
28
|
+
* information contained in `oClassInfo`.
|
|
29
|
+
*
|
|
30
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.mdc.FilterBar.extend}.
|
|
31
|
+
*
|
|
32
|
+
* @returns Created class / constructor function
|
|
33
|
+
*/
|
|
34
|
+
static extend<T extends Record<string, unknown>>(
|
|
35
|
+
/**
|
|
36
|
+
* Name of the class being created
|
|
37
|
+
*/
|
|
38
|
+
sClassName: string,
|
|
39
|
+
/**
|
|
40
|
+
* Object literal with information about the class
|
|
41
|
+
*/
|
|
42
|
+
oClassInfo?: sap.ClassInfo<T, FilterBar>,
|
|
43
|
+
/**
|
|
44
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
45
|
+
* used by this class
|
|
46
|
+
*/
|
|
47
|
+
FNMetaImpl?: Function
|
|
48
|
+
): Function;
|
|
49
|
+
/**
|
|
50
|
+
* Returns a metadata object for class sap.sac.df.FilterBar.
|
|
51
|
+
*
|
|
52
|
+
* @returns Metadata object describing this class
|
|
53
|
+
*/
|
|
54
|
+
static getMetadata(): ElementMetadata;
|
|
55
|
+
/**
|
|
56
|
+
* Gets current value of property {@link #getMode mode}.
|
|
57
|
+
*
|
|
58
|
+
* Mode
|
|
59
|
+
*
|
|
60
|
+
* Default value is `"VariablesOfDataProvider"`.
|
|
61
|
+
*
|
|
62
|
+
* @returns Value of property `mode`
|
|
63
|
+
*/
|
|
64
|
+
getMode(): string;
|
|
65
|
+
/**
|
|
66
|
+
* Gets current value of property {@link #getMultiDimModelId multiDimModelId}.
|
|
67
|
+
*
|
|
68
|
+
* ID of multiDimModel
|
|
69
|
+
*
|
|
70
|
+
* Default value is `"om"`.
|
|
71
|
+
*
|
|
72
|
+
* @returns Value of property `multiDimModelId`
|
|
73
|
+
*/
|
|
74
|
+
getMultiDimModelId(): string;
|
|
75
|
+
/**
|
|
76
|
+
* Sets a new value for property {@link #getMode mode}.
|
|
77
|
+
*
|
|
78
|
+
* Mode
|
|
79
|
+
*
|
|
80
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
81
|
+
*
|
|
82
|
+
* Default value is `"VariablesOfDataProvider"`.
|
|
83
|
+
*
|
|
84
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
85
|
+
*/
|
|
86
|
+
setMode(
|
|
87
|
+
/**
|
|
88
|
+
* New value for property `mode`
|
|
89
|
+
*/
|
|
90
|
+
sMode?: string
|
|
91
|
+
): this;
|
|
92
|
+
/**
|
|
93
|
+
* Sets a new value for property {@link #getMultiDimModelId multiDimModelId}.
|
|
94
|
+
*
|
|
95
|
+
* ID of multiDimModel
|
|
96
|
+
*
|
|
97
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
98
|
+
*
|
|
99
|
+
* Default value is `"om"`.
|
|
100
|
+
*
|
|
101
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
102
|
+
*/
|
|
103
|
+
setMultiDimModelId(
|
|
104
|
+
/**
|
|
105
|
+
* New value for property `multiDimModelId`
|
|
106
|
+
*/
|
|
107
|
+
sMultiDimModelId?: string
|
|
108
|
+
): this;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export interface $FilterBarSettings
|
|
112
|
+
extends /* was: sap.ui.mdc.$FilterBarSettings */ Object {
|
|
113
|
+
/**
|
|
114
|
+
* ID of multiDimModel
|
|
115
|
+
*/
|
|
116
|
+
multiDimModelId?: string | PropertyBindingInfo;
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Mode
|
|
120
|
+
*/
|
|
121
|
+
mode?: string | PropertyBindingInfo;
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
declare module "sap/sac/df/FlexAnalysis" {
|
|
126
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
127
|
+
|
|
128
|
+
import FlexAnalysisPanel from "sap/sac/df/FlexAnalysisPanel";
|
|
129
|
+
|
|
130
|
+
import {
|
|
131
|
+
PropertyBindingInfo,
|
|
132
|
+
AggregationBindingInfo,
|
|
133
|
+
} from "sap/ui/base/ManagedObject";
|
|
134
|
+
|
|
135
|
+
import { CSSSize } from "sap/ui/core/library";
|
|
136
|
+
|
|
137
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
138
|
+
|
|
139
|
+
import SystemType from "sap/sac/df/types/SystemType";
|
|
140
|
+
|
|
141
|
+
/**
|
|
142
|
+
* @EXPERIMENTAL
|
|
143
|
+
*
|
|
144
|
+
* Enables users to view, navigate and change multidimensional data exposed via InA.
|
|
145
|
+
*
|
|
146
|
+
* Overview:
|
|
147
|
+
*
|
|
148
|
+
* The user can view the data in a Table, navigate in the data via a context menu or builder panels The
|
|
149
|
+
* data source that the FlexAnalysis consumes or renders has to be provided as a property value.
|
|
150
|
+
*/
|
|
151
|
+
export default class FlexAnalysis extends Control {
|
|
152
|
+
/**
|
|
153
|
+
* Constructor for a new `FlexAnalysis`.
|
|
154
|
+
*
|
|
155
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
156
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
157
|
+
* of the syntax of the settings object.
|
|
158
|
+
*/
|
|
159
|
+
constructor(
|
|
160
|
+
/**
|
|
161
|
+
* ID for the new control, generated automatically if no ID is given
|
|
162
|
+
*/
|
|
163
|
+
sId?: string
|
|
164
|
+
);
|
|
165
|
+
|
|
166
|
+
/**
|
|
167
|
+
* Creates a new subclass of class sap.sac.df.FlexAnalysis with name `sClassName` and enriches it with the
|
|
168
|
+
* information contained in `oClassInfo`.
|
|
169
|
+
*
|
|
170
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
171
|
+
*
|
|
172
|
+
* @returns Created class / constructor function
|
|
173
|
+
*/
|
|
174
|
+
static extend<T extends Record<string, unknown>>(
|
|
175
|
+
/**
|
|
176
|
+
* Name of the class being created
|
|
177
|
+
*/
|
|
178
|
+
sClassName: string,
|
|
179
|
+
/**
|
|
180
|
+
* Object literal with information about the class
|
|
181
|
+
*/
|
|
182
|
+
oClassInfo?: sap.ClassInfo<T, FlexAnalysis>,
|
|
183
|
+
/**
|
|
184
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
185
|
+
* used by this class
|
|
186
|
+
*/
|
|
187
|
+
FNMetaImpl?: Function
|
|
188
|
+
): Function;
|
|
189
|
+
/**
|
|
190
|
+
* Returns a metadata object for class sap.sac.df.FlexAnalysis.
|
|
191
|
+
*
|
|
192
|
+
* @returns Metadata object describing this class
|
|
193
|
+
*/
|
|
194
|
+
static getMetadata(): ElementMetadata;
|
|
195
|
+
/**
|
|
196
|
+
* Adds some customPanel to the aggregation {@link #getCustomPanels customPanels}.
|
|
197
|
+
*
|
|
198
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
199
|
+
*/
|
|
200
|
+
addCustomPanel(
|
|
201
|
+
/**
|
|
202
|
+
* The customPanel to add; if empty, nothing is inserted
|
|
203
|
+
*/
|
|
204
|
+
oCustomPanel: FlexAnalysisPanel
|
|
205
|
+
): this;
|
|
206
|
+
/**
|
|
207
|
+
* Binds property {@link #getDataProvider dataProvider} to model data.
|
|
208
|
+
*
|
|
209
|
+
* See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description
|
|
210
|
+
* of the possible properties of `oBindingInfo`
|
|
211
|
+
*
|
|
212
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
213
|
+
*/
|
|
214
|
+
bindDataProvider(
|
|
215
|
+
/**
|
|
216
|
+
* The binding information
|
|
217
|
+
*/
|
|
218
|
+
oBindingInfo: PropertyBindingInfo
|
|
219
|
+
): this;
|
|
220
|
+
/**
|
|
221
|
+
* Destroys all the customPanels in the aggregation {@link #getCustomPanels customPanels}.
|
|
222
|
+
*
|
|
223
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
224
|
+
*/
|
|
225
|
+
destroyCustomPanels(): this;
|
|
226
|
+
/**
|
|
227
|
+
* Gets current value of property {@link #getAutoUpdate autoUpdate}.
|
|
228
|
+
*
|
|
229
|
+
* Indicates if Flexible Analysis component automatically requests the ResultSet for the shown data source
|
|
230
|
+
*
|
|
231
|
+
* Default value is `true`.
|
|
232
|
+
*
|
|
233
|
+
* @returns Value of property `autoUpdate`
|
|
234
|
+
*/
|
|
235
|
+
getAutoUpdate(): boolean;
|
|
236
|
+
/**
|
|
237
|
+
* Gets current value of property {@link #getClientIdentifier clientIdentifier}.
|
|
238
|
+
*
|
|
239
|
+
* Client Identifier to be used for underlying InA queries
|
|
240
|
+
*
|
|
241
|
+
* @returns Value of property `clientIdentifier`
|
|
242
|
+
*/
|
|
243
|
+
getClientIdentifier(): string;
|
|
244
|
+
/**
|
|
245
|
+
* Gets current value of property {@link #getConfigObject configObject}.
|
|
246
|
+
*
|
|
247
|
+
* JSON object containing the configuration (alternative to configurationURI)
|
|
248
|
+
*
|
|
249
|
+
* @returns Value of property `configObject`
|
|
250
|
+
*/
|
|
251
|
+
getConfigObject(): object;
|
|
252
|
+
/**
|
|
253
|
+
* Gets current value of property {@link #getConfigurationURI configurationURI}.
|
|
254
|
+
*
|
|
255
|
+
* URI of the advanced configuration to be fetched
|
|
256
|
+
*
|
|
257
|
+
* @returns Value of property `configurationURI`
|
|
258
|
+
*/
|
|
259
|
+
getConfigurationURI(): string;
|
|
260
|
+
/**
|
|
261
|
+
* Gets content of aggregation {@link #getCustomPanels customPanels}.
|
|
262
|
+
*
|
|
263
|
+
* Custom panels for the flexible analysis control
|
|
264
|
+
*/
|
|
265
|
+
getCustomPanels(): FlexAnalysisPanel[];
|
|
266
|
+
/**
|
|
267
|
+
* Gets current value of property {@link #getDataProvider dataProvider}.
|
|
268
|
+
*
|
|
269
|
+
* Name of the Data Provider from the corresponding MultiDimModel to be used
|
|
270
|
+
*
|
|
271
|
+
* @returns Value of property `dataProvider`
|
|
272
|
+
*/
|
|
273
|
+
getDataProvider(): any;
|
|
274
|
+
/**
|
|
275
|
+
* Gets current value of property {@link #getDataSource dataSource}.
|
|
276
|
+
*
|
|
277
|
+
* Data source (Query name/ View, InA model etc) to be used to get the data from
|
|
278
|
+
*
|
|
279
|
+
* Default value is `"$datasource"`.
|
|
280
|
+
*
|
|
281
|
+
* @returns Value of property `dataSource`
|
|
282
|
+
*/
|
|
283
|
+
getDataSource(): string;
|
|
284
|
+
/**
|
|
285
|
+
* Gets current value of property {@link #getEnvironment environment}.
|
|
286
|
+
*
|
|
287
|
+
* Additional Flag to be passed to the control TODO: Document the possibilities
|
|
288
|
+
*
|
|
289
|
+
* Default value is `[]`.
|
|
290
|
+
*
|
|
291
|
+
* @returns Value of property `environment`
|
|
292
|
+
*/
|
|
293
|
+
getEnvironment(): string[];
|
|
294
|
+
/**
|
|
295
|
+
* Gets current value of property {@link #getHeight height}.
|
|
296
|
+
*
|
|
297
|
+
* Height of the component
|
|
298
|
+
*
|
|
299
|
+
* Default value is `"100%"`.
|
|
300
|
+
*
|
|
301
|
+
* @returns Value of property `height`
|
|
302
|
+
*/
|
|
303
|
+
getHeight(): CSSSize;
|
|
304
|
+
/**
|
|
305
|
+
* Gets current value of property {@link #getHideDesignPanel hideDesignPanel}.
|
|
306
|
+
*
|
|
307
|
+
* Sets if the Design Panel of FlexAnalysis is hidden
|
|
308
|
+
*
|
|
309
|
+
* Default value is `true`.
|
|
310
|
+
*
|
|
311
|
+
* @returns Value of property `hideDesignPanel`
|
|
312
|
+
*/
|
|
313
|
+
getHideDesignPanel(): boolean;
|
|
314
|
+
/**
|
|
315
|
+
* Gets current value of property {@link #getHideFilterLine hideFilterLine}.
|
|
316
|
+
*
|
|
317
|
+
* Sets if the filter of FlexAnalysis is hidden
|
|
318
|
+
*
|
|
319
|
+
* Default value is `false`.
|
|
320
|
+
*
|
|
321
|
+
* @returns Value of property `hideFilterLine`
|
|
322
|
+
*/
|
|
323
|
+
getHideFilterLine(): boolean;
|
|
324
|
+
/**
|
|
325
|
+
* Gets current value of property {@link #getHideLandingPage hideLandingPage}.
|
|
326
|
+
*
|
|
327
|
+
* Sets if the landing page of FlexAnalysis is hidden
|
|
328
|
+
*
|
|
329
|
+
* Default value is `true`.
|
|
330
|
+
*
|
|
331
|
+
* @returns Value of property `hideLandingPage`
|
|
332
|
+
*/
|
|
333
|
+
getHideLandingPage(): boolean;
|
|
334
|
+
/**
|
|
335
|
+
* Gets current value of property {@link #getHideMenuBar hideMenuBar}.
|
|
336
|
+
*
|
|
337
|
+
* Sets if the menu bar of FlexAnalysis is hidden
|
|
338
|
+
*
|
|
339
|
+
* Default value is `true`.
|
|
340
|
+
*
|
|
341
|
+
* @returns Value of property `hideMenuBar`
|
|
342
|
+
*/
|
|
343
|
+
getHideMenuBar(): boolean;
|
|
344
|
+
/**
|
|
345
|
+
* Gets current value of property {@link #getHideSideNavigation hideSideNavigation}.
|
|
346
|
+
*
|
|
347
|
+
* Sets if the side navigation bar of FlexAnalysis is hidden
|
|
348
|
+
*
|
|
349
|
+
* Default value is `false`.
|
|
350
|
+
*
|
|
351
|
+
* @returns Value of property `hideSideNavigation`
|
|
352
|
+
*/
|
|
353
|
+
getHideSideNavigation(): boolean;
|
|
354
|
+
/**
|
|
355
|
+
* Gets current value of property {@link #getHideStatusBar hideStatusBar}.
|
|
356
|
+
*
|
|
357
|
+
* Sets if the status bar of FlexAnalysis is hidden
|
|
358
|
+
*
|
|
359
|
+
* Default value is `true`.
|
|
360
|
+
*
|
|
361
|
+
* @returns Value of property `hideStatusBar`
|
|
362
|
+
*/
|
|
363
|
+
getHideStatusBar(): boolean;
|
|
364
|
+
/**
|
|
365
|
+
* Gets current value of property {@link #getHideStylePanel hideStylePanel}.
|
|
366
|
+
*
|
|
367
|
+
* Sets if the Style Panel of FlexAnalysis is hidden
|
|
368
|
+
*
|
|
369
|
+
* Default value is `true`.
|
|
370
|
+
*
|
|
371
|
+
* @returns Value of property `hideStylePanel`
|
|
372
|
+
*/
|
|
373
|
+
getHideStylePanel(): boolean;
|
|
374
|
+
/**
|
|
375
|
+
* Gets current value of property {@link #getHideToolBar hideToolBar}.
|
|
376
|
+
*
|
|
377
|
+
* Sets if the toolbar of FlexAnalysis is hidden
|
|
378
|
+
*
|
|
379
|
+
* Default value is `true`.
|
|
380
|
+
*
|
|
381
|
+
* @returns Value of property `hideToolBar`
|
|
382
|
+
*/
|
|
383
|
+
getHideToolBar(): boolean;
|
|
384
|
+
/**
|
|
385
|
+
* Gets current value of property {@link #getImplicitVariableHandling implicitVariableHandling}.
|
|
386
|
+
*
|
|
387
|
+
* Indicates if the variable are handled internal handling by FlexAnalysis. If set to false it is done via
|
|
388
|
+
* corresponding MultiDimModel
|
|
389
|
+
*
|
|
390
|
+
* Default value is `true`.
|
|
391
|
+
*
|
|
392
|
+
* @returns Value of property `implicitVariableHandling`
|
|
393
|
+
*/
|
|
394
|
+
getImplicitVariableHandling(): boolean;
|
|
395
|
+
/**
|
|
396
|
+
* Gets current value of property {@link #getKeepAliveInterval keepAliveInterval}.
|
|
397
|
+
*
|
|
398
|
+
* Interval to keep the InA session alive. values less than 1 deactivates the keep alive handling
|
|
399
|
+
*
|
|
400
|
+
* Default value is `0`.
|
|
401
|
+
*
|
|
402
|
+
* @returns Value of property `keepAliveInterval`
|
|
403
|
+
*/
|
|
404
|
+
getKeepAliveInterval(): int;
|
|
405
|
+
/**
|
|
406
|
+
* Gets current value of property {@link #getMultiDimModelId multiDimModelId}.
|
|
407
|
+
*
|
|
408
|
+
* Id of the MultiDimModel to use
|
|
409
|
+
*
|
|
410
|
+
* Default value is `"om"`.
|
|
411
|
+
*
|
|
412
|
+
* @returns Value of property `multiDimModelId`
|
|
413
|
+
*/
|
|
414
|
+
getMultiDimModelId(): string;
|
|
415
|
+
/**
|
|
416
|
+
* Gets current value of property {@link #getShowTitle showTitle}.
|
|
417
|
+
*
|
|
418
|
+
* Indicates Flexible Analysis component should display the component title
|
|
419
|
+
*
|
|
420
|
+
* Default value is `false`.
|
|
421
|
+
*
|
|
422
|
+
* @returns Value of property `showTitle`
|
|
423
|
+
*/
|
|
424
|
+
getShowTitle(): boolean;
|
|
425
|
+
/**
|
|
426
|
+
* Gets current value of property {@link #getStyleTemplateName styleTemplateName}.
|
|
427
|
+
*
|
|
428
|
+
* Indicates if the variable are handled internal handling by FlexAnalysis. If set to false it is done via
|
|
429
|
+
* corresponding MultiDimModel
|
|
430
|
+
*
|
|
431
|
+
* @returns Value of property `styleTemplateName`
|
|
432
|
+
*/
|
|
433
|
+
getStyleTemplateName(): string;
|
|
434
|
+
/**
|
|
435
|
+
* Gets current value of property {@link #getSystemName systemName}.
|
|
436
|
+
*
|
|
437
|
+
* System to take data from. If not set or set to "local" current url will be used to determine the system
|
|
438
|
+
*
|
|
439
|
+
* @returns Value of property `systemName`
|
|
440
|
+
*/
|
|
441
|
+
getSystemName(): string;
|
|
442
|
+
/**
|
|
443
|
+
* Gets current value of property {@link #getSystemType systemType}.
|
|
444
|
+
*
|
|
445
|
+
* Type the system to connect to get data
|
|
446
|
+
*
|
|
447
|
+
* Default value is `BW`.
|
|
448
|
+
*
|
|
449
|
+
* @returns Value of property `systemType`
|
|
450
|
+
*/
|
|
451
|
+
getSystemType(): SystemType | keyof typeof SystemType;
|
|
452
|
+
/**
|
|
453
|
+
* Gets current value of property {@link #getTitle title}.
|
|
454
|
+
*
|
|
455
|
+
* Sets title to be shown in the control. If not set the name of the corresponding back-end query is used
|
|
456
|
+
*
|
|
457
|
+
* @returns Value of property `title`
|
|
458
|
+
*/
|
|
459
|
+
getTitle(): string;
|
|
460
|
+
/**
|
|
461
|
+
* Gets current value of property {@link #getWidth width}.
|
|
462
|
+
*
|
|
463
|
+
* Width of the component
|
|
464
|
+
*
|
|
465
|
+
* Default value is `"100%"`.
|
|
466
|
+
*
|
|
467
|
+
* @returns Value of property `width`
|
|
468
|
+
*/
|
|
469
|
+
getWidth(): CSSSize;
|
|
470
|
+
/**
|
|
471
|
+
* Checks for the provided `sap.sac.df.FlexAnalysisPanel` in the aggregation {@link #getCustomPanels customPanels}.
|
|
472
|
+
* and returns its index if found or -1 otherwise.
|
|
473
|
+
*
|
|
474
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
475
|
+
*/
|
|
476
|
+
indexOfCustomPanel(
|
|
477
|
+
/**
|
|
478
|
+
* The customPanel whose index is looked for
|
|
479
|
+
*/
|
|
480
|
+
oCustomPanel: FlexAnalysisPanel
|
|
481
|
+
): int;
|
|
482
|
+
/**
|
|
483
|
+
* Inserts a customPanel into the aggregation {@link #getCustomPanels customPanels}.
|
|
484
|
+
*
|
|
485
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
486
|
+
*/
|
|
487
|
+
insertCustomPanel(
|
|
488
|
+
/**
|
|
489
|
+
* The customPanel to insert; if empty, nothing is inserted
|
|
490
|
+
*/
|
|
491
|
+
oCustomPanel: FlexAnalysisPanel,
|
|
492
|
+
/**
|
|
493
|
+
* The `0`-based index the customPanel should be inserted at; for a negative value of `iIndex`, the customPanel
|
|
494
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the customPanel
|
|
495
|
+
* is inserted at the last position
|
|
496
|
+
*/
|
|
497
|
+
iIndex: int
|
|
498
|
+
): this;
|
|
499
|
+
/**
|
|
500
|
+
* Removes all the controls from the aggregation {@link #getCustomPanels customPanels}.
|
|
501
|
+
*
|
|
502
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
503
|
+
*
|
|
504
|
+
* @returns An array of the removed elements (might be empty)
|
|
505
|
+
*/
|
|
506
|
+
removeAllCustomPanels(): FlexAnalysisPanel[];
|
|
507
|
+
/**
|
|
508
|
+
* Removes a customPanel from the aggregation {@link #getCustomPanels customPanels}.
|
|
509
|
+
*
|
|
510
|
+
* @returns The removed customPanel or `null`
|
|
511
|
+
*/
|
|
512
|
+
removeCustomPanel(
|
|
513
|
+
/**
|
|
514
|
+
* The customPanel to remove or its index or id
|
|
515
|
+
*/
|
|
516
|
+
vCustomPanel: int | string | FlexAnalysisPanel
|
|
517
|
+
): FlexAnalysisPanel | null;
|
|
518
|
+
/**
|
|
519
|
+
* Sets a new value for property {@link #getAutoUpdate autoUpdate}.
|
|
520
|
+
*
|
|
521
|
+
* Indicates if Flexible Analysis component automatically requests the ResultSet for the shown data source
|
|
522
|
+
*
|
|
523
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
524
|
+
*
|
|
525
|
+
* Default value is `true`.
|
|
526
|
+
*
|
|
527
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
528
|
+
*/
|
|
529
|
+
setAutoUpdate(
|
|
530
|
+
/**
|
|
531
|
+
* New value for property `autoUpdate`
|
|
532
|
+
*/
|
|
533
|
+
bAutoUpdate?: boolean
|
|
534
|
+
): this;
|
|
535
|
+
/**
|
|
536
|
+
* Sets a new value for property {@link #getClientIdentifier clientIdentifier}.
|
|
537
|
+
*
|
|
538
|
+
* Client Identifier to be used for underlying InA queries
|
|
539
|
+
*
|
|
540
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
541
|
+
*
|
|
542
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
543
|
+
*/
|
|
544
|
+
setClientIdentifier(
|
|
545
|
+
/**
|
|
546
|
+
* New value for property `clientIdentifier`
|
|
547
|
+
*/
|
|
548
|
+
sClientIdentifier: string
|
|
549
|
+
): this;
|
|
550
|
+
/**
|
|
551
|
+
* Sets a new value for property {@link #getConfigObject configObject}.
|
|
552
|
+
*
|
|
553
|
+
* JSON object containing the configuration (alternative to configurationURI)
|
|
554
|
+
*
|
|
555
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
556
|
+
*
|
|
557
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
558
|
+
*/
|
|
559
|
+
setConfigObject(
|
|
560
|
+
/**
|
|
561
|
+
* New value for property `configObject`
|
|
562
|
+
*/
|
|
563
|
+
oConfigObject: object
|
|
564
|
+
): this;
|
|
565
|
+
/**
|
|
566
|
+
* Sets a new value for property {@link #getConfigurationURI configurationURI}.
|
|
567
|
+
*
|
|
568
|
+
* URI of the advanced configuration to be fetched
|
|
569
|
+
*
|
|
570
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
571
|
+
*
|
|
572
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
573
|
+
*/
|
|
574
|
+
setConfigurationURI(
|
|
575
|
+
/**
|
|
576
|
+
* New value for property `configurationURI`
|
|
577
|
+
*/
|
|
578
|
+
sConfigurationURI: string
|
|
579
|
+
): this;
|
|
580
|
+
/**
|
|
581
|
+
* Sets a new value for property {@link #getDataProvider dataProvider}.
|
|
582
|
+
*
|
|
583
|
+
* Name of the Data Provider from the corresponding MultiDimModel to be used
|
|
584
|
+
*
|
|
585
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
586
|
+
*
|
|
587
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
588
|
+
*/
|
|
589
|
+
setDataProvider(
|
|
590
|
+
/**
|
|
591
|
+
* New value for property `dataProvider`
|
|
592
|
+
*/
|
|
593
|
+
oDataProvider: any
|
|
594
|
+
): this;
|
|
595
|
+
/**
|
|
596
|
+
* Sets a new value for property {@link #getDataSource dataSource}.
|
|
597
|
+
*
|
|
598
|
+
* Data source (Query name/ View, InA model etc) to be used to get the data from
|
|
599
|
+
*
|
|
600
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
601
|
+
*
|
|
602
|
+
* Default value is `"$datasource"`.
|
|
603
|
+
*
|
|
604
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
605
|
+
*/
|
|
606
|
+
setDataSource(
|
|
607
|
+
/**
|
|
608
|
+
* New value for property `dataSource`
|
|
609
|
+
*/
|
|
610
|
+
sDataSource?: string
|
|
611
|
+
): this;
|
|
612
|
+
/**
|
|
613
|
+
* Sets a new value for property {@link #getEnvironment environment}.
|
|
614
|
+
*
|
|
615
|
+
* Additional Flag to be passed to the control TODO: Document the possibilities
|
|
616
|
+
*
|
|
617
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
618
|
+
*
|
|
619
|
+
* Default value is `[]`.
|
|
620
|
+
*
|
|
621
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
622
|
+
*/
|
|
623
|
+
setEnvironment(
|
|
624
|
+
/**
|
|
625
|
+
* New value for property `environment`
|
|
626
|
+
*/
|
|
627
|
+
sEnvironment?: string[]
|
|
628
|
+
): this;
|
|
629
|
+
/**
|
|
630
|
+
* Sets a new value for property {@link #getHeight height}.
|
|
631
|
+
*
|
|
632
|
+
* Height of the component
|
|
633
|
+
*
|
|
634
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
635
|
+
*
|
|
636
|
+
* Default value is `"100%"`.
|
|
637
|
+
*
|
|
638
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
639
|
+
*/
|
|
640
|
+
setHeight(
|
|
641
|
+
/**
|
|
642
|
+
* New value for property `height`
|
|
643
|
+
*/
|
|
644
|
+
sHeight?: CSSSize
|
|
645
|
+
): this;
|
|
646
|
+
/**
|
|
647
|
+
* Sets a new value for property {@link #getHideDesignPanel hideDesignPanel}.
|
|
648
|
+
*
|
|
649
|
+
* Sets if the Design Panel of FlexAnalysis is hidden
|
|
650
|
+
*
|
|
651
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
652
|
+
*
|
|
653
|
+
* Default value is `true`.
|
|
654
|
+
*
|
|
655
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
656
|
+
*/
|
|
657
|
+
setHideDesignPanel(
|
|
658
|
+
/**
|
|
659
|
+
* New value for property `hideDesignPanel`
|
|
660
|
+
*/
|
|
661
|
+
bHideDesignPanel?: boolean
|
|
662
|
+
): this;
|
|
663
|
+
/**
|
|
664
|
+
* Sets a new value for property {@link #getHideFilterLine hideFilterLine}.
|
|
665
|
+
*
|
|
666
|
+
* Sets if the filter of FlexAnalysis is hidden
|
|
667
|
+
*
|
|
668
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
669
|
+
*
|
|
670
|
+
* Default value is `false`.
|
|
671
|
+
*
|
|
672
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
673
|
+
*/
|
|
674
|
+
setHideFilterLine(
|
|
675
|
+
/**
|
|
676
|
+
* New value for property `hideFilterLine`
|
|
677
|
+
*/
|
|
678
|
+
bHideFilterLine?: boolean
|
|
679
|
+
): this;
|
|
680
|
+
/**
|
|
681
|
+
* Sets a new value for property {@link #getHideLandingPage hideLandingPage}.
|
|
682
|
+
*
|
|
683
|
+
* Sets if the landing page of FlexAnalysis is hidden
|
|
684
|
+
*
|
|
685
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
686
|
+
*
|
|
687
|
+
* Default value is `true`.
|
|
688
|
+
*
|
|
689
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
690
|
+
*/
|
|
691
|
+
setHideLandingPage(
|
|
692
|
+
/**
|
|
693
|
+
* New value for property `hideLandingPage`
|
|
694
|
+
*/
|
|
695
|
+
bHideLandingPage?: boolean
|
|
696
|
+
): this;
|
|
697
|
+
/**
|
|
698
|
+
* Sets a new value for property {@link #getHideMenuBar hideMenuBar}.
|
|
699
|
+
*
|
|
700
|
+
* Sets if the menu bar of FlexAnalysis is hidden
|
|
701
|
+
*
|
|
702
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
703
|
+
*
|
|
704
|
+
* Default value is `true`.
|
|
705
|
+
*
|
|
706
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
707
|
+
*/
|
|
708
|
+
setHideMenuBar(
|
|
709
|
+
/**
|
|
710
|
+
* New value for property `hideMenuBar`
|
|
711
|
+
*/
|
|
712
|
+
bHideMenuBar?: boolean
|
|
713
|
+
): this;
|
|
714
|
+
/**
|
|
715
|
+
* Sets a new value for property {@link #getHideSideNavigation hideSideNavigation}.
|
|
716
|
+
*
|
|
717
|
+
* Sets if the side navigation bar of FlexAnalysis is hidden
|
|
718
|
+
*
|
|
719
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
720
|
+
*
|
|
721
|
+
* Default value is `false`.
|
|
722
|
+
*
|
|
723
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
724
|
+
*/
|
|
725
|
+
setHideSideNavigation(
|
|
726
|
+
/**
|
|
727
|
+
* New value for property `hideSideNavigation`
|
|
728
|
+
*/
|
|
729
|
+
bHideSideNavigation?: boolean
|
|
730
|
+
): this;
|
|
731
|
+
/**
|
|
732
|
+
* Sets a new value for property {@link #getHideStatusBar hideStatusBar}.
|
|
733
|
+
*
|
|
734
|
+
* Sets if the status bar of FlexAnalysis is hidden
|
|
735
|
+
*
|
|
736
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
737
|
+
*
|
|
738
|
+
* Default value is `true`.
|
|
739
|
+
*
|
|
740
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
741
|
+
*/
|
|
742
|
+
setHideStatusBar(
|
|
743
|
+
/**
|
|
744
|
+
* New value for property `hideStatusBar`
|
|
745
|
+
*/
|
|
746
|
+
bHideStatusBar?: boolean
|
|
747
|
+
): this;
|
|
748
|
+
/**
|
|
749
|
+
* Sets a new value for property {@link #getHideStylePanel hideStylePanel}.
|
|
750
|
+
*
|
|
751
|
+
* Sets if the Style Panel of FlexAnalysis is hidden
|
|
752
|
+
*
|
|
753
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
754
|
+
*
|
|
755
|
+
* Default value is `true`.
|
|
756
|
+
*
|
|
757
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
758
|
+
*/
|
|
759
|
+
setHideStylePanel(
|
|
760
|
+
/**
|
|
761
|
+
* New value for property `hideStylePanel`
|
|
762
|
+
*/
|
|
763
|
+
bHideStylePanel?: boolean
|
|
764
|
+
): this;
|
|
765
|
+
/**
|
|
766
|
+
* Sets a new value for property {@link #getHideToolBar hideToolBar}.
|
|
767
|
+
*
|
|
768
|
+
* Sets if the toolbar of FlexAnalysis is hidden
|
|
769
|
+
*
|
|
770
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
771
|
+
*
|
|
772
|
+
* Default value is `true`.
|
|
773
|
+
*
|
|
774
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
775
|
+
*/
|
|
776
|
+
setHideToolBar(
|
|
777
|
+
/**
|
|
778
|
+
* New value for property `hideToolBar`
|
|
779
|
+
*/
|
|
780
|
+
bHideToolBar?: boolean
|
|
781
|
+
): this;
|
|
782
|
+
/**
|
|
783
|
+
* Sets a new value for property {@link #getImplicitVariableHandling implicitVariableHandling}.
|
|
784
|
+
*
|
|
785
|
+
* Indicates if the variable are handled internal handling by FlexAnalysis. If set to false it is done via
|
|
786
|
+
* corresponding MultiDimModel
|
|
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 `true`.
|
|
791
|
+
*
|
|
792
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
793
|
+
*/
|
|
794
|
+
setImplicitVariableHandling(
|
|
795
|
+
/**
|
|
796
|
+
* New value for property `implicitVariableHandling`
|
|
797
|
+
*/
|
|
798
|
+
bImplicitVariableHandling?: boolean
|
|
799
|
+
): this;
|
|
800
|
+
/**
|
|
801
|
+
* Sets a new value for property {@link #getKeepAliveInterval keepAliveInterval}.
|
|
802
|
+
*
|
|
803
|
+
* Interval to keep the InA session alive. values less than 1 deactivates the keep alive handling
|
|
804
|
+
*
|
|
805
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
806
|
+
*
|
|
807
|
+
* Default value is `0`.
|
|
808
|
+
*
|
|
809
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
810
|
+
*/
|
|
811
|
+
setKeepAliveInterval(
|
|
812
|
+
/**
|
|
813
|
+
* New value for property `keepAliveInterval`
|
|
814
|
+
*/
|
|
815
|
+
iKeepAliveInterval?: int
|
|
816
|
+
): this;
|
|
817
|
+
/**
|
|
818
|
+
* Sets a new value for property {@link #getMultiDimModelId multiDimModelId}.
|
|
819
|
+
*
|
|
820
|
+
* Id of the MultiDimModel to use
|
|
821
|
+
*
|
|
822
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
823
|
+
*
|
|
824
|
+
* Default value is `"om"`.
|
|
825
|
+
*
|
|
826
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
827
|
+
*/
|
|
828
|
+
setMultiDimModelId(
|
|
829
|
+
/**
|
|
830
|
+
* New value for property `multiDimModelId`
|
|
831
|
+
*/
|
|
832
|
+
sMultiDimModelId?: string
|
|
833
|
+
): this;
|
|
834
|
+
/**
|
|
835
|
+
* Sets a new value for property {@link #getShowTitle showTitle}.
|
|
836
|
+
*
|
|
837
|
+
* Indicates Flexible Analysis component should display the component title
|
|
838
|
+
*
|
|
839
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
840
|
+
*
|
|
841
|
+
* Default value is `false`.
|
|
842
|
+
*
|
|
843
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
844
|
+
*/
|
|
845
|
+
setShowTitle(
|
|
846
|
+
/**
|
|
847
|
+
* New value for property `showTitle`
|
|
848
|
+
*/
|
|
849
|
+
bShowTitle?: boolean
|
|
850
|
+
): this;
|
|
851
|
+
/**
|
|
852
|
+
* Sets a new value for property {@link #getStyleTemplateName styleTemplateName}.
|
|
853
|
+
*
|
|
854
|
+
* Indicates if the variable are handled internal handling by FlexAnalysis. If set to false it is done via
|
|
855
|
+
* corresponding MultiDimModel
|
|
856
|
+
*
|
|
857
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
858
|
+
*
|
|
859
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
860
|
+
*/
|
|
861
|
+
setStyleTemplateName(
|
|
862
|
+
/**
|
|
863
|
+
* New value for property `styleTemplateName`
|
|
864
|
+
*/
|
|
865
|
+
sStyleTemplateName: string
|
|
866
|
+
): this;
|
|
867
|
+
/**
|
|
868
|
+
* Sets a new value for property {@link #getSystemName systemName}.
|
|
869
|
+
*
|
|
870
|
+
* System to take data from. If not set or set to "local" current url will be used to determine the system
|
|
871
|
+
*
|
|
872
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
873
|
+
*
|
|
874
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
875
|
+
*/
|
|
876
|
+
setSystemName(
|
|
877
|
+
/**
|
|
878
|
+
* New value for property `systemName`
|
|
879
|
+
*/
|
|
880
|
+
sSystemName: string
|
|
881
|
+
): this;
|
|
882
|
+
/**
|
|
883
|
+
* Sets a new value for property {@link #getSystemType systemType}.
|
|
884
|
+
*
|
|
885
|
+
* Type the system to connect to get data
|
|
886
|
+
*
|
|
887
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
888
|
+
*
|
|
889
|
+
* Default value is `BW`.
|
|
890
|
+
*
|
|
891
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
892
|
+
*/
|
|
893
|
+
setSystemType(
|
|
894
|
+
/**
|
|
895
|
+
* New value for property `systemType`
|
|
896
|
+
*/
|
|
897
|
+
sSystemType?: SystemType | keyof typeof SystemType
|
|
898
|
+
): this;
|
|
899
|
+
/**
|
|
900
|
+
* Sets a new value for property {@link #getTitle title}.
|
|
901
|
+
*
|
|
902
|
+
* Sets title to be shown in the control. If not set the name of the corresponding back-end query is used
|
|
903
|
+
*
|
|
904
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
905
|
+
*
|
|
906
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
907
|
+
*/
|
|
908
|
+
setTitle(
|
|
909
|
+
/**
|
|
910
|
+
* New value for property `title`
|
|
911
|
+
*/
|
|
912
|
+
sTitle: string
|
|
913
|
+
): this;
|
|
914
|
+
/**
|
|
915
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
916
|
+
*
|
|
917
|
+
* Width of the component
|
|
918
|
+
*
|
|
919
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
920
|
+
*
|
|
921
|
+
* Default value is `"100%"`.
|
|
922
|
+
*
|
|
923
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
924
|
+
*/
|
|
925
|
+
setWidth(
|
|
926
|
+
/**
|
|
927
|
+
* New value for property `width`
|
|
928
|
+
*/
|
|
929
|
+
sWidth?: CSSSize
|
|
930
|
+
): this;
|
|
931
|
+
/**
|
|
932
|
+
* Unbinds property {@link #getDataProvider dataProvider} from model data.
|
|
933
|
+
*
|
|
934
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
935
|
+
*/
|
|
936
|
+
unbindDataProvider(): this;
|
|
937
|
+
}
|
|
938
|
+
|
|
939
|
+
export interface $FlexAnalysisSettings extends $ControlSettings {
|
|
940
|
+
/**
|
|
941
|
+
* Sets title to be shown in the control. If not set the name of the corresponding back-end query is used
|
|
942
|
+
*/
|
|
943
|
+
title?: string | PropertyBindingInfo;
|
|
944
|
+
|
|
945
|
+
/**
|
|
946
|
+
* Indicates Flexible Analysis component should display the component title
|
|
947
|
+
*/
|
|
948
|
+
showTitle?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
949
|
+
|
|
950
|
+
/**
|
|
951
|
+
* Indicates if Flexible Analysis component automatically requests the ResultSet for the shown data source
|
|
952
|
+
*/
|
|
953
|
+
autoUpdate?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
954
|
+
|
|
955
|
+
/**
|
|
956
|
+
* URI of the advanced configuration to be fetched
|
|
957
|
+
*/
|
|
958
|
+
configurationURI?: string | PropertyBindingInfo;
|
|
959
|
+
|
|
960
|
+
/**
|
|
961
|
+
* JSON object containing the configuration (alternative to configurationURI)
|
|
962
|
+
*/
|
|
963
|
+
configObject?: object | PropertyBindingInfo | `{${string}}`;
|
|
964
|
+
|
|
965
|
+
/**
|
|
966
|
+
* Width of the component
|
|
967
|
+
*/
|
|
968
|
+
width?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
969
|
+
|
|
970
|
+
/**
|
|
971
|
+
* Height of the component
|
|
972
|
+
*/
|
|
973
|
+
height?: CSSSize | PropertyBindingInfo | `{${string}}`;
|
|
974
|
+
|
|
975
|
+
/**
|
|
976
|
+
* Sets if the Design Panel of FlexAnalysis is hidden
|
|
977
|
+
*/
|
|
978
|
+
hideDesignPanel?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
979
|
+
|
|
980
|
+
/**
|
|
981
|
+
* Sets if the Style Panel of FlexAnalysis is hidden
|
|
982
|
+
*/
|
|
983
|
+
hideStylePanel?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
984
|
+
|
|
985
|
+
/**
|
|
986
|
+
* Sets if the menu bar of FlexAnalysis is hidden
|
|
987
|
+
*/
|
|
988
|
+
hideMenuBar?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
989
|
+
|
|
990
|
+
/**
|
|
991
|
+
* Sets if the status bar of FlexAnalysis is hidden
|
|
992
|
+
*/
|
|
993
|
+
hideStatusBar?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
994
|
+
|
|
995
|
+
/**
|
|
996
|
+
* Sets if the toolbar of FlexAnalysis is hidden
|
|
997
|
+
*/
|
|
998
|
+
hideToolBar?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
999
|
+
|
|
1000
|
+
/**
|
|
1001
|
+
* Sets if the filter of FlexAnalysis is hidden
|
|
1002
|
+
*/
|
|
1003
|
+
hideFilterLine?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1004
|
+
|
|
1005
|
+
/**
|
|
1006
|
+
* Sets if the side navigation bar of FlexAnalysis is hidden
|
|
1007
|
+
*/
|
|
1008
|
+
hideSideNavigation?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1009
|
+
|
|
1010
|
+
/**
|
|
1011
|
+
* Sets if the landing page of FlexAnalysis is hidden
|
|
1012
|
+
*/
|
|
1013
|
+
hideLandingPage?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1014
|
+
|
|
1015
|
+
/**
|
|
1016
|
+
* Additional Flag to be passed to the control TODO: Document the possibilities
|
|
1017
|
+
*/
|
|
1018
|
+
environment?: string[] | PropertyBindingInfo | `{${string}}`;
|
|
1019
|
+
|
|
1020
|
+
/**
|
|
1021
|
+
* System to take data from. If not set or set to "local" current url will be used to determine the system
|
|
1022
|
+
*/
|
|
1023
|
+
systemName?: string | PropertyBindingInfo;
|
|
1024
|
+
|
|
1025
|
+
/**
|
|
1026
|
+
* Data source (Query name/ View, InA model etc) to be used to get the data from
|
|
1027
|
+
*/
|
|
1028
|
+
dataSource?: string | PropertyBindingInfo;
|
|
1029
|
+
|
|
1030
|
+
/**
|
|
1031
|
+
* Type the system to connect to get data
|
|
1032
|
+
*/
|
|
1033
|
+
systemType?:
|
|
1034
|
+
| (SystemType | keyof typeof SystemType)
|
|
1035
|
+
| PropertyBindingInfo
|
|
1036
|
+
| `{${string}}`;
|
|
1037
|
+
|
|
1038
|
+
/**
|
|
1039
|
+
* Interval to keep the InA session alive. values less than 1 deactivates the keep alive handling
|
|
1040
|
+
*/
|
|
1041
|
+
keepAliveInterval?: int | PropertyBindingInfo | `{${string}}`;
|
|
1042
|
+
|
|
1043
|
+
/**
|
|
1044
|
+
* Client Identifier to be used for underlying InA queries
|
|
1045
|
+
*/
|
|
1046
|
+
clientIdentifier?: string | PropertyBindingInfo;
|
|
1047
|
+
|
|
1048
|
+
/**
|
|
1049
|
+
* Name of the Data Provider from the corresponding MultiDimModel to be used
|
|
1050
|
+
*/
|
|
1051
|
+
dataProvider?: any | PropertyBindingInfo | `{${string}}`;
|
|
1052
|
+
|
|
1053
|
+
/**
|
|
1054
|
+
* Id of the MultiDimModel to use
|
|
1055
|
+
*/
|
|
1056
|
+
multiDimModelId?: string | PropertyBindingInfo;
|
|
1057
|
+
|
|
1058
|
+
/**
|
|
1059
|
+
* Indicates if the variable are handled internal handling by FlexAnalysis. If set to false it is done via
|
|
1060
|
+
* corresponding MultiDimModel
|
|
1061
|
+
*/
|
|
1062
|
+
implicitVariableHandling?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
1063
|
+
|
|
1064
|
+
/**
|
|
1065
|
+
* Indicates if the variable are handled internal handling by FlexAnalysis. If set to false it is done via
|
|
1066
|
+
* corresponding MultiDimModel
|
|
1067
|
+
*/
|
|
1068
|
+
styleTemplateName?: string | PropertyBindingInfo;
|
|
1069
|
+
|
|
1070
|
+
/**
|
|
1071
|
+
* Custom panels for the flexible analysis control
|
|
1072
|
+
*/
|
|
1073
|
+
customPanels?:
|
|
1074
|
+
| FlexAnalysisPanel[]
|
|
1075
|
+
| FlexAnalysisPanel
|
|
1076
|
+
| AggregationBindingInfo
|
|
1077
|
+
| `{${string}}`;
|
|
1078
|
+
}
|
|
1079
|
+
}
|
|
1080
|
+
|
|
1081
|
+
declare module "sap/sac/df/FlexAnalysisPanel" {
|
|
1082
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
1083
|
+
|
|
1084
|
+
import Control from "sap/ui/core/Control";
|
|
1085
|
+
|
|
1086
|
+
import { URI } from "sap/ui/core/library";
|
|
1087
|
+
|
|
1088
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1089
|
+
|
|
1090
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1091
|
+
|
|
1092
|
+
/**
|
|
1093
|
+
* A panel to be added into FlexAnalysis control
|
|
1094
|
+
*/
|
|
1095
|
+
export default class FlexAnalysisPanel extends UI5Element {
|
|
1096
|
+
/**
|
|
1097
|
+
* Constructor for a new Flexible Analysis Panel.
|
|
1098
|
+
*
|
|
1099
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1100
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1101
|
+
* of the syntax of the settings object.
|
|
1102
|
+
*/
|
|
1103
|
+
constructor(
|
|
1104
|
+
/**
|
|
1105
|
+
* initial settings for the new control
|
|
1106
|
+
*/
|
|
1107
|
+
mSettings?: $FlexAnalysisPanelSettings
|
|
1108
|
+
);
|
|
1109
|
+
/**
|
|
1110
|
+
* Constructor for a new Flexible Analysis Panel.
|
|
1111
|
+
*
|
|
1112
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1113
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1114
|
+
* of the syntax of the settings object.
|
|
1115
|
+
*/
|
|
1116
|
+
constructor(
|
|
1117
|
+
/**
|
|
1118
|
+
* id for the new control, generated automatically if no id is given
|
|
1119
|
+
*/
|
|
1120
|
+
sId?: string,
|
|
1121
|
+
/**
|
|
1122
|
+
* initial settings for the new control
|
|
1123
|
+
*/
|
|
1124
|
+
mSettings?: $FlexAnalysisPanelSettings
|
|
1125
|
+
);
|
|
1126
|
+
|
|
1127
|
+
/**
|
|
1128
|
+
* Creates a new subclass of class sap.sac.df.FlexAnalysisPanel with name `sClassName` and enriches it with
|
|
1129
|
+
* the information contained in `oClassInfo`.
|
|
1130
|
+
*
|
|
1131
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
1132
|
+
*
|
|
1133
|
+
* @returns Created class / constructor function
|
|
1134
|
+
*/
|
|
1135
|
+
static extend<T extends Record<string, unknown>>(
|
|
1136
|
+
/**
|
|
1137
|
+
* Name of the class being created
|
|
1138
|
+
*/
|
|
1139
|
+
sClassName: string,
|
|
1140
|
+
/**
|
|
1141
|
+
* Object literal with information about the class
|
|
1142
|
+
*/
|
|
1143
|
+
oClassInfo?: sap.ClassInfo<T, FlexAnalysisPanel>,
|
|
1144
|
+
/**
|
|
1145
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1146
|
+
* used by this class
|
|
1147
|
+
*/
|
|
1148
|
+
FNMetaImpl?: Function
|
|
1149
|
+
): Function;
|
|
1150
|
+
/**
|
|
1151
|
+
* Returns a metadata object for class sap.sac.df.FlexAnalysisPanel.
|
|
1152
|
+
*
|
|
1153
|
+
* @returns Metadata object describing this class
|
|
1154
|
+
*/
|
|
1155
|
+
static getMetadata(): ElementMetadata;
|
|
1156
|
+
/**
|
|
1157
|
+
* Destroys the content in the aggregation {@link #getContent content}.
|
|
1158
|
+
*
|
|
1159
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1160
|
+
*/
|
|
1161
|
+
destroyContent(): this;
|
|
1162
|
+
/**
|
|
1163
|
+
* Gets content of aggregation {@link #getContent content}.
|
|
1164
|
+
*
|
|
1165
|
+
* The content of this panel
|
|
1166
|
+
*/
|
|
1167
|
+
getContent(): Control;
|
|
1168
|
+
/**
|
|
1169
|
+
* Gets current value of property {@link #getDescription description}.
|
|
1170
|
+
*
|
|
1171
|
+
* The description of the panel, displayed as tooltip on the side navigation item.
|
|
1172
|
+
*
|
|
1173
|
+
* @returns Value of property `description`
|
|
1174
|
+
*/
|
|
1175
|
+
getDescription(): string;
|
|
1176
|
+
/**
|
|
1177
|
+
* Gets current value of property {@link #getIcon icon}.
|
|
1178
|
+
*
|
|
1179
|
+
* The icon of the panel, displayed on the side navigation item and the panel header.
|
|
1180
|
+
*
|
|
1181
|
+
* @returns Value of property `icon`
|
|
1182
|
+
*/
|
|
1183
|
+
getIcon(): URI;
|
|
1184
|
+
/**
|
|
1185
|
+
* Gets current value of property {@link #getTitle title}.
|
|
1186
|
+
*
|
|
1187
|
+
* The title of the panel header.
|
|
1188
|
+
*
|
|
1189
|
+
* @returns Value of property `title`
|
|
1190
|
+
*/
|
|
1191
|
+
getTitle(): string;
|
|
1192
|
+
/**
|
|
1193
|
+
* Sets the aggregated {@link #getContent content}.
|
|
1194
|
+
*
|
|
1195
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1196
|
+
*/
|
|
1197
|
+
setContent(
|
|
1198
|
+
/**
|
|
1199
|
+
* The content to set
|
|
1200
|
+
*/
|
|
1201
|
+
oContent: Control
|
|
1202
|
+
): this;
|
|
1203
|
+
/**
|
|
1204
|
+
* Sets a new value for property {@link #getDescription description}.
|
|
1205
|
+
*
|
|
1206
|
+
* The description of the panel, displayed as tooltip on the side navigation item.
|
|
1207
|
+
*
|
|
1208
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1209
|
+
*
|
|
1210
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1211
|
+
*/
|
|
1212
|
+
setDescription(
|
|
1213
|
+
/**
|
|
1214
|
+
* New value for property `description`
|
|
1215
|
+
*/
|
|
1216
|
+
sDescription: string
|
|
1217
|
+
): this;
|
|
1218
|
+
/**
|
|
1219
|
+
* Sets a new value for property {@link #getIcon icon}.
|
|
1220
|
+
*
|
|
1221
|
+
* The icon of the panel, displayed on the side navigation item and the panel header.
|
|
1222
|
+
*
|
|
1223
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1224
|
+
*
|
|
1225
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1226
|
+
*/
|
|
1227
|
+
setIcon(
|
|
1228
|
+
/**
|
|
1229
|
+
* New value for property `icon`
|
|
1230
|
+
*/
|
|
1231
|
+
sIcon: URI
|
|
1232
|
+
): this;
|
|
1233
|
+
/**
|
|
1234
|
+
* Sets a new value for property {@link #getTitle title}.
|
|
1235
|
+
*
|
|
1236
|
+
* The title of the panel header.
|
|
1237
|
+
*
|
|
1238
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
1239
|
+
*
|
|
1240
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
1241
|
+
*/
|
|
1242
|
+
setTitle(
|
|
1243
|
+
/**
|
|
1244
|
+
* New value for property `title`
|
|
1245
|
+
*/
|
|
1246
|
+
sTitle: string
|
|
1247
|
+
): this;
|
|
1248
|
+
}
|
|
1249
|
+
|
|
1250
|
+
export interface $FlexAnalysisPanelSettings extends $ElementSettings {
|
|
1251
|
+
/**
|
|
1252
|
+
* The description of the panel, displayed as tooltip on the side navigation item.
|
|
1253
|
+
*/
|
|
1254
|
+
description?: string | PropertyBindingInfo;
|
|
1255
|
+
|
|
1256
|
+
/**
|
|
1257
|
+
* The title of the panel header.
|
|
1258
|
+
*/
|
|
1259
|
+
title?: string | PropertyBindingInfo;
|
|
1260
|
+
|
|
1261
|
+
/**
|
|
1262
|
+
* The icon of the panel, displayed on the side navigation item and the panel header.
|
|
1263
|
+
*/
|
|
1264
|
+
icon?: URI | PropertyBindingInfo | `{${string}}`;
|
|
1265
|
+
|
|
1266
|
+
/**
|
|
1267
|
+
* The content of this panel
|
|
1268
|
+
*/
|
|
1269
|
+
content?: Control;
|
|
1270
|
+
}
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
declare module "sap/sac/df/olap/MultiDimDataProvider" {
|
|
1274
|
+
import MultiDimModel from "sap/sac/df/olap/MultiDimModel";
|
|
1275
|
+
|
|
1276
|
+
import Format from "sap/sac/grid/Format";
|
|
1277
|
+
|
|
1278
|
+
/**
|
|
1279
|
+
* @EXPERIMENTAL
|
|
1280
|
+
*
|
|
1281
|
+
* A `MultiDimDataProvider` is a Analytical query exposed via an OLAP engine and accessed via InA protocol
|
|
1282
|
+
* HANA - MDS BW Query. In BW it could be done via a CDS view that is annotated as an AnalyticQuery.
|
|
1283
|
+
*
|
|
1284
|
+
* Instances of this class should only be created by the {sap.sac.df.olap.MultiDimModel}. The `MultiDimModel`
|
|
1285
|
+
* populates it's exposed data via Binding to Controls. The structure of data exposed by a MultiDimDataProvider
|
|
1286
|
+
* is as follows:
|
|
1287
|
+
*
|
|
1288
|
+
* **Structure of Exposed Data**
|
|
1289
|
+
*
|
|
1290
|
+
*
|
|
1291
|
+
* - `Grid/Cells`: The list of all `Cell` representing the data retrieved via `MultiDimDataProvider`
|
|
1292
|
+
* - `FreeDimensions`: The list of all Dimensions lying in the Free Axis
|
|
1293
|
+
* `Name`: the external name of the dimension `Description`: the language dependant description of
|
|
1294
|
+
* the dimension `IsStructure`: boolean flag indicating whether the dimension is a structure
|
|
1295
|
+
*
|
|
1296
|
+
* - RowsDimensions: The list of all Dimensions lying on the Rows Axis
|
|
1297
|
+
* Name: the external name of the dimension Description: the language dependant description of the
|
|
1298
|
+
* dimension IsStructure: boolean flag indicating whether the dimension is a structure *
|
|
1299
|
+
* - ColumnsDimensions: The list of all Dimensions lying on the Columns Axis
|
|
1300
|
+
* Name: the external name of the dimension Description: the language dependant description of the
|
|
1301
|
+
* dimension IsStructure: boolean flag indicating whether the dimension is a structure
|
|
1302
|
+
* - Conditions: list of conditions (result set filters)
|
|
1303
|
+
* - Exceptions: list of exceptions (conditional formats)
|
|
1304
|
+
* - StructureMembers: list of structure members (collection of Members of all Structure Dimension)
|
|
1305
|
+
*/
|
|
1306
|
+
export default class MultiDimDataProvider {
|
|
1307
|
+
/**
|
|
1308
|
+
* Constructor for a new MultiDimDataProvider.
|
|
1309
|
+
*
|
|
1310
|
+
* A MultiDimDataProvider represents a navigable queryManager and allows to access and change data from
|
|
1311
|
+
* servers providing the InA
|
|
1312
|
+
* Protocol.
|
|
1313
|
+
*/
|
|
1314
|
+
constructor(
|
|
1315
|
+
/**
|
|
1316
|
+
* the model to which the MultiDimDataProvider belongs
|
|
1317
|
+
*/
|
|
1318
|
+
oMultiDimModel: MultiDimModel,
|
|
1319
|
+
/**
|
|
1320
|
+
* name of the MultiDimDataProvider
|
|
1321
|
+
*/
|
|
1322
|
+
sMultiDimDataProviderName: string,
|
|
1323
|
+
/**
|
|
1324
|
+
* the firefly application associated to the `MultiDimModel`
|
|
1325
|
+
*/
|
|
1326
|
+
oApplication: object,
|
|
1327
|
+
/**
|
|
1328
|
+
* the firefly queryManager that is wrapped by the `MultiDimDataProvider`
|
|
1329
|
+
*/
|
|
1330
|
+
oQueryManager: object
|
|
1331
|
+
);
|
|
1332
|
+
|
|
1333
|
+
/**
|
|
1334
|
+
* add a new condition (aka resultset filter).
|
|
1335
|
+
*
|
|
1336
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1337
|
+
*/
|
|
1338
|
+
addCondition(
|
|
1339
|
+
/**
|
|
1340
|
+
* Condition Definiton
|
|
1341
|
+
*/
|
|
1342
|
+
oData: object,
|
|
1343
|
+
/**
|
|
1344
|
+
* Target state of the condition
|
|
1345
|
+
*/
|
|
1346
|
+
bActive: boolean
|
|
1347
|
+
): Promise<this>;
|
|
1348
|
+
/**
|
|
1349
|
+
* Do a drill operation on a dimension member on an Axis
|
|
1350
|
+
*
|
|
1351
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1352
|
+
*/
|
|
1353
|
+
drill(
|
|
1354
|
+
/**
|
|
1355
|
+
* the external name of the Dimension
|
|
1356
|
+
*/
|
|
1357
|
+
sDim: string,
|
|
1358
|
+
/**
|
|
1359
|
+
* the Tuple Index of the member in the resultset.
|
|
1360
|
+
*/
|
|
1361
|
+
nIndex: int
|
|
1362
|
+
): this;
|
|
1363
|
+
/**
|
|
1364
|
+
* Gets the scaling factor of a measure or data cell
|
|
1365
|
+
*
|
|
1366
|
+
* @returns the current decimal places setting
|
|
1367
|
+
*/
|
|
1368
|
+
getDecimalPlaces(
|
|
1369
|
+
/**
|
|
1370
|
+
* the Member of the Measure Structure
|
|
1371
|
+
*/
|
|
1372
|
+
sMeasureMember: string,
|
|
1373
|
+
/**
|
|
1374
|
+
* the Member of the Non Measure Structure, if this is not given the value for the sMeasureMember is returned
|
|
1375
|
+
*/
|
|
1376
|
+
sNonMeasureMember: string
|
|
1377
|
+
): int;
|
|
1378
|
+
/**
|
|
1379
|
+
* get the list of filters of a dimension
|
|
1380
|
+
*
|
|
1381
|
+
* @returns list of a range with components
|
|
1382
|
+
* `Low`: The Low value of the range `High`: The High value of the range `Operator`: The Operator:
|
|
1383
|
+
* EQ,LE,..,BT
|
|
1384
|
+
*/
|
|
1385
|
+
getFilterOfDim(
|
|
1386
|
+
/**
|
|
1387
|
+
* the name of the dimension from which the filter is retrieved
|
|
1388
|
+
*/
|
|
1389
|
+
sDim: string
|
|
1390
|
+
): object[];
|
|
1391
|
+
/**
|
|
1392
|
+
* get the current resultset from the InA Server
|
|
1393
|
+
*
|
|
1394
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1395
|
+
*/
|
|
1396
|
+
getResultSet(): Promise<this>;
|
|
1397
|
+
/**
|
|
1398
|
+
* get the list of the jump targets associated to a datacell defined via the report report interface.
|
|
1399
|
+
*
|
|
1400
|
+
* @returns resolving to the List of jump targets.
|
|
1401
|
+
*/
|
|
1402
|
+
getRRITargets(
|
|
1403
|
+
/**
|
|
1404
|
+
* Row of the data cell
|
|
1405
|
+
*/
|
|
1406
|
+
nRow: int,
|
|
1407
|
+
/**
|
|
1408
|
+
* Column of the data cell
|
|
1409
|
+
*/
|
|
1410
|
+
nColumn: int
|
|
1411
|
+
): Promise<this>;
|
|
1412
|
+
/**
|
|
1413
|
+
* Gets the scaling factor of a measure
|
|
1414
|
+
*
|
|
1415
|
+
* @returns the exponent of the scaling factor in Base 10
|
|
1416
|
+
*/
|
|
1417
|
+
getScalingFactor(
|
|
1418
|
+
/**
|
|
1419
|
+
* the Member of the Measure Structure
|
|
1420
|
+
*/
|
|
1421
|
+
sMeasureMember: string,
|
|
1422
|
+
/**
|
|
1423
|
+
* the Member of the Non Measure Structure
|
|
1424
|
+
*/
|
|
1425
|
+
sNonMeasureMember: string
|
|
1426
|
+
): int;
|
|
1427
|
+
/**
|
|
1428
|
+
* hasVariable Checks whether a Variable is influencing the MultiDimDataProvider
|
|
1429
|
+
*
|
|
1430
|
+
* @returns Whether the vairable influences the MultiDimDataProvider
|
|
1431
|
+
*/
|
|
1432
|
+
hasVariable(
|
|
1433
|
+
/**
|
|
1434
|
+
* Name of the Variable
|
|
1435
|
+
*/
|
|
1436
|
+
the: string
|
|
1437
|
+
): boolean;
|
|
1438
|
+
/**
|
|
1439
|
+
* move a dimension one position down on it's axis
|
|
1440
|
+
*
|
|
1441
|
+
* @returns the `MultiDimDataProvider` to allow chaining.
|
|
1442
|
+
*/
|
|
1443
|
+
moveDown(
|
|
1444
|
+
/**
|
|
1445
|
+
* name of the dimension
|
|
1446
|
+
*/
|
|
1447
|
+
sName: string,
|
|
1448
|
+
/**
|
|
1449
|
+
* Target state of the condition
|
|
1450
|
+
*/
|
|
1451
|
+
bActive: boolean
|
|
1452
|
+
): this;
|
|
1453
|
+
/**
|
|
1454
|
+
* move a dimension one position up on it's axis
|
|
1455
|
+
*
|
|
1456
|
+
* @returns the `MultiDimDataProvider` to allow chaining.
|
|
1457
|
+
*/
|
|
1458
|
+
moveUp(
|
|
1459
|
+
/**
|
|
1460
|
+
* name of the dimension
|
|
1461
|
+
*/
|
|
1462
|
+
sName: string,
|
|
1463
|
+
/**
|
|
1464
|
+
* Target state of the condition
|
|
1465
|
+
*/
|
|
1466
|
+
bActive: boolean
|
|
1467
|
+
): this;
|
|
1468
|
+
/**
|
|
1469
|
+
* Open a dialog that allows to display and change the property of an `Axis` of the `MultiDimDataProvider`.
|
|
1470
|
+
*
|
|
1471
|
+
* @returns indicator whether the dialog was confirmed or canceled
|
|
1472
|
+
*/
|
|
1473
|
+
openAxisDialog(
|
|
1474
|
+
/**
|
|
1475
|
+
* the external name of the Dimension
|
|
1476
|
+
*/
|
|
1477
|
+
sDim: string
|
|
1478
|
+
): Promise<boolean>;
|
|
1479
|
+
/**
|
|
1480
|
+
* Open a dialog that allows to display and change the property of a `Query Cell` of the `MultiDimDataProvider`.
|
|
1481
|
+
*
|
|
1482
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining. In case that a the Currency Translation
|
|
1483
|
+
* Settings have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
|
|
1484
|
+
*/
|
|
1485
|
+
openCellDialog(
|
|
1486
|
+
/**
|
|
1487
|
+
* the external name of the first structure
|
|
1488
|
+
*/
|
|
1489
|
+
sDim1?: string,
|
|
1490
|
+
/**
|
|
1491
|
+
* the external name of the member of the first structure
|
|
1492
|
+
*/
|
|
1493
|
+
sMem1?: string,
|
|
1494
|
+
/**
|
|
1495
|
+
* the external name of the second structure
|
|
1496
|
+
*/
|
|
1497
|
+
sDim2?: string,
|
|
1498
|
+
/**
|
|
1499
|
+
* the external name of the member of the second structure
|
|
1500
|
+
*/
|
|
1501
|
+
sMem2?: string
|
|
1502
|
+
): Promise<this>;
|
|
1503
|
+
/**
|
|
1504
|
+
* Open a dialog that allows to display and change the currency translation settings of the `MultiDimDataProvider`.
|
|
1505
|
+
*
|
|
1506
|
+
* @returns indicator whether the dialog was confirmed or canceled in the dialog, the new resultset was
|
|
1507
|
+
* retrieved before the promise gets resolved.
|
|
1508
|
+
*/
|
|
1509
|
+
openCurrencyTranslationDialog(): Promise<boolean>;
|
|
1510
|
+
/**
|
|
1511
|
+
* Open a dialog to display and change the settings of a dimension of the `MultiDimDataProvider`
|
|
1512
|
+
*
|
|
1513
|
+
* @returns indicator whether the dialog was confirmed or canceled
|
|
1514
|
+
*/
|
|
1515
|
+
openDimDialog(
|
|
1516
|
+
/**
|
|
1517
|
+
* the external name of the Dimension
|
|
1518
|
+
*/
|
|
1519
|
+
sDim: string
|
|
1520
|
+
): Promise<boolean>;
|
|
1521
|
+
/**
|
|
1522
|
+
* Open a dialog to display and change the filter on a dimension of the `MultiDimDataProvider`
|
|
1523
|
+
*
|
|
1524
|
+
* @returns resolving to a boolean which is false when the dialog is cancelled and true if is was closed
|
|
1525
|
+
* with Ok and dynamic filters of the given dimension are updated
|
|
1526
|
+
*/
|
|
1527
|
+
openSelector(
|
|
1528
|
+
/**
|
|
1529
|
+
* the external name of the Dimension
|
|
1530
|
+
*/
|
|
1531
|
+
sDimensionName: string
|
|
1532
|
+
): Promise<any>;
|
|
1533
|
+
/**
|
|
1534
|
+
* Remove the filter of a dimension
|
|
1535
|
+
*
|
|
1536
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1537
|
+
*/
|
|
1538
|
+
removeFilter(
|
|
1539
|
+
/**
|
|
1540
|
+
* the external name
|
|
1541
|
+
*/
|
|
1542
|
+
sDim: string
|
|
1543
|
+
): this;
|
|
1544
|
+
/**
|
|
1545
|
+
* Distribute the dimension among the rows and columns
|
|
1546
|
+
*
|
|
1547
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining. In case that a the Currency Translation
|
|
1548
|
+
* Settings have been changed in the dialog, the new resultset was retrieved before the promise gets resolved.
|
|
1549
|
+
*/
|
|
1550
|
+
setAxesLayout(
|
|
1551
|
+
/**
|
|
1552
|
+
* an Object containing a `rows` member referencing a string array containing the names of the dimensions
|
|
1553
|
+
* and a `columns` member referencing a string array containing the dimension on the columns. The order
|
|
1554
|
+
* in the array control the positon on the axis.
|
|
1555
|
+
*/
|
|
1556
|
+
mLayout: object
|
|
1557
|
+
): this;
|
|
1558
|
+
/**
|
|
1559
|
+
* Sets the number of decimal of a measure/query cell
|
|
1560
|
+
*
|
|
1561
|
+
* @returns the MultiDimDataProvider
|
|
1562
|
+
*/
|
|
1563
|
+
setDecimalPlaces(
|
|
1564
|
+
/**
|
|
1565
|
+
* number of the decimal palaces to be shown after the separator
|
|
1566
|
+
*/
|
|
1567
|
+
nNumberOfDecimalPlaces: int,
|
|
1568
|
+
/**
|
|
1569
|
+
* the Member of the Measure Structure
|
|
1570
|
+
*/
|
|
1571
|
+
sMeasureMember: string,
|
|
1572
|
+
/**
|
|
1573
|
+
* Member of the Non Measure Structure, if this is not given the setting is applied for the whole sMeasureMember
|
|
1574
|
+
*/
|
|
1575
|
+
the: string
|
|
1576
|
+
): this;
|
|
1577
|
+
/**
|
|
1578
|
+
* Set Display Hierachy
|
|
1579
|
+
*
|
|
1580
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1581
|
+
*/
|
|
1582
|
+
setDisplayHierarchy(
|
|
1583
|
+
/**
|
|
1584
|
+
* the external name of the structure on which the new restriction is created
|
|
1585
|
+
*/
|
|
1586
|
+
sDim: string,
|
|
1587
|
+
/**
|
|
1588
|
+
* whether the hierarchy should be activated
|
|
1589
|
+
*/
|
|
1590
|
+
bActive: boolean,
|
|
1591
|
+
/**
|
|
1592
|
+
* the name of the hierarchy (optional)
|
|
1593
|
+
*/
|
|
1594
|
+
sHierachy: string,
|
|
1595
|
+
/**
|
|
1596
|
+
* the version of the hierarchy (optional)
|
|
1597
|
+
*/
|
|
1598
|
+
sVersion: string
|
|
1599
|
+
): this;
|
|
1600
|
+
/**
|
|
1601
|
+
* Set the filter for a dimension
|
|
1602
|
+
*
|
|
1603
|
+
* @returns {{this} resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1604
|
+
*/
|
|
1605
|
+
setFilter(
|
|
1606
|
+
/**
|
|
1607
|
+
* the external name
|
|
1608
|
+
*/
|
|
1609
|
+
sDim: string,
|
|
1610
|
+
/**
|
|
1611
|
+
* the filter
|
|
1612
|
+
*/
|
|
1613
|
+
oFilter: object
|
|
1614
|
+
): undefined;
|
|
1615
|
+
/**
|
|
1616
|
+
* sets the format property of the MultiDimDataProvider, this can influence the resultset that is aggregated
|
|
1617
|
+
* in the `Grid.Cells` collection. Its main purpose is to influence the visualisation of a `sap.sac.df.PivotTable`
|
|
1618
|
+
*/
|
|
1619
|
+
setFormat(
|
|
1620
|
+
/**
|
|
1621
|
+
* the format to be used
|
|
1622
|
+
*/
|
|
1623
|
+
sFormat: Format | keyof typeof Format
|
|
1624
|
+
): void;
|
|
1625
|
+
/**
|
|
1626
|
+
* Sets the scaling factor of a measure/query cell
|
|
1627
|
+
*
|
|
1628
|
+
* @returns the MultiDimDataProvider
|
|
1629
|
+
*/
|
|
1630
|
+
setScalingFactor(
|
|
1631
|
+
/**
|
|
1632
|
+
* the exponential of the scaling factor
|
|
1633
|
+
*/
|
|
1634
|
+
nFactor: int,
|
|
1635
|
+
/**
|
|
1636
|
+
* the Member of the Measure Structure
|
|
1637
|
+
*/
|
|
1638
|
+
sMeasureMember: string,
|
|
1639
|
+
/**
|
|
1640
|
+
* the Member of the Non Measure Structure
|
|
1641
|
+
*/
|
|
1642
|
+
sNonMeasureMember: string
|
|
1643
|
+
): this;
|
|
1644
|
+
/**
|
|
1645
|
+
* Sort the members of a dimension
|
|
1646
|
+
*
|
|
1647
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1648
|
+
*/
|
|
1649
|
+
sort(
|
|
1650
|
+
/**
|
|
1651
|
+
* the external name of the Dimension
|
|
1652
|
+
*/
|
|
1653
|
+
sDim: string,
|
|
1654
|
+
/**
|
|
1655
|
+
* of sorting
|
|
1656
|
+
*/
|
|
1657
|
+
type: /* was: sap.sac.df.types.SortType */ any,
|
|
1658
|
+
/**
|
|
1659
|
+
* of sorting
|
|
1660
|
+
*/
|
|
1661
|
+
direction: /* was: sap.sac.df.types.SortDirection */ any,
|
|
1662
|
+
/**
|
|
1663
|
+
* in case of a structure the measure according to which is sorted
|
|
1664
|
+
*/
|
|
1665
|
+
sMember?: string
|
|
1666
|
+
): Promise<this>;
|
|
1667
|
+
/**
|
|
1668
|
+
* submit the value of the input enabled queries to the InA Server
|
|
1669
|
+
*
|
|
1670
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1671
|
+
*/
|
|
1672
|
+
submitVariables(): Promise<this>;
|
|
1673
|
+
/**
|
|
1674
|
+
* suppress a unit/currency from being populated to the result cells
|
|
1675
|
+
*
|
|
1676
|
+
* @returns the MultiDimDataProvider to allow chaining
|
|
1677
|
+
*/
|
|
1678
|
+
suppressUnit(
|
|
1679
|
+
/**
|
|
1680
|
+
* the key of the suppressed unit
|
|
1681
|
+
*/
|
|
1682
|
+
sUnit: string
|
|
1683
|
+
): this;
|
|
1684
|
+
/**
|
|
1685
|
+
* retrieve the data of the current naviation state `MultiDimDataProvider` from the InA Server.
|
|
1686
|
+
*
|
|
1687
|
+
* @returns to allow chaining.
|
|
1688
|
+
*/
|
|
1689
|
+
synchronize(): Promise<this>;
|
|
1690
|
+
/**
|
|
1691
|
+
* Move a dimension to the columns axis
|
|
1692
|
+
*
|
|
1693
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1694
|
+
*/
|
|
1695
|
+
toColumns(
|
|
1696
|
+
/**
|
|
1697
|
+
* the external name of the Dimension
|
|
1698
|
+
*/
|
|
1699
|
+
sDim: string
|
|
1700
|
+
): this;
|
|
1701
|
+
/**
|
|
1702
|
+
* Move a dimension to the rows axis
|
|
1703
|
+
*
|
|
1704
|
+
* @returns resolving to the `MultiDimDataProvider` to allow chaining.
|
|
1705
|
+
*/
|
|
1706
|
+
toRows(
|
|
1707
|
+
/**
|
|
1708
|
+
* the external name of the Dimension
|
|
1709
|
+
*/
|
|
1710
|
+
sDim: string
|
|
1711
|
+
): this;
|
|
1712
|
+
}
|
|
1713
|
+
}
|
|
1714
|
+
|
|
1715
|
+
declare module "sap/sac/df/olap/MultiDimModel" {
|
|
1716
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1717
|
+
|
|
1718
|
+
/**
|
|
1719
|
+
* @EXPERIMENTAL
|
|
1720
|
+
*
|
|
1721
|
+
* Model implementation for InA provider
|
|
1722
|
+
*
|
|
1723
|
+
* The MultiDimModel can populate it's exposed data via Binding to Controls. The structure of the exposed
|
|
1724
|
+
* data is as follows: **Structure of Exposed Data**
|
|
1725
|
+
*
|
|
1726
|
+
*
|
|
1727
|
+
* - DataProvider: The associative array of all `DataProvider` aggregated by the SemanticStyles:
|
|
1728
|
+
* The associative array of all `SemanticStyle` for the `MultiDimModel` VariableGroups: The associative
|
|
1729
|
+
* array of registered Variable Groups Messages: The list of all messages posted by the Analytical Engine
|
|
1730
|
+
*/
|
|
1731
|
+
export default class MultiDimModel
|
|
1732
|
+
/* was: sap.sac.df.DFKernel */ extends Object {
|
|
1733
|
+
/**
|
|
1734
|
+
* Constructor for a new OlapMode.
|
|
1735
|
+
*
|
|
1736
|
+
* The Olap Model allows to access and change data from servers providing the InA Protocol.
|
|
1737
|
+
*/
|
|
1738
|
+
constructor();
|
|
1739
|
+
|
|
1740
|
+
/**
|
|
1741
|
+
* Creates a new subclass of class sap.sac.df.olap.MultiDimModel with name `sClassName` and enriches it
|
|
1742
|
+
* with the information contained in `oClassInfo`.
|
|
1743
|
+
*
|
|
1744
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.sac.df.DFKernel.extend}.
|
|
1745
|
+
*
|
|
1746
|
+
* @returns Created class / constructor function
|
|
1747
|
+
*/
|
|
1748
|
+
static extend<T extends Record<string, unknown>>(
|
|
1749
|
+
/**
|
|
1750
|
+
* Name of the class being created
|
|
1751
|
+
*/
|
|
1752
|
+
sClassName: string,
|
|
1753
|
+
/**
|
|
1754
|
+
* Object literal with information about the class
|
|
1755
|
+
*/
|
|
1756
|
+
oClassInfo?: sap.ClassInfo<T, MultiDimModel>,
|
|
1757
|
+
/**
|
|
1758
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1759
|
+
* used by this class
|
|
1760
|
+
*/
|
|
1761
|
+
FNMetaImpl?: Function
|
|
1762
|
+
): Function;
|
|
1763
|
+
/**
|
|
1764
|
+
* Returns a metadata object for class sap.sac.df.olap.MultiDimModel.
|
|
1765
|
+
*
|
|
1766
|
+
* @returns Metadata object describing this class
|
|
1767
|
+
*/
|
|
1768
|
+
static getMetadata(): Metadata;
|
|
1769
|
+
}
|
|
1770
|
+
}
|
|
1771
|
+
|
|
1772
|
+
declare module "sap/sac/df/olap/OlapListBinding" {
|
|
1773
|
+
import ListBinding from "sap/ui/model/ListBinding";
|
|
1774
|
+
|
|
1775
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1776
|
+
|
|
1777
|
+
/**
|
|
1778
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1779
|
+
*
|
|
1780
|
+
* List binding implementation for `OlapModel`.
|
|
1781
|
+
*/
|
|
1782
|
+
export default class OlapListBinding extends ListBinding {
|
|
1783
|
+
/**
|
|
1784
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1785
|
+
*
|
|
1786
|
+
* Creates a new OlapListBinding.
|
|
1787
|
+
*
|
|
1788
|
+
* This constructor should only be called by subclasses or model implementations, not by application or
|
|
1789
|
+
* control code. Such code should use {@link sap.sac.df.olap.OlapModel#bindList OlapModel#bindList} on the
|
|
1790
|
+
* corresponding model instance instead.
|
|
1791
|
+
*/
|
|
1792
|
+
constructor();
|
|
1793
|
+
|
|
1794
|
+
/**
|
|
1795
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1796
|
+
*
|
|
1797
|
+
* Creates a new subclass of class sap.sac.df.olap.OlapListBinding with name `sClassName` and enriches it
|
|
1798
|
+
* with the information contained in `oClassInfo`.
|
|
1799
|
+
*
|
|
1800
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
|
|
1801
|
+
*
|
|
1802
|
+
* @returns Created class / constructor function
|
|
1803
|
+
*/
|
|
1804
|
+
static extend<T extends Record<string, unknown>>(
|
|
1805
|
+
/**
|
|
1806
|
+
* Name of the class being created
|
|
1807
|
+
*/
|
|
1808
|
+
sClassName: string,
|
|
1809
|
+
/**
|
|
1810
|
+
* Object literal with information about the class
|
|
1811
|
+
*/
|
|
1812
|
+
oClassInfo?: sap.ClassInfo<T, OlapListBinding>,
|
|
1813
|
+
/**
|
|
1814
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1815
|
+
* used by this class
|
|
1816
|
+
*/
|
|
1817
|
+
FNMetaImpl?: Function
|
|
1818
|
+
): Function;
|
|
1819
|
+
/**
|
|
1820
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1821
|
+
*
|
|
1822
|
+
* Returns a metadata object for class sap.sac.df.olap.OlapListBinding.
|
|
1823
|
+
*
|
|
1824
|
+
* @returns Metadata object describing this class
|
|
1825
|
+
*/
|
|
1826
|
+
static getMetadata(): Metadata;
|
|
1827
|
+
}
|
|
1828
|
+
}
|
|
1829
|
+
|
|
1830
|
+
declare module "sap/sac/df/olap/OlapListGridBinding" {
|
|
1831
|
+
import ListBinding from "sap/ui/model/ListBinding";
|
|
1832
|
+
|
|
1833
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1834
|
+
|
|
1835
|
+
/**
|
|
1836
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1837
|
+
*
|
|
1838
|
+
* List binding implementation for `OlapModel`.
|
|
1839
|
+
*/
|
|
1840
|
+
export default class OlapListGridBinding extends ListBinding {
|
|
1841
|
+
/**
|
|
1842
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1843
|
+
*
|
|
1844
|
+
* Creates a new OlapListGridBinding.
|
|
1845
|
+
*
|
|
1846
|
+
* This constructor should only be called by subclasses or model implementations, not by application or
|
|
1847
|
+
* control code. Such code should use {@link sap.sac.df.OlapModel#bindList OlapModel#bindList} on the corresponding
|
|
1848
|
+
* model instance instead.
|
|
1849
|
+
*/
|
|
1850
|
+
constructor();
|
|
1851
|
+
|
|
1852
|
+
/**
|
|
1853
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1854
|
+
*
|
|
1855
|
+
* Creates a new subclass of class sap.sac.df.olap.OlapListGridBinding with name `sClassName` and enriches
|
|
1856
|
+
* it with the information contained in `oClassInfo`.
|
|
1857
|
+
*
|
|
1858
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
|
|
1859
|
+
*
|
|
1860
|
+
* @returns Created class / constructor function
|
|
1861
|
+
*/
|
|
1862
|
+
static extend<T extends Record<string, unknown>>(
|
|
1863
|
+
/**
|
|
1864
|
+
* Name of the class being created
|
|
1865
|
+
*/
|
|
1866
|
+
sClassName: string,
|
|
1867
|
+
/**
|
|
1868
|
+
* Object literal with information about the class
|
|
1869
|
+
*/
|
|
1870
|
+
oClassInfo?: sap.ClassInfo<T, OlapListGridBinding>,
|
|
1871
|
+
/**
|
|
1872
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1873
|
+
* used by this class
|
|
1874
|
+
*/
|
|
1875
|
+
FNMetaImpl?: Function
|
|
1876
|
+
): Function;
|
|
1877
|
+
/**
|
|
1878
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1879
|
+
*
|
|
1880
|
+
* Returns a metadata object for class sap.sac.df.olap.OlapListGridBinding.
|
|
1881
|
+
*
|
|
1882
|
+
* @returns Metadata object describing this class
|
|
1883
|
+
*/
|
|
1884
|
+
static getMetadata(): Metadata;
|
|
1885
|
+
}
|
|
1886
|
+
}
|
|
1887
|
+
|
|
1888
|
+
declare module "sap/sac/df/olap/OlapPropertyBinding" {
|
|
1889
|
+
import ListBinding from "sap/ui/model/ListBinding";
|
|
1890
|
+
|
|
1891
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
1892
|
+
|
|
1893
|
+
/**
|
|
1894
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1895
|
+
*
|
|
1896
|
+
* Property binding implementation for `OlapModel`.
|
|
1897
|
+
*/
|
|
1898
|
+
export default class OlapPropertyBinding extends ListBinding {
|
|
1899
|
+
/**
|
|
1900
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1901
|
+
*
|
|
1902
|
+
* Creates a new OlapPropertyBinding.
|
|
1903
|
+
*
|
|
1904
|
+
* This constructor should only be called by subclasses or model implementations, not by application or
|
|
1905
|
+
* control code. Such code should use {@link sap.sac.df.olap.OlapModel#bindProperty OlapModel#bindProperty}
|
|
1906
|
+
* on the corresponding model instance instead.
|
|
1907
|
+
*/
|
|
1908
|
+
constructor();
|
|
1909
|
+
|
|
1910
|
+
/**
|
|
1911
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1912
|
+
*
|
|
1913
|
+
* Creates a new subclass of class sap.sac.df.olap.OlapPropertyBinding with name `sClassName` and enriches
|
|
1914
|
+
* it with the information contained in `oClassInfo`.
|
|
1915
|
+
*
|
|
1916
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.ListBinding.extend}.
|
|
1917
|
+
*
|
|
1918
|
+
* @returns Created class / constructor function
|
|
1919
|
+
*/
|
|
1920
|
+
static extend<T extends Record<string, unknown>>(
|
|
1921
|
+
/**
|
|
1922
|
+
* Name of the class being created
|
|
1923
|
+
*/
|
|
1924
|
+
sClassName: string,
|
|
1925
|
+
/**
|
|
1926
|
+
* Object literal with information about the class
|
|
1927
|
+
*/
|
|
1928
|
+
oClassInfo?: sap.ClassInfo<T, OlapPropertyBinding>,
|
|
1929
|
+
/**
|
|
1930
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
1931
|
+
* used by this class
|
|
1932
|
+
*/
|
|
1933
|
+
FNMetaImpl?: Function
|
|
1934
|
+
): Function;
|
|
1935
|
+
/**
|
|
1936
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1937
|
+
*
|
|
1938
|
+
* Returns a metadata object for class sap.sac.df.olap.OlapPropertyBinding.
|
|
1939
|
+
*
|
|
1940
|
+
* @returns Metadata object describing this class
|
|
1941
|
+
*/
|
|
1942
|
+
static getMetadata(): Metadata;
|
|
1943
|
+
}
|
|
1944
|
+
}
|
|
1945
|
+
|
|
1946
|
+
declare module "sap/sac/df/PivotTable" {
|
|
1947
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
1948
|
+
|
|
1949
|
+
import Event from "sap/ui/base/Event";
|
|
1950
|
+
|
|
1951
|
+
import NavigationCommandType from "sap/sac/df/types/NavigationCommandType";
|
|
1952
|
+
|
|
1953
|
+
import Format from "sap/sac/grid/Format";
|
|
1954
|
+
|
|
1955
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
1956
|
+
|
|
1957
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1958
|
+
|
|
1959
|
+
/**
|
|
1960
|
+
* @EXPERIMENTAL
|
|
1961
|
+
*
|
|
1962
|
+
* Enables users to view, navigate and change multidimensional data exposed via InA in a PivotTable.
|
|
1963
|
+
*
|
|
1964
|
+
* Overview:
|
|
1965
|
+
*
|
|
1966
|
+
* The user can view the data in the Pivot Table, navigate in the data via a context menu or enter data
|
|
1967
|
+
* in input enables cells cells.
|
|
1968
|
+
*
|
|
1969
|
+
* Usage:
|
|
1970
|
+
*
|
|
1971
|
+
* The `PivotTable` is mimicked after the OData Smart Controls. Instead of OData they bind against an {sap.sac.df.olap.OlapModel}
|
|
1972
|
+
* with the name "om". Each Analytical Query in the `Olap Model` is exposed as a DataProvider. The data
|
|
1973
|
+
* provider that the PivotTable consumes needs to be provided as a property value.
|
|
1974
|
+
*/
|
|
1975
|
+
export default class PivotTable extends Control {
|
|
1976
|
+
/**
|
|
1977
|
+
* Constructor for a new `PivotTable`.
|
|
1978
|
+
*
|
|
1979
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1980
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1981
|
+
* of the syntax of the settings object.
|
|
1982
|
+
*/
|
|
1983
|
+
constructor(
|
|
1984
|
+
/**
|
|
1985
|
+
* Initial settings for the new control
|
|
1986
|
+
*/
|
|
1987
|
+
mSettings?: $PivotTableSettings
|
|
1988
|
+
);
|
|
1989
|
+
/**
|
|
1990
|
+
* Constructor for a new `PivotTable`.
|
|
1991
|
+
*
|
|
1992
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
1993
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
1994
|
+
* of the syntax of the settings object.
|
|
1995
|
+
*/
|
|
1996
|
+
constructor(
|
|
1997
|
+
/**
|
|
1998
|
+
* ID for the new control, generated automatically if no ID is given
|
|
1999
|
+
*/
|
|
2000
|
+
sId?: string,
|
|
2001
|
+
/**
|
|
2002
|
+
* Initial settings for the new control
|
|
2003
|
+
*/
|
|
2004
|
+
mSettings?: $PivotTableSettings
|
|
2005
|
+
);
|
|
2006
|
+
|
|
2007
|
+
/**
|
|
2008
|
+
* Creates a new subclass of class sap.sac.df.PivotTable with name `sClassName` and enriches it with the
|
|
2009
|
+
* information contained in `oClassInfo`.
|
|
2010
|
+
*
|
|
2011
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
2012
|
+
*
|
|
2013
|
+
* @returns Created class / constructor function
|
|
2014
|
+
*/
|
|
2015
|
+
static extend<T extends Record<string, unknown>>(
|
|
2016
|
+
/**
|
|
2017
|
+
* Name of the class being created
|
|
2018
|
+
*/
|
|
2019
|
+
sClassName: string,
|
|
2020
|
+
/**
|
|
2021
|
+
* Object literal with information about the class
|
|
2022
|
+
*/
|
|
2023
|
+
oClassInfo?: sap.ClassInfo<T, PivotTable>,
|
|
2024
|
+
/**
|
|
2025
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2026
|
+
* used by this class
|
|
2027
|
+
*/
|
|
2028
|
+
FNMetaImpl?: Function
|
|
2029
|
+
): Function;
|
|
2030
|
+
/**
|
|
2031
|
+
* Returns a metadata object for class sap.sac.df.PivotTable.
|
|
2032
|
+
*
|
|
2033
|
+
* @returns Metadata object describing this class
|
|
2034
|
+
*/
|
|
2035
|
+
static getMetadata(): ElementMetadata;
|
|
2036
|
+
/**
|
|
2037
|
+
* Attaches event handler `fnFunction` to the {@link #event:navigationCmd navigationCmd} event of this `sap.sac.df.PivotTable`.
|
|
2038
|
+
*
|
|
2039
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2040
|
+
* otherwise it will be bound to this `sap.sac.df.PivotTable` itself.
|
|
2041
|
+
*
|
|
2042
|
+
* Fired when a user launches a navigation command
|
|
2043
|
+
*
|
|
2044
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2045
|
+
*/
|
|
2046
|
+
attachNavigationCmd(
|
|
2047
|
+
/**
|
|
2048
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
2049
|
+
* object when firing the event
|
|
2050
|
+
*/
|
|
2051
|
+
oData: object,
|
|
2052
|
+
/**
|
|
2053
|
+
* The function to be called when the event occurs
|
|
2054
|
+
*/
|
|
2055
|
+
fnFunction: (p1: Event) => void,
|
|
2056
|
+
/**
|
|
2057
|
+
* Context object to call the event handler with. Defaults to this `sap.sac.df.PivotTable` itself
|
|
2058
|
+
*/
|
|
2059
|
+
oListener?: object
|
|
2060
|
+
): this;
|
|
2061
|
+
/**
|
|
2062
|
+
* Attaches event handler `fnFunction` to the {@link #event:navigationCmd navigationCmd} event of this `sap.sac.df.PivotTable`.
|
|
2063
|
+
*
|
|
2064
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
2065
|
+
* otherwise it will be bound to this `sap.sac.df.PivotTable` itself.
|
|
2066
|
+
*
|
|
2067
|
+
* Fired when a user launches a navigation command
|
|
2068
|
+
*
|
|
2069
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2070
|
+
*/
|
|
2071
|
+
attachNavigationCmd(
|
|
2072
|
+
/**
|
|
2073
|
+
* The function to be called when the event occurs
|
|
2074
|
+
*/
|
|
2075
|
+
fnFunction: (p1: Event) => void,
|
|
2076
|
+
/**
|
|
2077
|
+
* Context object to call the event handler with. Defaults to this `sap.sac.df.PivotTable` itself
|
|
2078
|
+
*/
|
|
2079
|
+
oListener?: object
|
|
2080
|
+
): this;
|
|
2081
|
+
/**
|
|
2082
|
+
* Detaches event handler `fnFunction` from the {@link #event:navigationCmd navigationCmd} event of this
|
|
2083
|
+
* `sap.sac.df.PivotTable`.
|
|
2084
|
+
*
|
|
2085
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
2086
|
+
*
|
|
2087
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2088
|
+
*/
|
|
2089
|
+
detachNavigationCmd(
|
|
2090
|
+
/**
|
|
2091
|
+
* The function to be called, when the event occurs
|
|
2092
|
+
*/
|
|
2093
|
+
fnFunction: (p1: Event) => void,
|
|
2094
|
+
/**
|
|
2095
|
+
* Context object on which the given function had to be called
|
|
2096
|
+
*/
|
|
2097
|
+
oListener?: object
|
|
2098
|
+
): this;
|
|
2099
|
+
/**
|
|
2100
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
2101
|
+
*
|
|
2102
|
+
* Fires event {@link #event:navigationCmd navigationCmd} to attached listeners.
|
|
2103
|
+
*
|
|
2104
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2105
|
+
*/
|
|
2106
|
+
fireNavigationCmd(
|
|
2107
|
+
/**
|
|
2108
|
+
* Parameters to pass along with the event
|
|
2109
|
+
*/
|
|
2110
|
+
mParameters?: {
|
|
2111
|
+
/**
|
|
2112
|
+
* The control in the cell on which the command was initiated
|
|
2113
|
+
*/
|
|
2114
|
+
anchor?: Control;
|
|
2115
|
+
/**
|
|
2116
|
+
* Type of the navigation command: Context Menu, Drill, Row/Col request, Data Entry
|
|
2117
|
+
*/
|
|
2118
|
+
navigationCmdType?:
|
|
2119
|
+
| NavigationCommandType
|
|
2120
|
+
| keyof typeof NavigationCommandType;
|
|
2121
|
+
/**
|
|
2122
|
+
* The Row and Column Selection of the cell on which the command was initiated
|
|
2123
|
+
*/
|
|
2124
|
+
selection?: object;
|
|
2125
|
+
/**
|
|
2126
|
+
* the function that executed the command. The function will return a Promise that resolves/rejects when
|
|
2127
|
+
* the command execution finished.
|
|
2128
|
+
*/
|
|
2129
|
+
cmd?: Function;
|
|
2130
|
+
}
|
|
2131
|
+
): this;
|
|
2132
|
+
/**
|
|
2133
|
+
* Gets current value of property {@link #getDataProviderName dataProviderName}.
|
|
2134
|
+
*
|
|
2135
|
+
* Name of the Data Provider within {sap.sac.df.olap.OlapModel} with name `om`, which is displayed and available
|
|
2136
|
+
* for interactions
|
|
2137
|
+
*
|
|
2138
|
+
* Default value is `"0"`.
|
|
2139
|
+
*
|
|
2140
|
+
* @returns Value of property `dataProviderName`
|
|
2141
|
+
*/
|
|
2142
|
+
getDataProviderName(): string;
|
|
2143
|
+
/**
|
|
2144
|
+
* Gets current value of property {@link #getFormat format}.
|
|
2145
|
+
*
|
|
2146
|
+
* Property for different table formats
|
|
2147
|
+
*
|
|
2148
|
+
* Default value is `ExcelStyle`.
|
|
2149
|
+
*
|
|
2150
|
+
* @returns Value of property `format`
|
|
2151
|
+
*/
|
|
2152
|
+
getFormat(): Format | keyof typeof Format;
|
|
2153
|
+
/**
|
|
2154
|
+
* Sets a new value for property {@link #getDataProviderName dataProviderName}.
|
|
2155
|
+
*
|
|
2156
|
+
* Name of the Data Provider within {sap.sac.df.olap.OlapModel} with name `om`, which is displayed and available
|
|
2157
|
+
* for interactions
|
|
2158
|
+
*
|
|
2159
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2160
|
+
*
|
|
2161
|
+
* Default value is `"0"`.
|
|
2162
|
+
*
|
|
2163
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2164
|
+
*/
|
|
2165
|
+
setDataProviderName(
|
|
2166
|
+
/**
|
|
2167
|
+
* New value for property `dataProviderName`
|
|
2168
|
+
*/
|
|
2169
|
+
sDataProviderName?: string
|
|
2170
|
+
): this;
|
|
2171
|
+
/**
|
|
2172
|
+
* Sets a new value for property {@link #getFormat format}.
|
|
2173
|
+
*
|
|
2174
|
+
* Property for different table formats
|
|
2175
|
+
*
|
|
2176
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2177
|
+
*
|
|
2178
|
+
* Default value is `ExcelStyle`.
|
|
2179
|
+
*
|
|
2180
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
2181
|
+
*/
|
|
2182
|
+
setFormat(
|
|
2183
|
+
/**
|
|
2184
|
+
* New value for property `format`
|
|
2185
|
+
*/
|
|
2186
|
+
sFormat?: Format | keyof typeof Format
|
|
2187
|
+
): this;
|
|
2188
|
+
}
|
|
2189
|
+
|
|
2190
|
+
export interface $PivotTableSettings extends $ControlSettings {
|
|
2191
|
+
/**
|
|
2192
|
+
* Name of the Data Provider within {sap.sac.df.olap.OlapModel} with name `om`, which is displayed and available
|
|
2193
|
+
* for interactions
|
|
2194
|
+
*/
|
|
2195
|
+
dataProviderName?: string | PropertyBindingInfo;
|
|
2196
|
+
|
|
2197
|
+
/**
|
|
2198
|
+
* Property for different table formats
|
|
2199
|
+
*/
|
|
2200
|
+
format?:
|
|
2201
|
+
| (Format | keyof typeof Format)
|
|
2202
|
+
| PropertyBindingInfo
|
|
2203
|
+
| `{${string}}`;
|
|
2204
|
+
|
|
2205
|
+
/**
|
|
2206
|
+
* Fired when a user launches a navigation command
|
|
2207
|
+
*/
|
|
2208
|
+
navigationCmd?: (oEvent: Event) => void;
|
|
2209
|
+
}
|
|
2210
|
+
}
|
|
2211
|
+
|
|
2212
|
+
declare module "sap/sac/df/types/NavigationCommandType" {
|
|
2213
|
+
/**
|
|
2214
|
+
* Types of navigation commands.
|
|
2215
|
+
*/
|
|
2216
|
+
enum NavigationCommandType {
|
|
2217
|
+
/**
|
|
2218
|
+
* Click on a cell
|
|
2219
|
+
*/
|
|
2220
|
+
CellClick = "CellClick",
|
|
2221
|
+
/**
|
|
2222
|
+
* request for additional columns
|
|
2223
|
+
*/
|
|
2224
|
+
ColumnRequest = "ColumnRequest",
|
|
2225
|
+
/**
|
|
2226
|
+
* Context menu entry
|
|
2227
|
+
*/
|
|
2228
|
+
ContextMenuCmd = "ContextMenuCmd",
|
|
2229
|
+
/**
|
|
2230
|
+
* Hierachy drill operation
|
|
2231
|
+
*/
|
|
2232
|
+
HierarchyNavigation = "HierarchyNavigation",
|
|
2233
|
+
/**
|
|
2234
|
+
* request for additional rows
|
|
2235
|
+
*/
|
|
2236
|
+
RowRequest = "RowRequest",
|
|
2237
|
+
}
|
|
2238
|
+
export default NavigationCommandType;
|
|
2239
|
+
}
|
|
2240
|
+
|
|
2241
|
+
declare module "sap/sac/df/types/SystemType" {
|
|
2242
|
+
/**
|
|
2243
|
+
* System Type of an InA System
|
|
2244
|
+
*/
|
|
2245
|
+
enum SystemType {
|
|
2246
|
+
/**
|
|
2247
|
+
* The ABAP analytic engine
|
|
2248
|
+
*/
|
|
2249
|
+
ABAP_MDS = "ABAP_MDS",
|
|
2250
|
+
/**
|
|
2251
|
+
* The BW analytic engine
|
|
2252
|
+
*/
|
|
2253
|
+
BW = "BW",
|
|
2254
|
+
/**
|
|
2255
|
+
* The Data Warehouce Cloud analytic engine
|
|
2256
|
+
*/
|
|
2257
|
+
DWC = "DWC",
|
|
2258
|
+
/**
|
|
2259
|
+
* The HANA/MDS analytic engine
|
|
2260
|
+
*/
|
|
2261
|
+
HANA = "HANA",
|
|
2262
|
+
}
|
|
2263
|
+
export default SystemType;
|
|
2264
|
+
}
|
|
2265
|
+
|
|
2266
|
+
declare namespace sap {
|
|
2267
|
+
interface IUI5DefineDependencyNames {
|
|
2268
|
+
"sap/sac/df/FilterBar": undefined;
|
|
2269
|
+
|
|
2270
|
+
"sap/sac/df/FlexAnalysis": undefined;
|
|
2271
|
+
|
|
2272
|
+
"sap/sac/df/FlexAnalysisPanel": undefined;
|
|
2273
|
+
|
|
2274
|
+
"sap/sac/df/library": undefined;
|
|
2275
|
+
|
|
2276
|
+
"sap/sac/df/olap/MultiDimDataProvider": undefined;
|
|
2277
|
+
|
|
2278
|
+
"sap/sac/df/olap/MultiDimModel": undefined;
|
|
2279
|
+
|
|
2280
|
+
"sap/sac/df/olap/OlapListBinding": undefined;
|
|
2281
|
+
|
|
2282
|
+
"sap/sac/df/olap/OlapListGridBinding": undefined;
|
|
2283
|
+
|
|
2284
|
+
"sap/sac/df/olap/OlapPropertyBinding": undefined;
|
|
2285
|
+
|
|
2286
|
+
"sap/sac/df/PivotTable": undefined;
|
|
2287
|
+
|
|
2288
|
+
"sap/sac/df/types/NavigationCommandType": undefined;
|
|
2289
|
+
|
|
2290
|
+
"sap/sac/df/types/SystemType": undefined;
|
|
2291
|
+
}
|
|
2292
|
+
}
|