@openui5/ts-types 1.108.2 → 1.110.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.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -9950,24 +9950,24 @@ declare namespace sap {
9950
9950
  /**
9951
9951
  * Adds a control to the main content area. Only the main content part in the aggregation is re-rendered.
9952
9952
  *
9953
- * @returns this pointer for chaining
9953
+ * @returns Reference to `this` for method chaining
9954
9954
  */
9955
9955
  addMainContent(
9956
9956
  /**
9957
9957
  * Object to be added in the aggregation
9958
9958
  */
9959
- oControl: object
9959
+ oControl: sap.ui.core.Control
9960
9960
  ): this;
9961
9961
  /**
9962
9962
  * Adds a control to the side content area. Only the side content part in the aggregation is re-rendered.
9963
9963
  *
9964
- * @returns this pointer for chaining
9964
+ * @returns Reference to `this` for method chaining
9965
9965
  */
9966
9966
  addSideContent(
9967
9967
  /**
9968
9968
  * Object to be added in the aggregation
9969
9969
  */
9970
- oControl: object
9970
+ oControl: sap.ui.core.Control
9971
9971
  ): this;
9972
9972
  /**
9973
9973
  * @SINCE 1.32
@@ -10116,7 +10116,7 @@ declare namespace sap {
10116
10116
  /**
10117
10117
  * The control instance that requested the scroll helper
10118
10118
  */
10119
- oControl: object
10119
+ oControl: sap.ui.core.Control
10120
10120
  ): sap.ui.core.delegate.ScrollEnablement;
10121
10121
  /**
10122
10122
  * Gets current value of property {@link #getShowMainContent showMainContent}.
@@ -10308,7 +10308,7 @@ declare namespace sap {
10308
10308
  /**
10309
10309
  * Sets or unsets the page in equalSplit mode.
10310
10310
  *
10311
- * @returns this pointer for chaining
10311
+ * @returns Reference to `this` for method chaining
10312
10312
  */
