@openui5/ts-types 1.127.0 → 1.128.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.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -2094,17 +2094,22 @@ declare namespace sap {
2094
2094
  | `{${string}}`;
2095
2095
 
2096
2096
  /**
2097
- * Template (cell renderer) of this column. A template is decoupled from the column. Each time the template's
2098
- * properties or aggregations have been changed, the template has to be applied again via `setTemplate`
2099
- * for the changes to take effect. If a string is defined, a default text control will be created with its
2100
- * text property bound to the value of the string. The default template depends on the libraries loaded.
2101
- * If there is no template, the column will not be rendered in the table. The set of supported controls
2102
- * is limited. See section "{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}"
2097
+ * Template (cell renderer) of this column.
2098
+ *
2099
+ * A template is decoupled from the column. Each time the template's properties or aggregations have been
2100
+ * changed, the template has to be applied again via `setTemplate` for the changes to take effect.
2101
+ *
2102
+ * If there is no template, the column will not be rendered in the table.
2103
+ *
2104
+ * The set of supported controls is limited. See section "{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}"
2103
2105
  * in the documentation for more details. While it is technically possible to also use other controls, doing
2104
2106
  * so might lead to issues with regards to scrolling, alignment, condensed mode, screen reader support,
2105
2107
  * and keyboard support.
2106
2108
  *
2107
- * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
2109
+ * If a string is defined, this string is interpreted as the binding path. Internally, a default text control
2110
+ * will be created with its `text` property bound to the value of the string. The default template depends
2111
+ * on the libraries loaded. **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control`
2112
+ * instead.
2108
2113
  */
2109
2114
  template?:
2110
2115
  | string
@@ -2407,16 +2412,39 @@ declare namespace sap {
2407
2412
 
2408
2413
  /**
2409
2414
  * Defines how many additional (not yet visible) data records from the back-end system are pre-fetched to
2410
- * enable smooth scrolling. The threshold is always added to the `visibleRowCount`. If the `visibleRowCount`
2411
- * is 10 and the `threshold` is 100, there will be 110 records fetched with the initial load. If the `threshold`
2412
- * is lower than the number of rows in the scrollable area (`visibleRowCount` minus number of fixed rows),
2413
- * this number is used as the `threshold`. If the value is 0, thresholding is disabled.
2415
+ * enable smooth scrolling. The threshold is always added to the number of rows. If the number of rows is
2416
+ * 10 and the `threshold` is 100, 110 records will be fetched with the initial load. This property affects
2417
+ * requests triggered by changes in the binding, for example, initial loading, sorting, filtering, etc.
2418
+ * The threshold that is applied during scrolling can be configured with the `scrollThreshold` property.
2419
+ * If the `threshold` is lower than the number of rows in the scrollable area (`visibleRowCount` minus number
2420
+ * of fixed rows), this number is used as the `threshold`. If the value is 0, thresholding is disabled.
2414
2421
  */
2415
2422
  threshold?:
2416
2423
  | int
2417
2424
  | sap.ui.base.ManagedObject.PropertyBindingInfo
2418
2425
  | `{${string}}`;
2419
2426
 
2427
+ /**
2428
+ * Defines how many additional data records are requested from the back-end system when the user scrolls
2429
+ * vertically in the table. The `scrollThreshold` is always added to the number of rows. If the number of
2430
+ * rows is 10 and the `scrollThreshold` is 100, 110 records will be fetched during scrolling. The threshold
2431
+ * that is applied to requests that are not initiated by scrolling can be configured with the `threshold`
2432
+ * property. If the `scrollThreshold` is lower than the number of rows in the scrollable area (number of
2433
+ * rows minus number of fixed rows), this number is used as the `scrollThreshold`. If the value is 0, no
2434
+ * threshold is applied during scrolling. The value -1 applies the same value as the `threshold` property.
2435
+ *
2436
+ * **Note:** This property only takes effect if it is set to a positive integer value.
2437
+ *
2438
+ * For `AnalyticalTable` and `TreeTable`, the `scrollThreshold` property must be higher than the `threshold`
2439
+ * property to take effect.
2440
+ *
2441
+ * @since 1.128
2442
+ */
2443
+ scrollThreshold?:
2444
+ | int
2445
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
2446
+ | `{${string}}`;
2447
+
2420
2448
  /**
2421
2449
  * Flag to enable or disable column reordering
2422
2450
  *
@@ -4987,17 +5015,22 @@ declare namespace sap {
4987
5015
  /**
4988
5016
  * Gets content of aggregation {@link #getTemplate template}.
4989
5017
  *
4990
- * Template (cell renderer) of this column. A template is decoupled from the column. Each time the template's
4991
- * properties or aggregations have been changed, the template has to be applied again via `setTemplate`
4992
- * for the changes to take effect. If a string is defined, a default text control will be created with its
4993
- * text property bound to the value of the string. The default template depends on the libraries loaded.
4994
- * If there is no template, the column will not be rendered in the table. The set of supported controls
4995
- * is limited. See section "{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}"
5018
+ * Template (cell renderer) of this column.
5019
+ *
5020
+ * A template is decoupled from the column. Each time the template's properties or aggregations have been
5021
+ * changed, the template has to be applied again via `setTemplate` for the changes to take effect.
5022
+ *
5023
+ * If there is no template, the column will not be rendered in the table.
5024
+ *
5025
+ * The set of supported controls is limited. See section "{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}"
4996
5026
  * in the documentation for more details. While it is technically possible to also use other controls, doing
4997
5027
  * so might lead to issues with regards to scrolling, alignment, condensed mode, screen reader support,
4998
5028
  * and keyboard support.
4999
5029
  *
5000
- * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
5030
+ * If a string is defined, this string is interpreted as the binding path. Internally, a default text control
5031
+ * will be created with its `text` property bound to the value of the string. The default template depends
5032
+ * on the libraries loaded. **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control`
5033
+ * instead.
5001
5034
  */
5002
5035
  getTemplate(): sap.ui.core.Control | string;
5003
5036
  /**
@@ -8752,6 +8785,29 @@ declare namespace sap {
8752
8785
  * changes to take effect.
8753
8786
  */
8754
8787
  getRowSettingsTemplate(): sap.ui.table.RowSettings;
8788
+ /**
8789
+ * Gets current value of property {@link #getScrollThreshold scrollThreshold}.
8790
+ *
8791
+ * Defines how many additional data records are requested from the back-end system when the user scrolls
8792
+ * vertically in the table. The `scrollThreshold` is always added to the number of rows. If the number of
8793
+ * rows is 10 and the `scrollThreshold` is 100, 110 records will be fetched during scrolling. The threshold
8794
+ * that is applied to requests that are not initiated by scrolling can be configured with the `threshold`
8795
+ * property. If the `scrollThreshold` is lower than the number of rows in the scrollable area (number of
8796
+ * rows minus number of fixed rows), this number is used as the `scrollThreshold`. If the value is 0, no
8797
+ * threshold is applied during scrolling. The value -1 applies the same value as the `threshold` property.
8798
+ *
8799
+ * **Note:** This property only takes effect if it is set to a positive integer value.
8800
+ *
8801
+ * For `AnalyticalTable` and `TreeTable`, the `scrollThreshold` property must be higher than the `threshold`
8802
+ * property to take effect.
8803
+ *
8804
+ * Default value is `-1`.
8805
+ *
8806
+ * @since 1.128
8807
+ *
8808
+ * @returns Value of property `scrollThreshold`
8809
+ */
8810
+ getScrollThreshold(): int;
8755
8811
  /**
8756
8812
  * Retrieves the lead selection index.
8757
8813
  *
@@ -8856,10 +8912,12 @@ declare namespace sap {
8856
8912
  * Gets current value of property {@link #getThreshold threshold}.
8857
8913
  *
8858
8914
  * Defines how many additional (not yet visible) data records from the back-end system are pre-fetched to
8859
- * enable smooth scrolling. The threshold is always added to the `visibleRowCount`. If the `visibleRowCount`
8860
- * is 10 and the `threshold` is 100, there will be 110 records fetched with the initial load. If the `threshold`
8861
- * is lower than the number of rows in the scrollable area (`visibleRowCount` minus number of fixed rows),
8862
- * this number is used as the `threshold`. If the value is 0, thresholding is disabled.
8915
+ * enable smooth scrolling. The threshold is always added to the number of rows. If the number of rows is
8916
+ * 10 and the `threshold` is 100, 110 records will be fetched with the initial load. This property affects
8917
+ * requests triggered by changes in the binding, for example, initial loading, sorting, filtering, etc.
8918
+ * The threshold that is applied during scrolling can be configured with the `scrollThreshold` property.
8919
+ * If the `threshold` is lower than the number of rows in the scrollable area (`visibleRowCount` minus number
8920
+ * of fixed rows), this number is used as the `threshold`. If the value is 0, thresholding is disabled.
8863
8921
  *
8864
8922
  * Default value is `100`.
8865
8923
  *
@@ -9715,6 +9773,19 @@ declare namespace sap {
9715
9773
  */
9716
9774
  oRowSettingsTemplate: sap.ui.table.RowSettings
9717
9775
  ): this;
9776
+ /**
9777
+ * Sets the threshold value, which will be added to all data requests initiated by scrolling if the `Table`
9778
+ * is bound against an OData service.
9779
+ *
9780
+ *
9781
+ * @returns Reference to `this` in order to allow method chaining
9782
+ */
9783
+ setScrollThreshold(
9784
+ /**
9785
+ * The threshold for scrolling
9786
+ */
9787
+ iThreshold: int
9788
+ ): this;
9718
9789
  /**
9719
9790
  * Sets the selected index. The previous selection is removed.
9720
9791
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {