@openui5/types 1.126.1 → 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.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  import Control from "sap/ui/core/Control";
@@ -8,7 +8,9 @@ declare module "sap/ui/rta/api/startAdaptation" {
8
8
  /**
9
9
  * Starts UI adaptation, initiated for an application at the passed root control instance. With this API
10
10
  * you are also able to modify the UI adaptation plugins list and or add some event handler functions to
11
- * be called on start, failed and stop events.
11
+ * be called on start, failed and stop events. CAUTION: In the key user layer (CUSTOMER) the adaptation
12
+ * mode starts automatically after a reload triggered by the adaptation mode (e.g. due to personalization
13
+ * changes or versioning). In this case the RuntimeAuthoring class will be started with default parameters.
12
14
  *
13
15
  * @since 1.83
14
16
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/suite/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/support/library" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -2009,17 +2009,22 @@ declare module "sap/ui/table/Column" {
2009
2009
  /**
2010
2010
  * Gets content of aggregation {@link #getTemplate template}.
2011
2011
  *
2012
- * Template (cell renderer) of this column. A template is decoupled from the column. Each time the template's
2013
- * properties or aggregations have been changed, the template has to be applied again via `setTemplate`
2014
- * for the changes to take effect. If a string is defined, a default text control will be created with its
2015
- * text property bound to the value of the string. The default template depends on the libraries loaded.
2016
- * If there is no template, the column will not be rendered in the table. The set of supported controls
2017
- * is limited. See section "{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}"
2012
+ * Template (cell renderer) of this column.
2013
+ *
2014
+ * A template is decoupled from the column. Each time the template's properties or aggregations have been
2015
+ * changed, the template has to be applied again via `setTemplate` for the changes to take effect.
2016
+ *
2017
+ * If there is no template, the column will not be rendered in the table.
2018
+ *
2019
+ * The set of supported controls is limited. See section "{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}"
2018
2020
  * in the documentation for more details. While it is technically possible to also use other controls, doing
2019
2021
  * so might lead to issues with regards to scrolling, alignment, condensed mode, screen reader support,
2020
2022
  * and keyboard support.
2021
2023
  *
2022
- * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
2024
+ * If a string is defined, this string is interpreted as the binding path. Internally, a default text control
2025
+ * will be created with its `text` property bound to the value of the string. The default template depends
2026
+ * on the libraries loaded. **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control`
2027
+ * instead.
2023
2028
  */
2024
2029
  getTemplate(): Control | string;
2025
2030
  /**
@@ -2834,17 +2839,22 @@ declare module "sap/ui/table/Column" {
2834
2839
  multiLabels?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
2835
2840
 
2836
2841
  /**
2837
- * Template (cell renderer) of this column. A template is decoupled from the column. Each time the template's
2838
- * properties or aggregations have been changed, the template has to be applied again via `setTemplate`
2839
- * for the changes to take effect. If a string is defined, a default text control will be created with its
2840
- * text property bound to the value of the string. The default template depends on the libraries loaded.
2841
- * If there is no template, the column will not be rendered in the table. The set of supported controls
2842
- * is limited. See section "{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}"
2842
+ * Template (cell renderer) of this column.
2843
+ *
2844
+ * A template is decoupled from the column. Each time the template's properties or aggregations have been
2845
+ * changed, the template has to be applied again via `setTemplate` for the changes to take effect.
2846
+ *
2847
+ * If there is no template, the column will not be rendered in the table.
2848
+ *
2849
+ * The set of supported controls is limited. See section "{@link https://ui5.sap.com/#/topic/148892ff9aea4a18b912829791e38f3e Tables: Which One Should I Choose?}"
2843
2850
  * in the documentation for more details. While it is technically possible to also use other controls, doing
2844
2851
  * so might lead to issues with regards to scrolling, alignment, condensed mode, screen reader support,
2845
2852
  * and keyboard support.
2846
2853
  *
2847
- * **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control` instead.
2854
+ * If a string is defined, this string is interpreted as the binding path. Internally, a default text control
2855
+ * will be created with its `text` property bound to the value of the string. The default template depends
2856
+ * on the libraries loaded. **Note:** The `altType` string is deprecated as of version 1.118. Use a `Control`
2857
+ * instead.
2848
2858
  */
2849
2859
  template?: string | Control | PropertyBindingInfo;
2850
2860
 
@@ -5327,15 +5337,15 @@ declare module "sap/ui/table/rowmodes/Type" {
5327
5337
  */
5328
5338
  enum Type {
5329
5339
  /**
5330
- * Equivalent to the default configuration of {@link module:sap/ui/table/rowmodes/Auto}
5340
+ * Equivalent to the default configuration of {@link sap.ui.table.rowmodes.Auto}
5331
5341
  */
5332
5342
  Auto = "Auto",
5333
5343
  /**
5334
- * Equivalent to the default configuration of {@link module:sap/ui/table/rowmodes/Fixed}
5344
+ * Equivalent to the default configuration of {@link sap.ui.table.rowmodes.Fixed}
5335
5345
  */
5336
5346
  Fixed = "Fixed",
5337
5347
  /**
5338
- * Equivalent to the default configuration of {@link module:sap/ui/table/rowmodes/Interactive}
5348
+ * Equivalent to the default configuration of {@link sap.ui.table.rowmodes.Interactive}
5339
5349
  */
5340
5350
  Interactive = "Interactive",
5341
5351
  }
@@ -5641,8 +5651,10 @@ declare module "sap/ui/table/Table" {
5641
5651
  * This allows the Table control to handle huge amounts of data. Nevertheless, restrictions apply regarding
5642
5652
  * the number of displayed columns. Keep the number as low as possible to improve performance. Due to the
5643
5653
  * nature of tables, the used control for column templates also has a big influence on the performance.
5644
- * The Table control relies completely on data binding, and its supported feature set is tightly
5645
- * coupled to the data model and binding being used.
5654
+ * Because of the described reuse of the controls during scrolling, all data-related changes must be based
5655
+ * on bindings. Static changes, such as calling mutator functions or defining a one-time binding, must be
5656
+ * avoided. The Table control relies completely on data binding, and its supported feature set
5657
+ * is tightly coupled to the data model and binding being used.
5646
5658
  */
5647
5659
  export default class Table extends Control {
5648
5660
  /**
@@ -7648,6 +7660,10 @@ declare module "sap/ui/table/Table" {
7648
7660
  *
7649
7661
  * Flag to enable or disable column reordering
7650
7662
  *
7663
+ * **Note**: Column reordering is possible via drag&drop and keyboard shortcuts. Single-pointer alternative
7664
+ * is not provided out-of-the-box and should be implemented on application side. For example the {@link sap.m.p13n.Engine }
7665
+ * can be used, see the following sample: {@link https://ui5.sap.com/#/entity/sap.ui.table.Table/sample/sap.m.sample.p13n.EngineGridTable Personalization for grid table}.
7666
+ *
7651
7667
  * Default value is `true`.
7652
7668
  *
7653
7669
  *
@@ -7913,6 +7929,29 @@ declare module "sap/ui/table/Table" {
7913
7929
  * changes to take effect.
7914
7930
  */
7915
7931
  getRowSettingsTemplate(): RowSettings;
7932
+ /**
7933
+ * Gets current value of property {@link #getScrollThreshold scrollThreshold}.
7934
+ *
7935
+ * Defines how many additional data records are requested from the back-end system when the user scrolls
7936
+ * vertically in the table. The `scrollThreshold` is always added to the number of rows. If the number of
7937
+ * rows is 10 and the `scrollThreshold` is 100, 110 records will be fetched during scrolling. The threshold
7938
+ * that is applied to requests that are not initiated by scrolling can be configured with the `threshold`
7939
+ * property. If the `scrollThreshold` is lower than the number of rows in the scrollable area (number of
7940
+ * rows minus number of fixed rows), this number is used as the `scrollThreshold`. If the value is 0, no
7941
+ * threshold is applied during scrolling. The value -1 applies the same value as the `threshold` property.
7942
+ *
7943
+ * **Note:** This property only takes effect if it is set to a positive integer value.
7944
+ *
7945
+ * For `AnalyticalTable` and `TreeTable`, the `scrollThreshold` property must be higher than the `threshold`
7946
+ * property to take effect.
7947
+ *
7948
+ * Default value is `-1`.
7949
+ *
7950
+ * @since 1.128
7951
+ *
7952
+ * @returns Value of property `scrollThreshold`
7953
+ */
7954
+ getScrollThreshold(): int;
7916
7955
  /**
7917
7956
  * Retrieves the lead selection index.
7918
7957
  *
@@ -8017,10 +8056,12 @@ declare module "sap/ui/table/Table" {
8017
8056
  * Gets current value of property {@link #getThreshold threshold}.
8018
8057
  *
8019
8058
  * Defines how many additional (not yet visible) data records from the back-end system are pre-fetched to
8020
- * enable smooth scrolling. The threshold is always added to the `visibleRowCount`. If the `visibleRowCount`
8021
- * is 10 and the `threshold` is 100, there will be 110 records fetched with the initial load. If the `threshold`
8022
- * is lower than the number of rows in the scrollable area (`visibleRowCount` minus number of fixed rows),
8023
- * this number is used as the `threshold`. If the value is 0, thresholding is disabled.
8059
+ * enable smooth scrolling. The threshold is always added to the number of rows. If the number of rows is
8060
+ * 10 and the `threshold` is 100, 110 records will be fetched with the initial load. This property affects
8061
+ * requests triggered by changes in the binding, for example, initial loading, sorting, filtering, etc.
8062
+ * The threshold that is applied during scrolling can be configured with the `scrollThreshold` property.
8063
+ * If the `threshold` is lower than the number of rows in the scrollable area (`visibleRowCount` minus number
8064
+ * of fixed rows), this number is used as the `threshold`. If the value is 0, thresholding is disabled.
8024
8065
  *
8025
8066
  * Default value is `100`.
8026
8067
  *
@@ -8540,6 +8581,10 @@ declare module "sap/ui/table/Table" {
8540
8581
  *
8541
8582
  * Flag to enable or disable column reordering
8542
8583
  *
8584
+ * **Note**: Column reordering is possible via drag&drop and keyboard shortcuts. Single-pointer alternative
8585
+ * is not provided out-of-the-box and should be implemented on application side. For example the {@link sap.m.p13n.Engine }
8586
+ * can be used, see the following sample: {@link https://ui5.sap.com/#/entity/sap.ui.table.Table/sample/sap.m.sample.p13n.EngineGridTable Personalization for grid table}.
8587
+ *
8543
8588
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
8544
8589
  *
8545
8590
  * Default value is `true`.
@@ -8874,6 +8919,19 @@ declare module "sap/ui/table/Table" {
8874
8919
  */
8875
8920
  oRowSettingsTemplate: RowSettings
8876
8921
  ): this;
8922
+ /**
8923
+ * Sets the threshold value, which will be added to all data requests initiated by scrolling if the `Table`
8924
+ * is bound against an OData service.
8925
+ *
8926
+ *
8927
+ * @returns Reference to `this` in order to allow method chaining
8928
+ */
8929
+ setScrollThreshold(
8930
+ /**
8931
+ * The threshold for scrolling
8932
+ */
8933
+ iThreshold: int
8934
+ ): this;
8877
8935
  /**
8878
8936
  * Sets the selected index. The previous selection is removed.
8879
8937
  *
@@ -9285,15 +9343,39 @@ declare module "sap/ui/table/Table" {
9285
9343
 
9286
9344
  /**
9287
9345
  * Defines how many additional (not yet visible) data records from the back-end system are pre-fetched to
9288
- * enable smooth scrolling. The threshold is always added to the `visibleRowCount`. If the `visibleRowCount`
9289
- * is 10 and the `threshold` is 100, there will be 110 records fetched with the initial load. If the `threshold`
9290
- * is lower than the number of rows in the scrollable area (`visibleRowCount` minus number of fixed rows),
9291
- * this number is used as the `threshold`. If the value is 0, thresholding is disabled.
9346
+ * enable smooth scrolling. The threshold is always added to the number of rows. If the number of rows is
9347
+ * 10 and the `threshold` is 100, 110 records will be fetched with the initial load. This property affects
9348
+ * requests triggered by changes in the binding, for example, initial loading, sorting, filtering, etc.
9349
+ * The threshold that is applied during scrolling can be configured with the `scrollThreshold` property.
9350
+ * If the `threshold` is lower than the number of rows in the scrollable area (`visibleRowCount` minus number
9351
+ * of fixed rows), this number is used as the `threshold`. If the value is 0, thresholding is disabled.
9292
9352
  */
9293
9353
  threshold?: int | PropertyBindingInfo | `{${string}}`;
9294
9354
 
9355
+ /**
9356
+ * Defines how many additional data records are requested from the back-end system when the user scrolls
9357
+ * vertically in the table. The `scrollThreshold` is always added to the number of rows. If the number of
9358
+ * rows is 10 and the `scrollThreshold` is 100, 110 records will be fetched during scrolling. The threshold
9359
+ * that is applied to requests that are not initiated by scrolling can be configured with the `threshold`
9360
+ * property. If the `scrollThreshold` is lower than the number of rows in the scrollable area (number of
9361
+ * rows minus number of fixed rows), this number is used as the `scrollThreshold`. If the value is 0, no
9362
+ * threshold is applied during scrolling. The value -1 applies the same value as the `threshold` property.
9363
+ *
9364
+ * **Note:** This property only takes effect if it is set to a positive integer value.
9365
+ *
9366
+ * For `AnalyticalTable` and `TreeTable`, the `scrollThreshold` property must be higher than the `threshold`
9367
+ * property to take effect.
9368
+ *
9369
+ * @since 1.128
9370
+ */
9371
+ scrollThreshold?: int | PropertyBindingInfo | `{${string}}`;
9372
+
9295
9373
  /**
9296
9374
  * Flag to enable or disable column reordering
9375
+ *
9376
+ * **Note**: Column reordering is possible via drag&drop and keyboard shortcuts. Single-pointer alternative
9377
+ * is not provided out-of-the-box and should be implemented on application side. For example the {@link sap.m.p13n.Engine }
9378
+ * can be used, see the following sample: {@link https://ui5.sap.com/#/entity/sap.ui.table.Table/sample/sap.m.sample.p13n.EngineGridTable Personalization for grid table}.
9297
9379
  */
9298
9380
  enableColumnReordering?: boolean | PropertyBindingInfo | `{${string}}`;
9299
9381
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.126.1
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare module "sap/ui/testrecorder/library" {}
4
4