@sapui5/ts-types-esm 1.90.6 → 1.90.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.apf.d.ts +234 -401
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.common.d.ts +1 -1
- package/types/sap.fe.core.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +1 -1
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.gantt.d.ts +1 -1
- package/types/sap.m.d.ts +1 -1
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +1 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1 -1
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +3 -3
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +1 -1
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +1 -1
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +6 -6
- package/types/sap.ui.table.d.ts +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +2 -1
- package/types/sap.ushell.d.ts +1 -1
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/package.json
CHANGED
package/types/sap.apf.d.ts
CHANGED
|
@@ -1,403 +1,7 @@
|
|
|
1
|
-
// For Library Version: 1.90.
|
|
1
|
+
// For Library Version: 1.90.2
|
|
2
2
|
|
|
3
3
|
declare module "sap/apf/library" {}
|
|
4
4
|
|
|
5
|
-
declare module "sap/apf/api" {
|
|
6
|
-
import Component from "sap/apf/Component";
|
|
7
|
-
|
|
8
|
-
import Component1 from "sap/apf/base/Component";
|
|
9
|
-
|
|
10
|
-
import MessageObject from "sap/apf/core/messageObject";
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
* Official API for Analysis Path Framework (APF)
|
|
14
|
-
* The APF API provides a consuming application access to the functionality of the APF. It is assumed
|
|
15
|
-
* that the consuming application extends type {@link sap.apf.base.Component}. The API reference is returned
|
|
16
|
-
* by method {@link sap.apf.base.Component#getApi}.
|
|
17
|
-
* Objects and types returned by methods of APF API or passed in parameters of APF API method also belong
|
|
18
|
-
* to the API. These objects and types are documented in their respective sections of this documentation.
|
|
19
|
-
* All methods, objects or types that are not explicitly documented as public are strictly internal and
|
|
20
|
-
* may be changed without prior notice. This also includes all methods, objects or types being classified
|
|
21
|
-
* as experimental.
|
|
22
|
-
* Furthermore there is no need to instantiate required entities directly by applying the JavaScript 'new'-operator
|
|
23
|
-
* on their respective constructors. Instead they should be created by consumers using a create method available
|
|
24
|
-
* on API-level, such as e.g. {@link sap.apf.Api#createMessageObject} for {@link sap.apf.core.MessageObject}
|
|
25
|
-
* or {@link sap.apf.Api#createFilter} for {@link sap.apf.utils.Filter}.
|
|
26
|
-
*/
|
|
27
|
-
export default class Api {
|
|
28
|
-
/**/
|
|
29
|
-
constructor(
|
|
30
|
-
/**
|
|
31
|
-
* A reference to the calling Component.js. The reference provides access to parameters and context.
|
|
32
|
-
*/
|
|
33
|
-
oComponent: Component | Component1,
|
|
34
|
-
/**
|
|
35
|
-
* injected constructors and functions for testing only.
|
|
36
|
-
*/
|
|
37
|
-
inject?: Object,
|
|
38
|
-
/**
|
|
39
|
-
* manifests of the component and the base component itself
|
|
40
|
-
*/
|
|
41
|
-
manifests?: Object
|
|
42
|
-
);
|
|
43
|
-
/**
|
|
44
|
-
* Contains 'api'
|
|
45
|
-
*/
|
|
46
|
-
type: undefined;
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* @EXPERIMENTAL
|
|
50
|
-
*
|
|
51
|
-
* The handling of the window.onerror by the message handler is either switched on or off. Per default the
|
|
52
|
-
* handling is deactivated.
|
|
53
|
-
*/
|
|
54
|
-
activateOnErrorHandling(
|
|
55
|
-
/**
|
|
56
|
-
* Boolean true switches the winow.onerror handling on
|
|
57
|
-
*/
|
|
58
|
-
bHandling: boolean
|
|
59
|
-
): undefined;
|
|
60
|
-
/**
|
|
61
|
-
* @deprecated (since 1.23.1) - Remains in api in order to maintain downward compatibility to 3 Wave 5 apps.
|
|
62
|
-
* @EXPERIMENTAL
|
|
63
|
-
*
|
|
64
|
-
* Adds an element to the footer area.
|
|
65
|
-
*/
|
|
66
|
-
addMasterFooterContent(
|
|
67
|
-
/**
|
|
68
|
-
* any valid UI5 control.
|
|
69
|
-
*/
|
|
70
|
-
oControl: object
|
|
71
|
-
): void;
|
|
72
|
-
/**
|
|
73
|
-
* Adds a filter to the path. Subsequent changes need to be done by the update method providing the identifier.
|
|
74
|
-
* Limitation: Only a single filter term or a disjunction/conjunction of single terms over a single property
|
|
75
|
-
* is supported. Limitation: Only the operators EQ, LE (less equal than) and GE (greater equal than) are
|
|
76
|
-
* supported.
|
|
77
|
-
*/
|
|
78
|
-
addPathFilter(filter: sap.apf.utils.Filter): number;
|
|
79
|
-
/**
|
|
80
|
-
* Creates an empty filter object. Its methods can be used to create a logical filter expression.
|
|
81
|
-
*/
|
|
82
|
-
createFilter(): sap.apf.utils.Filter;
|
|
83
|
-
/**
|
|
84
|
-
* Creates a message object, which is the mandatory parameter for API method putMessage. So first create
|
|
85
|
-
* the message object and afterwards call putMessage with the message object as argument.
|
|
86
|
-
*/
|
|
87
|
-
createMessageObject(
|
|
88
|
-
/**
|
|
89
|
-
* Configuration object for the message object.
|
|
90
|
-
*/
|
|
91
|
-
oConfig: {
|
|
92
|
-
/**
|
|
93
|
-
* The message is classified by its code. The code identifies an entry in the message configuration.
|
|
94
|
-
*/
|
|
95
|
-
code: string;
|
|
96
|
-
/**
|
|
97
|
-
* Additional parameters for the message. The parameters are filled into the message text, when the message
|
|
98
|
-
* will be processed by the text resource handler.
|
|
99
|
-
*/
|
|
100
|
-
aParameters?: Array<any>;
|
|
101
|
-
/**
|
|
102
|
-
* Reference of the calling object. This can be used later to visualize on the user interface, where the
|
|
103
|
-
* message occurred.
|
|
104
|
-
*/
|
|
105
|
-
oCallingObject?: object;
|
|
106
|
-
/**
|
|
107
|
-
* Raw text for non translated messages.
|
|
108
|
-
*/
|
|
109
|
-
rawText?: string;
|
|
110
|
-
}
|
|
111
|
-
): MessageObject;
|
|
112
|
-
/**
|
|
113
|
-
* Creates an object for performing an Odata Request get operation.
|
|
114
|
-
* See:
|
|
115
|
-
* sap.apf#createReadRequest
|
|
116
|
-
*/
|
|
117
|
-
createReadRequest(
|
|
118
|
-
/**
|
|
119
|
-
* identifies a request configuration, which is contained in the analytical configuration. or the request
|
|
120
|
-
* configuration is directly passed as an object oRequestConfiguration.
|
|
121
|
-
*/
|
|
122
|
-
requestConfiguration: String | Object
|
|
123
|
-
): sap.apf.core.ReadRequest;
|
|
124
|
-
/**
|
|
125
|
-
* helps to call customer defined custom formatter function(fnCallback).
|
|
126
|
-
*/
|
|
127
|
-
customFormat(
|
|
128
|
-
/**
|
|
129
|
-
* custom format function need to be called.
|
|
130
|
-
*/
|
|
131
|
-
fnCallback: Function
|
|
132
|
-
): void;
|
|
133
|
-
/**
|
|
134
|
-
* Gets a path filter fragment for the given identifier by fully replacing the existing one.
|
|
135
|
-
*/
|
|
136
|
-
getPathFilter(
|
|
137
|
-
/**
|
|
138
|
-
* Identifier of the path filter fragment as it was returned by addPathFilter method.
|
|
139
|
-
*/
|
|
140
|
-
id: number | string
|
|
141
|
-
): sap.apf.utils.Filter;
|
|
142
|
-
/**
|
|
143
|
-
* Retrieves a text and applies HTML encoding
|
|
144
|
-
*/
|
|
145
|
-
getTextHtmlEncoded(
|
|
146
|
-
/**
|
|
147
|
-
* || {string} Label object or text key
|
|
148
|
-
*/
|
|
149
|
-
oLabel: object,
|
|
150
|
-
/**
|
|
151
|
-
* Array with parameters to replace place holders in text.
|
|
152
|
-
*/
|
|
153
|
-
aParameters: string[]
|
|
154
|
-
): string;
|
|
155
|
-
/**
|
|
156
|
-
* Retrieves a text without application of HTML encoding
|
|
157
|
-
*/
|
|
158
|
-
getTextNotHtmlEncoded(
|
|
159
|
-
/**
|
|
160
|
-
* || {string} Label object or text key
|
|
161
|
-
*/
|
|
162
|
-
oLabel: object,
|
|
163
|
-
/**
|
|
164
|
-
* Array with parameters to replace place holders in text.
|
|
165
|
-
*/
|
|
166
|
-
aParameters: string[]
|
|
167
|
-
): string;
|
|
168
|
-
/**
|
|
169
|
-
* @deprecated (since 1.23.1)
|
|
170
|
-
* @EXPERIMENTAL
|
|
171
|
-
*
|
|
172
|
-
* Loads a new application configuration in JSON format. When called many times, the file is loaded only
|
|
173
|
-
* the first time.
|
|
174
|
-
*/
|
|
175
|
-
loadApplicationConfig(
|
|
176
|
-
/**
|
|
177
|
-
* The absolute path of an application configuration file. Host and port will be added in front of this
|
|
178
|
-
* path.
|
|
179
|
-
*/
|
|
180
|
-
sFilePath: string
|
|
181
|
-
): void;
|
|
182
|
-
/**
|
|
183
|
-
* A message is passed to the APF message handler for further processing. All message specific settings
|
|
184
|
-
* (e.g. message code or severity) need to be passed within an APF message object instance.
|
|
185
|
-
*/
|
|
186
|
-
putMessage(
|
|
187
|
-
/**
|
|
188
|
-
* The message object shall be created by method {@link sap.apf.Api#createMessageObject}.
|
|
189
|
-
*/
|
|
190
|
-
oMessage: MessageObject
|
|
191
|
-
): undefined;
|
|
192
|
-
/**
|
|
193
|
-
* @EXPERIMENTAL
|
|
194
|
-
*
|
|
195
|
-
* Calls the sap.apf.core.instance#updatePath (also see {@link sap.apf.core.Path#update}) with proper callback
|
|
196
|
-
* for UI. It also refreshes the steps either from the active step or all the steps depending on the boolean
|
|
197
|
-
* value passed.
|
|
198
|
-
*/
|
|
199
|
-
selectionChanged(bRefreshAllSteps: boolean): void;
|
|
200
|
-
/**
|
|
201
|
-
* Register the function callback to be executed after APF start-up and content has been created. Callback
|
|
202
|
-
* is called with APF API instance as parameter and 'this' set to the Component instance.
|
|
203
|
-
*/
|
|
204
|
-
setCallbackAfterApfStartup(
|
|
205
|
-
/**
|
|
206
|
-
* that will be executed after APF start-up and content has been created.
|
|
207
|
-
*/
|
|
208
|
-
fnCallback: Function
|
|
209
|
-
): void;
|
|
210
|
-
/**
|
|
211
|
-
* Register the function callback to be executed before APF start-up. Callback is called with APF API instance
|
|
212
|
-
* as parameter and 'this' set to the Component instance.
|
|
213
|
-
*/
|
|
214
|
-
setCallbackBeforeApfStartup(
|
|
215
|
-
/**
|
|
216
|
-
* that will be executed before APF start-up.
|
|
217
|
-
*/
|
|
218
|
-
fnCallback: Function
|
|
219
|
-
): void;
|
|
220
|
-
/**
|
|
221
|
-
* @EXPERIMENTAL
|
|
222
|
-
*
|
|
223
|
-
* Register the function callback to be executed on the given event type. fnCallback will be executed under
|
|
224
|
-
* a context and will be passed with arguments depending on the event type.
|
|
225
|
-
*/
|
|
226
|
-
setEventCallback(
|
|
227
|
-
/**
|
|
228
|
-
* is the type of event for registering the fnCallback for that particular event type printTriggered - Registers
|
|
229
|
-
* a callback for initial page print, this callback returns 2d array contextChanged : Registers a callback
|
|
230
|
-
* for context change, which will set the context of the application
|
|
231
|
-
*/
|
|
232
|
-
sEventType: any,
|
|
233
|
-
/**
|
|
234
|
-
* that will be executed depending on the event type.
|
|
235
|
-
*/
|
|
236
|
-
fnCallback: Function
|
|
237
|
-
): boolean;
|
|
238
|
-
/**
|
|
239
|
-
* true, when no fatal error occurred during startup phase. Startup phase includes the initialization +
|
|
240
|
-
* startupApf
|
|
241
|
-
*/
|
|
242
|
-
startupSucceeded(): boolean;
|
|
243
|
-
/**
|
|
244
|
-
* Updates a filter of the path. Limitation: Only a single filter term or a disjunction/conjunction of single
|
|
245
|
-
* terms over a single property is supported. Limitation: Only the operators EQ, LE (less equal than) and
|
|
246
|
-
* GE (greater equal than) are supported.
|
|
247
|
-
*/
|
|
248
|
-
updatePathFilter(
|
|
249
|
-
/**
|
|
250
|
-
* Identifier of the path filter as it was returned by addPathFilter method. When using an ID of type string
|
|
251
|
-
* the caller must ensure that it is unique.
|
|
252
|
-
*/
|
|
253
|
-
id: number | string,
|
|
254
|
-
|
|
255
|
-
filter: sap.apf.utils.Filter
|
|
256
|
-
): void;
|
|
257
|
-
}
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
declare module "sap/apf/base/Component" {
|
|
261
|
-
import {
|
|
262
|
-
default as UIComponent,
|
|
263
|
-
$UIComponentSettings,
|
|
264
|
-
} from "sap/ui/core/UIComponent";
|
|
265
|
-
|
|
266
|
-
import Control from "sap/ui/core/Control";
|
|
267
|
-
|
|
268
|
-
import Api from "sap/apf/api";
|
|
269
|
-
|
|
270
|
-
import ComponentMetadata from "sap/ui/core/ComponentMetadata";
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
* Base Component for all APF based applications.
|
|
274
|
-
*/
|
|
275
|
-
export default class Component extends UIComponent {
|
|
276
|
-
/**/
|
|
277
|
-
constructor();
|
|
278
|
-
|
|
279
|
-
/**
|
|
280
|
-
* Creates the content of the component. A component that extends this component shall call this method.
|
|
281
|
-
*/
|
|
282
|
-
createContent(): Control;
|
|
283
|
-
/**
|
|
284
|
-
* Cleanup the Component instance. The component that extends this component should call this method.
|
|
285
|
-
*/
|
|
286
|
-
exit(): void;
|
|
287
|
-
/**
|
|
288
|
-
* Creates a new subclass of class sap.apf.base.Component with name `sClassName` and enriches it with the
|
|
289
|
-
* information contained in `oClassInfo`.
|
|
290
|
-
*
|
|
291
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
292
|
-
*/
|
|
293
|
-
static extend<T extends Record<string, unknown>>(
|
|
294
|
-
/**
|
|
295
|
-
* Name of the class being created
|
|
296
|
-
*/
|
|
297
|
-
sClassName: string,
|
|
298
|
-
/**
|
|
299
|
-
* Object literal with information about the class
|
|
300
|
-
*/
|
|
301
|
-
oClassInfo?: sap.ClassInfo<T, Component>,
|
|
302
|
-
/**
|
|
303
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
304
|
-
* used by this class
|
|
305
|
-
*/
|
|
306
|
-
FNMetaImpl?: Function
|
|
307
|
-
): Function;
|
|
308
|
-
/**
|
|
309
|
-
* Returns the instance of the APF API.
|
|
310
|
-
*/
|
|
311
|
-
getApi(): Api;
|
|
312
|
-
/**
|
|
313
|
-
* @SINCE 1.38.4
|
|
314
|
-
* @EXPERIMENTAL
|
|
315
|
-
*
|
|
316
|
-
* This function is optional and can be implemented in any extending Component.js. Its return value is an
|
|
317
|
-
* object containing injected constructors, functions, references and exits. The injected sub entities are
|
|
318
|
-
* all optional and will be used by the APF logic when defined. Exits are used to change predefined enhancement
|
|
319
|
-
* points. Instances, functions and constructors are used for test isolation. Probe is used in tests to
|
|
320
|
-
* access internal APF references.
|
|
321
|
-
*/
|
|
322
|
-
getInjections(): object;
|
|
323
|
-
/**
|
|
324
|
-
* Returns a metadata object for class sap.apf.base.Component.
|
|
325
|
-
*/
|
|
326
|
-
static getMetadata(): ComponentMetadata;
|
|
327
|
-
}
|
|
328
|
-
|
|
329
|
-
export interface $ComponentSettings extends $UIComponentSettings {}
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
declare module "sap/apf/Component" {
|
|
333
|
-
import {
|
|
334
|
-
default as UIComponent,
|
|
335
|
-
$UIComponentSettings,
|
|
336
|
-
} from "sap/ui/core/UIComponent";
|
|
337
|
-
|
|
338
|
-
import Control from "sap/ui/core/Control";
|
|
339
|
-
|
|
340
|
-
import Api from "sap/apf/api";
|
|
341
|
-
|
|
342
|
-
import ComponentMetadata from "sap/ui/core/ComponentMetadata";
|
|
343
|
-
|
|
344
|
-
/**
|
|
345
|
-
* @deprecated - since SAP UI 1.30. This ./Component.js was used for any application build with UI5 Version
|
|
346
|
-
* < 1.30. Use the new ./base/Component.js instead for any application build with UI5 Version >= 1.30
|
|
347
|
-
*
|
|
348
|
-
* Base Component for all APF based applications.
|
|
349
|
-
*/
|
|
350
|
-
export default class Component extends UIComponent {
|
|
351
|
-
/**/
|
|
352
|
-
constructor();
|
|
353
|
-
|
|
354
|
-
/**
|
|
355
|
-
* Creates the content of the component. A component, that extends this component should call this method.
|
|
356
|
-
*/
|
|
357
|
-
createContent(): Control;
|
|
358
|
-
/**
|
|
359
|
-
* Cleanup the Component instance . The component, that extends this component should call this method.
|
|
360
|
-
*/
|
|
361
|
-
exit(): void;
|
|
362
|
-
/**
|
|
363
|
-
* Creates a new subclass of class sap.apf.Component with name `sClassName` and enriches it with the information
|
|
364
|
-
* contained in `oClassInfo`.
|
|
365
|
-
*
|
|
366
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.UIComponent.extend}.
|
|
367
|
-
*/
|
|
368
|
-
static extend<T extends Record<string, unknown>>(
|
|
369
|
-
/**
|
|
370
|
-
* Name of the class being created
|
|
371
|
-
*/
|
|
372
|
-
sClassName: string,
|
|
373
|
-
/**
|
|
374
|
-
* Object literal with information about the class
|
|
375
|
-
*/
|
|
376
|
-
oClassInfo?: sap.ClassInfo<T, Component>,
|
|
377
|
-
/**
|
|
378
|
-
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
379
|
-
* used by this class
|
|
380
|
-
*/
|
|
381
|
-
FNMetaImpl?: Function
|
|
382
|
-
): Function;
|
|
383
|
-
/**
|
|
384
|
-
* Returns the instance of the APF API.
|
|
385
|
-
*/
|
|
386
|
-
getApi(): Api;
|
|
387
|
-
/**
|
|
388
|
-
* Returns a metadata object for class sap.apf.Component.
|
|
389
|
-
*/
|
|
390
|
-
static getMetadata(): ComponentMetadata;
|
|
391
|
-
/**
|
|
392
|
-
* Initialize the Component instance after creation. The component, that extends this component should call
|
|
393
|
-
* this method.
|
|
394
|
-
*/
|
|
395
|
-
init(): void;
|
|
396
|
-
}
|
|
397
|
-
|
|
398
|
-
export interface $ComponentSettings extends $UIComponentSettings {}
|
|
399
|
-
}
|
|
400
|
-
|
|
401
5
|
declare module "sap/apf/core/messageObject" {
|
|
402
6
|
/**
|
|
403
7
|
* The message object represents the APF specific message object for detailed evaluation. The message object
|
|
@@ -1070,6 +674,239 @@ declare namespace sap {
|
|
|
1070
674
|
getId(): string;
|
|
1071
675
|
}
|
|
1072
676
|
}
|
|
677
|
+
|
|
678
|
+
/**
|
|
679
|
+
* Official API for Analysis Path Framework (APF)
|
|
680
|
+
* The APF API provides a consuming application access to the functionality of the APF. It is assumed
|
|
681
|
+
* that the consuming application extends type {@link sap.apf.base.Component}. The API reference is returned
|
|
682
|
+
* by method {@link sap.apf.base.Component#getApi}.
|
|
683
|
+
* Objects and types returned by methods of APF API or passed in parameters of APF API method also belong
|
|
684
|
+
* to the API. These objects and types are documented in their respective sections of this documentation.
|
|
685
|
+
* All methods, objects or types that are not explicitly documented as public are strictly internal and
|
|
686
|
+
* may be changed without prior notice. This also includes all methods, objects or types being classified
|
|
687
|
+
* as experimental.
|
|
688
|
+
* Furthermore there is no need to instantiate required entities directly by applying the JavaScript 'new'-operator
|
|
689
|
+
* on their respective constructors. Instead they should be created by consumers using a create method available
|
|
690
|
+
* on API-level, such as e.g. {@link sap.apf.Api#createMessageObject} for {@link sap.apf.core.MessageObject}
|
|
691
|
+
* or {@link sap.apf.Api#createFilter} for {@link sap.apf.utils.Filter}.
|
|
692
|
+
*/
|
|
693
|
+
class Api {
|
|
694
|
+
/**/
|
|
695
|
+
constructor(
|
|
696
|
+
/**
|
|
697
|
+
* A reference to the calling Component.js. The reference provides access to parameters and context.
|
|
698
|
+
*/
|
|
699
|
+
oComponent: /* was: sap.apf.Component */
|
|
700
|
+
| any
|
|
701
|
+
| /* was: sap.apf.base.Component */ any,
|
|
702
|
+
/**
|
|
703
|
+
* injected constructors and functions for testing only.
|
|
704
|
+
*/
|
|
705
|
+
inject?: Object,
|
|
706
|
+
/**
|
|
707
|
+
* manifests of the component and the base component itself
|
|
708
|
+
*/
|
|
709
|
+
manifests?: Object
|
|
710
|
+
);
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* @EXPERIMENTAL
|
|
714
|
+
*
|
|
715
|
+
* The handling of the window.onerror by the message handler is either switched on or off. Per default the
|
|
716
|
+
* handling is deactivated.
|
|
717
|
+
*/
|
|
718
|
+
activateOnErrorHandling(
|
|
719
|
+
/**
|
|
720
|
+
* Boolean true switches the winow.onerror handling on
|
|
721
|
+
*/
|
|
722
|
+
bHandling: boolean
|
|
723
|
+
): undefined;
|
|
724
|
+
/**
|
|
725
|
+
* @deprecated (since 1.23.1) - Remains in api in order to maintain downward compatibility to 3 Wave 5 apps.
|
|
726
|
+
* @EXPERIMENTAL
|
|
727
|
+
*
|
|
728
|
+
* Adds an element to the footer area.
|
|
729
|
+
*/
|
|
730
|
+
addMasterFooterContent(
|
|
731
|
+
/**
|
|
732
|
+
* any valid UI5 control.
|
|
733
|
+
*/
|
|
734
|
+
oControl: object
|
|
735
|
+
): void;
|
|
736
|
+
/**
|
|
737
|
+
* Adds a filter to the path. Subsequent changes need to be done by the update method providing the identifier.
|
|
738
|
+
* Limitation: Only a single filter term or a disjunction/conjunction of single terms over a single property
|
|
739
|
+
* is supported. Limitation: Only the operators EQ, LE (less equal than) and GE (greater equal than) are
|
|
740
|
+
* supported.
|
|
741
|
+
*/
|
|
742
|
+
addPathFilter(filter: sap.apf.utils.Filter): number;
|
|
743
|
+
/**
|
|
744
|
+
* Creates an empty filter object. Its methods can be used to create a logical filter expression.
|
|
745
|
+
*/
|
|
746
|
+
createFilter(): sap.apf.utils.Filter;
|
|
747
|
+
/**
|
|
748
|
+
* Creates a message object, which is the mandatory parameter for API method putMessage. So first create
|
|
749
|
+
* the message object and afterwards call putMessage with the message object as argument.
|
|
750
|
+
*/
|
|
751
|
+
createMessageObject(
|
|
752
|
+
/**
|
|
753
|
+
* Configuration object for the message object.
|
|
754
|
+
*/
|
|
755
|
+
oConfig: {
|
|
756
|
+
/**
|
|
757
|
+
* The message is classified by its code. The code identifies an entry in the message configuration.
|
|
758
|
+
*/
|
|
759
|
+
code: string;
|
|
760
|
+
/**
|
|
761
|
+
* Additional parameters for the message. The parameters are filled into the message text, when the message
|
|
762
|
+
* will be processed by the text resource handler.
|
|
763
|
+
*/
|
|
764
|
+
aParameters?: Array<any>;
|
|
765
|
+
/**
|
|
766
|
+
* Reference of the calling object. This can be used later to visualize on the user interface, where the
|
|
767
|
+
* message occurred.
|
|
768
|
+
*/
|
|
769
|
+
oCallingObject?: object;
|
|
770
|
+
/**
|
|
771
|
+
* Raw text for non translated messages.
|
|
772
|
+
*/
|
|
773
|
+
rawText?: string;
|
|
774
|
+
}
|
|
775
|
+
): import("sap/apf/core/messageObject").default;
|
|
776
|
+
/**
|
|
777
|
+
* helps to call customer defined custom formatter function(fnCallback).
|
|
778
|
+
*/
|
|
779
|
+
customFormat(
|
|
780
|
+
/**
|
|
781
|
+
* custom format function need to be called.
|
|
782
|
+
*/
|
|
783
|
+
fnCallback: Function
|
|
784
|
+
): void;
|
|
785
|
+
/**
|
|
786
|
+
* Gets a path filter fragment for the given identifier by fully replacing the existing one.
|
|
787
|
+
*/
|
|
788
|
+
getPathFilter(
|
|
789
|
+
/**
|
|
790
|
+
* Identifier of the path filter fragment as it was returned by addPathFilter method.
|
|
791
|
+
*/
|
|
792
|
+
id: number | string
|
|
793
|
+
): sap.apf.utils.Filter;
|
|
794
|
+
/**
|
|
795
|
+
* Retrieves a text and applies HTML encoding
|
|
796
|
+
*/
|
|
797
|
+
getTextHtmlEncoded(
|
|
798
|
+
/**
|
|
799
|
+
* || {string} Label object or text key
|
|
800
|
+
*/
|
|
801
|
+
oLabel: object,
|
|
802
|
+
/**
|
|
803
|
+
* Array with parameters to replace place holders in text.
|
|
804
|
+
*/
|
|
805
|
+
aParameters: string[]
|
|
806
|
+
): string;
|
|
807
|
+
/**
|
|
808
|
+
* Retrieves a text without application of HTML encoding
|
|
809
|
+
*/
|
|
810
|
+
getTextNotHtmlEncoded(
|
|
811
|
+
/**
|
|
812
|
+
* || {string} Label object or text key
|
|
813
|
+
*/
|
|
814
|
+
oLabel: object,
|
|
815
|
+
/**
|
|
816
|
+
* Array with parameters to replace place holders in text.
|
|
817
|
+
*/
|
|
818
|
+
aParameters: string[]
|
|
819
|
+
): string;
|
|
820
|
+
/**
|
|
821
|
+
* @deprecated (since 1.23.1)
|
|
822
|
+
* @EXPERIMENTAL
|
|
823
|
+
*
|
|
824
|
+
* Loads a new application configuration in JSON format. When called many times, the file is loaded only
|
|
825
|
+
* the first time.
|
|
826
|
+
*/
|
|
827
|
+
loadApplicationConfig(
|
|
828
|
+
/**
|
|
829
|
+
* The absolute path of an application configuration file. Host and port will be added in front of this
|
|
830
|
+
* path.
|
|
831
|
+
*/
|
|
832
|
+
sFilePath: string
|
|
833
|
+
): void;
|
|
834
|
+
/**
|
|
835
|
+
* A message is passed to the APF message handler for further processing. All message specific settings
|
|
836
|
+
* (e.g. message code or severity) need to be passed within an APF message object instance.
|
|
837
|
+
*/
|
|
838
|
+
putMessage(
|
|
839
|
+
/**
|
|
840
|
+
* The message object shall be created by method {@link sap.apf.Api#createMessageObject}.
|
|
841
|
+
*/
|
|
842
|
+
oMessage: import("sap/apf/core/messageObject").default
|
|
843
|
+
): undefined;
|
|
844
|
+
/**
|
|
845
|
+
* @EXPERIMENTAL
|
|
846
|
+
*
|
|
847
|
+
* Calls the sap.apf.core.instance#updatePath (also see {@link sap.apf.core.Path#update}) with proper callback
|
|
848
|
+
* for UI. It also refreshes the steps either from the active step or all the steps depending on the boolean
|
|
849
|
+
* value passed.
|
|
850
|
+
*/
|
|
851
|
+
selectionChanged(bRefreshAllSteps: boolean): void;
|
|
852
|
+
/**
|
|
853
|
+
* Register the function callback to be executed after APF start-up and content has been created. Callback
|
|
854
|
+
* is called with APF API instance as parameter and 'this' set to the Component instance.
|
|
855
|
+
*/
|
|
856
|
+
setCallbackAfterApfStartup(
|
|
857
|
+
/**
|
|
858
|
+
* that will be executed after APF start-up and content has been created.
|
|
859
|
+
*/
|
|
860
|
+
fnCallback: Function
|
|
861
|
+
): void;
|
|
862
|
+
/**
|
|
863
|
+
* Register the function callback to be executed before APF start-up. Callback is called with APF API instance
|
|
864
|
+
* as parameter and 'this' set to the Component instance.
|
|
865
|
+
*/
|
|
866
|
+
setCallbackBeforeApfStartup(
|
|
867
|
+
/**
|
|
868
|
+
* that will be executed before APF start-up.
|
|
869
|
+
*/
|
|
870
|
+
fnCallback: Function
|
|
871
|
+
): void;
|
|
872
|
+
/**
|
|
873
|
+
* @EXPERIMENTAL
|
|
874
|
+
*
|
|
875
|
+
* Register the function callback to be executed on the given event type. fnCallback will be executed under
|
|
876
|
+
* a context and will be passed with arguments depending on the event type.
|
|
877
|
+
*/
|
|
878
|
+
setEventCallback(
|
|
879
|
+
/**
|
|
880
|
+
* is the type of event for registering the fnCallback for that particular event type printTriggered - Registers
|
|
881
|
+
* a callback for initial page print, this callback returns 2d array contextChanged : Registers a callback
|
|
882
|
+
* for context change, which will set the context of the application
|
|
883
|
+
*/
|
|
884
|
+
sEventType: /* was: sap.apf.core.constants.eventTypes */ any,
|
|
885
|
+
/**
|
|
886
|
+
* that will be executed depending on the event type.
|
|
887
|
+
*/
|
|
888
|
+
fnCallback: Function
|
|
889
|
+
): boolean;
|
|
890
|
+
/**
|
|
891
|
+
* true, when no fatal error occurred during startup phase. Startup phase includes the initialization +
|
|
892
|
+
* startupApf
|
|
893
|
+
*/
|
|
894
|
+
startupSucceeded(): boolean;
|
|
895
|
+
/**
|
|
896
|
+
* Updates a filter of the path. Limitation: Only a single filter term or a disjunction/conjunction of single
|
|
897
|
+
* terms over a single property is supported. Limitation: Only the operators EQ, LE (less equal than) and
|
|
898
|
+
* GE (greater equal than) are supported.
|
|
899
|
+
*/
|
|
900
|
+
updatePathFilter(
|
|
901
|
+
/**
|
|
902
|
+
* Identifier of the path filter as it was returned by addPathFilter method. When using an ID of type string
|
|
903
|
+
* the caller must ensure that it is unique.
|
|
904
|
+
*/
|
|
905
|
+
id: number | string,
|
|
906
|
+
|
|
907
|
+
filter: sap.apf.utils.Filter
|
|
908
|
+
): void;
|
|
909
|
+
}
|
|
1073
910
|
}
|
|
1074
911
|
|
|
1075
912
|
interface IUI5DefineDependencyNames {
|
|
@@ -1077,10 +914,6 @@ declare namespace sap {
|
|
|
1077
914
|
|
|
1078
915
|
"sap/apf/api": undefined;
|
|
1079
916
|
|
|
1080
|
-
"sap/apf/base/Component": undefined;
|
|
1081
|
-
|
|
1082
|
-
"sap/apf/Component": undefined;
|
|
1083
|
-
|
|
1084
917
|
"sap/apf/core/messageObject": undefined;
|
|
1085
918
|
|
|
1086
919
|
"sap/apf/core/readRequest": undefined;
|
package/types/sap.chart.d.ts
CHANGED
package/types/sap.f.d.ts
CHANGED
package/types/sap.fe.common.d.ts
CHANGED
package/types/sap.fe.core.d.ts
CHANGED
package/types/sap.fe.macros.d.ts
CHANGED
package/types/sap.fe.test.d.ts
CHANGED
package/types/sap.fe.tools.d.ts
CHANGED
package/types/sap.gantt.d.ts
CHANGED
package/types/sap.m.d.ts
CHANGED
package/types/sap.makit.d.ts
CHANGED
package/types/sap.me.d.ts
CHANGED
package/types/sap.ndc.d.ts
CHANGED
package/types/sap.ovp.d.ts
CHANGED
package/types/sap.tnt.d.ts
CHANGED
package/types/sap.ui.comp.d.ts
CHANGED
package/types/sap.ui.core.d.ts
CHANGED
package/types/sap.ui.dt.d.ts
CHANGED
package/types/sap.ui.export.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.90.
|
|
1
|
+
// For Library Version: 1.90.9
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/export/library" {
|
|
4
4
|
/**
|
|
@@ -133,7 +133,7 @@ declare module "sap/ui/export/Spreadsheet" {
|
|
|
133
133
|
* - `workbook.context` - Context object that will be applied to the generated file. It may contain the
|
|
134
134
|
* following fields:
|
|
135
135
|
* - `application` (string) - The application that creates the XLSX document (default: "SAP UI5")
|
|
136
|
-
* - `version` (string) - Application version that creates the XLSX document (default: "1.90.
|
|
136
|
+
* - `version` (string) - Application version that creates the XLSX document (default: "1.90.9")
|
|
137
137
|
* - `title` (string) - Title of the XLSX document (NOT the filename)
|
|
138
138
|
* - `modifiedBy` (string) - User context for the XLSX document
|
|
139
139
|
* - `sheetName` (string) - The label of the data sheet
|
|
@@ -219,7 +219,7 @@ declare module "sap/ui/export/Spreadsheet" {
|
|
|
219
219
|
* columns: aColumns,
|
|
220
220
|
* context: {
|
|
221
221
|
* application: 'Debug Test Application',
|
|
222
|
-
* version: '1.90.
|
|
222
|
+
* version: '1.90.9',
|
|
223
223
|
* title: 'Some random title',
|
|
224
224
|
* modifiedBy: 'John Doe',
|
|
225
225
|
* metaSheetName: 'Custom metadata',
|
package/types/sap.ui.fl.d.ts
CHANGED
package/types/sap.ui.layout.d.ts
CHANGED
package/types/sap.ui.mdc.d.ts
CHANGED
package/types/sap.ui.rta.d.ts
CHANGED
package/types/sap.ui.suite.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
// For Library Version: 1.90.
|
|
1
|
+
// For Library Version: 1.90.9
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/support/library" {
|
|
4
4
|
/**
|
|
5
|
-
* @SINCE 1.90.
|
|
5
|
+
* @SINCE 1.90.9
|
|
6
6
|
*
|
|
7
7
|
* Defines the Audiences.
|
|
8
8
|
*/
|
|
@@ -21,7 +21,7 @@ declare module "sap/ui/support/library" {
|
|
|
21
21
|
Internal = "Internal",
|
|
22
22
|
}
|
|
23
23
|
/**
|
|
24
|
-
* @SINCE 1.90.
|
|
24
|
+
* @SINCE 1.90.9
|
|
25
25
|
*
|
|
26
26
|
* Issue Categories.
|
|
27
27
|
*/
|
|
@@ -76,7 +76,7 @@ declare module "sap/ui/support/library" {
|
|
|
76
76
|
Usage = "Usage",
|
|
77
77
|
}
|
|
78
78
|
/**
|
|
79
|
-
* @SINCE 1.90.
|
|
79
|
+
* @SINCE 1.90.9
|
|
80
80
|
*
|
|
81
81
|
* Analysis history formats.
|
|
82
82
|
*/
|
|
@@ -91,7 +91,7 @@ declare module "sap/ui/support/library" {
|
|
|
91
91
|
String = "String",
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
|
-
* @SINCE 1.90.
|
|
94
|
+
* @SINCE 1.90.9
|
|
95
95
|
*
|
|
96
96
|
* Defines severity types.
|
|
97
97
|
*/
|
|
@@ -110,7 +110,7 @@ declare module "sap/ui/support/library" {
|
|
|
110
110
|
Medium = "Medium",
|
|
111
111
|
}
|
|
112
112
|
/**
|
|
113
|
-
* @SINCE 1.90.
|
|
113
|
+
* @SINCE 1.90.9
|
|
114
114
|
*
|
|
115
115
|
* Contains the available system presets.
|
|
116
116
|
*/
|
package/types/sap.ui.table.d.ts
CHANGED
package/types/sap.ui.ux3.d.ts
CHANGED
package/types/sap.ui.vk.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.90.
|
|
1
|
+
// For Library Version: 1.90.9
|
|
2
2
|
|
|
3
3
|
declare module "sap/uiext/inbox/library" {}
|
|
4
4
|
|
|
@@ -1964,6 +1964,7 @@ declare module "sap/uiext/inbox/Inbox" {
|
|
|
1964
1964
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
1965
1965
|
|
|
1966
1966
|
/**
|
|
1967
|
+
* @deprecated (since 1.38.0)
|
|
1967
1968
|
* @EXPERIMENTAL (since 1.5.2)
|
|
1968
1969
|
*
|
|
1969
1970
|
* A comprehensive UI design approach with graphical and functional elements for search tasks, filter tasks,
|
package/types/sap.ushell.d.ts
CHANGED
package/types/sap.uxap.d.ts
CHANGED
package/types/sap.viz.d.ts
CHANGED
package/types/sap.zen.dsh.d.ts
CHANGED