@sapui5/ts-types 1.116.0 → 1.117.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/index.d.ts +1 -0
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +144 -57
- package/types/sap.chart.d.ts +29 -8
- package/types/sap.collaboration.d.ts +5 -2
- package/types/sap.esh.search.ui.d.ts +9 -3
- package/types/sap.f.d.ts +160 -63
- package/types/sap.fe.core.d.ts +21 -35
- package/types/sap.fe.macros.d.ts +148 -16
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.optimisticBatch.d.ts +3 -0
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +344 -1208
- package/types/sap.insights.d.ts +251 -11
- package/types/sap.landvisz.d.ts +64 -25
- package/types/sap.m.d.ts +2259 -806
- package/types/sap.makit.d.ts +22 -7
- package/types/sap.me.d.ts +40 -16
- package/types/sap.ndc.d.ts +20 -15
- package/types/sap.ovp.d.ts +24 -111
- package/types/sap.rules.ui.d.ts +17 -5
- package/types/sap.sac.df.d.ts +87 -1
- package/types/sap.suite.ui.commons.d.ts +531 -182
- package/types/sap.suite.ui.generic.template.d.ts +5 -2
- package/types/sap.suite.ui.microchart.d.ts +85 -34
- package/types/sap.tnt.d.ts +13 -4
- package/types/sap.ui.codeeditor.d.ts +9 -3
- package/types/sap.ui.commons.d.ts +297 -116
- package/types/sap.ui.comp.d.ts +631 -256
- package/types/sap.ui.core.d.ts +976 -286
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +193 -3
- package/types/sap.ui.fl.d.ts +25 -10
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +90 -23
- package/types/sap.ui.layout.d.ts +93 -30
- package/types/sap.ui.mdc.d.ts +6507 -6291
- package/types/sap.ui.richtexteditor.d.ts +17 -5
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +9 -3
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +149 -43
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +265 -103
- package/types/sap.ui.ux3.d.ts +300 -120
- package/types/sap.ui.vbm.d.ts +288 -120
- package/types/sap.ui.vk.d.ts +685 -271
- package/types/sap.ui.vtm.d.ts +177 -72
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +170 -68
- package/types/sap.ui.webc.main.d.ts +495 -198
- package/types/sap.uiext.inbox.d.ts +64 -25
- package/types/sap.ushell.d.ts +658 -47
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +51 -21
- package/types/sap.viz.d.ts +675 -267
- package/types/sap.webanalytics.core.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 +35 -14
package/types/sap.fe.core.d.ts
CHANGED
|
@@ -14,30 +14,6 @@ declare namespace sap {
|
|
|
14
14
|
* can override to allow more flexibility.
|
|
15
15
|
*/
|
|
16
16
|
namespace controllerextensions {
|
|
17
|
-
namespace ViewState {
|
|
18
|
-
/**
|
|
19
|
-
* Definition of a custom action to be used inside the table toolbar
|
|
20
|
-
*/
|
|
21
|
-
type NavigationParameter = {
|
|
22
|
-
/**
|
|
23
|
-
* The actual navigation type.
|
|
24
|
-
*/
|
|
25
|
-
navigationType: string;
|
|
26
|
-
/**
|
|
27
|
-
* Defines whether the standard variant must be used in variant management
|
|
28
|
-
*/
|
|
29
|
-
requiresStandardVariant: boolean;
|
|
30
|
-
/**
|
|
31
|
-
* The selectionVariant from the navigation.
|
|
32
|
-
*/
|
|
33
|
-
selectionVariant: /* was: sap.fe.navigation.SelectionVariant.SelectionVariant */ any;
|
|
34
|
-
/**
|
|
35
|
-
* The selectionVariant defaults from the navigation
|
|
36
|
-
*/
|
|
37
|
-
selectionVariantDefaults: /* was: sap.fe.navigation.SelectionVariant.SelectionVariant */ any;
|
|
38
|
-
};
|
|
39
|
-
}
|
|
40
|
-
|
|
41
17
|
/**
|
|
42
18
|
* @since 1.90.0
|
|
43
19
|
*
|
|
@@ -108,9 +84,12 @@ declare namespace sap {
|
|
|
108
84
|
createAtEnd?: boolean;
|
|
109
85
|
/**
|
|
110
86
|
* The creation mode using one of the following:
|
|
87
|
+
*
|
|
111
88
|
* NewPage - the created document is shown in a new page, depending on whether metadata
|
|
112
89
|
* 'Sync', 'Async' or 'Deferred' is used
|
|
90
|
+
*
|
|
113
91
|
* Inline - The creation is done inline (in a table)
|
|
92
|
+
*
|
|
114
93
|
* External - The creation is done in a different application specified via the parameter
|
|
115
94
|
* 'outbound'
|
|
116
95
|
*/
|
|
@@ -154,16 +133,16 @@ declare namespace sap {
|
|
|
154
133
|
/**
|
|
155
134
|
* @since 1.90.0
|
|
156
135
|
*
|
|
157
|
-
* Creates a draft document for
|
|
136
|
+
* Creates a draft document for the existing active document.
|
|
158
137
|
*
|
|
159
|
-
* @returns Promise resolves once the editable document is available
|
|
138
|
+
* @returns Promise resolves once the editable document is available with the editable context
|
|
160
139
|
*/
|
|
161
140
|
editDocument(
|
|
162
141
|
/**
|
|
163
142
|
* Context of the active document
|
|
164
143
|
*/
|
|
165
144
|
oContext: sap.ui.model.odata.v4.Context
|
|
166
|
-
): Promise<void>;
|
|
145
|
+
): Promise<sap.ui.model.odata.v4.Context | void>;
|
|
167
146
|
/**
|
|
168
147
|
* @since 1.90.0
|
|
169
148
|
*
|
|
@@ -771,7 +750,7 @@ declare namespace sap {
|
|
|
771
750
|
/**
|
|
772
751
|
* Email-specific metadata.
|
|
773
752
|
*/
|
|
774
|
-
email
|
|
753
|
+
email: {
|
|
775
754
|
/**
|
|
776
755
|
* Title that will be used as "email subject" in 'Send Email'. This takes precedence over oShareMetadata.title.
|
|
777
756
|
*/
|
|
@@ -784,7 +763,7 @@ declare namespace sap {
|
|
|
784
763
|
/**
|
|
785
764
|
* SAP Jam-specific metadata.
|
|
786
765
|
*/
|
|
787
|
-
jam
|
|
766
|
+
jam: {
|
|
788
767
|
/**
|
|
789
768
|
* Title that will be used as 'share text' in 'Share in SAP Jam'. This takes precedence over oShareMetadata.title.
|
|
790
769
|
*/
|
|
@@ -797,7 +776,7 @@ declare namespace sap {
|
|
|
797
776
|
/**
|
|
798
777
|
* Save as Tile-specific metadata.
|
|
799
778
|
*/
|
|
800
|
-
tile
|
|
779
|
+
tile: {
|
|
801
780
|
/**
|
|
802
781
|
* Icon to be used for the tile.
|
|
803
782
|
*/
|
|
@@ -830,8 +809,8 @@ declare namespace sap {
|
|
|
830
809
|
url: string;
|
|
831
810
|
}
|
|
832
811
|
):
|
|
833
|
-
| Promise</* was: sap.fe.core.controllerextensions.Share.
|
|
834
|
-
| /* was: sap.fe.core.controllerextensions.Share.
|
|
812
|
+
| Promise</* was: sap.fe.core.controllerextensions.Share.ShareMetadata */ any>
|
|
813
|
+
| /* was: sap.fe.core.controllerextensions.Share.ShareMetadata */ any;
|
|
835
814
|
/**
|
|
836
815
|
* @since 1.93.0
|
|
837
816
|
*
|
|
@@ -989,12 +968,16 @@ declare namespace sap {
|
|
|
989
968
|
/**
|
|
990
969
|
* The view state to apply (can be undefined)
|
|
991
970
|
*/
|
|
992
|
-
oViewState:
|
|
971
|
+
oViewState: Record<string, unknown> | undefined,
|
|
993
972
|
/**
|
|
994
973
|
* The current navigation parameter
|
|
995
974
|
*/
|
|
996
|
-
oNavParameter: sap.fe.core.controllerextensions.ViewState.NavigationParameter
|
|
997
|
-
|
|
975
|
+
oNavParameter: /* was: sap.fe.core.controllerextensions.ViewState.NavigationParameter */ any,
|
|
976
|
+
/**
|
|
977
|
+
* Boolean which determines to skip the key user shine through
|
|
978
|
+
*/
|
|
979
|
+
skipMerge?: boolean
|
|
980
|
+
): Promise<void>;
|
|
998
981
|
/**
|
|
999
982
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
1000
983
|
*
|
|
@@ -1178,6 +1161,9 @@ declare namespace sap {
|
|
|
1178
1161
|
* Provides a hook to initialize feature toggles.
|
|
1179
1162
|
* This hook is being called by the SAP Fiori elements AppComponent at the time feature toggles can be initialized.
|
|
1180
1163
|
* To change page configuration use the {@link sap.fe.core.AppComponent#changePageConfiguration} method.
|
|
1164
|
+
*
|
|
1165
|
+
*
|
|
1166
|
+
* @returns A promise without any value to allow asynchronous processes
|
|
1181
1167
|
*/
|
|
1182
1168
|
initializeFeatureToggles(): Promise<void>;
|
|
1183
1169
|
}
|
package/types/sap.fe.macros.d.ts
CHANGED
|
@@ -183,6 +183,49 @@ declare namespace sap {
|
|
|
183
183
|
*/
|
|
184
184
|
width: string;
|
|
185
185
|
};
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* Create options for the table.
|
|
189
|
+
*/
|
|
190
|
+
type TableCreationOptions = {
|
|
191
|
+
/**
|
|
192
|
+
* Specifies if the new entry should be created at the top or bottom of a table in case of creationMode
|
|
193
|
+
* 'Inline'
|
|
194
|
+
*
|
|
195
|
+
* The default value is 'false'
|
|
196
|
+
*/
|
|
197
|
+
createAtEnd: boolean;
|
|
198
|
+
/**
|
|
199
|
+
* Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'
|
|
200
|
+
*
|
|
201
|
+
* The default value is 'false'
|
|
202
|
+
*/
|
|
203
|
+
inlineCreationRowsHiddenInEditMode: boolean;
|
|
204
|
+
/**
|
|
205
|
+
* Defines the creation mode to be used by the table.
|
|
206
|
+
* Allowed values are `NewPage`, `Inline`, `InlineCreationsRows` or `External`.
|
|
207
|
+
*
|
|
208
|
+
*
|
|
209
|
+
*
|
|
210
|
+
* NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
|
|
211
|
+
* or 'Deferred' is used
|
|
212
|
+
*
|
|
213
|
+
* Inline - The creation is done inline
|
|
214
|
+
*
|
|
215
|
+
* InlineCreationsRows - The creation is done inline with an empty row
|
|
216
|
+
*
|
|
217
|
+
* External - The creation is done in a different application specified via the parameter 'outbound'
|
|
218
|
+
*
|
|
219
|
+
* If not set with any value:
|
|
220
|
+
*
|
|
221
|
+
* if navigation is defined, the default value is 'NewPage'. Otherwise it is 'Inline'.
|
|
222
|
+
*/
|
|
223
|
+
name: string;
|
|
224
|
+
/**
|
|
225
|
+
* The navigation target where the document is created in case of creationMode 'External'
|
|
226
|
+
*/
|
|
227
|
+
outbound: string;
|
|
228
|
+
};
|
|
186
229
|
}
|
|
187
230
|
|
|
188
231
|
interface $MacroAPISettings extends sap.ui.core.$ControlSettings {
|
|
@@ -486,6 +529,14 @@ declare namespace sap {
|
|
|
486
529
|
*/
|
|
487
530
|
contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
488
531
|
|
|
532
|
+
/**
|
|
533
|
+
* A set of options that can be configured.
|
|
534
|
+
*/
|
|
535
|
+
creationMode?:
|
|
536
|
+
| sap.fe.macros.table.TableCreationOptions
|
|
537
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
538
|
+
| `{${string}}`;
|
|
539
|
+
|
|
489
540
|
/**
|
|
490
541
|
* Specifies if the column width is automatically calculated.
|
|
491
542
|
*/
|
|
@@ -598,6 +649,26 @@ declare namespace sap {
|
|
|
598
649
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
599
650
|
| `{${string}}`;
|
|
600
651
|
|
|
652
|
+
/**
|
|
653
|
+
* Number of rows to be displayed in the table. Does not apply to Responsive tables.
|
|
654
|
+
*/
|
|
655
|
+
rowCount?:
|
|
656
|
+
| number
|
|
657
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
658
|
+
| `{${string}}`;
|
|
659
|
+
|
|
660
|
+
/**
|
|
661
|
+
* Defines how the table handles the visible rows. Does not apply to Responsive tables.
|
|
662
|
+
* Allowed values are `Auto`, `Fixed`.
|
|
663
|
+
*
|
|
664
|
+
* - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
|
|
665
|
+
*
|
|
666
|
+
* - If set to `Auto`, the number of rows is changed by the table automatically. It will then adjust its
|
|
667
|
+
* row count to the space it is allowed to cover (limited by the surrounding container) but it cannot have
|
|
668
|
+
* less than defined in the `rowCount` property.
|
|
669
|
+
*/
|
|
670
|
+
rowCountMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
671
|
+
|
|
601
672
|
/**
|
|
602
673
|
* Defines the selection mode to be used by the table.
|
|
603
674
|
* Allowed values are `None`, `Single`, `Multi` or `Auto`. If not set to 'None', SAP Fiori elements hooks
|
|
@@ -807,7 +878,8 @@ declare namespace sap {
|
|
|
807
878
|
vValues?: boolean | boolean[] | number | number[] | string | string[]
|
|
808
879
|
): Promise<void>;
|
|
809
880
|
/**
|
|
810
|
-
* Sets {@link sap.fe.navigation.SelectionVariant} to the filter bar.
|
|
881
|
+
* Sets {@link sap.fe.navigation.SelectionVariant} to the filter bar. Note: setSelectionVariant will clear
|
|
882
|
+
* existing filters and then apply the SelectionVariant values.
|
|
811
883
|
*
|
|
812
884
|
* @returns A promise for asynchronous handling
|
|
813
885
|
*/
|
|
@@ -870,6 +942,32 @@ declare namespace sap {
|
|
|
870
942
|
class Paginator extends sap.ui.core.Control {
|
|
871
943
|
constructor();
|
|
872
944
|
}
|
|
945
|
+
/**
|
|
946
|
+
* @since 1.93.0
|
|
947
|
+
*
|
|
948
|
+
* Building block used to create the ‘Share’ functionality.
|
|
949
|
+
*
|
|
950
|
+
*
|
|
951
|
+
* Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
|
|
952
|
+
* SAP Jam.
|
|
953
|
+
*
|
|
954
|
+
*
|
|
955
|
+
* If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
|
|
956
|
+
* the 'Save as Tile' option is not visible.
|
|
957
|
+
* Usage example:
|
|
958
|
+
*
|
|
959
|
+
* ```javascript
|
|
960
|
+
*
|
|
961
|
+
* <macro:Share
|
|
962
|
+
* id="someID"
|
|
963
|
+
* visible="true"
|
|
964
|
+
* />
|
|
965
|
+
* ```
|
|
966
|
+
*/
|
|
967
|
+
class Share
|
|
968
|
+
/* was: sap.fe.core.buildingBlocks.RuntimeBuildingBlock */ extends Object {
|
|
969
|
+
constructor();
|
|
970
|
+
}
|
|
873
971
|
/**
|
|
874
972
|
* Building block used to create a table based on the metadata provided by OData V4.
|
|
875
973
|
*
|
|
@@ -922,6 +1020,10 @@ declare namespace sap {
|
|
|
922
1020
|
* @returns Contexts of the rows selected by the user
|
|
923
1021
|
*/
|
|
924
1022
|
getSelectedContexts(): sap.ui.model.odata.v4.Context[];
|
|
1023
|
+
/**
|
|
1024
|
+
* Requests a refresh of the table.
|
|
1025
|
+
*/
|
|
1026
|
+
refresh(): void;
|
|
925
1027
|
/**
|
|
926
1028
|
* Removes a message from the table.
|
|
927
1029
|
*/
|
|
@@ -1028,21 +1130,45 @@ declare namespace sap {
|
|
|
1028
1130
|
showMessages: boolean;
|
|
1029
1131
|
};
|
|
1030
1132
|
|
|
1031
|
-
type Chart$SelectionChangeEvent = sap.ui.base.Event<
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
type
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1133
|
+
type Chart$SelectionChangeEvent = sap.ui.base.Event<
|
|
1134
|
+
Chart$SelectionChangeEventParameters,
|
|
1135
|
+
Chart
|
|
1136
|
+
>;
|
|
1137
|
+
|
|
1138
|
+
type Field$ChangeEvent = sap.ui.base.Event<
|
|
1139
|
+
Field$ChangeEventParameters,
|
|
1140
|
+
Field
|
|
1141
|
+
>;
|
|
1142
|
+
|
|
1143
|
+
type Field$LiveChangeEvent = sap.ui.base.Event<
|
|
1144
|
+
Field$LiveChangeEventParameters,
|
|
1145
|
+
Field
|
|
1146
|
+
>;
|
|
1147
|
+
|
|
1148
|
+
type FilterBar$AfterClearEvent = sap.ui.base.Event<
|
|
1149
|
+
FilterBar$AfterClearEventParameters,
|
|
1150
|
+
FilterBar
|
|
1151
|
+
>;
|
|
1152
|
+
|
|
1153
|
+
type FilterBar$FilterChangedEvent = sap.ui.base.Event<
|
|
1154
|
+
FilterBar$FilterChangedEventParameters,
|
|
1155
|
+
FilterBar
|
|
1156
|
+
>;
|
|
1157
|
+
|
|
1158
|
+
type FilterBar$SearchEvent = sap.ui.base.Event<
|
|
1159
|
+
FilterBar$SearchEventParameters,
|
|
1160
|
+
FilterBar
|
|
1161
|
+
>;
|
|
1162
|
+
|
|
1163
|
+
type Table$RowPressEvent = sap.ui.base.Event<
|
|
1164
|
+
Table$RowPressEventParameters,
|
|
1165
|
+
Table
|
|
1166
|
+
>;
|
|
1167
|
+
|
|
1168
|
+
type Table$SelectionChangeEvent = sap.ui.base.Event<
|
|
1169
|
+
Table$SelectionChangeEventParameters,
|
|
1170
|
+
Table
|
|
1171
|
+
>;
|
|
1046
1172
|
}
|
|
1047
1173
|
}
|
|
1048
1174
|
|
|
@@ -1067,6 +1193,12 @@ declare namespace sap {
|
|
|
1067
1193
|
|
|
1068
1194
|
"sap/fe/macros/paginator/Paginator.block": undefined;
|
|
1069
1195
|
|
|
1196
|
+
"sap/fe/macros/richtexteditor/RichTextEditor.block": undefined;
|
|
1197
|
+
|
|
1198
|
+
"sap/fe/macros/richtexteditor/RichTextEditorWithMetadata.block": undefined;
|
|
1199
|
+
|
|
1200
|
+
"sap/fe/macros/share/Share.block": undefined;
|
|
1201
|
+
|
|
1070
1202
|
"sap/fe/macros/table/TableAPI": undefined;
|
|
1071
1203
|
}
|
|
1072
1204
|
}
|
package/types/sap.fe.test.d.ts
CHANGED
package/types/sap.fe.tools.d.ts
CHANGED