@openui5/ts-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/ts-types",
3
- "version": "1.120.22",
3
+ "version": "1.120.24",
4
4
  "description": "OpenUI5 TypeScript Definitions",
5
5
  "homepage": "https://openui5.org",
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 namespace sap {
4
4
  /**
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 namespace sap {
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 namespace sap {
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 namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -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
  /**
@@ -52498,10 +52498,10 @@ declare namespace sap {
52498
52498
  */
52499
52499
  oContext: sap.ui.model.Context,
52500
52500
  /**
52501
- * Parameters, specifying the aggregation level for which contexts shall be fetched or (legacy signature
52502
- * variant) index of first child entry to return from the parent context (zero-based)
52501
+ * Parameters, specifying the aggregation level for which contexts shall be fetched or the index of the
52502
+ * first child entry to return from the parent contexts
52503
52503
  */
52504
- mParameters:
52504
+ mParameters?:
52505
52505
  | {
52506
52506
  /**
52507
52507
  * Level number for oContext, because it might occur at multiple levels; context with group ID `"/"` has
@@ -52613,7 +52613,7 @@ declare namespace sap {
52613
52613
  * value can be set to define the parameter `startIndex` as described in this parameter list. In this case,
52614
52614
  * the function parameters `iLength`, `iNumberOfExpandedLevels` and `iThreshold` become mandatory.
52615
52615
  */
52616
- mParameters:
52616
+ mParameters?:
52617
52617
  | {
52618
52618
  /**
52619
52619
  * Number of entries to return at and after the given start index; defaults to the model's size limit, see
@@ -73976,12 +73976,14 @@ declare namespace sap {
73976
73976
  */
73977
73977
  filter(
73978
73978
  /**
73979
- * Single filter object or an array of filter objects
73979
+ * The filters to use; in case of type {@link sap.ui.model.FilterType.Application} this replaces the filters
73980
+ * given in {@link sap.ui.model.ClientModel#bindTree}; a falsy value is treated as an empty array and thus
73981
+ * removes all filters of the specified type
73980
73982
  */
73981
- aFilters: sap.ui.model.Filter | sap.ui.model.Filter[],
73983
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
73982
73984
  /**
73983
- * Type of the filter to be adjusted; if no type is given, any previously configured application filters
73984
- * are cleared, and the given filters are used as control filters
73985
+ * The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
73986
+ * are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
73985
73987
  */
73986
73988
  sFilterType?: sap.ui.model.FilterType
73987
73989
  ): this;
@@ -73996,11 +73998,11 @@ declare namespace sap {
73996
73998
  */
73997
73999
  getCount(): number | undefined;
73998
74000
  /**
73999
- * Return node contexts for the tree
74001
+ * Return node contexts for the tree.
74000
74002
  *
74001
74003
  * @ui5-protected Do not call from applications (only from related classes in the framework)
74002
74004
  *
74003
- * @returns the contexts array
74005
+ * @returns the context's array
74004
74006
  */
74005
74007
  getNodeContexts(
74006
74008
  /**
@@ -74008,42 +74010,44 @@ declare namespace sap {
74008
74010
  */
74009
74011
  oContext: sap.ui.model.Context,
74010
74012
  /**
74011
- * the startIndex where to start the retrieval of contexts
74013
+ * the index from which to start the retrieval of contexts
74012
74014
  */
74013
- iStartIndex: int,
74015
+ iStartIndex?: int,
74014
74016
  /**
74015
- * determines how many contexts to retrieve beginning from the start index.
74017
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
74018
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
74016
74019
  */
74017
- iLength: int
74020
+ iLength?: int
74018
74021
  ): sap.ui.model.Context[];
74019
74022
  /**
74020
- * Return root contexts for the tree
74023
+ * Return root contexts for the tree.
74021
74024
  *
74022
74025
  * @ui5-protected Do not call from applications (only from related classes in the framework)
74023
74026
  *
74024
- * @returns the contexts array
74027
+ * @returns the context's array
74025
74028
  */
74026
74029
  getRootContexts(
74027
74030
  /**
74028
- * the startIndex where to start the retrieval of contexts
74031
+ * the index from which to start the retrieval of contexts
74029
74032
  */
74030
- iStartIndex: int,
74033
+ iStartIndex?: int,
74031
74034
  /**
74032
- * determines how many contexts to retrieve beginning from the start index.
74035
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
74036
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
74033
74037
  */
74034
- iLength: int
74035
- ): object[];
74038
+ iLength?: int
74039
+ ): sap.ui.model.Context[];
74036
74040
  /**
74037
74041
  * Returns if the node has child nodes.
74038
74042
  *
74039
74043
  *
74040
- * @returns true if node has children
74044
+ * @returns `true` if the node has children
74041
74045
  */
74042
74046
  hasChildren(
74043
74047
  /**
74044
74048
  * the context element of the node
74045
74049
  */
74046
- oContext: object
74050
+ oContext: sap.ui.model.Context
74047
74051
  ): boolean;
74048
74052
  /**
74049
74053
  * Sorts the contexts of this ClientTreeBinding. The tree will be sorted level by level. So the nodes are
@@ -74054,9 +74058,10 @@ declare namespace sap {
74054
74058
  */
74055
74059
  sort(
74056
74060
  /**
74057
- * An array of Sorter instances which will be applied
74061
+ * The sorters to use; they replace the sorters given in {@link sap.ui.model.ClientModel#bindTree}; a falsy
74062
+ * value is treated as an empty array and thus removes all sorters
74058
74063
  */
74059
- aSorters: sap.ui.model.Sorter[]
74064
+ aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
74060
74065
  ): this;
74061
74066
  }
74062
74067
 
@@ -77506,15 +77511,16 @@ declare namespace sap {
77506
77511
  /**
77507
77512
  * Context object for this binding (optional)
77508
77513
  */
77509
- oContext?: object,
77514
+ oContext?: sap.ui.model.Context,
77510
77515
  /**
77511
- * Predefined filter or an array of filters (optional)
77516
+ * The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
77517
+ * to replace them
77512
77518
  */
77513
- aFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
77519
+ aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
77514
77520
  /**
77515
77521
  * Additional model specific parameters (optional)
77516
77522
  */
77517
- mParameters?: string,
77523
+ mParameters?: object,
77518
77524
  /**
77519
77525
  * Predefined sorter or an array of sorters (optional)
77520
77526
  */
@@ -77604,7 +77610,7 @@ declare namespace sap {
77604
77610
  sFilterType: sap.ui.model.FilterType
77605
77611
  ): void;
77606
77612
  /**
77607
- * Returns the number of child nodes of a specific context
77613
+ * Returns the number of child nodes of a specific context.
77608
77614
  *
77609
77615
  *
77610
77616
  * @returns the number of children
@@ -77613,7 +77619,7 @@ declare namespace sap {
77613
77619
  /**
77614
77620
  * the context element of the node
77615
77621
  */
77616
- oContext: Object
77622
+ oContext: sap.ui.model.Context
77617
77623
  ): int;
77618
77624
  /**
77619
77625
  * Returns the count of entries in the tree, or `undefined` if it is unknown. If the tree is filtered, the
@@ -77629,7 +77635,7 @@ declare namespace sap {
77629
77635
  */
77630
77636
  getCount(): number | undefined;
77631
77637
  /**
77632
- * Returns the current value of the bound target
77638
+ * Returns the current value of the bound target.
77633
77639
  *
77634
77640
  *
77635
77641
  * @returns the array of child contexts for the given node
@@ -77640,41 +77646,43 @@ declare namespace sap {
77640
77646
  */
77641
77647
  oContext: sap.ui.model.Context,
77642
77648
  /**
77643
- * the startIndex where to start the retrieval of contexts
77649
+ * the index from which to start the retrieval of contexts
77644
77650
  */
77645
- iStartIndex: int,
77651
+ iStartIndex?: int,
77646
77652
  /**
77647
- * determines how many contexts to retrieve beginning from the start index.
77653
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
77654
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
77648
77655
  */
77649
- iLength: int
77656
+ iLength?: int
77650
77657
  ): sap.ui.model.Context[];
77651
77658
  /**
77652
- * Returns the current value of the bound target
77659
+ * Returns the current value of the bound target.
77653
77660
  *
77654
77661
  *
77655
77662
  * @returns the array of child contexts for the root node
77656
77663
  */
77657
77664
  getRootContexts(
77658
77665
  /**
77659
- * the startIndex where to start the retrieval of contexts
77666
+ * the index from which to start the retrieval of contexts
77660
77667
  */
77661
- iStartIndex: int,
77668
+ iStartIndex?: int,
77662
77669
  /**
77663
- * determines how many contexts to retrieve beginning from the start index.
77670
+ * determines how many contexts to retrieve, beginning from the start index. Defaults to the model's size
77671
+ * limit; see {@link sap.ui.model.Model#setSizeLimit}.
77664
77672
  */
77665
- iLength: int
77666
- ): any[];
77673
+ iLength?: int
77674
+ ): sap.ui.model.Context[];
77667
77675
  /**
77668
- * Returns if the node has child nodes
77676
+ * Returns `true` if the node has child nodes.
77669
77677
  *
77670
77678
  *
77671
- * @returns true if node has children
77679
+ * @returns `true` if the node has children
77672
77680
  */
