@sapui5/ts-types 1.131.1 → 1.132.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.
Files changed (69) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +7 -7
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.cux.home.d.ts +8 -0
  8. package/types/sap.esh.search.ui.d.ts +38 -1
  9. package/types/sap.f.d.ts +95 -187
  10. package/types/sap.fe.base.d.ts +1 -1
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +1 -1
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +108 -101
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +1 -1
  19. package/types/sap.fe.test.d.ts +1 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +1 -1
  23. package/types/sap.insights.d.ts +1 -1
  24. package/types/{mobile-1.131.0-d.ts → sap.m.d.ts} +390 -47
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +7 -2
  29. package/types/sap.rules.ui.d.ts +84 -1
  30. package/types/sap.sac.df.d.ts +978 -623
  31. package/types/sap.suite.ui.commons.d.ts +1 -1
  32. package/types/sap.suite.ui.generic.template.d.ts +7 -7
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/{tnt-1.131.0-d.ts → sap.tnt.d.ts} +1 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/{commons-1.131.0-d.ts → sap.ui.commons.d.ts} +1 -1
  37. package/types/sap.ui.comp.d.ts +59 -5
  38. package/types/{core-1.131.0-d.ts → sap.ui.core.d.ts} +363 -282
  39. package/types/{dt-1.131.0-d.ts → sap.ui.dt.d.ts} +1 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +7 -1
  42. package/types/sap.ui.generic.app.d.ts +5 -11
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +1 -1
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/{mdc-1.131.0-d.ts → sap.ui.mdc.d.ts} +330 -229
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +3 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +1 -1
  51. package/types/sap.ui.table.d.ts +13 -1
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +25 -15
  54. package/types/{ux3-1.131.0-d.ts → sap.ui.ux3.d.ts} +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +100 -1
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.ui.webc.common.d.ts +1 -1
  59. package/types/sap.ui.webc.fiori.d.ts +1 -1
  60. package/types/sap.ui.webc.main.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +5 -1
  63. package/types/sap.ushell_abap.d.ts +1 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.131.0
282
+ // For Library Version: 1.132.1
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -1559,9 +1559,9 @@ declare module "sap/base/i18n/ResourceBundle" {
1559
1559
  sKey: string,
1560
1560
  /**
1561
1561
  * List of parameter values which should replace the placeholders "{n}" (n is the index) in
1562
- * the found locale-specific string value. Note that the replacement is done whenever `aArgs` is given,
1563
- * no matter whether the text contains placeholders or not and no matter whether `aArgs` contains a value
1564
- * for n or not.
1562
+ * the found locale-specific string value. Note that the replacement is done whenever `aArgs` is given (not
1563
+ * `undefined`), no matter whether the text contains placeholders or not and no matter whether `aArgs` contains
1564
+ * a value for n or not.
1565
1565
  */
1566
1566
  aArgs?: any[],
1567
1567
  /**
@@ -8766,50 +8766,84 @@ declare namespace sap {
8766
8766
  sAggregationName?: string
8767
8767
  ): sap.ui.core.Control[] | Promise<sap.ui.core.Control[]>;
8768
8768
  /**
8769
- * Instantiate a Fragment - this method loads the Fragment content, instantiates it, and returns this content.
8770
- * The Fragment object itself is not an entity which has further significance beyond this constructor.
8769
+ * Loads and instantiates a fragment. The fragment object itself is not an entity that has any further significance
8770
+ * beyond this factory function.
8771
8771
  *
8772
- * To instantiate an existing Fragment, call this method as: sap.ui.fragment(sName, sType, [oController]);
8773
- * The sName must correspond to a Fragment module which can be loaded via the module system (fragmentName
8774
- * + suffix ".fragment.[typeextension]") and which defines the Fragment content. If oController is given,
8775
- * the (event handler) methods referenced in the Fragment will be called on this controller. Note that Fragments
8776
- * may require a Controller to be given and certain methods to be available.
8772
+ * To instantiate a fragment that is already defined separately, call:
8773
+ * ```javascript
8774
+ *
8775
+ * sap.ui.fragment(sName, sType, oController?);
8776
+ * ```
8777
+ *
8778
+ *
8779
+ * Advanced usage to give further configuration options:
8780
+ * ```javascript
8777
8781
  *
8778
- * The Fragment types "XML", "JS" and "HTML" are available by default; additional Fragment types can be
8779
- * implemented and added using the sap.ui.core.Fragment.registerType() function.
8782
+ * sap.ui.fragment(oFragmentConfig, oController?);
8783
+ * ```
8784
+ * In addition to `id` and `type`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
8785
+ * property, but not both.
8786
+ *
8787
+ * To define a fragment ID, which can be used as a prefix for the created control IDs, you must use either
8788
+ * the above advanced version with an `id` or one of the typed factory functions like {@link sap.ui.xmlfragment }
8789
+ * or {@link sap.ui.jsfragment}.
8790
+ *
8791
+ * A fragment type must be given in all cases. The fragment types `"XML"`, `"JS"`, and `"HTML"` (type `"HTML"`
8792
+ * is deprecated) are available by default. Additional fragment types can be implemented and added using
8793
+ * the {@link sap.ui.core.Fragment.registerType} function.
8780
8794
  *
8781
- * Advanced usage: To instantiate a Fragment and give further configuration options, call this method as:
8782
- * sap.ui.fragment(oFragmentConfig, [oController]); The oFragmentConfig object can have the following properties:
8783
- * - "fragmentName": the name of the Fragment, as above - "fragmentContent": the definition of the Fragment
8784
- * content itself. When this property is given, any given name is ignored. The type of this property depends
8785
- * on the Fragment type, e.g. it could be a string for XML Fragments. - "type": the type of the Fragment,
8786
- * as above (mandatory) - "id": the ID of the Fragment (optional) Further properties may be supported by
8787
- * future or custom Fragment types. Any given properties will be forwarded to the Fragment implementation.
8795
+ * Custom fragment types can support further properties. Any given properties will be forwarded to the fragment
8796
+ * implementation.
8788
8797
  *
8789
- * If you want to give a fixed ID for the Fragment, please use the advanced version of this method call
8790
- * with the configuration object or use the typed factories like sap.ui.xmlfragment(...) or sap.ui.jsfragment(...).
8791
- * Otherwise the Fragment ID is generated. In any case, the Fragment ID will be used as prefix for the ID
8792
- * of all contained controls.
8798
+ * The optional `oController` can be either the controller of an enclosing view, a new controller instance,
8799
+ * or a simple object with the necessary methods attached. Note that a fragment has no runtime representation
8800
+ * besides its contained controls. Therefore, there is no API to retrieve the controller from the return
8801
+ * value. Note also that fragments may require a controller to be given and certain methods to be available.
8793
8802
  *
8794
- * @deprecated (since 1.58) - use {@link sap.ui.core.Fragment.load} instead
8803
+ * **Note:** In case you are embedding a Fragment into an existing View, please also have a look at the
8804
+ * {@link sap.ui.core.mvc.Controller.loadFragment loadFragment} factory for a closer coupling to the corresponding
8805
+ * Controller instance.
8795
8806
  *
8796
- * @returns the root Control(s) of the Fragment content
8807
+ * @deprecated (since 1.58) - Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
8808
+ *
8809
+ * @returns the instantiated root control(s) from the fragment content
8797
8810
  */
8798
8811
  function fragment(
8799
8812
  /**
8800
- * the Fragment name
8813
+ * resource name of the fragment module in dot notation without the `.fragment.<typeExtension>`
8814
+ * suffix from the file name. Alternatively, a configuration object as specified below
8801
8815
  */
8802
- sName: string | Object,
8816
+ vName:
8817
+ | string
8818
+ | {
8819
+ /**
8820
+ * optional ID of the created fragment
8821
+ */
8822
+ id?: string;
8823
+ /**
8824
+ * definition of the fragment content that will be used instead of loading the content from a separate file.
8825
+ * The type of this property depends on the fragment type. For example, it could be a string for XML fragments
8826
+ * or an object for JS fragments
8827
+ */
8828
+ fragmentContent?: string | object;
8829
+ /**
8830
+ * recource name of the fragment module as specified above
8831
+ */
8832
+ fragmentName?: string;
8833
+ /**
8834
+ * type of the fragment, for example, `"XML"`, `"JS"`, `"HTML"`, or any other type that has been implemented
8835
+ * additionally
8836
+ */
8837
+ type: string;
8838
+ },
8803
8839
  /**
8804
- * the Fragment type, e.g. "XML", "JS", or "HTML"
8840
+ * type of the fragment as specified by `vName.type` or, in the advanced usage case, an optional `oController`
8805
8841
  */
8806
- sType: string,
8842
+ vType: string | sap.ui.core.mvc.Controller | object,
8807
8843
  /**
8808
- * the Controller or Object which should be used by the controls in the Fragment. Note that some Fragments
8809
- * may not need a Controller and other may need one - and even rely on certain methods implemented in the
8810
- * Controller.
8844
+ * controller object to be used for methods or event handlers referenced in the fragment
8811
8845
  */
8812
- oController?: sap.ui.core.mvc.Controller | Object
8846
+ oController?: sap.ui.core.mvc.Controller | object
8813
8847
  ): sap.ui.core.Control | sap.ui.core.Control[];
8814
8848
  /**
8815
8849
  * Retrieve the {@link sap.ui.core.Core SAPUI5 Core} instance for the current window.
@@ -8853,124 +8887,101 @@ declare namespace sap {
8853
8887
  }
8854
8888
  ): object | undefined | Promise<any>;
8855
8889
  /**
8856
- * Instantiates an HTML-based Fragment.
8890
+ * Loads and instantiates an HTML-based fragment.
8857
8891
  *
8858
- * To instantiate a fragment, call:
8892
+ * To instantiate a fragment that is already defined separately, call:
8859
8893
  * ```javascript
8860
8894
  *
8861
- * sap.ui.htmlfragment([sId], sFragmentName, [oController]);
8895
+ * sap.ui.htmlfragment(sId?, sFragmentName, oController?);
8862
8896
  * ```
8863
- * The fragment instance ID is optional and will be used as prefix for the ID of all contained controls.
8864
- * If no ID is passed, controls will not be prefixed. The `sFragmentName` must correspond to an HTML fragment
8865
- * which can be loaded via the module system (fragmentName + ".fragment.html") and which defines the fragment.
8866
- * If `oController` is given, the methods referenced in the fragment will be called on this controller.
8867
- * Note that fragments may require a controller to be given and certain methods to be available.
8868
- *
8869
- * Advanced usage:: To instantiate a fragment and optionally directly give the HTML definition instead of
8870
- * loading it from a file, call:
8897
+ *
8898
+ *
8899
+ * Advanced usage:
8871
8900
  * ```javascript
8872
8901
  *
8873
- * sap.ui.htmlfragment(oFragmentConfig, [oController]);
8902
+ * sap.ui.htmlfragment(oFragmentConfig, oController?);
8874
8903
  * ```
8875
- * The `oFragmentConfig` object can either have a `fragmentName` or a `fragmentContent` property, but not
8876
- * both of them. `fragmentContent` can hold the fragment definition as XML string; if not given, `fragmentName`
8877
- * must be given and the fragment content definition is loaded by the module system. Again, if `oController`
8878
- * is given, any methods referenced in the fragment will be called on this controller.
8904
+ * In addition to an `id`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
8905
+ * property, but not both.
8879
8906
  *
8880
- * @deprecated (since 1.58) - use {@link sap.ui.core.Fragment.load} instead
8907
+ * @deprecated (since 1.58) - Additionally, use of fragments based on type `"HTML"` is deprecated since
8908
+ * 1.108. If you need declarative fragments, use XML fragments instead. Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
8881
8909
  *
8882
- * @returns Root control or controls of the created fragment instance
8910
+ * @returns the instantiated root control(s) from the fragment content
8883
8911
  */
8884
8912
  function htmlfragment(
8885
8913
  /**
8886
- * ID of the newly created fragment
8914
+ * ID of the created fragment which will be used as prefix to all contained control IDs. If the first argument
8915
+ * is not an ID, it must be either the fragment name (`sFragmentName`) or a configuration object (`oFragmentConfig`)
8916
+ * as specified below
8887
8917
  */
8888
- sId: string,
8889
- /**
8890
- * Resource name of the fragment, a module name in dot notation without the '.fragment.html' suffix. Alternatively,
8891
- * a configuration object can be given with the properties described below. In this case, no `sId` may be
8892
- * given as first parameter, but as property `id` in the configuration object.
8893
- */
8894
- vFragment:
8918
+ vId:
8895
8919
  | string
8896
8920
  | {
8897
8921
  /**
8898
- * ID of the newly created fragment; will be used as a prefix to all contained control IDs
8922
+ * ID of the created fragment which will be used as prefix to all contained control IDs
8899
8923
  */
8900
8924
  id?: string;
8901
8925
  /**
8902
- * Resource name of the Fragment; a module name in dot notation without the '.fragment.html' suffix
8926
+ * definition of the fragment content as an HTML string that will be used instead of loading the content
8927
+ * from a separate `.fragment.html` file. When this property is given, any given fragment name is ignored
8903
8928
  */
8904
- fragmentName?: string;
8929
+ fragmentContent?: string;
8905
8930
  /**
8906
- * Definition of the fragment as an HTML string
8931
+ * resource name of the fragment module in dot notation without the `.fragment.html` suffix from the file
8932
+ * name
8907
8933
  */
8908
- fragmentContent?: string;
8934
+ fragmentName?: string;
8909
8935
  },
8910
8936
  /**
8911
- * A controller to be used for event handlers in the fragment; can either be the controller of an enclosing
8937
+ * resource name of the fragment module as specified by `vId.fragmentName` or, in the advanced usage case,
8938
+ * an optional `oController`
8939
+ */
8940
+ vFragment: string | sap.ui.core.mvc.Controller | object,
8941
+ /**
8942
+ * controller object to be used for methods or event handlers. Can be either the controller of an enclosing
8912
8943
  * view, a new controller instance, or a simple object with the necessary methods attached. Note that a
8913
- * fragment has no runtime representation besides its contained controls. There's therefore no API to retrieve
8914
- * the controller after creating a fragment
8944
+ * fragment has no runtime representation besides its contained controls. Therefore, there is no API to
8945
+ * retrieve the controller from the return value. Note also that fragments may require a controller to be
8946
+ * given and certain methods to be available
8915
8947
  */
8916
8948
  oController?: sap.ui.core.mvc.Controller | object
8917
8949
  ): sap.ui.core.Control | sap.ui.core.Control[];
8918
8950
  /**
8919
- * Instantiates an HTML-based Fragment.
8951
+ * Loads and instantiates an HTML-based fragment.
8920
8952
  *
8921
- * To instantiate a fragment, call:
8953
+ * To instantiate a fragment that is already defined separately, call:
8922
8954
  * ```javascript
8923
8955
  *
8924
- * sap.ui.htmlfragment([sId], sFragmentName, [oController]);
8956
+ * sap.ui.htmlfragment(sId?, sFragmentName, oController?);
8925
8957
  * ```
8926
- * The fragment instance ID is optional and will be used as prefix for the ID of all contained controls.
8927
- * If no ID is passed, controls will not be prefixed. The `sFragmentName` must correspond to an HTML fragment
8928
- * which can be loaded via the module system (fragmentName + ".fragment.html") and which defines the fragment.
8929
- * If `oController` is given, the methods referenced in the fragment will be called on this controller.
8930
- * Note that fragments may require a controller to be given and certain methods to be available.
8931
- *
8932
- * Advanced usage:: To instantiate a fragment and optionally directly give the HTML definition instead of
8933
- * loading it from a file, call:
8958
+ *
8959
+ *
8960
+ * Advanced usage:
8934
8961
  * ```javascript
8935
8962
  *
8936
- * sap.ui.htmlfragment(oFragmentConfig, [oController]);
8963
+ * sap.ui.htmlfragment(oFragmentConfig, oController?);
8937
8964
  * ```
8938
- * The `oFragmentConfig` object can either have a `fragmentName` or a `fragmentContent` property, but not
8939
- * both of them. `fragmentContent` can hold the fragment definition as XML string; if not given, `fragmentName`
8940
- * must be given and the fragment content definition is loaded by the module system. Again, if `oController`
8941
- * is given, any methods referenced in the fragment will be called on this controller.
8965
+ * In addition to an `id`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
8966
+ * property, but not both.
8942
8967
  *
8943
- * @deprecated (since 1.58) - use {@link sap.ui.core.Fragment.load} instead
8968
+ * @deprecated (since 1.58) - Additionally, use of fragments based on type `"HTML"` is deprecated since
8969
+ * 1.108. If you need declarative fragments, use XML fragments instead. Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
8944
8970
  *
8945
- * @returns Root control or controls of the created fragment instance
8971
+ * @returns the instantiated root control(s) from the fragment content
8946
8972
  */
8947
8973
  function htmlfragment(
8948
8974
  /**
8949
- * Resource name of the fragment, a module name in dot notation without the '.fragment.html' suffix. Alternatively,
8950
- * a configuration object can be given with the properties described below. In this case, no `sId` may be
8951
- * given as first parameter, but as property `id` in the configuration object.
8975
+ * resource name of the fragment module as specified by `vId.fragmentName` or, in the advanced usage case,
8976
+ * an optional `oController`
8952
8977
  */
8953
- vFragment:
8954
- | string
8955
- | {
8956
- /**
8957
- * ID of the newly created fragment; will be used as a prefix to all contained control IDs
8958
- */
8959
- id?: string;
8960
- /**
8961
- * Resource name of the Fragment; a module name in dot notation without the '.fragment.html' suffix
8962
- */
8963
- fragmentName?: string;
8964
- /**
8965
- * Definition of the fragment as an HTML string
8966
- */
8967
- fragmentContent?: string;
8968
- },
8978
+ vFragment: string | sap.ui.core.mvc.Controller | object,
8969
8979
  /**
8970
- * A controller to be used for event handlers in the fragment; can either be the controller of an enclosing
8980
+ * controller object to be used for methods or event handlers. Can be either the controller of an enclosing
8971
8981
  * view, a new controller instance, or a simple object with the necessary methods attached. Note that a
8972
- * fragment has no runtime representation besides its contained controls. There's therefore no API to retrieve
8973
- * the controller after creating a fragment
8982
+ * fragment has no runtime representation besides its contained controls. Therefore, there is no API to
8983
+ * retrieve the controller from the return value. Note also that fragments may require a controller to be
8984
+ * given and certain methods to be available
8974
8985
  */
8975
8986
  oController?: sap.ui.core.mvc.Controller | object
8976
8987
  ): sap.ui.core.Control | sap.ui.core.Control[];
@@ -9045,71 +9056,66 @@ declare namespace sap {
9045
9056
  }
9046
9057
  ): sap.ui.core.mvc.HTMLView | undefined;
9047
9058
  /**
9048
- * Defines OR instantiates an HTML-based fragment.
9059
+ * Defines **or** instantiates a JS-based fragment.
9049
9060
  *
9050
9061
  * To define a JS fragment, call:
9051
9062
  * ```javascript
9052
9063
  *
9053
- * sap.ui.jsfragment(sName, oFragmentDefinition)
9064
+ * sap.ui.jsfragment(sName, oFragmentDefinition);
9065
+ * ```
9066
+ *
9067
+ *
9068
+ * To instantiate a JS fragment that is already defined, call:
9069
+ * ```javascript
9070
+ *
9071
+ * sap.ui.jsfragment(sId?, sFragmentName, oController?);
9054
9072
  * ```
9055
- * where:
9056
- * - `sName` is the name by which this fragment later can be found and instantiated. If defined in its
9057
- * own file, in order to be found by the module loading system, the file location and name must correspond
9058
- * to `sName` (path + file name must be: fragmentName + ".fragment.js").
9059
- * - `oFragmentDefinition` is an object at least holding the `createContent(oController)` method which
9060
- * defines the fragment content. If given during instantiation, the `createContent` method receives a controller
9061
- * instance (otherwise, parameter `oController` will be undefined) and the return value must be one `sap.ui.core.Control`
9062
- * (which could have any number of children).
9063
- *
9064
- * To instantiate a JS fragment, call:
9073
+ * Advanced usage:
9065
9074
  * ```javascript
9066
9075
  *
9067
- * sap.ui.jsfragment([sId], sFragmentName, [oController]);
9076
+ * sap.ui.jsfragment(oFragmentConfig, oController?);
9068
9077
  * ```
9069
- * The fragment ID is optional (generated if not given) and the fragment implementation can use
9070
- * it to make contained controls unique (this depends on the implementation: some JS fragments may choose
9071
- * not to support multiple instances within one application and not use the ID prefixing). The `sFragmentName`
9072
- * must correspond to a JS fragment which can be loaded via the module system (`sFragmentName` converted
9073
- * to a path + ".fragment.js" suffix) and which defines the fragment. Or it can be a name that has been
9074
- * used earlier to define a fragment of that name. If `oController` is given, the methods referenced in
9075
- * the fragment will be called on this controller. Note that fragments may require a controller to be given
9076
- * and certain methods to be available.
9077
9078
  *
9078
- * @deprecated (since 1.58) - use {@link sap.ui.core.Fragment.load} instead
9079
9079
  *
9080
- * @returns The root control(s) of the created fragment instance
9080
+ * @deprecated (since 1.58) - Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
9081
+ *
9082
+ * @returns the instantiated root control(s) from the fragment content
9081
9083
  */
9082
9084
  function jsfragment(
9083
9085
  /**
9084
- * Name of the fragment when defining a fragment; ID or name or configuration object when instantiating
9085
- * a fragment
9086
+ * when defining a fragment: name of the fragment.
9087
+ * When loading a fragment: fragment ID (optional), fragment name, or configuration object as specified
9088
+ * below
9086
9089
  */
9087
9090
  vName:
9088
9091
  | string
9089
9092
  | {
9090
9093
  /**
9091
- * ID of the newly created fragment; will be used as a prefix to all contained control IDs
9094
+ * ID of the newly created fragment which can be used as a prefix when creating the IDs in the JS
9095
+ * fragment content. Even if an `id` is given, some JS fragments may choose not to use the ID prefixing,
9096
+ * for example, in order to prevent the fragment from being instantiated multiple times within the lifecycle
9097
+ * of the existing fragment
9092
9098
  */
9093
9099
  id?: string;
9094
9100
  /**
9095
- * Name of the fragment. When no fragment has been defined with that name, the name will be converted to
9096
- * a path by replacing dots with slashes and appending '.fragment.js'. The corresponding resource will be
9097
- * loaded and is expected to define a fragment with the `fragmentName`
9101
+ * resource name of the fragment module in dot notation without the `.fragment.js` suffix from the file
9102
+ * name. When no fragment has been defined with that name, the name will be converted to a path by replacing
9103
+ * dots with slashes and appending `.fragment.js`. The corresponding resource to load is expected to have
9104
+ * a fragment defined with the same `fragmentName`
9098
9105
  */
9099
- fragmentName?: string;
9106
+ fragmentName: string;
9100
9107
  },
9101
9108
  /**
9102
- * When defining a fragment, this parameter must be a factory object that will be used to create new instances
9103
- * of the fragment; it must at least contain a `createContent` method. When creating an instance of a fragment
9104
- * and when `vName` was an ID, this parameter must be the name of the fragment. When the first parameter
9105
- * was a name, this parameter must be omitted.
9109
+ * when defining a fragment: object holding at least the `createContent(oController?)` method that returns
9110
+ * an instance of `sap.ui.core.Control` or an array thereof.
9111
+ * When loading a fragment and the first argument is an ID: the `fragmentName`
9106
9112
  */
9107
- vFragmentDefinition?: object | string,
9113
+ vFragmentDefinition: object | string,
9108
9114
  /**
9109
- * A controller to be used for event handlers in the fragment; can either be the controller of an enclosing
9115
+ * controller object to be used for methods or event handlers. Can be either the controller of an enclosing
9110
9116
  * view, a new controller instance, or a simple object with the necessary methods attached. Note that a
9111
- * fragment has no runtime representation besides its contained controls. There's therefore no API to retrieve
9112
- * the controller after creating a fragment
9117
+ * fragment has no runtime representation besides its contained controls. Therefore, there is no API to
9118
+ * retrieve the controller from the return value
9113
9119
  */
9114
9120
  oController?: sap.ui.core.mvc.Controller | object
9115
9121
  ): sap.ui.core.Control | sap.ui.core.Control[];
@@ -9747,126 +9753,99 @@ declare namespace sap {
9747
9753
  }
9748
9754
  ): sap.ui.core.mvc.View;
9749
9755
  /**
9750
- * Instantiates an XML-based Fragment.
9756
+ * Loads and instantiates an XML-based fragment.
9751
9757
  *
9752
- * To instantiate a fragment, call:
9758
+ * To instantiate a fragment that is already defined separately, call:
9753
9759
  * ```javascript
9754
9760
  *
9755
- * sap.ui.xmlfragment([sId], sFragmentName, [oController]);
9761
+ * sap.ui.xmlfragment(sId?, sFragmentName, oController?);
9756
9762
  * ```
9757
- * The fragment instance ID is optional and will be used as prefix for the ID of all contained controls.
9758
- * If no ID is passed, controls will not be prefixed. The `sFragmentName` must correspond to an XML fragment
9759
- * which can be loaded via the module system (fragmentName + ".fragment.xml") and which defines the fragment.
9760
- * If `oController` is given, the methods referenced in the fragment will be called on this controller.
9761
9763
  *
9762
- * Note that fragments may require a controller to be given and certain methods to be available.
9763
9764
  *
9764
- * Advanced usage:: To instantiate a fragment and optionally directly give the XML definition instead of
9765
- * loading it from a file, call:
9765
+ * Advanced usage:
9766
9766
  * ```javascript
9767
9767
  *
9768
- * sap.ui.xmlfragment(oFragmentConfig, [oController]);
9768
+ * sap.ui.xmlfragment(oFragmentConfig, oController?);
9769
9769
  * ```
9770
- * The `oFragmentConfig` object can either have a `fragmentName` or a `fragmentContent` property, but not
9771
- * both. `fragmentContent` can hold the fragment definition as XML string; if not given, `fragmentName`
9772
- * must be given and the fragment content definition is loaded via the module system. Again, if `oController`
9773
- * is given, the methods referenced in the fragment will be called on this controller.
9770
+ * In addition to an `id`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
9771
+ * property, but not both.
9774
9772
  *
9775
- * @deprecated (since 1.58) - use {@link sap.ui.core.Fragment.load} instead
9773
+ * @deprecated (since 1.58) - Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
9776
9774
  *
9777
- * @returns the root Control(s) of the created fragment instance
9775
+ * @returns the instantiated root control(s) from the fragment content
9778
9776
  */
9779
9777
  function xmlfragment(
9780
9778
  /**
9781
- * ID of the newly created fragment
9782
- */
9783
- sId: string,
9784
- /**
9785
- * Resource name of the fragment; a module name in dot notation without the '.fragment.xml' suffix. Alternatively,
9786
- * a configuration object can be given with the properties described below. In this case, no `sId` may be
9787
- * given as first parameter, but as property `id` in the configuration object.
9779
+ * ID of the created fragment which will be used as prefix to all contained control IDs. If the first argument
9780
+ * is not an ID, it must be either the fragment name (`sFragmentName`) or a configuration object (`oFragmentConfig`)
9781
+ * as specified below
9788
9782
  */
9789
- vFragment:
9783
+ vId:
9790
9784
  | string
9791
9785
  | {
9792
9786
  /**
9793
- * ID of the newly created fragment; will be used as a prefix to all contained control IDs
9787
+ * ID of the created fragment which will be used as prefix to all contained control IDs
9794
9788
  */
9795
9789
  id?: string;
9796
9790
  /**
9797
- * Resource name of the fragment; a module name in dot notation without the '.fragment.html' suffix
9791
+ * definition of the fragment content as an XML string that will be used instead of loading the content
9792
+ * from a separate `.fragment.xml` file. When this property is given, any given fragment name is ignored
9798
9793
  */
9799
- fragmentName?: string;
9794
+ fragmentContent?: string;
9800
9795
  /**
9801
- * Definition of the fragment as an XML string
9796
+ * resource name of the fragment module in dot notation without the `.fragment.xml` suffix from the file
9797
+ * name
9802
9798
  */
9803
- fragmentContent?: string;
9799
+ fragmentName?: string;
9804
9800
  },
9805
9801
  /**
9806
- * A controller to be used for event handlers in the fragment; can either be the controller of an enclosing
9802
+ * resource name of the fragment module as specified by `vId.fragmentName` or, in the advanced usage case,
9803
+ * an optional `oController`
9804
+ */
9805
+ vFragment: string | sap.ui.core.mvc.Controller | object,
9806
+ /**
9807
+ * controller object to be used for methods or event handlers. Can be either the controller of an enclosing
9807
9808
  * view, a new controller instance, or a simple object with the necessary methods attached. Note that a
9808
- * fragment has no runtime representation besides its contained controls. There's therefore no API to retrieve
9809
- * the controller after creating a fragment
9809
+ * fragment has no runtime representation besides its contained controls. Therefore, there is no API to
9810
+ * retrieve the controller from the return value. Note also that fragments may require a controller to be
9811
+ * given and certain methods to be available
9810
9812
  */
9811
9813
  oController?: sap.ui.core.mvc.Controller | object
9812
9814
  ): sap.ui.core.Control | sap.ui.core.Control[];
9813
9815
  /**
9814
- * Instantiates an XML-based Fragment.
9816
+ * Loads and instantiates an XML-based fragment.
9815
9817
  *
9816
- * To instantiate a fragment, call:
9818
+ * To instantiate a fragment that is already defined separately, call:
9817
9819
  * ```javascript
9818
9820
  *
9819
- * sap.ui.xmlfragment([sId], sFragmentName, [oController]);
9821
+ * sap.ui.xmlfragment(sId?, sFragmentName, oController?);
9820
9822
  * ```
9821
- * The fragment instance ID is optional and will be used as prefix for the ID of all contained controls.
9822
- * If no ID is passed, controls will not be prefixed. The `sFragmentName` must correspond to an XML fragment
9823
- * which can be loaded via the module system (fragmentName + ".fragment.xml") and which defines the fragment.
9824
- * If `oController` is given, the methods referenced in the fragment will be called on this controller.
9825
9823
  *
9826
- * Note that fragments may require a controller to be given and certain methods to be available.
9827
9824
  *
9828
- * Advanced usage:: To instantiate a fragment and optionally directly give the XML definition instead of
9829
- * loading it from a file, call:
9825
+ * Advanced usage:
9830
9826
  * ```javascript
9831
9827
  *
9832
- * sap.ui.xmlfragment(oFragmentConfig, [oController]);
9828
+ * sap.ui.xmlfragment(oFragmentConfig, oController?);
9833
9829
  * ```
9834
- * The `oFragmentConfig` object can either have a `fragmentName` or a `fragmentContent` property, but not
9835
- * both. `fragmentContent` can hold the fragment definition as XML string; if not given, `fragmentName`
9836
- * must be given and the fragment content definition is loaded via the module system. Again, if `oController`
9837
- * is given, the methods referenced in the fragment will be called on this controller.
9830
+ * In addition to an `id`, the `oFragmentConfig` object can have either a `fragmentName` or a `fragmentContent`
9831
+ * property, but not both.
9838
9832
  *
9839
- * @deprecated (since 1.58) - use {@link sap.ui.core.Fragment.load} instead
9833
+ * @deprecated (since 1.58) - Refer to {@link topic:04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
9840
9834
  *
9841
- * @returns the root Control(s) of the created fragment instance
9835
+ * @returns the instantiated root control(s) from the fragment content
9842
9836
  */
9843
9837
  function xmlfragment(
9844
9838
  /**
9845
- * Resource name of the fragment; a module name in dot notation without the '.fragment.xml' suffix. Alternatively,
9846
- * a configuration object can be given with the properties described below. In this case, no `sId` may be
9847
- * given as first parameter, but as property `id` in the configuration object.
9839
+ * resource name of the fragment module as specified by `vId.fragmentName` or, in the advanced usage case,
9840
+ * an optional `oController`
9848
9841
  */
9849
- vFragment:
9850
- | string
9851
- | {
9852
- /**
9853
- * ID of the newly created fragment; will be used as a prefix to all contained control IDs
9854
- */
9855
- id?: string;
9856
- /**
9857
- * Resource name of the fragment; a module name in dot notation without the '.fragment.html' suffix
9858
- */
9859
- fragmentName?: string;
9860
- /**
9861
- * Definition of the fragment as an XML string
9862
- */
9863
- fragmentContent?: string;
9864
- },
9842
+ vFragment: string | sap.ui.core.mvc.Controller | object,
9865
9843
  /**
9866
- * A controller to be used for event handlers in the fragment; can either be the controller of an enclosing
9844
+ * controller object to be used for methods or event handlers. Can be either the controller of an enclosing
9867
9845
  * view, a new controller instance, or a simple object with the necessary methods attached. Note that a
9868
- * fragment has no runtime representation besides its contained controls. There's therefore no API to retrieve
9869
- * the controller after creating a fragment
9846
+ * fragment has no runtime representation besides its contained controls. Therefore, there is no API to
9847
+ * retrieve the controller from the return value. Note also that fragments may require a controller to be
9848
+ * given and certain methods to be available
9870
9849
  */
9871
9850
  oController?: sap.ui.core.mvc.Controller | object
9872
9851
  ): sap.ui.core.Control | sap.ui.core.Control[];
@@ -15083,7 +15062,7 @@ declare namespace sap {
15083
15062
  *
15084
15063
  * @returns Whether the given object is an instance of the given type or of any of the given types
15085
15064
  */
15086
- static isObjectA(
15065
+ static isObjectA<T extends sap.ui.base.Object = sap.ui.base.Object>(
15087
15066
  /**
15088
15067
  * Object which will be checked whether it is an instance of the given type
15089
15068
  */
@@ -15092,7 +15071,7 @@ declare namespace sap {
15092
15071
  * Type or types to check for
15093
15072
  */
15094
15073
  vTypeName: string | string[]
15095
- ): boolean;
15074
+ ): oObject is T;
15096
15075
  /**
15097
15076
  * Destructor method for objects.
15098
15077
  */
@@ -17822,9 +17801,10 @@ declare namespace sap {
17822
17801
  */
17823
17802
  format(
17824
17803
  /**
17825
- * The date to format
17804
+ * The date to format. If it is `null` or `undefined` only the timezone will be formatted, any other invalid
17805
+ * date is formatted as empty string.
17826
17806
  */
17827
- oJSDate: Date,
17807
+ oJSDate?: Date,
17828
17808
  /**
17829
17809
  * The IANA timezone ID in which the date will be calculated and formatted e.g. "America/New_York". If the
17830
17810
  * parameter is omitted, `null` or an empty string, the timezone will be taken from {@link module:sap/base/i18n/Localization.getTimezone Localization.getTimezone}.
@@ -18743,6 +18723,16 @@ declare namespace sap {
18743
18723
  * and {@link module:sap/base/i18n/Formatting.addCustomCurrencies Formatting.addCustomCurrencies}.
18744
18724
  */
18745
18725
  customCurrencies?: Record<string, object>;
18726
+ /**
18727
+ * The target length of places after the decimal separator; if the number has fewer decimal places than
18728
+ * given in this option, it is padded with whitespaces at the end up to the target length. An additional
18729
+ * whitespace character for the decimal separator is added for a number without any decimals. **Note:**
18730
+ * This format option is only allowed if the following conditions apply:
18731
+ * - It has a value greater than 0.
18732
+ * - The `FormatOptions.showMeasure` format option is set to `false`.
18733
+ * - The `oFormatOptions.style` format option is **not** set to `"short"` or `"long"`.
18734
+ */
18735
+ decimalPadding?: int;
18746
18736
  /**
18747
18737
  * defines the number of decimal digits
18748
18738
  */
@@ -18913,6 +18903,15 @@ declare namespace sap {
18913
18903
  * to the type and locale settings are used.
18914
18904
  */
18915
18905
  oFormatOptions?: {
18906
+ /**
18907
+ * The target length of places after the decimal separator; if the number has fewer decimal places than
18908
+ * given in this option, it is padded with whitespaces at the end up to the target length. An additional
18909
+ * whitespace character for the decimal separator is added for a number without any decimals. **Note:**
18910
+ * This format option is only allowed if the following conditions apply:
18911
+ * - It has a value greater than 0.
18912
+ * - The `oFormatOptions.style` format option is **not** set to `"short"` or `"long"`.
18913
+ */
18914
+ decimalPadding?: int;
18916
18915
  /**
18917
18916
  * defines the number of decimal digits
18918
18917
  */
@@ -19072,6 +19071,10 @@ declare namespace sap {
19072
19071
  * to the type and locale settings are used.
19073
19072
  */
19074
19073
  oFormatOptions?: {
19074
+ /**
19075
+ * Not supported.
19076
+ */
19077
+ decimalPadding?: int;
19075
19078
  /**
19076
19079
  * defines the number of decimal digits
19077
19080
  */
@@ -19226,6 +19229,10 @@ declare namespace sap {
19226
19229
  * to the type and locale settings are used.
19227
19230
  */
19228
19231
  oFormatOptions?: {
19232
+ /**
19233
+ * Not supported.
19234
+ */
19235
+ decimalPadding?: int;
19229
19236
  /**
19230
19237
  * defines the number of decimal digits
19231
19238
  */
@@ -19386,6 +19393,16 @@ declare namespace sap {
19386
19393
  * }}
19387
19394
  */
19388
19395
  customUnits?: Record<string, object>;
19396
+ /**
19397
+ * The target length of places after the decimal separator; if the number has fewer decimal places than
19398
+ * given in this option, it is padded with whitespaces at the end up to the target length. An additional
19399
+ * whitespace character for the decimal separator is added for a number without any decimals. **Note:**
19400
+ * This format option is only allowed if the following conditions apply:
19401
+ * - It has a value greater than 0.
19402
+ * - The `FormatOptions.showMeasure` format option is set to `false`.
19403
+ * - The `oFormatOptions.style` format option is **not** set to `"short"` or `"long"`.
19404
+ */
19405
+ decimalPadding?: int;
19389
19406
  /**
19390
19407
  * defines the number of decimal digits
19391
19408
  */
@@ -39899,11 +39916,11 @@ declare namespace sap {
39899
39916
  * Note that this method can only be called when the control already has a DOM representation (it has been
39900
39917
  * rendered before) and when the control still is assigned to a UIArea.
39901
39918
  *
39902
- * @deprecated (since 1.70) - using this method is no longer recommended, but still works. Synchronous DOM
39903
- * updates via this method have several drawbacks: they only work when the control has been rendered before
39904
- * (no initial rendering possible), multiple state changes won't be combined automatically into a single
39905
- * re-rendering, they might cause additional layout trashing, standard invalidation might cause another
39906
- * async re-rendering.
39919
+ * @deprecated (since 1.70) - using this method is no longer recommended, but calling it still causes a
39920
+ * re-rendering of the control. Synchronous DOM updates via this method have several drawbacks: they only
39921
+ * work when the control has been rendered before (no initial rendering possible), multiple state changes
39922
+ * won't be combined automatically into a single re-rendering, they might cause additional layout thrashing,
39923
+ * standard invalidation might cause another async re-rendering.
39907
39924
  *
39908
39925
  * The recommended alternative is to rely on invalidation and standard re-rendering.
39909
39926
  * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -41436,11 +41453,11 @@ declare namespace sap {
41436
41453
  /**
41437
41454
  * This triggers immediate rerendering of its parent and thus of itself and its children.
41438
41455
  *
41439
- * @deprecated (since 1.70) - using this method is no longer recommended, but still works. Synchronous DOM
41440
- * updates via this method have several drawbacks: they only work when the control has been rendered before
41441
- * (no initial rendering possible), multiple state changes won't be combined automatically into a single
41442
- * re-rendering, they might cause additional layout trashing, standard invalidation might cause another
41443
- * async re-rendering.
41456
+ * @deprecated (since 1.70) - using this method is no longer recommended, but calling it still causes a
41457
+ * re-rendering of the element. Synchronous DOM updates via this method have several drawbacks: they only
41458
+ * work when the control has been rendered before (no initial rendering possible), multiple state changes
41459
+ * won't be combined automatically into a single re-rendering, they might cause additional layout thrashing,
41460
+ * standard invalidation might cause another async re-rendering.
41444
41461
  *
41445
41462
  * The recommended alternative is to rely on invalidation and standard re-rendering.
41446
41463
  *
@@ -42019,19 +42036,26 @@ declare namespace sap {
42019
42036
  */
42020
42037
  static getMetadata(): sap.ui.base.ManagedObjectMetadata;
42021
42038
  /**
42022
- * Loads and instantiates a Fragment. A Promise is returned, which resolves with the Fragments content.
42039
+ * Loads and instantiates a fragment. Also refer to {@link https://ui5.sap.com/#/topic/04129b2798c447368f4c8922c3c33cd7 Instantiation of Fragments}.
42040
+ *
42041
+ * The fragment object itself is not an entity that has any further significance beyond this factory function.
42023
42042
  *
42024
- * The Fragment object itself is not an entity with significance beyond this factory.
42043
+ * A Promise is returned, which resolves with the fragment's content.
42025
42044
  *
42026
- * The Fragment types "XML", "JS" and "HTML" (type "HTML" is deprecated) are available by default; additional
42027
- * Fragment types can be added using the sap.ui.core.Fragment.registerType() function.
42045
+ * The Fragment types `"XML"`, `"JS"`, and `"HTML"` (type `"HTML"` is deprecated) are available by default.
42046
+ * Additional Fragment types can be implemented and added using the {@link sap.ui.core.Fragment.registerType }
42047
+ * function.
42028
42048
  *
42029
42049
  * Further properties may be supported by future or custom Fragment types. Any given properties will be
42030
42050
  * forwarded to the Fragment implementation.
42031
42051
  *
42032
- * If no fixed ID is given, the Fragment ID is generated. In any case, the Fragment ID will be used as prefix
42052
+ * If no fixed ID is given, the fragment ID is generated. In any case, the fragment ID will be used as prefix
42033
42053
  * for the IDs of all contained controls.
42034
42054
  *
42055
+ * **Note:** In case you are embedding a Fragment into an existing View, please also have a look at the
42056
+ * {@link sap.ui.core.mvc.Controller.loadFragment loadFragment} factory for a closer coupling to the corresponding
42057
+ * Controller instance.
42058
+ *
42035
42059
  * @since 1.58
42036
42060
  *
42037
42061
  * @returns a `Promise` resolving with the resulting control (array) after fragment parsing and instantiation
@@ -42042,34 +42066,34 @@ declare namespace sap {
42042
42066
  */
42043
42067
  mOptions: {
42044
42068
  /**
42045
- * must be supplied if no "definition" parameter is given. The Fragment name must correspond to an XML Fragment
42046
- * which can be loaded via the module system (fragmentName + suffix ".fragment.[typeextension]") and which
42047
- * contains the Fragment definition. If "mOptions.controller" is supplied, the (event handler-) methods
42048
- * referenced in the Fragment will be called on this Controller. Note that Fragments may require a Controller
42049
- * to be given and certain methods to be implemented by it.
42069
+ * must be supplied if no `definition` parameter is given. The fragment name must correspond to an XML fragment
42070
+ * which can be loaded via the module system (fragmentName + suffix `.fragment.<typeExtension>`)
42071
+ * and which contains the fragment definition. If `mOptions.controller` is supplied, the (event handler)
42072
+ * methods referenced in the fragment will be called on that controller. Note that fragments may require
42073
+ * a controller to be given and certain methods to be implemented by it.
42050
42074
  */
42051
42075
  name?: string;
42052
42076
  /**
42053
- * the Fragment type, e.g. "XML", "JS", or "HTML" (type "HTML" is deprecated). Default is "XML"
42077
+ * the fragment type, e.g. `"XML"`, `"JS"`, or `"HTML"` (type `"HTML"` is deprecated). Default is `"XML"`
42054
42078
  */
42055
42079
  type?: string;
42056
42080
  /**
42057
- * definition of the Fragment content. When this property is supplied, the "name" parameter must not be
42081
+ * definition of the fragment content. When this property is supplied, the `name` parameter must not be
42058
42082
  * used. If both are supplied, the definition has priority. Please see the above example on how to use the
42059
- * 'definition' parameter.
42083
+ * `definition` parameter.
42060
42084
  */
42061
42085
  definition?: string;
42062
42086
  /**
42063
- * the ID of the Fragment
42087
+ * the ID of the fragment
42064
42088
  */
42065
42089
  id?: string;
42066
42090
  /**
42067
- * the Controller or Object which should be used by the controls in the Fragment. Note that some Fragments
42068
- * may not need a Controller while others may need one and certain methods to be implemented by it.
42091
+ * the controller or object which should be used by the controls in the fragment. Note that some fragments
42092
+ * may not need a controller while others may need one and certain methods to be implemented by it.
42069
42093
  */
42070
- controller?: sap.ui.core.mvc.Controller | Object;
42094
+ controller?: sap.ui.core.mvc.Controller | object;
42071
42095
  /**
42072
- * The view containing the Fragment content. If the Fragment content contains ExtensionPoints this parameter
42096
+ * The view containing the fragment content. If the fragment content contains `ExtensionPoint`s, this parameter
42073
42097
  * must be given.
42074
42098
  */
42075
42099
  containingView?: sap.ui.core.mvc.View;
@@ -50453,7 +50477,7 @@ declare namespace sap {
50453
50477
  /**
50454
50478
  * The types of `Calendar`.
50455
50479
  *
50456
- * @deprecated (since 1.120) - Please use {@link module:sap/base/18n/date/CalendarType} instead.
50480
+ * @deprecated (since 1.120) - Please use {@link module:sap/base/i18n/date/CalendarType} instead.
50457
50481
  */
50458
50482
  enum CalendarType {
50459
50483
  /**
@@ -59011,6 +59035,8 @@ declare namespace sap {
59011
59035
  * Attach event handler `fnFunction` to the 'createActivate' event of this binding.
59012
59036
  *
59013
59037
  * @since 1.98.0
59038
+ *
59039
+ * @returns Reference to `this` in order to allow method chaining
59014
59040
  */
59015
59041
  attachCreateActivate(
59016
59042
  /**
@@ -59021,7 +59047,7 @@ declare namespace sap {
59021
59047
  * Object on which to call the given function
59022
59048
  */
59023
59049
  oListener?: object
59024
- ): void;
59050
+ ): this;
59025
59051
  /**
59026
59052
  * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry }
59027
59053
  * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
@@ -59092,6 +59118,8 @@ declare namespace sap {
59092
59118
  * Detach event handler `fnFunction` from the 'createActivate' event of this binding.
59093
59119
  *
59094
59120
  * @since 1.98.0
59121
+ *
59122
+ * @returns Reference to `this` in order to allow method chaining
59095
59123
  */
59096
59124
  detachCreateActivate(
59097
59125
  /**
@@ -59102,7 +59130,7 @@ declare namespace sap {
59102
59130
  * Object on which to call the given function
59103
59131
  */
59104
59132
  oListener?: object
59105
- ): void;
59133
+ ): this;
59106
59134
  /**
59107
59135
  * Filters the list.
59108
59136
  *
@@ -63207,7 +63235,7 @@ declare namespace sap {
63207
63235
  */
63208
63236
  collapse(
63209
63237
  /**
63210
- * Whether to collapse the node and all its descendants (@experimental as of version 1.128.0)
63238
+ * Whether to collapse the node and all its descendants (since 1.132.0)
63211
63239
  */
63212
63240
  bAll?: boolean
63213
63241
  ): void;
@@ -63315,8 +63343,8 @@ declare namespace sap {
63315
63343
  */
63316
63344
  destroy(): void;
63317
63345
  /**
63318
- * Expands the group node that this context points to. Since 1.127.0, it is possible to expand a group node
63319
- * by a given number of levels.
63346
+ * Expands the group node that this context points to. Since 1.132.0, it is possible to do a full expand,
63347
+ * that is to expand all levels below a node, even if a node is already partially or fully expanded.
63320
63348
  * See:
63321
63349
  * #collapse
63322
63350
  * #isExpanded
@@ -63328,11 +63356,9 @@ declare namespace sap {
63328
63356
  */
63329
63357
  expand(
63330
63358
  /**
63331
- * The number of levels to expand (@experimental as of version 1.127.0), `iLevels >= Number.MAX_SAFE_INTEGER`
63332
- * can be used to expand all levels. If a node is expanded a second time, the expand state of the descendants
63333
- * is not changed.
63359
+ * Whether to expand the node and all its descendants (since 1.132.0)
63334
63360
  */
63335
- iLevels?: number
63361
+ bAll?: boolean
63336
63362
  ): Promise<void>;
63337
63363
  /**
63338
63364
  * Returns the binding this context belongs to.
@@ -63710,9 +63736,8 @@ declare namespace sap {
63710
63736
  * @since 1.122.0
63711
63737
  *
63712
63738
  * @returns A promise which:
63713
- * - Resolves if successful with either the parent node or `null` for a root node that has no parent
63714
- *
63715
- * - Rejects with an `Error` instance otherwise
63739
+ * Resolves if successful with either the parent node or `null` for a root node that has no parent
63740
+ * Rejects with an `Error` instance otherwise
63716
63741
  */
63717
63742
  requestParent(): Promise<sap.ui.model.odata.v4.Context | null>;
63718
63743
  /**
@@ -64365,7 +64390,8 @@ declare namespace sap {
64365
64390
  sGroupId?: string,
64366
64391
  /**
64367
64392
  * Whether the entity's ETag should be actively ignored (If-Match:*); supported for bound actions only,
64368
- * since 1.90.0. Ignored if there is no ETag (since 1.93.0).
64393
+ * since 1.90.0. This parameter is ignored if there is no ETag (since 1.93.0) unless no data has been read
64394
+ * so far (since 1.132.0).
64369
64395
  */
64370
64396
  bIgnoreETag?: boolean,
64371
64397
  /**
@@ -65492,7 +65518,9 @@ declare namespace sap {
65492
65518
  group?: object;
65493
65519
  /**
65494
65520
  * A list of groupable property names used to determine group levels. They may, but don't need to, be repeated
65495
- * in `oAggregation.group`. Group levels cannot be combined with:
65521
+ * in `oAggregation.group`. Since 1.132.0, the last group level is interpreted as the leaf level in case
65522
+ * there are no other groups than those given here. In that case, {@link #getAggregation} returns a shorter
65523
+ * `groupLevels` list. Group levels cannot be combined with:
65496
65524
  * filtering for aggregated properties, "$search" (since 1.93.0), the `vGroup` parameter of
65497
65525
  * {@link sap.ui.model.Sorter} (since 1.107.0), shared requests (since 1.108.0).
65498
65526
  */
@@ -66349,7 +66377,9 @@ declare namespace sap {
66349
66377
  * via {@link sap.ui.model.odata.v4.ODataModel#getHttpHeaders} from this meta model's data model. Since
66350
66378
  * 1.80.0, that model's parameter "sharedRequests" is set automatically (see {@link sap.ui.model.odata.v4.ODataModel#constructor}).
66351
66379
  * If the value list model is the data model associated with this meta model, use the binding-specific parameter
66352
- * "$$sharedRequest" instead, see {@link sap.ui.model.odata.v4.ODataModel#bindList}.
66380
+ * "$$sharedRequest" instead, see {@link sap.ui.model.odata.v4.ODataModel#bindList}. Since 1.132.0, the
66381
+ * data model's {@link sap.ui.model.odata.v4.ODataModel#setRetryAfterHandler "Retry-After" handler} is reused
66382
+ * by default, but can of course be overwritten.
66353
66383
  *
66354
66384
  * For fixed values, only one mapping is expected and the qualifier is ignored. The mapping is available
66355
66385
  * with key "" and has an additional property "$qualifier" which is the original qualifier (useful in case
@@ -74153,6 +74183,11 @@ declare namespace sap {
74153
74183
  * parameter is not set manually.
74154
74184
  */
74155
74185
  oFormatOptions?: {
74186
+ /**
74187
+ * The number of decimals to be used for formatting the number part of the unit; defaults to **3** if none
74188
+ * of the format options `maxFractionDigits`, `minFractionDigits` or `decimals` is given
74189
+ */
74190
+ decimals?: object;
74156
74191
  /**
74157
74192
  * By default decimals are preserved, unless `oFormatOptions.style` is given as "short" or "long"; since
74158
74193
  * 1.89.0
@@ -74580,6 +74615,8 @@ declare namespace sap {
74580
74615
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
74581
74616
  *
74582
74617
  * @ui5-protected Do not call from applications (only from related classes in the framework)
74618
+ *
74619
+ * @returns Reference to `this` in order to allow method chaining
74583
74620
  */
74584
74621
  attachAggregatedDataStateChange(
74585
74622
  /**
@@ -74590,12 +74627,15 @@ declare namespace sap {
74590
74627
  * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
74591
74628
  */
74592
74629
  oListener?: object
74593
- ): void;
74630
+ ): this;
74594
74631
  /**
74595
74632
  * Attaches the `fnFunction` event handler to the {@link #event:change change} event of this `sap.ui.model.Model`.
74596
74633
  *
74597
74634
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
74598
74635
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
74636
+ *
74637
+ *
74638
+ * @returns Reference to `this` in order to allow method chaining
74599
74639
  */
74600
74640
  attachChange(
74601
74641
  /**
@@ -74606,12 +74646,15 @@ declare namespace sap {
74606
74646
  * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
74607
74647
  */
74608
74648
  oListener?: object
74609
- ): void;
74649
+ ): this;
74610
74650
  /**
74611
74651
  * Attaches event handler `fnFunction` to the {@link #event:dataReceived dataReceived} event of this `sap.ui.model.Binding`.
74612
74652
  *
74613
74653
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
74614
74654
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
74655
+ *
74656
+ *
74657
+ * @returns Reference to `this` in order to allow method chaining
74615
74658
  */
74616
74659
  attachDataReceived(
74617
74660
  /**
@@ -74622,12 +74665,15 @@ declare namespace sap {
74622
74665
  * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
74623
74666
  */
74624
74667
  oListener?: object
74625
- ): void;
74668
+ ): this;
74626
74669
  /**
74627
74670
  * Attaches event handler `fnFunction` to the {@link #event:dataRequested dataRequested} event of this `sap.ui.model.Binding`.
74628
74671
  *
74629
74672
  * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
74630
74673
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
74674
+ *
74675
+ *
74676
+ * @returns Reference to `this` in order to allow method chaining
74631
74677
  */
74632
74678
  attachDataRequested(
74633
74679
  /**
@@ -74638,7 +74684,7 @@ declare namespace sap {
74638
74684
  * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
74639
74685
  */
74640
74686
  oListener?: object
74641
- ): void;
74687
+ ): this;
74642
74688
  /**
74643
74689
  * Attaches the `fnFunction` event handler to the {@link #event:DataStateChange DataStateChange} event of
74644
74690
  * thi `sap.ui.model.Binding`.
@@ -74647,6 +74693,8 @@ declare namespace sap {
74647
74693
  * otherwise it will be bound to this `sap.ui.model.Binding` itself.
74648
74694
  *
74649
74695
  * @ui5-protected Do not call from applications (only from related classes in the framework)
74696
+ *
74697
+ * @returns Reference to `this` in order to allow method chaining
74650
74698
  */
74651
74699
  attachDataStateChange(
74652
74700
  /**
@@ -74657,7 +74705,7 @@ declare namespace sap {
74657
74705
  * Context object to call the event handler with; defaults to this `sap.ui.model.Binding` itself
74658
74706
  */
74659
74707
  oListener?: object
74660
- ): void;
74708
+ ): this;
74661
74709
  /**
74662
74710
  * Attach multiple events.
74663
74711
  *
@@ -74683,6 +74731,8 @@ declare namespace sap {
74683
74731
  * event of this `sap.ui.model.Binding`.
74684
74732
  *
74685
74733
  * @ui5-protected Do not call from applications (only from related classes in the framework)
74734
+ *
74735
+ * @returns Reference to `this` in order to allow method chaining
74686
74736
  */
74687
74737
  detachAggregatedDataStateChange(
74688
74738
  /**
@@ -74693,9 +74743,12 @@ declare namespace sap {
74693
74743
  * Context object on which the given function had to be called
74694
74744
  */
74695
74745
  oListener?: object
74696
- ): void;
74746
+ ): this;
74697
74747
  /**
74698
74748
  * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.model.Binding`.
74749
+ *
74750
+ *
74751
+ * @returns Reference to `this` in order to allow method chaining
74699
74752
  */
74700
74753
  detachChange(
74701
74754
  /**
@@ -74706,9 +74759,12 @@ declare namespace sap {
74706
74759
  * Context object on which the given function had to be called
74707
74760
  */
74708
74761
  oListener?: object
74709
- ): void;
74762
+ ): this;
74710
74763
  /**
74711
74764
  * Detaches event handler `fnFunction` from the {@link #event:dataReceived dataReceived} event of this `sap.ui.model.Binding`.
74765
+ *
74766
+ *
74767
+ * @returns Reference to `this` in order to allow method chaining
74712
74768
  */
74713
74769
  detachDataReceived(
74714
74770
  /**
@@ -74719,10 +74775,13 @@ declare namespace sap {
74719
74775
  * Context object on which the given function had to be called
74720
74776
  */
74721
74777
  oListener?: object
74722
- ): void;
74778
+ ): this;
74723
74779
  /**
74724
74780
  * Detaches event handler `fnFunction` from the {@link #event:dataRequested dataRequested} event of this
74725
74781
  * `sap.ui.model.Binding`.
74782
+ *
74783
+ *
74784
+ * @returns Reference to `this` in order to allow method chaining
74726
74785
  */
74727
74786
  detachDataRequested(
74728
74787
  /**
@@ -74733,12 +74792,14 @@ declare namespace sap {
74733
74792
  * Context object on which the given function had to be called
74734
74793
  */
74735
74794
  oListener?: object
74736
- ): void;
74795
+ ): this;
74737
74796
  /**
74738
74797
  * Detaches event handler `fnFunction` from the {@link #event:DataStateChange DataStateChange} event of
74739
74798
  * this `sap.ui.model.Binding`.
74740
74799
  *
74741
74800
  * @ui5-protected Do not call from applications (only from related classes in the framework)
74801
+ *
74802
+ * @returns Reference to `this` in order to allow method chaining
74742
74803
  */
74743
74804
  detachDataStateChange(
74744
74805
  /**
@@ -74749,7 +74810,7 @@ declare namespace sap {
74749
74810
  * Context object on which the given function had to be called
74750
74811
  */
74751
74812
  oListener?: object
74752
- ): void;
74813
+ ): this;
74753
74814
  /**
74754
74815
  * Detach multiple events.
74755
74816
  *
@@ -75599,6 +75660,8 @@ declare namespace sap {
75599
75660
  * as parameter of the event contains all changes that were applied to the `DataState` in the running thread.
75600
75661
  *
75601
75662
  * @ui5-protected Do not call from applications (only from related classes in the framework)
75663
+ *
75664
+ * @returns Reference to `this` in order to allow method chaining
75602
75665
  */
75603
75666
  attachAggregatedDataStateChange(
75604
75667
  /**
@@ -75609,7 +75672,7 @@ declare namespace sap {
75609
75672
  * Object on which to call the given function
75610
75673
  */
75611
75674
  oListener?: object
75612
- ): void;
75675
+ ): this;
75613
75676
  /**
75614
75677
  * Attaches event handler `fnFunction` to the `change` event of this `sap.ui.model.CompositeBinding`.
75615
75678
  *
@@ -75617,6 +75680,8 @@ declare namespace sap {
75617
75680
  * otherwise it will be bound to this `sap.ui.model.CompositeBinding` itself.
75618
75681
  *
75619
75682
  * @ui5-protected Do not call from applications (only from related classes in the framework)
75683
+ *
75684
+ * @returns Reference to `this` in order to allow method chaining
75620
75685
  */
75621
75686
  attachChange(
75622
75687
  /**
@@ -75627,7 +75692,7 @@ declare namespace sap {
75627
75692
  * Object on which to call the given function
75628
75693
  */
75629
75694
  oListener?: object
75630
- ): void;
75695
+ ): this;
75631
75696
  /**
75632
75697
  * Attaches event handler `fnFunction` to the `DataStateChange` event of this `sap.ui.model.CompositeBinding`.
75633
75698
  *
@@ -75635,6 +75700,8 @@ declare namespace sap {
75635
75700
  * otherwise it will be bound to this `sap.ui.model.CompositeBinding` itself.
75636
75701
  *
75637
75702
  * @ui5-protected Do not call from applications (only from related classes in the framework)
75703
+ *
75704
+ * @returns Reference to `this` in order to allow method chaining
75638
75705
  */
75639
75706
  attachDataStateChange(
75640
75707
  /**
@@ -75645,11 +75712,13 @@ declare namespace sap {
75645
75712
  * Object on which to call the given function
75646
75713
  */
75647
75714
  oListener?: object
75648
- ): void;
75715
+ ): this;
75649
75716
  /**
75650
75717
  * Detaches event handler `fnFunction` from the `AggregatedDataStateChange` event of this `sap.ui.model.CompositeBinding`.
75651
75718
  *
75652
75719
  * @ui5-protected Do not call from applications (only from related classes in the framework)
75720
+ *
75721
+ * @returns Reference to `this` in order to allow method chaining
75653
75722
  */
75654
75723
  detachAggregatedDataStateChange(
75655
75724
  /**
@@ -75660,11 +75729,13 @@ declare namespace sap {
75660
75729
  * Object on which to call the given function
75661
75730
  */
75662
75731
  oListener?: object
75663
- ): void;
75732
+ ): this;
75664
75733
  /**
75665
75734
  * Detaches event handler `fnFunction` from the `change` event of this `sap.ui.model.CompositeBinding`.
75666
75735
  *
75667
75736
  * @ui5-protected Do not call from applications (only from related classes in the framework)
75737
+ *
75738
+ * @returns Reference to `this` in order to allow method chaining
75668
75739
  */
75669
75740
  detachChange(
75670
75741
  /**
@@ -75675,11 +75746,13 @@ declare namespace sap {
75675
75746
  * Object on which to call the given function
75676
75747
  */
75677
75748
  oListener?: object
75678
- ): void;
75749
+ ): this;
75679
75750
  /**
75680
75751
  * Detaches event handler `fnFunction` from the `DataStateChange` event of this `sap.ui.model.CompositeBinding`.
75681
75752
  *
75682
75753
  * @ui5-protected Do not call from applications (only from related classes in the framework)
75754
+ *
75755
+ * @returns Reference to `this` in order to allow method chaining
75683
75756
  */
75684
75757
  detachDataStateChange(
75685
75758
  /**
@@ -75690,7 +75763,7 @@ declare namespace sap {
75690
75763
  * Object on which to call the given function
75691
75764
  */
75692
75765
  oListener?: object
75693
- ): void;
75766
+ ): this;
75694
75767
  /**
75695
75768
  * Returns the property bindings contained in this composite binding.
75696
75769
  *
@@ -80227,6 +80300,10 @@ declare namespace sap {
80227
80300
  * The version of the operating system as `float`.
80228
80301
  *
80229
80302
  * Might be `-1` if no version can reliably be determined.
80303
+ *
80304
+ * **Note:** The property `version` may not contain the correct version for Windows 11 onwards, depending
80305
+ * on the point in time, the property is accessed or the browser's capability to provide the version. In
80306
+ * this case the `version` property may contain `10`.
80230
80307
  */
80231
80308
  export const version: float;
80232
80309
 
@@ -80234,6 +80311,10 @@ declare namespace sap {
80234
80311
  * The version of the operating system as `string`.
80235
80312
  *
80236
80313
  * Might be empty if no version can reliably be determined.
80314
+ *
80315
+ * **Note:** The property `versionStr` may not contain the correct version for Windows 11 onwards, depending
80316
+ * on the point in time, the property is accessed or the browser's capability to provide the version. In
80317
+ * this case the `versionStr` property may contain `10`.
80237
80318
  */
80238
80319
  export const versionStr: string;
80239
80320