@openui5/types 1.120.22 → 1.120.24

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/types",
3
- "version": "1.120.22",
3
+ "version": "1.120.24",
4
4
  "description": "OpenUI5 TypeScript Definitions",
5
5
  "homepage": "https://sap.github.io/ui5-typescript",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  export interface IToolHeader {
package/types/sap.m.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/f/library" {
4
4
  export interface IShellBar {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/codeeditor/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/commons/library" {
4
4
  import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";
@@ -280,7 +280,7 @@ declare namespace sap {
280
280
  }
281
281
  }
282
282
 
283
- // For Library Version: 1.120.22
283
+ // For Library Version: 1.120.24
284
284
 
285
285
  declare module "sap/base/assert" {
286
286
  /**
@@ -49558,10 +49558,10 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
49558
49558
  */
49559
49559
  oContext: Context,
49560
49560
  /**
49561
- * Parameters, specifying the aggregation level for which contexts shall be fetched or (legacy signature
49562
- * variant) index of first child entry to return from the parent context (zero-based)
49561
+ * Parameters, specifying the aggregation level for which contexts shall be fetched or the index of the
49562
+ * first child entry to return from the parent contexts
49563
49563
  */
49564
- mParameters:
49564
+ mParameters?:
49565
49565
  | {
49566
49566
  /**
49567
49567
  * Level number for oContext, because it might occur at multiple levels; context with group ID `"/"` has
@@ -49673,7 +49673,7 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
49673
49673
  * value can be set to define the parameter `startIndex` as described in this parameter list. In this case,
49674
49674
  * the function parameters `iLength`, `iNumberOfExpandedLevels` and `iThreshold` become mandatory.
49675
49675
  */
49676
- mParameters:
49676
+ mParameters?:
49677
49677
  | {
49678
49678
  /**
49679
49679
  * Number of entries to return at and after the given start index; defaults to the model's size limit, see
@@ -53254,12 +53254,14 @@ declare module "sap/ui/model/ClientTreeBinding" {
53254
53254
  */
53255
53255
  filter(
53256
53256
  /**
53257
- * Single filter object or an array of filter objects
53257
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
53258
+ * given in {@link sap.ui.model.ClientModel#bindTree}; a falsy value is treated as an empty array and thus
53259
+ * removes all filters of the specified type
53258
53260
  */
53259
- aFilters: Filter | Filter[],
53261
+ aFilters?: Filter[] | Filter,
53260
53262
  /**
53261
- * Type of the filter to be adjusted; if no type is given, any previously configured application filters
53262
- * are cleared, and the given filters are used as control filters
53263
+ * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
53264
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
53263
53265
  */
53264
53266
  sFilterType?: FilterType | keyof typeof FilterType
53265
53267
  ): this;
@@ -53274,11 +53276,11 @@ declare module "sap/ui/model/ClientTreeBinding" {
53274
53276
  */
53275
53277
  getCount(): number | undefined;
53276
53278
  /**
53277
- * Return node contexts for the tree
53279
+ * Return node contexts for the tree.
53278
53280
  *
53279
53281
  * @ui5-protected Do not call from applications (only from related classes in the framework)
53280
53282
  *
53281
- * @returns the contexts array
53283
+ * @returns the context's array
53282
53284
  */
53283
53285
  getNodeContexts(
53284
53286
  /**
@@ -53286,42 +53288,44 @@ declare module "sap/ui/model/ClientTreeBinding" {
53286
53288
  */
53287
53289
  oContext: Context,
53288
53290
  /**
53289
- * the startIndex where to start the retrieval of contexts
53291
+ * the index from which to start the retrieval of contexts
53290
53292
  */
53291
- iStartIndex: int,
53293
+ iStartIndex?: int,
53292
53294
  /**
53293
- * determines how many contexts to retrieve beginning from the start index.
53295
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
53296
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
53294
53297
  */
53295
- iLength: int
53298
+ iLength?: int
53296
53299
  ): Context[];
53297
53300
  /**
53298
- * Return root contexts for the tree
53301
+ * Return root contexts for the tree.
53299
53302
  *
53300
53303
  * @ui5-protected Do not call from applications (only from related classes in the framework)
53301
53304
  *
53302
- * @returns the contexts array
53305
+ * @returns the context's array
53303
53306
  */
53304
53307
  getRootContexts(
53305
53308
  /**
53306
- * the startIndex where to start the retrieval of contexts
53309
+ * the index from which to start the retrieval of contexts
53307
53310
  */
53308
- iStartIndex: int,
53311
+ iStartIndex?: int,
53309
53312
  /**
53310
- * determines how many contexts to retrieve beginning from the start index.
53313
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
53314
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
53311
53315
  */
53312
- iLength: int
53313
- ): object[];
53316
+ iLength?: int
53317
+ ): Context[];
53314
53318
  /**
53315
53319
  * Returns if the node has child nodes.
53316
53320
  *
53317
53321
  *
53318
- * @returns true if node has children
53322
+ * @returns `true` if the node has children
53319
53323
  */
53320
53324
  hasChildren(
53321
53325
  /**
53322
53326
  * the context element of the node
53323
53327
  */
53324
- oContext: object
53328
+ oContext: Context
53325
53329
  ): boolean;
53326
53330
  /**
53327
53331
  * Sorts the contexts of this ClientTreeBinding. The tree will be sorted level by level. So the nodes are
@@ -53332,9 +53336,10 @@ declare module "sap/ui/model/ClientTreeBinding" {
53332
53336
  */
53333
53337
  sort(
53334
53338
  /**
53335
- * An array of Sorter instances which will be applied
53339
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.ClientModel#bindTree}; a falsy
53340
+ * value is treated as an empty array and thus removes all sorters
53336
53341
  */
53337
- aSorters: Sorter[]
53342
+ aSorters?: Sorter[] | Sorter
53338
53343
  ): this;
53339
53344
  }
53340
53345
  }
@@ -76220,6 +76225,8 @@ declare module "sap/ui/model/TreeBinding" {
76220
76225
 
76221
76226
  import Model from "sap/ui/model/Model";
76222
76227
 
76228
+ import Context from "sap/ui/model/Context";
76229
+
76223
76230
  import Filter from "sap/ui/model/Filter";
76224
76231
 
76225
76232
  import Sorter from "sap/ui/model/Sorter";
@@ -76228,8 +76235,6 @@ declare module "sap/ui/model/TreeBinding" {
76228
76235
 
76229
76236
  import Metadata from "sap/ui/base/Metadata";
76230
76237
 
76231
- import Context from "sap/ui/model/Context";
76232
-
76233
76238
  /**
76234
76239
  * The TreeBinding is a specific binding for trees in the model, which can be used to populate Trees.
76235
76240
  */
@@ -76253,15 +76258,16 @@ declare module "sap/ui/model/TreeBinding" {
76253
76258
  /**
76254
76259
  * Context object for this binding (optional)
76255
76260
  */
76256
- oContext?: object,
76261
+ oContext?: Context,
76257
76262
  /**
76258
- * Predefined filter or an array of filters (optional)
76263
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
76264
+ * to replace them
76259
76265
  */
76260
- aFilters?: Filter | Filter[],
76266
+ aFilters?: Filter[] | Filter,
76261
76267
  /**
76262
76268
  * Additional model specific parameters (optional)
76263
76269
  */
76264
- mParameters?: string,
76270
+ mParameters?: object,
76265
76271
  /**
76266
76272
  * Predefined sorter or an array of sorters (optional)
76267
76273
  */
@@ -76351,7 +76357,7 @@ declare module "sap/ui/model/TreeBinding" {
76351
76357
  sFilterType: FilterType | keyof typeof FilterType
76352
76358
  ): void;
76353
76359
  /**
76354
- * Returns the number of child nodes of a specific context
76360
+ * Returns the number of child nodes of a specific context.
76355
76361
  *
76356
76362
  *
76357
76363
  * @returns the number of children
@@ -76360,7 +76366,7 @@ declare module "sap/ui/model/TreeBinding" {
76360
76366
  /**
76361
76367
  * the context element of the node
76362
76368
  */
76363
- oContext: Object
76369
+ oContext: Context
76364
76370
  ): int;
76365
76371
  /**
76366
76372
  * Returns the count of entries in the tree, or `undefined` if it is unknown. If the tree is filtered, the
@@ -76376,7 +76382,7 @@ declare module "sap/ui/model/TreeBinding" {
76376
76382
  */
76377
76383
  getCount(): number | undefined;
76378
76384
  /**
76379
- * Returns the current value of the bound target
76385
+ * Returns the current value of the bound target.
76380
76386
  *
76381
76387
  *
76382
76388
  * @returns the array of child contexts for the given node
@@ -76387,41 +76393,43 @@ declare module "sap/ui/model/TreeBinding" {
76387
76393
  */
76388
76394
  oContext: Context,
76389
76395
  /**
76390
- * the startIndex where to start the retrieval of contexts
76396
+ * the index from which to start the retrieval of contexts
76391
76397
  */
76392
- iStartIndex: int,
76398
+ iStartIndex?: int,
76393
76399
  /**
76394
- * determines how many contexts to retrieve beginning from the start index.
76400
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
76401
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
76395
76402
  */
76396
- iLength: int
76403
+ iLength?: int
76397
76404
  ): Context[];
76398
76405
  /**
76399
- * Returns the current value of the bound target
76406
+ * Returns the current value of the bound target.
76400
76407
  *
76401
76408
  *
76402
76409
  * @returns the array of child contexts for the root node
76403
76410
  */
76404
76411
  getRootContexts(
76405
76412
  /**
76406
- * the startIndex where to start the retrieval of contexts
76413
+ * the index from which to start the retrieval of contexts
76407
76414
  */
76408
- iStartIndex: int,
76415
+ iStartIndex?: int,
76409
76416
  /**
76410
- * determines how many contexts to retrieve beginning from the start index.
76417
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
76418
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
76411
76419
  */
76412
- iLength: int
76413
- ): any[];
76420
+ iLength?: int
76421
+ ): Context[];
76414
76422
  /**
76415
- * Returns if the node has child nodes
76423
+ * Returns `true` if the node has child nodes.
76416
76424
  *
76417
76425
  *
76418
- * @returns true if node has children
76426
+ * @returns `true` if the node has children
76419
76427
  */
76420
76428
  hasChildren(
76421
76429
  /**
76422
76430
  * the context element of the node
76423
76431
  */
76424
- oContext: Object
76432
+ oContext: Context
76425
76433
  ): boolean;
76426
76434
  /**
76427
76435
  * Sorts the tree according to the sorter definitions.
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/fl/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import Control from "sap/ui/core/Control";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/unified/library" {
4
4
  /**
@@ -964,8 +964,14 @@ declare module "sap/ui/unified/Calendar" {
964
964
  /**
965
965
  * Gets current value of property {@link #getNonWorkingDays nonWorkingDays}.
966
966
  *
967
- * If set, the provided weekdays are displayed as non-working days. Valid values inside the array are 0
968
- * to 6. If not set, the weekend defined in the locale settings is displayed as non-working days.
967
+ * This property sets chosen days of the week as non-working days, and overrides the weekend days defined
968
+ * in the locale settings. If set, the provided weekdays are displayed as non-working days.
969
+ *
970
+ * Users could override the non-working days for each week. Valid values inside the array are from 0
971
+ * to 6. For example:
972
+ * - A single day for each week - `[3]`.
973
+ * - All days for each week - `[0,1,2,3,4,5,6]`.
974
+ * - None of the days for each week - `[]`. In this case all weekdays are working days.
969
975
  *
970
976
  * **Note:** Keep in mind that this property sets only weekly-recurring days as non-working. If you need
971
977
  * specific dates or dates ranges, such as national holidays, use the `specialDates` aggregation to set
@@ -1392,8 +1398,14 @@ declare module "sap/ui/unified/Calendar" {
1392
1398
  /**
1393
1399
  * Sets a new value for property {@link #getNonWorkingDays nonWorkingDays}.
1394
1400
  *
1395
- * If set, the provided weekdays are displayed as non-working days. Valid values inside the array are 0
1396
- * to 6. If not set, the weekend defined in the locale settings is displayed as non-working days.
1401
+ * This property sets chosen days of the week as non-working days, and overrides the weekend days defined
1402
+ * in the locale settings. If set, the provided weekdays are displayed as non-working days.
1403
+ *
1404
+ * Users could override the non-working days for each week. Valid values inside the array are from 0
1405
+ * to 6. For example:
1406
+ * - A single day for each week - `[3]`.
1407
+ * - All days for each week - `[0,1,2,3,4,5,6]`.
1408
+ * - None of the days for each week - `[]`. In this case all weekdays are working days.
1397
1409
  *
1398
1410
  * **Note:** Keep in mind that this property sets only weekly-recurring days as non-working. If you need
1399
1411
  * specific dates or dates ranges, such as national holidays, use the `specialDates` aggregation to set
@@ -1554,8 +1566,14 @@ declare module "sap/ui/unified/Calendar" {
1554
1566
  firstDayOfWeek?: int | PropertyBindingInfo | `{${string}}`;
1555
1567
 
1556
1568
  /**
1557
- * If set, the provided weekdays are displayed as non-working days. Valid values inside the array are 0
1558
- * to 6. If not set, the weekend defined in the locale settings is displayed as non-working days.
1569
+ * This property sets chosen days of the week as non-working days, and overrides the weekend days defined
1570
+ * in the locale settings. If set, the provided weekdays are displayed as non-working days.
1571
+ *
1572
+ * Users could override the non-working days for each week. Valid values inside the array are from 0
1573
+ * to 6. For example:
1574
+ * - A single day for each week - `[3]`.
1575
+ * - All days for each week - `[0,1,2,3,4,5,6]`.
1576
+ * - None of the days for each week - `[]`. In this case all weekdays are working days.
1559
1577
  *
1560
1578
  * **Note:** Keep in mind that this property sets only weekly-recurring days as non-working. If you need
1561
1579
  * specific dates or dates ranges, such as national holidays, use the `specialDates` aggregation to set
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/ux3/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/webc/common/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/webc/fiori/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/ui/webc/main/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare module "sap/uxap/library" {
4
4
  /**