77673
77681
  hasChildren(
77674
77682
  /**
77675
77683
  * the context element of the node
77676
77684
  */
77677
- oContext: Object
77685
+ oContext: sap.ui.model.Context
77678
77686
  ): boolean;
77679
77687
  /**
77680
77688
  * 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 namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -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
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -5910,8 +5910,14 @@ declare namespace sap {
5910
5910
  | `{${string}}`;
5911
5911
 
5912
5912
  /**
5913
- * If set, the provided weekdays are displayed as non-working days. Valid values inside the array are 0
5914
- * to 6. If not set, the weekend defined in the locale settings is displayed as non-working days.
5913
+ * This property sets chosen days of the week as non-working days, and overrides the weekend days defined
5914
+ * in the locale settings. If set, the provided weekdays are displayed as non-working days.
5915
+ *
5916
+ * Users could override the non-working days for each week. Valid values inside the array are from 0
5917
+ * to 6. For example:
5918
+ * - A single day for each week - `[3]`.
5919
+ * - All days for each week - `[0,1,2,3,4,5,6]`.
5920
+ * - None of the days for each week - `[]`. In this case all weekdays are working days.
5915
5921
  *
5916
5922
  * **Note:** Keep in mind that this property sets only weekly-recurring days as non-working. If you need
5917
5923
  * specific dates or dates ranges, such as national holidays, use the `specialDates` aggregation to set
@@ -9385,8 +9391,14 @@ declare namespace sap {
9385
9391
  /**
9386
9392
  * Gets current value of property {@link #getNonWorkingDays nonWorkingDays}.
9387
9393
  *
9388
- * If set, the provided weekdays are displayed as non-working days. Valid values inside the array are 0
9389
- * to 6. If not set, the weekend defined in the locale settings is displayed as non-working days.
9394
+ * This property sets chosen days of the week as non-working days, and overrides the weekend days defined
9395
+ * in the locale settings. If set, the provided weekdays are displayed as non-working days.
9396
+ *
9397
+ * Users could override the non-working days for each week. Valid values inside the array are from 0
9398
+ * to 6. For example:
9399
+ * - A single day for each week - `[3]`.
9400
+ * - All days for each week - `[0,1,2,3,4,5,6]`.
9401
+ * - None of the days for each week - `[]`. In this case all weekdays are working days.
9390
9402
  *
9391
9403
  * **Note:** Keep in mind that this property sets only weekly-recurring days as non-working. If you need
9392
9404
  * specific dates or dates ranges, such as national holidays, use the `specialDates` aggregation to set
@@ -9813,8 +9825,14 @@ declare namespace sap {
9813
9825
  /**
9814
9826
  * Sets a new value for property {@link #getNonWorkingDays nonWorkingDays}.
9815
9827
  *
9816
- * If set, the provided weekdays are displayed as non-working days. Valid values inside the array are 0
9817
- * to 6. If not set, the weekend defined in the locale settings is displayed as non-working days.
9828
+ * This property sets chosen days of the week as non-working days, and overrides the weekend days defined
9829
+ * in the locale settings. If set, the provided weekdays are displayed as non-working days.
9830
+ *
9831
+ * Users could override the non-working days for each week. Valid values inside the array are from 0
9832
+ * to 6. For example:
9833
+ * - A single day for each week - `[3]`.
9834
+ * - All days for each week - `[0,1,2,3,4,5,6]`.
9835
+ * - None of the days for each week - `[]`. In this case all weekdays are working days.
9818
9836
  *
9819
9837
  * **Note:** Keep in mind that this property sets only weekly-recurring days as non-working. If you need
9820
9838
  * 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 namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.22
1
+ // For Library Version: 1.120.24
2
2
 
3
3
  declare namespace sap {
4
4
  /**