@sapui5/ts-types 1.114.0 → 1.115.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/package.json +1 -1
- package/types/sap.apf.d.ts +2 -2
- package/types/sap.ca.ui.d.ts +135 -67
- package/types/sap.chart.d.ts +154 -125
- package/types/sap.collaboration.d.ts +80 -78
- package/types/sap.esh.search.ui.d.ts +93 -1
- package/types/sap.f.d.ts +1331 -950
- package/types/sap.fe.core.d.ts +38 -152
- package/types/sap.fe.macros.d.ts +53 -7
- package/types/sap.fe.navigation.d.ts +34 -27
- package/types/sap.fe.templates.d.ts +8 -275
- package/types/sap.fe.test.d.ts +4 -10
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +1716 -1087
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.landvisz.d.ts +35 -9
- package/types/sap.m.d.ts +7228 -4499
- package/types/sap.makit.d.ts +17 -5
- package/types/sap.me.d.ts +122 -63
- package/types/sap.ndc.d.ts +99 -39
- package/types/sap.ovp.d.ts +1 -2
- package/types/sap.rules.ui.d.ts +43 -19
- package/types/sap.sac.df.d.ts +3 -3
- package/types/sap.suite.ui.commons.d.ts +2056 -1282
- package/types/sap.suite.ui.generic.template.d.ts +29 -40
- package/types/sap.suite.ui.microchart.d.ts +188 -136
- package/types/sap.tnt.d.ts +134 -54
- package/types/sap.ui.codeeditor.d.ts +51 -29
- package/types/sap.ui.commons.d.ts +1017 -599
- package/types/sap.ui.comp.d.ts +2370 -1523
- package/types/sap.ui.core.d.ts +4086 -2346
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +32 -29
- package/types/sap.ui.fl.d.ts +123 -80
- package/types/sap.ui.generic.app.d.ts +40 -39
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +241 -163
- package/types/sap.ui.layout.d.ts +312 -355
- package/types/sap.ui.mdc.d.ts +21827 -6
- package/types/sap.ui.richtexteditor.d.ts +61 -49
- package/types/sap.ui.rta.d.ts +1 -2
- package/types/sap.ui.suite.d.ts +9 -9
- package/types/sap.ui.support.d.ts +5 -7
- package/types/sap.ui.table.d.ts +678 -452
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +925 -593
- package/types/sap.ui.ux3.d.ts +1038 -549
- package/types/sap.ui.vbm.d.ts +1262 -710
- package/types/sap.ui.vk.d.ts +2981 -1751
- package/types/sap.ui.vtm.d.ts +704 -457
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +532 -301
- package/types/sap.ui.webc.main.d.ts +1222 -720
- package/types/sap.uiext.inbox.d.ts +47 -24
- package/types/sap.ushell.d.ts +359 -173
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +287 -199
- package/types/sap.viz.d.ts +678 -391
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +5 -5
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +147 -81
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.115.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace ui {
|
|
@@ -27,8 +27,8 @@ declare namespace sap {
|
|
|
27
27
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
28
28
|
* of the syntax of the settings object.
|
|
29
29
|
*
|
|
30
|
-
* This class does not have its own settings, but all settings applicable to the base type {@link sap.fe.navigation.NavError#constructor
|
|
31
|
-
*
|
|
30
|
+
* This class does not have its own settings, but all settings applicable to the base type {@link sap.fe.navigation.NavError#constructor sap.fe.navigation.NavError }
|
|
31
|
+
* can be used.
|
|
32
32
|
*/
|
|
33
33
|
constructor(
|
|
34
34
|
/**
|
|
@@ -88,13 +88,12 @@ declare namespace sap {
|
|
|
88
88
|
* as the app state.
|
|
89
89
|
* Also, all properties annotated as `com.sap.vocabularies.Analytics.v1.Measure` will be removed from the
|
|
90
90
|
* data stored as the xapp state.
|
|
91
|
-
* To verify the information to be removed, the `NavigationHandler` requires an unnamed model of type {@link
|
|
92
|
-
*
|
|
93
|
-
* method.
|
|
91
|
+
* To verify the information to be removed, the `NavigationHandler` requires an unnamed model of type {@link sap.ui.model.odata.v2.ODataModel }
|
|
92
|
+
* on component level. It is possible to set such a model using the `setModel` method.
|
|
94
93
|
* **Note:** The check for excluded data requires that the OData metadata has already been loaded completely.
|
|
95
94
|
* If the OData metadata model has not been loaded completely, all properties are removed from the application
|
|
96
95
|
* context.
|
|
97
|
-
* **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation}
|
|
96
|
+
* **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation }
|
|
98
97
|
* is available and initialized.
|
|
99
98
|
*/
|
|
100
99
|
class NavigationHandler
|
|
@@ -107,8 +106,7 @@ declare namespace sap {
|
|
|
107
106
|
*/
|
|
108
107
|
oController: object,
|
|
109
108
|
/**
|
|
110
|
-
* Mode to be used to handle conflicts when merging URL parameters and the SelectionVariant class, see {@link
|
|
111
|
-
* sap.ui.generic.app.navigation.service.ParamHandlingMode}
|
|
109
|
+
* Mode to be used to handle conflicts when merging URL parameters and the SelectionVariant class, see {@link sap.ui.generic.app.navigation.service.ParamHandlingMode}
|
|
112
110
|
*/
|
|
113
111
|
sParamHandlingMode?: string
|
|
114
112
|
);
|
|
@@ -118,9 +116,8 @@ declare namespace sap {
|
|
|
118
116
|
* @deprecated (since 1.83.0)
|
|
119
117
|
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
120
118
|
*
|
|
121
|
-
* The method creates a context url based on provided data. This context url can either be used as {@link
|
|
122
|
-
* sap.ui.generic.app.navigation.service.NavigationHandler#
|
|
123
|
-
* {@link sap.ui.generic.app.navigation.service.NavigationHandler#setFilterContextUrl FilterContextUrl}
|
|
119
|
+
* The method creates a context url based on provided data. This context url can either be used as {@link sap.ui.generic.app.navigation.service.NavigationHandler#setParameterContextUrl ParameterContextUrl }
|
|
120
|
+
* or {@link sap.ui.generic.app.navigation.service.NavigationHandler#setFilterContextUrl FilterContextUrl}
|
|
124
121
|
*
|
|
125
122
|
* @returns context url for the given entities
|
|
126
123
|
*/
|
|
@@ -185,7 +182,7 @@ declare namespace sap {
|
|
|
185
182
|
* Combines the given parameters and selection variant into a new selection variant containing properties
|
|
186
183
|
* from both, with the parameters overriding existing properties in the selection variant. The new selection
|
|
187
184
|
* variant does not contain any parameters. All parameters are merged into select options. The output of
|
|
188
|
-
* this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate}
|
|
185
|
+
* this function, converted to a JSON string, can be used for the {@link #.navigate NavigationHandler.navigate }
|
|
189
186
|
* method.
|
|
190
187
|
*
|
|
191
188
|
* @returns Instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
|
|
@@ -200,10 +197,9 @@ declare namespace sap {
|
|
|
200
197
|
*/
|
|
201
198
|
sSelectionVariant: string,
|
|
202
199
|
/**
|
|
203
|
-
* Indicates whether semantic attributes with special values (see {@link sap.ui.generic.app.navigation.service.SuppressionBehavior
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
* with the bitwise OR operator (|)
|
|
200
|
+
* Indicates whether semantic attributes with special values (see {@link sap.ui.generic.app.navigation.service.SuppressionBehavior suppression behavior})
|
|
201
|
+
* must be suppressed before they are combined with the selection variant; several {@link sap.ui.generic.app.navigation.service.SuppressionBehavior suppression behaviors }
|
|
202
|
+
* can be combined with the bitwise OR operator (|)
|
|
207
203
|
*/
|
|
208
204
|
iSuppressionBehavior?: int
|
|
209
205
|
): object;
|
|
@@ -775,25 +771,25 @@ declare namespace sap {
|
|
|
775
771
|
* execution is successful, the extracted app state, the startup parameters, and the type of navigation
|
|
776
772
|
* are returned, see also the example above. The app state is an object that contains the following information:
|
|
777
773
|
*
|
|
778
|
-
* - `oAppData.oSelectionVariant`: An instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
|
|
779
|
-
*
|
|
774
|
+
* - `oAppData.oSelectionVariant`: An instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant }
|
|
775
|
+
* containing only parameters/select options that are related to navigation
|
|
780
776
|
* - `oAppData.selectionVariant`: The navigation-related selection variant as a JSON-formatted string
|
|
781
777
|
*
|
|
782
|
-
* - `oAppData.oDefaultedSelectionVariant`: An instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant}
|
|
783
|
-
*
|
|
778
|
+
* - `oAppData.oDefaultedSelectionVariant`: An instance of {@link sap.ui.generic.app.navigation.service.SelectionVariant }
|
|
779
|
+
* containing only the parameters/select options that are set by user default data
|
|
784
780
|
* - `oAppData.bNavSelVarHasDefaultsOnly`: A Boolean flag that indicates whether only defaulted parameters
|
|
785
|
-
*
|
|
781
|
+
* and no navigation parameters are present.
|
|
786
782
|
* **Note:** If no navigation parameters are available, `bNavSelVarHasDefaultsOnly` is set to `true`, even
|
|
787
783
|
* though parameters without default might be available as well. If the navigation-related selection
|
|
788
784
|
* variant is empty, it is replaced by a copy of the defaulted selection variant.
|
|
789
|
-
* The navigation type is an enumeration type of type {@link sap.ui.generic.app.navigation.service.NavType}
|
|
785
|
+
* The navigation type is an enumeration type of type {@link sap.ui.generic.app.navigation.service.NavType }
|
|
790
786
|
* (possible values are initial, URLParams, xAppState, and iAppState).
|
|
791
|
-
* **Note:** If the navigation type is {@link sap.ui.generic.app.navigation.service.NavType.iAppState}
|
|
787
|
+
* **Note:** If the navigation type is {@link sap.ui.generic.app.navigation.service.NavType.iAppState }
|
|
792
788
|
* oAppData has two additional properties
|
|
793
789
|
* - `oAppData.tableVariantId`
|
|
794
|
-
* - `oAppData.customData` which return the inner app data as stored in {@link #.navigate navigate}
|
|
795
|
-
*
|
|
796
|
-
*
|
|
790
|
+
* - `oAppData.customData` which return the inner app data as stored in {@link #.navigate navigate }
|
|
791
|
+
* or {@link #.storeInnerAppState storeInnerAppState}. `oAppData.oDefaultedSelectionVariant` is an empty
|
|
792
|
+
* selection variant and `oAppData.bNavSelVarHasDefaultsOnly` is `false` in this case.
|
|
797
793
|
* **Note:** If the navigation type is {@link sap.ui.generic.app.navigation.service.NavType.initial} oAppData
|
|
798
794
|
* is an empty object!
|
|
799
795
|
* If an error occurs, an error object of type {@link sap.ui.generic.app.navigation.service.NavError},
|
|
@@ -812,13 +808,13 @@ declare namespace sap {
|
|
|
812
808
|
* - If `mInnerAppData` is provided, this inner app state is saved for back navigation at a later time.
|
|
813
809
|
*
|
|
814
810
|
* - The table event parameters (semantic attributes) and the selection variant data are combined by calling
|
|
815
|
-
*
|
|
811
|
+
* the method {@link #.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant}.
|
|
816
812
|
* - The combined data is saved as the cross app state to be handed over to the target app, and the corresponding
|
|
817
|
-
*
|
|
813
|
+
* sap-xapp-state key is set in the URL.
|
|
818
814
|
* - All single selections ("including equal") of the combined selection data are passed to the SmartLink
|
|
819
|
-
*
|
|
815
|
+
* popover as semantic attributes.
|
|
820
816
|
* - The method `oTableEventParameters.open()` is called. Note that this does not really open the popover,
|
|
821
|
-
*
|
|
817
|
+
* but the SmartLink control proceeds with firing the event `navigationTargetsObtained`.
|
|
822
818
|
*
|
|
823
819
|
* @returns A Promise object to monitor when all actions of the function have been executed; if the execution
|
|
824
820
|
* is successful, the modified oTableEventParameters is returned; if an error occurs, an error object of
|
|
@@ -931,8 +927,8 @@ declare namespace sap {
|
|
|
931
927
|
* Changes the URL according to the current app state and stores the app state for later retrieval.
|
|
932
928
|
*
|
|
933
929
|
* @returns A Promise object to monitor when all the actions of the function have been executed; if the
|
|
934
|
-
* execution is successful, the app state key is returned; if an error occurs, an object of type {@link
|
|
935
|
-
*
|
|
930
|
+
* execution is successful, the app state key is returned; if an error occurs, an object of type {@link sap.ui.generic.app.navigation.service.NavError }
|
|
931
|
+
* is returned
|
|
936
932
|
*/
|
|
937
933
|
static storeInnerAppState(
|
|
938
934
|
/**
|
|
@@ -1372,7 +1368,7 @@ declare namespace sap {
|
|
|
1372
1368
|
* - `Option`: The option of the range
|
|
1373
1369
|
* - `Low`: The low value of the range; returning value `null` is not possible
|
|
1374
1370
|
* - `High`: The high value of the range; if this value is not necessary, `null` is used For further
|
|
1375
|
-
*
|
|
1371
|
+
* information about the meaning of the attributes, refer to method `addSelectOption`.
|
|
1376
1372
|
*/
|
|
1377
1373
|
static getSelectOption(
|
|
1378
1374
|
/**
|
|
@@ -1412,7 +1408,7 @@ declare namespace sap {
|
|
|
1412
1408
|
* - `Option`: The option of the range
|
|
1413
1409
|
* - `Low`: The low value of the range; returning the value `null` is not possible
|
|
1414
1410
|
* - `High`: The high value of the range; if this value is not necessary, `null` (but does exist)
|
|
1415
|
-
*
|
|
1411
|
+
* For further information on the meaning of the attributes, refer to method {@link #.addSelectOption addSelectOption}.
|
|
1416
1412
|
*/
|
|
1417
1413
|
static getValue(
|
|
1418
1414
|
/**
|
|
@@ -1577,6 +1573,12 @@ declare namespace sap {
|
|
|
1577
1573
|
* A static enumeration type which indicates the type of inbound navigation
|
|
1578
1574
|
*/
|
|
1579
1575
|
enum NavType {
|
|
1576
|
+
/**
|
|
1577
|
+
* @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
1578
|
+
*
|
|
1579
|
+
* Passing iapp-state data within xapp state in addition to existing values
|
|
1580
|
+
*/
|
|
1581
|
+
hybrid = "undefined",
|
|
1580
1582
|
/**
|
|
1581
1583
|
* Back navigation with sap-iapp-state parameter
|
|
1582
1584
|
*/
|
|
@@ -1623,9 +1625,8 @@ declare namespace sap {
|
|
|
1623
1625
|
*
|
|
1624
1626
|
* A static enumeration type which indicates whether semantic attributes with values `null`, `undefined`
|
|
1625
1627
|
* or `""` (empty string) shall be suppressed, before they are mixed in to the selection variant in the
|
|
1626
|
-
* method {@link sap.ui.generic.app.navigation.service.NavigationHandler.mixAttributesAndSelectionVariant
|
|
1627
|
-
*
|
|
1628
|
-
* NavigationHandler}
|
|
1628
|
+
* method {@link sap.ui.generic.app.navigation.service.NavigationHandler.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant }
|
|
1629
|
+
* of the {@link sap.ui.generic.app.navigation.service.NavigationHandler NavigationHandler}
|
|
1629
1630
|
*/
|
|
1630
1631
|
enum SuppressionBehavior {
|
|
1631
1632
|
/**
|
|
@@ -1639,7 +1640,7 @@ declare namespace sap {
|
|
|
1639
1640
|
*/
|
|
1640
1641
|
raiseErrorOnNull = "undefined",
|
|
1641
1642
|
/**
|
|
1642
|
-
* Semantic attributes with an `undefined` value lead to an {@link sap.fin.central.lib.error.Error error}
|
|
1643
|
+
* Semantic attributes with an `undefined` value lead to an {@link sap.fin.central.lib.error.Error error }
|
|
1643
1644
|
* of type NavigationHandler.INVALID_INPUT
|
|
1644
1645
|
*/
|
|
1645
1646
|
raiseErrorOnUndefined = "undefined",
|