10313
10313
  setEqualSplit(
10314
10314
  /**
@@ -10319,7 +10319,7 @@ declare namespace sap {
10319
10319
  /**
10320
10320
  * Sets the showMainContent property.
10321
10321
  *
10322
- * @returns this pointer for chaining
10322
+ * @returns Reference to `this` for method chaining
10323
10323
  */
10324
10324
  setShowMainContent(
10325
10325
  /**
@@ -10334,7 +10334,7 @@ declare namespace sap {
10334
10334
  /**
10335
10335
  * Sets the showSideContent property.
10336
10336
  *
10337
- * @returns this pointer for chaining
10337
+ * @returns Reference to `this` for method chaining
10338
10338
  */
10339
10339
  setShowSideContent(
10340
10340
  /**
@@ -10385,7 +10385,7 @@ declare namespace sap {
10385
10385
  /**
10386
10386
  * Sets the sideContentVisibility property.
10387
10387
  *
10388
- * @returns this pointer for chaining
10388
+ * @returns Reference to `this` for method chaining
10389
10389
  */
10390
10390
  setSideContentVisibility(
10391
10391
  /**
@@ -10402,7 +10402,7 @@ declare namespace sap {
10402
10402
  * area is visible. This helper method is used to implement a button/switch for changing between the main
10403
10403
  * and side content areas. Only works if the current breakpoint is "S".
10404
10404
  *
10405
- * @returns this pointer for chaining
10405
+ * @returns Reference to `this` for method chaining
10406
10406
  */
10407
10407
  toggle(): this;
10408
10408
  }
@@ -12131,7 +12131,7 @@ declare namespace sap {
12131
12131
  *
12132
12132
  * @returns Current accessibility state of the control
12133
12133
  */
12134
- getAccessibilityInfo(): object;
12134
+ getAccessibilityInfo(): sap.ui.core.AccessibilityInfo;
12135
12135
  /**
12136
12136
  * Gets current value of property {@link #getAllowWrapping allowWrapping}.
12137
12137
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -16,6 +16,8 @@ declare namespace sap {
16
16
 
17
17
  "sap/ui/mdc/chart/SelectionDetailsActions": undefined;
18
18
 
19
+ "sap/ui/mdc/ChartDelegate": undefined;
20
+
19
21
  "sap/ui/mdc/condition/Condition": undefined;
20
22
 
21
23
  "sap/ui/mdc/condition/ConditionConverter": undefined;
@@ -24,6 +26,8 @@ declare namespace sap {
24
26
 
25
27
  "sap/ui/mdc/condition/ConditionModelPropertyBinding": undefined;
26
28
 
29
+ "sap/ui/mdc/condition/ConditionValidateException": undefined;
30
+
27
31
  "sap/ui/mdc/condition/FilterConverter": undefined;
28
32
 
29
33
  "sap/ui/mdc/condition/FilterOperatorUtil": undefined;
@@ -144,6 +148,8 @@ declare namespace sap {
144
148
 
145
149
  "sap/ui/mdc/Link": undefined;
146
150
 
151
+ "sap/ui/mdc/link/LinkItem": undefined;
152
+
147
153
  "sap/ui/mdc/LinkDelegate": undefined;
148
154
 
149
155
  "sap/ui/mdc/mixin/AdaptationMixin": undefined;
@@ -166,14 +172,8 @@ declare namespace sap {
166
172
 
167
173
  "sap/ui/mdc/odata/v4/ValueHelpDelegate": undefined;
168
174
 
169
- "sap/ui/mdc/p13n/AdaptationProvider": undefined;
170
-
171
175
  "sap/ui/mdc/p13n/Engine": undefined;
172
176
 
173
- "sap/ui/mdc/p13n/modification/ModificationHandler": undefined;
174
-
175
- "sap/ui/mdc/p13n/modules/DefaultProviderRegistry": undefined;
176
-
177
177
  "sap/ui/mdc/p13n/panels/FilterPanel": undefined;
178
178
 
179
179
  "sap/ui/mdc/p13n/StateUtil": undefined;
@@ -186,12 +186,16 @@ declare namespace sap {
186
186
 
187
187
  "sap/ui/mdc/table/Column": undefined;
188
188
 
189
+ "sap/ui/mdc/table/ColumnSettings": undefined;
190
+
189
191
  "sap/ui/mdc/table/CreationRow": undefined;
190
192
 
191
193
  "sap/ui/mdc/table/GridTableType": undefined;
192
194
 
193
195
  "sap/ui/mdc/table/PropertyHelper": undefined;
194
196
 
197
+ "sap/ui/mdc/table/ResponsiveColumnSettings": undefined;
198
+
195
199
  "sap/ui/mdc/table/ResponsiveTableType": undefined;
196
200
 
197
201
  "sap/ui/mdc/table/RowActionItem": undefined;
@@ -200,6 +204,8 @@ declare namespace sap {
200
204
 
201
205
  "sap/ui/mdc/table/TableTypeBase": undefined;
202
206
 
207
+ "sap/ui/mdc/table/TreeTableType": undefined;
208
+
203
209
  "sap/ui/mdc/table/V4AnalyticsPropertyHelper": undefined;
204
210
 
205
211
  "sap/ui/mdc/TableDelegate": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -11,78 +11,6 @@ declare namespace sap {
11
11
  * to check all aspects of an application.
12
12
  */
13
13
  namespace support {
14
- export const CoreFacade: undefined;
15
-
16
- /**
17
- * Creates a RuleSet. The RuleSet can store multiple rules concerning namespaces. Usage: The RuleSet is
18
- * an interface used to create, update and delete rulesets.
19
- */
20
- namespace RuleSet {
21
- /**
22
- * Adds rules to RuleSet.
23
- *
24
- * @returns sRuleVerificationStatus Verification status
25
- */
26
- function addRule(
27
- /**
28
- * Settings object with rule information
29
- */
30
- oSettings: object
31
- ): string;
32
- /**
33
- * Clears all rulesets inside the RuleSet.
34
- */
35
- function clearAllRuleSets(): void;
36
- /**
37
- * Gets all rules from the RuleSet.
38
- *
39
- * @returns All rules within the current RuleSet
40
- */
41
- function getRules(): object;
42
- /**
43
- * Loads the previous selection of the user - which rules are selected to be run by the Rule Analyzer. The
44
- * method applies the settings to the currently loaded rules.
45
- */
46
- function loadSelectionOfRules(
47
- /**
48
- * The current loaded libraries and their rules
49
- */
50
- aLibraries: Object[]
51
- ): void;
52
- /**
53
- * Remove rule from RuleSet.
54
- */
55
- function removeRule(
56
- /**
57
- * Rule object that will be removed
58
- */
59
- oRule: object
60
- ): void;
61
- /**
62
- * Stores which rules are selected to be run by the analyzer on the next check
63
- */
64
- function storeSelectionOfRules(
65
- /**
66
- * The data for the libraries and their rules
67
- */
68
- aLibraries: Object[]
69
- ): void;
70
- /**
71
- * Updates rules from the RuleSet.
72
- *
73
- * @returns sRuleVerification Rule Verification status
74
- */
75
- function updateRule(
76
- /**
77
- * Rule ID
78
- */
79
- sRuleId: string,
80
- /**
81
- * Rule settings
82
- */
83
- ORuleSettings: object
84
- ): string;
85
- }
86
14
  /**
87
15
  * The `sap.ui.support.RuleAnalyzer` namespace is the central entry point for the Support Assistant functionality.
88
16
  *
@@ -112,7 +40,7 @@ declare namespace sap {
112
40
  * Settings for the new rule. For detailed information about its properties see {@link topic:eaeea19a991d46f29e6d8d8827317d0e
113
41
  * Rule Property Values}
114
42
  */
115
- oRule: object
43
+ oRule: sap.ui.support.RuleConfiguration
116
44
  ): string;
117
45
  /**
118
46
  * Main method to perform analysis of a given running application.
@@ -180,6 +108,32 @@ declare namespace sap {
180
108
  }
181
109
  const RuleAnalyzer: RuleAnalyzer;
182
110
 
111
+ /**
112
+ * The CoreFacade interface allows rule developers to access the metadata, models, UI areas and components
113
+ * of the Core.
114
+ *
115
+ * Usage: The CoreFacade is passed as second argument to all rule check functions.
116
+ */
117
+ class CoreFacade {
118
+ constructor();
119
+
120
+ /**
121
+ * Gets the Components from the Core object.
122
+ */
123
+ getComponents(): void;
124
+ /**
125
+ * Gets the Metadata from the Core object.
126
+ */
127
+ getMetadata(): void;
128
+ /**
129
+ * Gets the Models from the Core object.
130
+ */
131
+ getModels(): void;
132
+ /**
133
+ * Gets the UI areas from the Core object.
134
+ */
135
+ getUIAreas(): void;
136
+ }
183
137
  /**
184
138
  * @SINCE 1.48
185
139
  *
@@ -187,17 +141,14 @@ declare namespace sap {
187
141
  *
188
142
  * Overview:
189
143
  *
190
- * `ExecutionScope` is the third parameter of a rule check function. It provides access to internal UI5
191
- * objects available for inspection. The `getElements` API method allows the user to select a specific subset
192
- * of elements valid for their case. It accepts one query object argument.
144
+ * The ExecutionScope provides access to internal UI5 objects available for inspection. The `getElements`
145
+ * API method allows the user to select a specific subset of elements valid for their case. It accepts one
146
+ * query object argument.
193
147
  *
194
- * Usage:
148
+ * Usage: The ExecutionScope is passed as third argument to all rule check functions.
195
149
  *
196
- * When a rule is executed, three parameters are passed: `oIssueManager`, `oCoreFacade` and `oScope`.
197
- *
198
- * An `ExecutionScope` instance is passed to every call of a rule check function. When you analyze your
199
- * application, available objects are collected depending on the settings passed to the Support Assistant
200
- * at the moment when you start it.
150
+ * When you analyze your application, available objects are collected depending on the settings passed to
151
+ * the Support Assistant at the moment when you start it.
201
152
  */
202
153
  class ExecutionScope {
203
154
  constructor();
@@ -206,7 +157,7 @@ declare namespace sap {
206
157
  *
207
158
  * @returns Array of matched elements
208
159
  */
209
- static getElements(
160
+ getElements(
210
161
  /**
211
162
  * Object with specific filtering options
212
163
  */
@@ -230,7 +181,7 @@ declare namespace sap {
230
181
  *
231
182
  * @returns Array of matched elements
232
183
  */
233
- static getElementsByClassName(
184
+ getElementsByClassName(
234
185
  /**
235
186
  * Either string or function to be used when selecting a subset of elements
236
187
  */
@@ -241,7 +192,7 @@ declare namespace sap {
241
192
  *
242
193
  * @returns Array of logged objects
243
194
  */
244
- static getLoggedObjects(
195
+ getLoggedObjects(
245
196
  /**
246
197
  * Type of logged objects
247
198
  */
@@ -252,13 +203,39 @@ declare namespace sap {
252
203
  *
253
204
  * @returns Array of matched elements
254
205
  */
255
- static getPublicElements(): any[];
206
+ getPublicElements(): any[];
256
207
  /**
257
208
  * Gets the type of the execution scope
258
209
  *
259
210
  * @returns The type of the execution scope. Possible values are `global`, `subtree` or `components`.
260
211
  */
261
- static getType(): string;
212
+ getType(): string;
213
+ }
214
+ /**
215
+ * The IssueManagerFacade allows rule developers to add new issues.
216
+ *
217
+ * Usage: The IssueManagerFacade is passed as first argument to all rule check functions.
218
+ */
219
+ class IssueManagerFacade {
220
+ constructor();
221
+
222
+ /**
223
+ * Adds issue
224
+ */
225
+ addIssue(
226
+ /**
227
+ * Issue object to be added
228
+ */
229
+ oIssue: {
230
+ severity: sap.ui.support.Severity;
231
+
232
+ details: string;
233
+
234
+ context: {
235
+ id: string;
236
+ };
237
+ }
238
+ ): void;
262
239
  }
263
240
  /**
264
241
  * @SINCE 1.50
@@ -416,20 +393,45 @@ declare namespace sap {
416
393
  */
417
394
  issues: Object[];
418
395
  };
396
+
397
+ /**
398
+ * Support Assistant rule configuration
399
+ */
400
+ type RuleConfiguration = {
401
+ id: string;
402
+
403
+ async: boolean;
404
+
405
+ title: string;
406
+
407
+ resolution: string;
408
+
409
+ minversion: string;
410
+
411
+ categories: sap.ui.support.Categories[];
412
+
413
+ audiences: sap.ui.support.Audiences[];
414
+
415
+ description: string;
416
+
417
+ resolutionurls: string;
418
+
419
+ check: string;
420
+ };
419
421
  }
420
422
  }
421
423
 
422
424
  interface IUI5DefineDependencyNames {
423
- "sap/ui/support/jQuery.sap.support": undefined;
424
-
425
425
  "sap/ui/support/library": undefined;
426
426
 
427
427
  "sap/ui/support/RuleAnalyzer": undefined;
428
428
 
429
+ "sap/ui/support/supportRules/CoreFacade": undefined;
430
+
429
431
  "sap/ui/support/supportRules/ExecutionScope": undefined;
430
432
 
431
433
  "sap/ui/support/supportRules/History": undefined;
432
434
 
433
- "sap/ui/support/supportRules/RuleSet": undefined;
435
+ "sap/ui/support/supportRules/IssueManager": undefined;
434
436
  }
435
437
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1047,6 +1047,13 @@ declare namespace sap {
1047
1047
  */
1048
1048
  menu?: sap.ui.unified.Menu;
1049
1049
 
1050
+ /**
1051
+ * @SINCE 1.104
1052
+ *
1053
+ * The menu that can be opened by the header element of this column.
1054
+ */
1055
+ headerMenu?: sap.ui.core.IColumnHeaderMenu | string;
1056
+
1050
1057
  /**
1051
1058
  * @SINCE 1.33.0
1052
1059
  *
@@ -1316,7 +1323,7 @@ declare namespace sap {
1316
1323
  | `{${string}}`;
1317
1324
 
1318
1325
  /**
1319
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
1326
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
1320
1327
  *
1321
1328
  * Enables or disables grouping. If grouping is enabled, the table is grouped by the column which is defined
1322
1329
  * in the `groupBy` association.
@@ -1929,8 +1936,6 @@ declare namespace sap {
1929
1936
  }
1930
1937
 
1931
1938
  /**
1932
- * @EXPERIMENTAL (since 1.21)
1933
- *
1934
1939
  * This column adds additional properties to the table column which are needed for the analytical binding
1935
1940
  * and table
1936
1941
  */
@@ -2215,7 +2220,7 @@ declare namespace sap {
2215
2220
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2216
2221
  * of the syntax of the settings object.
2217
2222
  * See:
2218
- * http://scn.sap.com/docs/DOC-44986
2223
+ * https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
2219
2224
  * {@link topic:08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
2220
2225
  * {@link fiori:/analytical-table-alv/ Analytical Table}
2221
2226
  */
@@ -2232,7 +2237,7 @@ declare namespace sap {
2232
2237
  * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
2233
2238
  * of the syntax of the settings object.
2234
2239
  * See:
2235
- * http://scn.sap.com/docs/DOC-44986
2240
+ * https://github.com/SAP/odata-vocabularies/blob/main/docs/v2-annotations.md
2236
2241
  * {@link topic:08197fa68e4f479cbe30f639cc1cd22c sap.ui.table}
2237
2242
  * {@link fiori:/analytical-table-alv/ Analytical Table}
2238
2243
  */
@@ -3140,6 +3145,13 @@ declare namespace sap {
3140
3145
  * @returns Value of property `hAlign`
3141
3146
  */
3142
3147
  getHAlign(): sap.ui.core.HorizontalAlign;
3148
+ /**
3149
+ * @SINCE 1.104
3150
+ *
3151
+ * ID of the element which is the current target of the association {@link #getHeaderMenu headerMenu}, or
3152
+ * `null`.
3153
+ */
3154
+ getHeaderMenu(): sap.ui.core.ID;
3143
3155
  /**
3144
3156
  * Gets current value of property {@link #getHeaderSpan headerSpan}.
3145
3157
  *
@@ -3578,6 +3590,20 @@ declare namespace sap {
3578
3590
  */
3579
3591
  sHAlign?: sap.ui.core.HorizontalAlign
3580
3592
  ): this;
3593
+ /**
3594
+ * @SINCE 1.104
3595
+ *
3596
+ * Sets the associated {@link #getHeaderMenu headerMenu}.
3597
+ *
3598
+ * @returns Reference to `this` in order to allow method chaining
3599
+ */
3600
+ setHeaderMenu(
3601
+ /**
3602
+ * ID of an element which becomes the new target of this headerMenu association; alternatively, an element
3603
+ * instance may be given
3604
+ */
3605
+ oHeaderMenu: sap.ui.core.ID | sap.ui.core.IColumnHeaderMenu
3606
+ ): this;
3581
3607
  /**
3582
3608
  * Sets a new value for property {@link #getHeaderSpan headerSpan}.
3583
3609
  *
@@ -4377,7 +4403,16 @@ declare namespace sap {
4377
4403
  /**
4378
4404
  * Parameters to pass along with the event
4379
4405
  */
4380
- mParameters?: object
4406
+ mParameters?: {
4407
+ /**
4408
+ * The item which was pressed.
4409
+ */
4410
+ item?: sap.ui.table.RowActionItem;
4411
+ /**
4412
+ * The table row to which the pressed item belongs to.
4413
+ */
4414
+ row?: sap.ui.table.Row;
4415
+ }
4381
4416
  ): this;
4382
4417
  /**
4383
4418
  * Gets current value of property {@link #getIcon icon}.
@@ -6183,7 +6218,12 @@ declare namespace sap {
6183
6218
  /**
6184
6219
  * Parameters to pass along with the event
6185
6220
  */
6186
- mParameters?: object
6221
+ mParameters?: {
6222
+ /**
6223
+ * busy state
6224
+ */
6225
+ busy?: boolean;
6226
+ }
6187
6227
  ): this;
6188
6228
  /**
6189
6229
  * @SINCE 1.21.0
@@ -6390,7 +6430,16 @@ declare namespace sap {
6390
6430
  /**
6391
6431
  * Parameters to pass along with the event
6392
6432
  */
6393
- mParameters?: object
6433
+ mParameters?: {
6434
+ /**
6435
+ * The column instance on which the custom filter button was pressed.
6436
+ */
6437
+ column?: sap.ui.table.Column;
6438
+ /**
6439
+ * Filter value.
6440
+ */
6441
+ value?: string;
6442
+ }
6394
6443
  ): this;
6395
6444
  /**
6396
6445
  * Fires event {@link #event:filter filter} to attached listeners.
@@ -6426,7 +6475,12 @@ declare namespace sap {
6426
6475
  /**
6427
6476
  * Parameters to pass along with the event
6428
6477
  */
6429
- mParameters?: object
6478
+ mParameters?: {
6479
+ /**
6480
+ * First visible row
6481
+ */
6482
+ firstVisibleRow?: int;
6483
+ }
6430
6484
  ): this;
6431
6485
  /**
6432
6486
  * Fires event {@link #event:group group} to attached listeners.
@@ -6751,7 +6805,7 @@ declare namespace sap {
6751
6805
  */
6752
6806
  getEnableCustomFilter(): boolean;
6753
6807
  /**
6754
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
6808
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
6755
6809
  *
6756
6810
  * Gets current value of property {@link #getEnableGrouping enableGrouping}.
6757
6811
  *
@@ -7583,7 +7637,7 @@ declare namespace sap {
7583
7637
  bEnableCustomFilter?: boolean
7584
7638
  ): this;
7585
7639
  /**
7586
- * @EXPERIMENTAL (since 1.28) - This feature has a limited functionality.
7640
+ * @deprecated (since 1.110) - this feature has a limited functionality and should not be used anymore.
7587
7641
  *
7588
7642
  * Sets a new value for property {@link #getEnableGrouping enableGrouping}.
7589
7643
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.108.2
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {