@sapui5/ts-types 1.148.1 → 1.149.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 (66) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.esh.search.ui.d.ts +4 -4
  7. package/types/sap.f.d.ts +1 -1
  8. package/types/sap.fe.ariba.d.ts +1 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +1 -1
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +17 -17
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +19 -5
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +1 -1
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +56 -2
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +26 -4
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +3 -1
  30. package/types/sap.suite.ui.commons.d.ts +48 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  32. package/types/sap.suite.ui.microchart.d.ts +45 -1
  33. package/types/sap.tnt.d.ts +83 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +41 -10
  37. package/types/sap.ui.core.d.ts +308 -387
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +1 -1
  41. package/types/sap.ui.generic.app.d.ts +1 -1
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.geomap.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/sap.ui.mdc.d.ts +39 -2
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -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 +10 -1
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +687 -1
  54. package/types/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 +1 -1
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.uiext.inbox.d.ts +1 -1
  59. package/types/sap.ushell.d.ts +337 -1
  60. package/types/sap.ushell_abap.d.ts +1 -1
  61. package/types/sap.uxap.d.ts +1 -1
  62. package/types/sap.viz.d.ts +1 -1
  63. package/types/sap.webanalytics.core.d.ts +1 -1
  64. package/types/sap.zen.commons.d.ts +1 -1
  65. package/types/sap.zen.crosstab.d.ts +1 -1
  66. 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.148.0
282
+ // For Library Version: 1.149.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -18802,6 +18802,184 @@ declare namespace sap {
18802
18802
  */
18803
18803
  TOWARDS_ZERO = "TOWARDS_ZERO",
18804
18804
  }
18805
+ /**
18806
+ * The format options for floating-point numbers.
18807
+ */
18808
+ type FloatFormatOptions =
18809
+ sap.ui.core.format.NumberFormat.FormatOptions & {
18810
+ /**
18811
+ * The target length of places after the decimal separator; if the number has fewer decimal places than
18812
+ * given in this option, it is padded with whitespaces at the end up to the target length. An additional
18813
+ * whitespace character for the decimal separator is added for a number without any decimals. **Note:**
18814
+ * This format option is only allowed if the following conditions apply:
18815
+ * - It has a value greater than 0.
18816
+ * - The `oFormatOptions.style` format option is **not** set to `"short"` or `"long"`.
18817
+ */
18818
+ decimalPadding?: int;
18819
+ /**
18820
+ * The minimal number of decimal digits.
18821
+ */
18822
+ minFractionDigits?: int;
18823
+ /**
18824
+ * The maximum number of digits in the formatted representation of a number; if the `precision` is less
18825
+ * than the overall length of the number, its fractional part is truncated through rounding. As the `precision`
18826
+ * only affects the rounding of a number, its integer part can retain more digits than defined by this parameter.
18827
+ * **Example:** With a `precision` of 2, `234.567` is formatted to `235`. **Note:** The formatted output
18828
+ * may differ depending on locale.
18829
+ */
18830
+ precision?: int;
18831
+ /**
18832
+ * The style of format. Valid values are based on the CLDR `decimalFormat`. When set to `short` or `long`,
18833
+ * numbers are formatted into compact forms. When this option is set, the default value of the `precision`
18834
+ * option is set to `2`. This can be changed by setting either `min/maxFractionDigits`, `decimals`, `shortDecimals`,
18835
+ * or the `precision` option itself.
18836
+ */
18837
+ style?: "short" | "long" | "standard";
18838
+ };
18839
+
18840
+ /**
18841
+ * The base type for the numeric format options.
18842
+ */
18843
+ type FormatOptions = {
18844
+ /**
18845
+ * The number of decimal digits.
18846
+ */
18847
+ decimals?: int;
18848
+ /**
18849
+ * The character used as decimal separator. If none is given, the locale-specific decimal separator is used.
18850
+ * **Note:** `decimalSeparator` must always be different from `groupingSeparator`.
18851
+ */
18852
+ decimalSeparator?: string;
18853
+ /**
18854
+ * Since 1.130.0. Defines what value an empty string is parsed into and what value is formatted as an empty
18855
+ * string. The {@link #format} and {@link #parse} functions are done in a symmetric way. For example, when
18856
+ * this parameter is set to `NaN`, an empty string is parsed as `NaN`, and `NaN` is formatted as an empty
18857
+ * string.
18858
+ */
18859
+ emptyString?: null | number | string;
18860
+ /**
18861
+ * The grouping base size in digits if it is different from the grouping size (e.g. Indian grouping).
18862
+ */
18863
+ groupingBaseSize?: int;
18864
+ /**
18865
+ * Whether grouping is enabled (grouping separators are shown). **Note:** Grouping is disabled if the `groupingSize`
18866
+ * format option is set to a non-positive value.
18867
+ */
18868
+ groupingEnabled?: boolean;
18869
+ /**
18870
+ * The character used as grouping separator. If none is given, the locale-specific grouping separator is
18871
+ * used. **Note:** `groupingSeparator` must always be different from `decimalSeparator`.
18872
+ */
18873
+ groupingSeparator?: string;
18874
+ /**
18875
+ * The grouping size in digits. **Note:** Grouping is disabled if this format option is set to a non-positive
18876
+ * value.
18877
+ */
18878
+ groupingSize?: int;
18879
+ /**
18880
+ * The maximum number of decimal digits.
18881
+ */
18882
+ maxFractionDigits?: int;
18883
+ /**
18884
+ * The maximum number of non-decimal digits.
18885
+ */
18886
+ maxIntegerDigits?: int;
18887
+ /**
18888
+ * The minimal number of non-decimal digits.
18889
+ */
18890
+ minIntegerDigits?: int;
18891
+ /**
18892
+ * The symbol for the minus sign. If none is given, the locale-specific minus sign is used.
18893
+ */
18894
+ minusSign?: string;
18895
+ /**
18896
+ * Since 1.28.2, whether to parse the number as a string in order to keep the precision for big numbers.
18897
+ * Numbers in scientific notation are parsed back to standard notation. For example, `5e-3` is parsed to
18898
+ * `0.005`.
18899
+ */
18900
+ parseAsString?: boolean;
18901
+ /**
18902
+ * The CLDR number pattern which is used to format a number. If none is given, the default pattern for the
18903
+ * locale and type is used.
18904
+ */
18905
+ pattern?: string;
18906
+ /**
18907
+ * The symbol for the plus sign. If none is given, the locale-specific plus sign is used.
18908
+ */
18909
+ plusSign?: string;
18910
+ /**
18911
+ * Whether {@link #format} preserves decimal digits except trailing zeros if there are more decimals than
18912
+ * the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number is
18913
+ * rounded to `maxFractionDigits`.
18914
+ */
18915
+ preserveDecimals?: boolean;
18916
+ /**
18917
+ * Defines how numbers are rounded when the number of fraction digits exceeds the value of `maxFractionDigits`.
18918
+ * The rounding behavior of the formatter can be defined in the following ways:
18919
+ * - Setting this format option to a value from the {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode }
18920
+ * enum
18921
+ * - Setting this format option to a function used for rounding the number. The function must take two
18922
+ * parameters: the number itself, and the number of decimal digits that should be preserved. String-based
18923
+ * numbers are not rounded by this custom function. **Deprecated as of version 1.121.0; apply rounding by
18924
+ * specifying a rounding mode instead.**
18925
+ */
18926
+ roundingMode?:
18927
+ | sap.ui.core.format.NumberFormat.RoundingMode
18928
+ | Function;
18929
+ /**
18930
+ * The number of decimals in the shortened format string. If this option isn't specified, the `decimals`
18931
+ * option is used instead.
18932
+ */
18933
+ shortDecimals?: int;
18934
+ /**
18935
+ * A limit above which only short number formatting is used.
18936
+ */
18937
+ shortLimit?: int;
18938
+ /**
18939
+ * Since 1.40, specifies a number from which the scale factor for the `short` or `long` style format is
18940
+ * generated. The generated scale factor is used for all numbers which are formatted with this format instance.
18941
+ * This option only takes effect when the `style` option is set to `short` or `long`. It is set to `undefined`
18942
+ * by default, which means that the scale factor is selected automatically for each number being formatted.
18943
+ */
18944
+ shortRefNumber?: int;
18945
+ /**
18946
+ * Since 1.40, specifies whether the scale factor is shown in the formatted number. This option takes effect
18947
+ * only when the `style` option is set to either `short` or `long`.
18948
+ */
18949
+ showScale?: boolean;
18950
+ /**
18951
+ * Whether the positions of grouping separators are validated. Space characters used as grouping separators
18952
+ * are not validated.
18953
+ */
18954
+ strictGroupingValidation?: boolean;
18955
+ };
18956
+
18957
+ /**
18958
+ * The format options for integer numbers.
18959
+ */
18960
+ type IntegerFormatOptions =
18961
+ sap.ui.core.format.NumberFormat.FormatOptions & {
18962
+ /**
18963
+ * The minimal number of decimal digits.
18964
+ */
18965
+ minFractionDigits?: int;
18966
+ /**
18967
+ * **Note:** Only considered if the number format leads to a representation with decimal places, e.g. if
18968
+ * the option `style: "short"` is set. The maximum number of digits in the formatted representation of a
18969
+ * number; if the `precision` is less than the overall length of the number, its fractional part is truncated
18970
+ * through rounding. As the `precision` only affects the rounding of a number, its integer part can retain
18971
+ * more digits than defined by this parameter. **Example:** With a `precision` of 2 and `style: "short"`,
18972
+ * `234567` is formatted to `"235K"`.
18973
+ */
18974
+ precision?: int;
18975
+ /**
18976
+ * The style of format. Valid values are based on the CLDR `decimalFormat`. When set to `short` or `long`,
18977
+ * numbers are formatted into compact forms. When this option is set, the default value of the `precision`
18978
+ * option is set to `2`. This can be changed by setting either `min/maxFractionDigits`, `decimals`, `shortDecimals`,
18979
+ * or the `precision` option itself.
18980
+ */
18981
+ style?: "short" | "long" | "standard";
18982
+ };
18805
18983
  }
18806
18984
 
18807
18985
  /**
@@ -19798,143 +19976,7 @@ declare namespace sap {
19798
19976
  * The option object, which supports the following parameters. If no options are given, default values according
19799
19977
  * to the type and locale settings are used.
19800
19978
  */
19801
- oFormatOptions?: {
19802
- /**
19803
- * The target length of places after the decimal separator; if the number has fewer decimal places than
19804
- * given in this option, it is padded with whitespaces at the end up to the target length. An additional
19805
- * whitespace character for the decimal separator is added for a number without any decimals. **Note:**
19806
- * This format option is only allowed if the following conditions apply:
19807
- * - It has a value greater than 0.
19808
- * - The `oFormatOptions.style` format option is **not** set to `"short"` or `"long"`.
19809
- */
19810
- decimalPadding?: int;
19811
- /**
19812
- * defines the number of decimal digits
19813
- */
19814
- decimals?: int;
19815
- /**
19816
- * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
19817
- * `groupingSeparator`.
19818
- */
19819
- decimalSeparator?: string;
19820
- /**
19821
- * since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
19822
- * allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
19823
- * in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as NaN,
19824
- * and NaN is formatted as an empty string.
19825
- */
19826
- emptyString?: null | number | string;
19827
- /**
19828
- * defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
19829
- */
19830
- groupingBaseSize?: int;
19831
- /**
19832
- * defines whether grouping is enabled (grouping separators are shown). **Note:** Grouping is disabled if
19833
- * the `groupingSize` format option is set to a non-positive value.
19834
- */
19835
- groupingEnabled?: boolean;
19836
- /**
19837
- * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
19838
- * from `decimalSeparator`.
19839
- */
19840
- groupingSeparator?: string;
19841
- /**
19842
- * defines the grouping size in digits; the default is `3`. **Note:** If this format option is set to a
19843
- * non-positive value, grouping will be disabled entirely.
19844
- */
19845
- groupingSize?: int;
19846
- /**
19847
- * defines the maximum number of decimal digits
19848
- */
19849
- maxFractionDigits?: int;
19850
- /**
19851
- * defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
19852
- * characters are shown instead of digits.
19853
- */
19854
- maxIntegerDigits?: int;
19855
- /**
19856
- * defines the minimal number of decimal digits
19857
- */
19858
- minFractionDigits?: int;
19859
- /**
19860
- * defines the minimal number of non-decimal digits
19861
- */
19862
- minIntegerDigits?: int;
19863
- /**
19864
- * defines the used minus symbol
19865
- */
19866
- minusSign?: string;
19867
- /**
19868
- * since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
19869
- * for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
19870
- * is parsed to "0.005".
19871
- */
19872
- parseAsString?: boolean;
19873
- /**
19874
- * CLDR number pattern which is used to format the number
19875
- */
19876
- pattern?: string;
19877
- /**
19878
- * defines the used plus symbol
19879
- */
19880
- plusSign?: string;
19881
- /**
19882
- * The maximum number of digits in the formatted representation of a number; if the `precision` is less
19883
- * than the overall length of the number, its fractional part is truncated through rounding. As the `precision`
19884
- * only affects the rounding of a number, its integer part can retain more digits than defined by this parameter.
19885
- * **Example:** With a `precision` of 2, `234.567` is formatted to `235`. **Note:** The formatted output
19886
- * may differ depending on locale.
19887
- */
19888
- precision?: int;
19889
- /**
19890
- * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
19891
- * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
19892
- * is rounded to `maxFractionDigits`.
19893
- */
19894
- preserveDecimals?: boolean;
19895
- /**
19896
- * Specifies the rounding behavior for discarding the digits after the maximum fraction digits defined by
19897
- * `maxFractionDigits`. This can be assigned
19898
- * - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
19899
- * - via a function that is used for rounding the number and takes two parameters: the number itself,
19900
- * and the number of decimal digits that should be reserved. **Using a function is deprecated since 1.121.0**;
19901
- * string based numbers are not rounded via this custom function.
19902
- */
19903
- roundingMode?: sap.ui.core.format.NumberFormat.RoundingMode;
19904
- /**
19905
- * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
19906
- * options is used
19907
- */
19908
- shortDecimals?: int;
19909
- /**
19910
- * only use short number formatting for values above this limit
19911
- */
19912
- shortLimit?: int;
19913
- /**
19914
- * since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
19915
- * The generated scale factor is used for all numbers which are formatted with this format instance. This
19916
- * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
19917
- * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
19918
- */
19919
- shortRefNumber?: int;
19920
- /**
19921
- * since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
19922
- * only when the 'style' options is set to either 'short' or 'long'.
19923
- */
19924
- showScale?: boolean;
19925
- /**
19926
- * whether the positions of grouping separators are validated. Space characters used as grouping separators
19927
- * are not validated.
19928
- */
19929
- strictGroupingValidation?: boolean;
19930
- /**
19931
- * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on the CLDR decimalFormat).
19932
- * When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
19933
- * default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
19934
- * decimals, shortDecimals, or the 'precision' option itself.
19935
- */
19936
- style?: string;
19937
- },
19979
+ oFormatOptions?: sap.ui.core.format.NumberFormat.FloatFormatOptions,
19938
19980
  /**
19939
19981
  * The locale to get the formatter for; if no locale is given, a locale for the currently configured language
19940
19982
  * is used; see {@link module:sap/base/i18n/Formatting.getLanguageTag Formatting.getLanguageTag}
@@ -19968,139 +20010,7 @@ declare namespace sap {
19968
20010
  * The option object, which supports the following parameters. If no options are given, default values according
19969
20011
  * to the type and locale settings are used.
19970
20012
  */
19971
- oFormatOptions?: {
19972
- /**
19973
- * Not supported.
19974
- */
19975
- decimalPadding?: int;
19976
- /**
19977
- * defines the number of decimal digits
19978
- */
19979
- decimals?: int;
19980
- /**
19981
- * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
19982
- * `groupingSeparator`.
19983
- */
19984
- decimalSeparator?: string;
19985
- /**
19986
- * since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
19987
- * allowed values are "" (empty string) NaN, `null`, or 0. The 'format' and 'parse' functions are done in
19988
- * a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as NaN, and
19989
- * NaN is formatted as an empty string.
19990
- */
19991
- emptyString?: null | number | string;
19992
- /**
19993
- * defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
19994
- */
19995
- groupingBaseSize?: int;
19996
- /**
19997
- * defines whether grouping is enabled (grouping separators are shown). **Note:** Grouping is disabled if
19998
- * the `groupingSize` format option is set to a non-positive value.
19999
- */
20000
- groupingEnabled?: boolean;
20001
- /**
20002
- * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
20003
- * from `decimalSeparator`.
20004
- */
20005
- groupingSeparator?: string;
20006
- /**
20007
- * defines the grouping size in digits; the default is `3`. **Note:** If this format option is set to a
20008
- * non-positive value, grouping will be disabled entirely.
20009
- */
20010
- groupingSize?: int;
20011
- /**
20012
- * defines the maximum number of decimal digits
20013
- */
20014
- maxFractionDigits?: int;
20015
- /**
20016
- * defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
20017
- * characters are shown instead of digits.
20018
- */
20019
- maxIntegerDigits?: int;
20020
- /**
20021
- * defines the minimal number of decimal digits
20022
- */
20023
- minFractionDigits?: int;
20024
- /**
20025
- * defines the minimal number of non-decimal digits
20026
- */
20027
- minIntegerDigits?: int;
20028
- /**
20029
- * defines the used minus symbol
20030
- */
20031
- minusSign?: string;
20032
- /**
20033
- * since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
20034
- * for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e+3"
20035
- * is parsed to "5000".
20036
- */
20037
- parseAsString?: boolean;
20038
- /**
20039
- * CLDR number pattern which is used to format the number
20040
- */
20041
- pattern?: string;
20042
- /**
20043
- * defines the used plus symbol
20044
- */
20045
- plusSign?: string;
20046
- /**
20047
- * **Note:** Only considered if the number format leads to a representation with decimal places, e.g. if
20048
- * the option `style: "short"` is set. The maximum number of digits in the formatted representation of a
20049
- * number; if the `precision` is less than the overall length of the number, its fractional part is truncated
20050
- * through rounding. As the `precision` only affects the rounding of a number, its integer part can retain
20051
- * more digits than defined by this parameter. **Example:** With a `precision` of 2 and `style: "short"`,
20052
- * `234567` is formatted to `"235K"`. **Note:** The formatted output may differ depending on locale.
20053
- */
20054
- precision?: int;
20055
- /**
20056
- * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
20057
- * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
20058
- * is rounded to `maxFractionDigits`.
20059
- */
20060
- preserveDecimals?: boolean;
20061
- /**
20062
- * Specifies the rounding behavior for discarding the digits after the maximum fraction digits defined by
20063
- * `maxFractionDigits`. This can be assigned
20064
- * - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
20065
- * - via a function that is used for rounding the number and takes two parameters: the number itself,
20066
- * and the number of decimal digits that should be reserved. **Using a function is deprecated since 1.121.0**;
20067
- * string based numbers are not rounded via this custom function.
20068
- */
20069
- roundingMode?: sap.ui.core.format.NumberFormat.RoundingMode;
20070
- /**
20071
- * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
20072
- * options is used
20073
- */
20074
- shortDecimals?: int;
20075
- /**
20076
- * only use short number formatting for values above this limit
20077
- */
20078
- shortLimit?: int;
20079
- /**
20080
- * since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
20081
- * The generated scale factor is used for all numbers which are formatted with this format instance. This
20082
- * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
20083
- * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
20084
- */
20085
- shortRefNumber?: int;
20086
- /**
20087
- * since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
20088
- * only when the 'style' options is set to either 'short' or 'long'.
20089
- */
20090
- showScale?: boolean;
20091
- /**
20092
- * whether the positions of grouping separators are validated. Space characters used as grouping separators
20093
- * are not validated.
20094
- */
20095
- strictGroupingValidation?: boolean;
20096
- /**
20097
- * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on the CLDR decimalFormat).
20098
- * When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
20099
- * default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
20100
- * decimals, shortDecimals, or the 'precision' option itself.
20101
- */
20102
- style?: string;
20103
- },
20013
+ oFormatOptions?: sap.ui.core.format.NumberFormat.IntegerFormatOptions,
20104
20014
  /**
20105
20015
  * The locale to get the formatter for; if no locale is given, a locale for the currently configured language
20106
20016
  * is used; see {@link module:sap/base/i18n/Formatting.getLanguageTag Formatting.getLanguageTag}
@@ -20534,12 +20444,12 @@ declare namespace sap {
20534
20444
  /**
20535
20445
  * Messages already existing before the `messageChange` event was fired.
20536
20446
  */
20537
- oldMessages?: sap.ui.core.message.Message;
20447
+ oldMessages?: sap.ui.core.message.Message[];
20538
20448
 
20539
20449
  /**
20540
20450
  * New messages added by the trigger of the `messageChange` event.
20541
20451
  */
20542
- newMessages?: sap.ui.core.message.Message;
20452
+ newMessages?: sap.ui.core.message.Message[];
20543
20453
  }
20544
20454
 
20545
20455
  /**
@@ -56619,13 +56529,7 @@ declare namespace sap {
56619
56529
  /**
56620
56530
  * Format options as defined in {@link sap.ui.core.format.NumberFormat.getIntegerInstance}
56621
56531
  */
56622
- oFormatOptions?: {
56623
- /**
56624
- * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
56625
- * see {@link sap.ui.model.odata.type.Int#parseValue parseValue}; since 1.115.0
56626
- */
56627
- parseEmptyValueToZero?: boolean;
56628
- },
56532
+ oFormatOptions?: sap.ui.model.odata.type.IntTypeFormatOptions,
56629
56533
  /**
56630
56534
  * constraints; {@link sap.ui.model.odata.type.Int#validateValue validateValue} throws an error if any constraint
56631
56535
  * is violated
@@ -57505,7 +57409,16 @@ declare namespace sap {
57505
57409
  *
57506
57410
  * @returns The language-dependent placeholder text or `undefined` if the type does not offer a placeholder
57507
57411
  */
57508
- getPlaceholderText(): string | undefined;
57412
+ getPlaceholderText(
57413
+ /**
57414
+ * The minimum date
57415
+ */
57416
+ oMinimum?: /* was: sap.ui.core.date.UI5Date */ any,
57417
+ /**
57418
+ * The maximum date
57419
+ */
57420
+ oMaximum?: /* was: sap.ui.core.date.UI5Date */ any
57421
+ ): string | undefined;
57509
57422
  /**
57510
57423
  * Parses the given value.
57511
57424
  *
@@ -57561,23 +57474,11 @@ declare namespace sap {
57561
57474
  */
57562
57475
  constructor(
57563
57476
  /**
57564
- * Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}. In contrast to
57565
- * NumberFormat `groupingEnabled` defaults to `true`. Note that `maxFractionDigits` and `minFractionDigits`
57566
- * are set to the value of the constraint `scale` unless it is "variable" or "floating". They can however
57567
- * be overwritten.
57477
+ * Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}. Note that `maxFractionDigits`
57478
+ * and `minFractionDigits` are set to the value of the constraint `scale` unless it is `"variable"` or `"floating"`.
57479
+ * They can however be overwritten.
57568
57480
  */
57569
- oFormatOptions?: {
57570
- /**
57571
- * Whether the empty string and `null` are parsed to `"0"` if the `nullable` constraint is set to `false`;
57572
- * see {@link #parseValue parseValue}; since 1.115.0
57573
- */
57574
- parseEmptyValueToZero?: boolean;
57575
- /**
57576
- * by default decimals are preserved, unless `oFormatOptions.style` is given as "short" or "long"; since
57577
- * 1.89.0
57578
- */
57579
- preserveDecimals?: boolean;
57580
- },
57481
+ oFormatOptions?: sap.ui.model.odata.type.DecimalTypeFormatOptions,
57581
57482
  /**
57582
57483
  * constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
57583
57484
  */
@@ -57735,21 +57636,9 @@ declare namespace sap {
57735
57636
  */
57736
57637
  constructor(
57737
57638
  /**
57738
- * Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}. In contrast to
57739
- * NumberFormat `groupingEnabled` defaults to `true`.
57639
+ * Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}.
57740
57640
  */
57741
- oFormatOptions?: {
57742
- /**
57743
- * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
57744
- * see {@link #parseValue parseValue}; since 1.115.0
57745
- */
57746
- parseEmptyValueToZero?: boolean;
57747
- /**
57748
- * by default decimals are preserved, unless `oFormatOptions.style` is given as "short" or "long"; since
57749
- * 1.89.0
57750
- */
57751
- preserveDecimals?: boolean;
57752
- },
57641
+ oFormatOptions?: sap.ui.model.odata.type.FloatTypeFormatOptions,
57753
57642
  /**
57754
57643
  * constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
57755
57644
  */
@@ -57980,13 +57869,7 @@ declare namespace sap {
57980
57869
  /**
57981
57870
  * type-specific format options; see subtypes
57982
57871
  */
57983
- oFormatOptions?: {
57984
- /**
57985
- * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
57986
- * see {@link #parseValue parseValue}; since 1.115.0
57987
- */
57988
- parseEmptyValueToZero?: boolean;
57989
- },
57872
+ oFormatOptions?: sap.ui.model.odata.type.IntTypeFormatOptions,
57990
57873
  /**
57991
57874
  * constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
57992
57875
  */
@@ -58097,13 +57980,7 @@ declare namespace sap {
58097
57980
  * Format options as defined in {@link sap.ui.core.format.NumberFormat.getIntegerInstance}. In contrast
58098
57981
  * to NumberFormat `groupingEnabled` defaults to `true`.
58099
57982
  */
58100
- oFormatOptions?: {
58101
- /**
58102
- * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
58103
- * see {@link sap.ui.model.odata.type.Int#parseValue parseValue}; since 1.115.0
58104
- */
58105
- parseEmptyValueToZero?: boolean;
58106
- },
57983
+ oFormatOptions?: sap.ui.model.odata.type.IntTypeFormatOptions,
58107
57984
  /**
58108
57985
  * constraints; {@link sap.ui.model.odata.type.Int#validateValue validateValue} throws an error if any constraint
58109
57986
  * is violated
@@ -58186,13 +58063,7 @@ declare namespace sap {
58186
58063
  * Format options as defined in {@link sap.ui.core.format.NumberFormat.getIntegerInstance}. In contrast
58187
58064
  * to NumberFormat `groupingEnabled` defaults to `true`.
58188
58065
  */
58189
- oFormatOptions?: {
58190
- /**
58191
- * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
58192
- * see {@link sap.ui.model.odata.type.Int#parseValue parseValue}; since 1.115.0
58193
- */
58194
- parseEmptyValueToZero?: boolean;
58195
- },
58066
+ oFormatOptions?: sap.ui.model.odata.type.IntTypeFormatOptions,
58196
58067
  /**
58197
58068
  * constraints; {@link sap.ui.model.odata.type.Int#validateValue validateValue} throws an error if any constraint
58198
58069
  * is violated
@@ -58275,13 +58146,7 @@ declare namespace sap {
58275
58146
  * Format options as defined in {@link sap.ui.core.format.NumberFormat.getIntegerInstance}. In contrast
58276
58147
  * to NumberFormat `groupingEnabled` defaults to `true`.
58277
58148
  */
58278
- oFormatOptions: {
58279
- /**
58280
- * Whether the empty string and `null` are parsed to `"0"` if the `nullable` constraint is set to `false`;
58281
- * see {@link #parseValue parseValue}; since 1.115.0
58282
- */
58283
- parseEmptyValueToZero?: boolean;
58284
- },
58149
+ oFormatOptions: sap.ui.model.odata.type.IntTypeFormatOptions,
58285
58150
  /**
58286
58151
  * constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
58287
58152
  */
@@ -58461,12 +58326,26 @@ declare namespace sap {
58461
58326
  static getMetadata(): sap.ui.base.Metadata;
58462
58327
  /**
58463
58328
  * Returns a language-dependent placeholder text such as "e.g. " where is formatted
58464
- * using this type.
58329
+ * using this type. The `oMinimum` and `oMaximum` parameters are supported since 1.149.0 and only by types
58330
+ * that use {@link sap.ui.core.format.DateFormat} for formatting ({@link sap.ui.model.odata.type.Date},
58331
+ * {@link sap.ui.model.odata.type.DateTime}, {@link sap.ui.model.odata.type.DateTimeOffset}, {@link sap.ui.model.odata.type.DateTimeWithTimezone},
58332
+ * {@link sap.ui.model.odata.type.Time}, and {@link sap.ui.model.odata.type.TimeOfDay}). The default sample
58333
+ * date is used if it is valid. Otherwise, the closest valid year end, highest valid month end, or highest
58334
+ * valid date is used.
58465
58335
  *
58466
58336
  *
58467
58337
  * @returns The language-dependent placeholder text or `undefined` if the type does not offer a placeholder
58468
58338
  */
58469
- getPlaceholderText(): string | undefined;
58339
+ getPlaceholderText(
58340
+ /**
58341
+ * The minimum date
58342
+ */
58343
+ oMinimum?: import("sap/ui/core/date/UI5Date").default,
58344
+ /**
58345
+ * The maximum date
58346
+ */
58347
+ oMaximum?: import("sap/ui/core/date/UI5Date").default
58348
+ ): string | undefined;
58470
58349
  }
58471
58350
  /**
58472
58351
  * This class represents a placeholder for all unsupported OData primitive types. It can only be used to
@@ -58585,13 +58464,7 @@ declare namespace sap {
58585
58464
  /**
58586
58465
  * Format options as defined in {@link sap.ui.core.format.NumberFormat.getIntegerInstance}
58587
58466
  */
58588
- oFormatOptions?: {
58589
- /**
58590
- * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
58591
- * see {@link sap.ui.model.odata.type.Int#parseValue parseValue}; since 1.115.0
58592
- */
58593
- parseEmptyValueToZero?: boolean;
58594
- },
58467
+ oFormatOptions?: sap.ui.model.odata.type.IntTypeFormatOptions,
58595
58468
  /**
58596
58469
  * constraints; {@link sap.ui.model.odata.type.Int#validateValue validateValue} throws an error if any constraint
58597
58470
  * is violated
@@ -58671,21 +58544,9 @@ declare namespace sap {
58671
58544
  */
58672
58545
  constructor(
58673
58546
  /**
58674
- * Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}. In contrast to
58675
- * NumberFormat `groupingEnabled` defaults to `true`.
58547
+ * Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}.
58676
58548
  */
58677
- oFormatOptions?: {
58678
- /**
58679
- * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
58680
- * see {@link #parseValue parseValue}; since 1.115.0
58681
- */
58682
- parseEmptyValueToZero?: boolean;
58683
- /**
58684
- * by default decimals are preserved, unless `oFormatOptions.style` is given as "short" or "long"; since
58685
- * 1.89.0
58686
- */
58687
- preserveDecimals?: boolean;
58688
- },
58549
+ oFormatOptions?: sap.ui.model.odata.type.FloatTypeFormatOptions,
58689
58550
  /**
58690
58551
  * constraints; {@link #validateValue validateValue} throws an error if any constraint is violated
58691
58552
  */
@@ -59505,6 +59366,46 @@ declare namespace sap {
59505
59366
  aValues: any[]
59506
59367
  ): void;
59507
59368
  }
59369
+
59370
+ /**
59371
+ * The format options of the OData floating point number type {@link sap.ui.model.odata.type.Decimal}. It
59372
+ * differs to the other two OData floating point number types {@link sap.ui.model.odata.type.Double} and
59373
+ * {@link sap.ui.model.odata.type.Single} by parsing the empty string and `null` to string `"0"` if the
59374
+ * `nullable` constraint is set to `false`.
59375
+ */
59376
+ type DecimalTypeFormatOptions =
59377
+ sap.ui.core.format.NumberFormat.FloatFormatOptions & {
59378
+ /**
59379
+ * Whether the empty string and `null` are parsed to `"0"` if the `nullable` constraint is set to `false`;
59380
+ * see {@link #parseValue parseValue}; since 1.115.0
59381
+ */
59382
+ parseEmptyValueToZero?: boolean;
59383
+ };
59384
+
59385
+ /**
59386
+ * The format options of the OData floating point number types, {@link sap.ui.model.odata.type.Double} and
59387
+ * {@link sap.ui.model.odata.type.Single}.
59388
+ */
59389
+ type FloatTypeFormatOptions =
59390
+ sap.ui.core.format.NumberFormat.FloatFormatOptions & {
59391
+ /**
59392
+ * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
59393
+ * see {@link #parseValue parseValue}; since 1.115.0
59394
+ */
59395
+ parseEmptyValueToZero?: boolean;
59396
+ };
59397
+
59398
+ /**
59399
+ * The format options of the {@link sap.ui.model.odata.type.Int Int} based OData types.
59400
+ */
59401
+ type IntTypeFormatOptions =
59402
+ sap.ui.core.format.NumberFormat.IntegerFormatOptions & {
59403
+ /**
59404
+ * Whether the empty string and `null` are parsed to `0` if the `nullable` constraint is set to `false`;
59405
+ * see {@link #parseValue parseValue}; since 1.115.0
59406
+ */
59407
+ parseEmptyValueToZero?: boolean;
59408
+ };
59508
59409
  }
59509
59410
  /**
59510
59411
  * OData-based DataBinding
@@ -63208,6 +63109,11 @@ declare namespace sap {
63208
63109
  * Optional parameter map containing any of the following properties:
63209
63110
  */
63210
63111
  mParameters?: {
63112
+ /**
63113
+ * Whether to calculate a canonical URL to request the data. See {@link sap.ui.model.odata.v2.ODataModel#constructor mParameters.canonicalRequests }
63114
+ * for details.
63115
+ */
63116
+ canonicalRequest?: boolean;
63211
63117
  /**
63212
63118
  * If specified, `sPath` has to be relative to the path given with the context.
63213
63119
  */
@@ -63216,6 +63122,10 @@ declare namespace sap {
63216
63122
  * A map containing the parameters that will be passed as query strings
63217
63123
  */
63218
63124
  urlParameters?: Record<string, string>;
63125
+ /**
63126
+ * A map of headers for this request
63127
+ */
63128
+ headers?: Record<string, string>;
63219
63129
  /**
63220
63130
  * An array of filters to be included in the request URL
63221
63131
  */
@@ -65809,7 +65719,8 @@ declare namespace sap {
65809
65719
  * or creates this method first waits for them to be processed.
65810
65720
  *
65811
65721
  * The 'dataRequested' and 'dataReceived' events are not fired unless a binding is refreshed completely.
65812
- * Whatever should happen in the event handler attached to...
65722
+ * In that case, they are fired only at the binding itself, not at the model! Whatever should happen in
65723
+ * the event handler attached to...
65813
65724
  * 'dataRequested', can instead be done before calling {@link #requestSideEffects}. 'dataReceived',
65814
65725
  * can instead be done once the `oPromise` returned by {@link #requestSideEffects} fulfills or rejects (using
65815
65726
  * `oPromise.then(function () {...}, function () {...})`).
@@ -67697,6 +67608,9 @@ declare namespace sap {
67697
67608
  * The dynamic sorters to be used; they replace the dynamic sorters given in {@link sap.ui.model.odata.v4.ODataModel#bindList}.
67698
67609
  * A nullish or missing value is treated as an empty array and thus removes all dynamic sorters. Static
67699
67610
  * sorters, as defined in the '$orderby' binding parameter, are always applied after the dynamic sorters.
67611
+ * Since 1.149.0, if any sorter has {@link sap.ui.model.Sorter#getGroupPaths group paths} and the {@link sap.ui.model.odata.v4.ODataModel model}'s
67612
+ * `autoExpandSelect` parameter is set, those paths contribute to `$select` and `$expand`; not supported
67613
+ * for {@link #setAggregation data aggregation}.
67700
67614
  */
67701
67615
  vSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[]
67702
67616
  ): this;
@@ -68906,8 +68820,7 @@ declare namespace sap {
68906
68820
  oContext?: sap.ui.model.Context,
68907
68821
  /**
68908
68822
  * The dynamic sorters to be used initially. Call {@link sap.ui.model.odata.v4.ODataListBinding#sort} to
68909
- * replace them. Static sorters, as defined in the '$orderby' binding parameter, are always applied after
68910
- * the dynamic sorters. Supported since 1.39.0.
68823
+ * replace them, see there for more details. Supported since 1.39.0.
68911
68824
  */
68912
68825
  vSorters?: sap.ui.model.Sorter | sap.ui.model.Sorter[],
68913
68826
  /**
@@ -75954,19 +75867,7 @@ declare namespace sap {
75954
75867
  /**
75955
75868
  * Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}
75956
75869
  */
75957
- oFormatOptions?: {
75958
- /**
75959
- * By default decimals are preserved, unless `oFormatOptions.style` is given as "short" or "long"; since
75960
- * 1.89.0
75961
- */
75962
- preserveDecimals?: boolean;
75963
- /**
75964
- * Additional set of format options to be used if the property in the model is not of type string and needs
75965
- * formatting as well. If an empty object is given, the grouping is disabled and a dot is used as decimal
75966
- * separator.
75967
- */
75968
- source?: object;
75969
- },
75870
+ oFormatOptions?: sap.ui.model.type.FloatTypeFormatOptions,
75970
75871
  /**
75971
75872
  * Value constraints
75972
75873
  */
@@ -76023,16 +75924,10 @@ declare namespace sap {
76023
75924
  */
76024
75925
  constructor(
76025
75926
  /**
76026
- * Format options as defined in {@link sap.ui.core.format.NumberFormat.getIntegerInstance}
75927
+ * The option object, which supports the following parameters. If no options are given, default values according
75928
+ * to the type and locale settings are used.
76027
75929
  */
76028
- oFormatOptions?: {
76029
- /**
76030
- * Additional set of format options to be used if the property in the model is not of type string and needs
76031
- * formatting as well. If an empty object is given, the grouping is disabled and a dot is used as decimal
76032
- * separator.
76033
- */
76034
- source?: object;
76035
- },
75930
+ oFormatOptions?: sap.ui.model.type.IntegerTypeFormatOptions,
76036
75931
  /**
76037
75932
  * Value constraints
76038
75933
  */
@@ -76498,6 +76393,32 @@ declare namespace sap {
76498
76393
  aCurrentValues?: any[]
76499
76394
  ): any[] | string;
76500
76395
  }
76396
+
76397
+ /**
76398
+ * The format options of the {@link sap.ui.model.type.Float} type.
76399
+ */
76400
+ type FloatTypeFormatOptions =
76401
+ sap.ui.core.format.NumberFormat.FloatFormatOptions & {
76402
+ /**
76403
+ * Additional set of format options to be used if the property in the model is not of type string and needs
76404
+ * formatting as well. If an empty object is given, the grouping is disabled and a dot is used as decimal
76405
+ * separator.
76406
+ */
76407
+ source?: Record<string, any>;
76408
+ };
76409
+
76410
+ /**
76411
+ * The format options of the {@link sap.ui.model.type.Integer} type.
76412
+ */
76413
+ type IntegerTypeFormatOptions =
76414
+ sap.ui.core.format.NumberFormat.IntegerFormatOptions & {
76415
+ /**
76416
+ * Additional set of format options to be used if the property in the model is not of type `string` and
76417
+ * needs formatting as well. If an empty object is given, the grouping is disabled and a dot is used as
76418
+ * decimal separator.
76419
+ */
76420
+ source?: Record<string, any>;
76421
+ };
76501
76422
  }
76502
76423
  /**
76503
76424
  * Parameters of the Binding#AggregatedDataStateChange event.