@openui5/ts-types-esm 1.99.0 → 1.100.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.
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.99.0
267
+ // For Library Version: 1.100.0
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -693,7 +693,7 @@ declare module "sap/base/Log" {
693
693
  /**
694
694
  * The default log level
695
695
  */
696
- iLogLevel?: Level
696
+ iDefaultLogLevel?: Level
697
697
  ): object;
698
698
  /**
699
699
  * Creates a new info-level entry in the log with the given message, details and calling component.
@@ -3243,6 +3243,54 @@ declare module "sap/ui/performance/Measurement" {
3243
3243
  };
3244
3244
  }
3245
3245
 
3246
+ declare module "sap/ui/performance/trace/FESRHelper" {
3247
+ import UI5Element from "sap/ui/core/Element";
3248
+
3249
+ /**
3250
+ * @SINCE 1.100
3251
+ *
3252
+ * FESRHelper API Provides helper functionality for FESR and consumers of FESR
3253
+ */
3254
+ interface FESRHelper {
3255
+ /**
3256
+ * @SINCE 1.100
3257
+ *
3258
+ * Get semantic stepname for an event of a given element used for FESR.
3259
+ */
3260
+ getSemanticStepname(
3261
+ /**
3262
+ * The element conatining the semantic stepname
3263
+ */
3264
+ oElement: UI5Element,
3265
+ /**
3266
+ * The event ID of the semantic stepname
3267
+ */
3268
+ sEventId: string
3269
+ ): string;
3270
+ /**
3271
+ * @SINCE 1.100
3272
+ *
3273
+ * Add semantic stepname for an event of a given element used for FESR.
3274
+ */
3275
+ setSemanticStepname(
3276
+ /**
3277
+ * The element the semantic stepname should be applied to
3278
+ */
3279
+ oElement: UI5Element,
3280
+ /**
3281
+ * The event ID the semantic stepname is valid for
3282
+ */
3283
+ sEventId: string,
3284
+ /**
3285
+ * The semantic stepname
3286
+ */
3287
+ sStepname: string
3288
+ ): void;
3289
+ }
3290
+ const FESRHelper: FESRHelper;
3291
+ export default FESRHelper;
3292
+ }
3293
+
3246
3294
  declare module "sap/ui/performance/trace/Interaction" {
3247
3295
  /**
3248
3296
  * @SINCE 1.76
@@ -8438,8 +8486,10 @@ declare module "sap/ui/core/library" {
8438
8486
  * Collision behavior: horizontal/vertical.
8439
8487
  *
8440
8488
  * Defines how the position of an element should be adjusted in case it overflows the window in some direction.
8441
- * For both directions this can be "flip", "fit" or "none". If only one behavior is provided it is applied
8442
- * to both directions. Examples: "flip", "fit none".
8489
+ * For both directions this can be "flip", "fit", "flipfit" or "none". If only one behavior is provided
8490
+ * it is applied to both directions.
8491
+ *
8492
+ * Examples: "flip", "fit none", "flipfit fit"
8443
8493
  */
8444
8494
  export type Collision = string;
8445
8495
 
@@ -9366,6 +9416,25 @@ declare module "sap/ui/core/library" {
9366
9416
  */
9367
9417
  OnOrBetween = "OnOrBetween",
9368
9418
  }
9419
+ /**
9420
+ * @SINCE 1.100.0
9421
+ *
9422
+ * Drop positions relative to a dropped element.
9423
+ */
9424
+ enum RelativeDropPosition {
9425
+ /**
9426
+ * Drop after the control.
9427
+ */
9428
+ After = "After",
9429
+ /**
9430
+ * Drop before the control.
9431
+ */
9432
+ Before = "Before",
9433
+ /**
9434
+ * Drop on the control.
9435
+ */
9436
+ On = "On",
9437
+ }
9369
9438
  }
9370
9439
 
9371
9440
  export namespace mvc {
@@ -11295,7 +11364,7 @@ declare module "sap/ui/core/ComponentMetadata" {
11295
11364
  /**
11296
11365
  * Static info to construct the metadata from
11297
11366
  */
11298
- oStaticInfo: object
11367
+ oClassInfo: object
11299
11368
  );
11300
11369
 
11301
11370
  /**
@@ -12052,7 +12121,9 @@ declare module "sap/ui/core/Configuration" {
12052
12121
  * To replace the CLDR currency digits completely ` { "DEFAULT": {"digits": 2}, "ADP": {"digits": 0}, ...
12053
12122
  * "XPF": {"digits": 0} } `
12054
12123
  *
12055
- * Note: To unset the custom currencies: call with `undefined`
12124
+ * Note: To unset the custom currencies: call with `undefined` Custom currencies must not only consist of
12125
+ * digits but contain at least one non-digit character, e.g. "a", so that the measure part can be distinguished
12126
+ * from the number part.
12056
12127
  */
12057
12128
  setCustomCurrencies(
12058
12129
  /**
@@ -13181,6 +13252,28 @@ declare module "sap/ui/core/Core" {
13181
13252
  */
13182
13253
  oListener?: object
13183
13254
  ): void;
13255
+ /**
13256
+ * Attaches event handler `fnFunction` to the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
13257
+ *
13258
+ * When called, the context of the listener (its `this`) will be bound to `oListener` if specified, otherwise
13259
+ * it will be bound to a dummy event provider object.
13260
+ *
13261
+ * Please note that this event is a bubbling event and may already be canceled before reaching the core.
13262
+ */
13263
+ attachFormatError(
13264
+ /**
13265
+ * An object that will be passed to the handler along with the event object when the event is fired
13266
+ */
13267
+ oData: object,
13268
+ /**
13269
+ * The function to be called, when the event occurs
13270
+ */
13271
+ fnFunction: Function,
13272
+ /**
13273
+ * Context object to call the event handler with. Defaults to a dummy event provider object
13274
+ */
13275
+ oListener?: object
13276
+ ): this;
13184
13277
  /**
13185
13278
  * Attaches event handler `fnFunction` to the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
13186
13279
  *
@@ -15840,6 +15933,8 @@ declare module "sap/ui/core/dnd/DragAndDrop" {
15840
15933
 
15841
15934
  import DropInfo from "sap/ui/core/dnd/DropInfo";
15842
15935
 
15936
+ import { dnd } from "sap/ui/core/library";
15937
+
15843
15938
  /**
15844
15939
  * When a user requests to drag some controls that can be dragged, a drag session is started. The drag session
15845
15940
  * can be used to transfer data between applications or between dragged and dropped controls. Please see
@@ -15887,7 +15982,9 @@ declare module "sap/ui/core/dnd/DragAndDrop" {
15887
15982
  /**
15888
15983
  * Returns the calculated position of the drop action relative to the valid dropped control.
15889
15984
  */
15890
- getDropPosition(): string;
15985
+ getDropPosition():
15986
+ | dnd.RelativeDropPosition
15987
+ | keyof typeof dnd.RelativeDropPosition;
15891
15988
  /**
15892
15989
  * Returns the drop indicator.
15893
15990
  */
@@ -17831,6 +17928,8 @@ declare module "sap/ui/core/format/DateFormat" {
17831
17928
 
17832
17929
  import Locale from "sap/ui/core/Locale";
17833
17930
 
17931
+ import DateFormatTimezoneDisplay from "sap/ui/core/format/DateFormatTimezoneDisplay";
17932
+
17834
17933
  /**
17835
17934
  * The DateFormat is a static class for formatting and parsing single date and time values or date and time
17836
17935
  * intervals according to a set of format options.
@@ -18001,6 +18100,7 @@ declare module "sap/ui/core/format/DateFormat" {
18001
18100
  ): DateFormat;
18002
18101
  /**
18003
18102
  * @SINCE 1.99.0
18103
+ * @EXPERIMENTAL (since 1.99.0)
18004
18104
  *
18005
18105
  * Get a datetimeWithTimezone instance of the DateFormat, which can be used for formatting.
18006
18106
  */
@@ -18027,7 +18127,9 @@ declare module "sap/ui/core/format/DateFormat" {
18027
18127
  * - "Only": display only timezone It is ignored for formatting when an options pattern or a format
18028
18128
  * are supplied.
18029
18129
  */
18030
- showTimezone?: /* was: sap.ui.core.format.DateFormatTimezoneDisplay */ any;
18130
+ showTimezone?:
18131
+ | DateFormatTimezoneDisplay
18132
+ | keyof typeof DateFormatTimezoneDisplay;
18031
18133
  /**
18032
18134
  * Can be either 'short, 'medium', 'long' or 'full'. For datetime you can also define mixed styles, separated
18033
18135
  * with a slash, where the first part is the date style and the second part is the time style (e.g. "medium/short").
@@ -18151,6 +18253,9 @@ declare module "sap/ui/core/format/DateFormat" {
18151
18253
  *
18152
18254
  * Uses the timezone from {@link sap.ui.core.Configuration#getTimezone}, which falls back to the browser's
18153
18255
  * local timezone to convert the given date.
18256
+ *
18257
+ * When using instances from getDateTimeWithTimezoneInstance, please see the corresponding documentation:
18258
+ * {@link sap.ui.core.format.DateFormat.getDateTimeWithTimezoneInstance#format}.
18154
18259
  */
18155
18260
  format(
18156
18261
  /**
@@ -18167,6 +18272,9 @@ declare module "sap/ui/core/format/DateFormat" {
18167
18272
  *
18168
18273
  * Uses the timezone from {@link sap.ui.core.Configuration#getTimezone}, which falls back to the browser's
18169
18274
  * local timezone to convert the given date.
18275
+ *
18276
+ * When using instances from getDateTimeWithTimezoneInstance, please see the corresponding documentation:
18277
+ * {@link sap.ui.core.format.DateFormat.getDateTimeWithTimezoneInstance#parse}.
18170
18278
  */
18171
18279
  parse(
18172
18280
  /**
@@ -18174,7 +18282,7 @@ declare module "sap/ui/core/format/DateFormat" {
18174
18282
  */
18175
18283
  sValue: string,
18176
18284
  /**
18177
- * whether to use UTC, if no timezone is contained
18285
+ * whether to use UTC
18178
18286
  */
18179
18287
  bUTC: boolean,
18180
18288
  /**
@@ -18207,8 +18315,9 @@ declare module "sap/ui/core/format/DateFormat" {
18207
18315
  */
18208
18316
  oJSDate: Date,
18209
18317
  /**
18210
- * The IANA timezone ID in which the date will be calculated and formatted e.g. "America/New_York". If omitted,
18211
- * the timezone will be taken from {@link sap.ui.core.Configuration#getTimezone}.
18318
+ * The IANA timezone ID in which the date will be calculated and formatted e.g. "America/New_York". If the
18319
+ * parameter is omitted, `null` or an empty string, the timezone will be taken from {@link sap.ui.core.Configuration#getTimezone}.
18320
+ * For an invalid IANA timezone ID, an empty string will be returned.
18212
18321
  */
18213
18322
  sTimezone?: string
18214
18323
  ): string;
@@ -18225,8 +18334,9 @@ declare module "sap/ui/core/format/DateFormat" {
18225
18334
  */
18226
18335
  sValue: string,
18227
18336
  /**
18228
- * The IANA timezone ID which should be used to convert the date e.g. "America/New_York". If omitted, the
18229
- * timezone will be taken from {@link sap.ui.core.Configuration#getTimezone}.
18337
+ * The IANA timezone ID which should be used to convert the date e.g. "America/New_York". If the parameter
18338
+ * is omitted, `null` or an empty string, the timezone will be taken from {@link sap.ui.core.Configuration#getTimezone}.
18339
+ * For an invalid IANA timezone ID, `null` will be returned.
18230
18340
  */
18231
18341
  sTimezone?: string,
18232
18342
  /**
@@ -18239,6 +18349,29 @@ declare module "sap/ui/core/format/DateFormat" {
18239
18349
  }
18240
18350
  }
18241
18351
 
18352
+ declare module "sap/ui/core/format/DateFormatTimezoneDisplay" {
18353
+ /**
18354
+ * @SINCE 1.99.0
18355
+ *
18356
+ * Configuration options for the `showTimezone` format option of `DateFormat#getDateTimeWithTimezoneInstance`.
18357
+ */
18358
+ enum DateFormatTimezoneDisplay {
18359
+ /**
18360
+ * Do not add the IANA timezone ID to the format output.
18361
+ */
18362
+ Hide = "Hide",
18363
+ /**
18364
+ * Only output the IANA timezone ID.
18365
+ */
18366
+ Only = "Only",
18367
+ /**
18368
+ * Add the IANA timezone ID to the format output.
18369
+ */
18370
+ Show = "Show",
18371
+ }
18372
+ export default DateFormatTimezoneDisplay;
18373
+ }
18374
+
18242
18375
  declare module "sap/ui/core/format/FileSizeFormat" {
18243
18376
  import BaseObject from "sap/ui/base/Object";
18244
18377
 
@@ -18466,51 +18599,43 @@ declare module "sap/ui/core/format/NumberFormat" {
18466
18599
  */
18467
18600
  oFormatOptions?: {
18468
18601
  /**
18469
- * defines minimal number of non-decimal digits
18602
+ * defines whether the currency is shown as a code in currency format. The currency symbol is displayed
18603
+ * when this option is set to `false` and a symbol has been defined for the given currency code.
18470
18604
  */
18471
- minIntegerDigits?: int;
18472
- /**
18473
- * defines maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?" characters
18474
- * are shown instead of digits.
18475
- */
18476
- maxIntegerDigits?: int;
18605
+ currencyCode?: boolean;
18477
18606
  /**
18478
- * defines minimal number of decimal digits
18607
+ * can be set either to 'standard' (the default value) or to 'accounting' for an accounting-specific currency
18608
+ * display
18479
18609
  */
18480
- minFractionDigits?: int;
18610
+ currencyContext?: string;
18481
18611
  /**
18482
- * defines maximum number of decimal digits
18612
+ * defines a set of custom currencies exclusive to this NumberFormat instance. Custom currencies must not
18613
+ * only consist of digits. If custom currencies are defined on the instance, no other currencies can be
18614
+ * formatted and parsed by this instance. Globally available custom currencies can be added via the global
18615
+ * configuration. See the above examples. See also {@link sap.ui.core.Configuration.FormatSettings#setCustomCurrencies}
18616
+ * and {@link sap.ui.core.Configuration.FormatSettings#addCustomCurrencies}.
18483
18617
  */
18484
- maxFractionDigits?: int;
18618
+ customCurrencies?: Record<string, object>;
18485
18619
  /**
18486
18620
  * defines the number of decimal digits
18487
18621
  */
18488
18622
  decimals?: int;
18489
18623
  /**
18490
- * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
18491
- * options is used
18492
- */
18493
- shortDecimals?: int;
18494
- /**
18495
- * only use short number formatting for values above this limit
18496
- */
18497
- shortLimit?: int;
18498
- /**
18499
- * @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
18500
- * The generated scale factor is used for all numbers which are formatted with this format instance. This
18501
- * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
18502
- * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
18624
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
18625
+ * `groupingSeparator`.
18503
18626
  */
18504
- shortRefNumber?: int;
18627
+ decimalSeparator?: string;
18505
18628
  /**
18506
- * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
18507
- * only when the 'style' options is set to either 'short' or 'long'.
18629
+ * @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
18630
+ * allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
18631
+ * in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as [NaN,
18632
+ * undefined], and NaN is formatted as an empty string.
18508
18633
  */
18509
- showScale?: boolean;
18634
+ emptyString?: number;
18510
18635
  /**
18511
- * CLDR number pattern which is used to format the number
18636
+ * defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
18512
18637
  */
18513
- pattern?: string;
18638
+ groupingBaseSize?: int;
18514
18639
  /**
18515
18640
  * defines whether grouping is enabled (show the grouping separators)
18516
18641
  */
@@ -18521,60 +18646,75 @@ declare module "sap/ui/core/format/NumberFormat" {
18521
18646
  */
18522
18647
  groupingSeparator?: string;
18523
18648
  /**
18524
- * defines the grouping size in digits, the default is three
18649
+ * defines the grouping size in digits; the default is `3`. It must be a positive number.
18525
18650
  */
18526
18651
  groupingSize?: int;
18527
18652
  /**
18528
- * defines the grouping base size in digits, in case it is different from the grouping size (e.g. indian
18529
- * grouping)
18653
+ * defines the maximum number of decimal digits
18530
18654
  */
18531
- groupingBaseSize?: int;
18655
+ maxFractionDigits?: int;
18532
18656
  /**
18533
- * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
18534
- * `groupingSeparator`.
18657
+ * defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
18658
+ * characters are shown instead of digits.
18535
18659
  */
18536
- decimalSeparator?: string;
18660
+ maxIntegerDigits?: int;
18537
18661
  /**
18538
- * defines the used plus symbol
18662
+ * defines the minimal number of decimal digits
18539
18663
  */
18540
- plusSign?: string;
18664
+ minFractionDigits?: int;
18665
+ /**
18666
+ * defines the minimal number of non-decimal digits
18667
+ */
18668
+ minIntegerDigits?: int;
18541
18669
  /**
18542
18670
  * defines the used minus symbol
18543
18671
  */
18544
18672
  minusSign?: string;
18545
18673
  /**
18546
- * @since 1.28.2 defines whether to output string from parse function in order to keep the precision for
18547
- * big numbers. Numbers in scientific notation are parsed back to the standard notation. For example "5e-3"
18674
+ * @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
18675
+ * for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
18548
18676
  * is parsed to "0.005".
18549
18677
  */
18550
18678
  parseAsString?: boolean;
18679
+ /**
18680
+ * CLDR number pattern which is used to format the number
18681
+ */
18682
+ pattern?: string;
18683
+ /**
18684
+ * defines the used plus symbol
18685
+ */
18686
+ plusSign?: string;
18551
18687
  /**
18552
18688
  * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
18553
18689
  * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
18554
18690
  * is rounded to `maxFractionDigits`.
18555
18691
  */
18556
18692
  preserveDecimals?: boolean;
18557
- /**
18558
- * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
18559
- * Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
18560
- * the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
18561
- * decimals, shortDecimals or precision option.
18562
- */
18563
- style?: string;
18564
18693
  /**
18565
18694
  * specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
18566
- * maxFractionDigits. Rounding will only be applied, if the passed value if of type number. This can be
18567
- * assigned by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode} or a function
18568
- * which will be used for rounding the number. The function is called with two parameters: the number and
18569
- * how many decimal digits should be reserved.
18695
+ * maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
18696
+ * assigned
18697
+ * - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
18698
+ * - via a function that is used for rounding the number and takes two parameters: the number itself,
18699
+ * and the number of decimal digits that should be reserved.
18570
18700
  */
18571
18701
  roundingMode?: RoundingMode | keyof typeof RoundingMode;
18572
18702
  /**
18573
- * Overrides the global configuration value {@link sap.ui.core.Configuration.FormatSettings#getTrailingCurrencyCode}
18574
- * whose default value is `true</>. This is ignored if oFormatOptions.currencyCode` is set to `false`
18575
- * or if `oFormatOptions.pattern` is supplied
18703
+ * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
18704
+ * options is used
18576
18705
  */
18577
- trailingCurrencyCode?: boolean;
18706
+ shortDecimals?: int;
18707
+ /**
18708
+ * only use short number formatting for values above this limit
18709
+ */
18710
+ shortLimit?: int;
18711
+ /**
18712
+ * @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
18713
+ * The generated scale factor is used for all numbers which are formatted with this format instance. This
18714
+ * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
18715
+ * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
18716
+ */
18717
+ shortRefNumber?: int;
18578
18718
  /**
18579
18719
  * defines whether the currency code/symbol is shown in the formatted string, e.g. true: "1.00 EUR", false:
18580
18720
  * "1.00" for locale "en" If both `showMeasure` and `showNumber` are false, an empty string is returned
@@ -18587,29 +18727,23 @@ declare module "sap/ui/core/format/NumberFormat" {
18587
18727
  */
18588
18728
  showNumber?: boolean;
18589
18729
  /**
18590
- * defines whether the currency is shown as code in currency format. The currency symbol is displayed when
18591
- * this is set to false and there is a symbol defined for the given currency code.
18592
- */
18593
- currencyCode?: boolean;
18594
- /**
18595
- * It can be set either with 'standard' (the default value) or with 'accounting' for an accounting specific
18596
- * currency display
18730
+ * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
18731
+ * only when the 'style' options is set to either 'short' or 'long'.
18597
18732
  */
18598
- currencyContext?: string;
18733
+ showScale?: boolean;
18599
18734
  /**
18600
- * @since 1.30.0 defines what empty string is parsed as and what is formatted as empty string. The allowed
18601
- * values are "" (empty string), NaN, null or 0. The 'format' and 'parse' are done in a symmetric way. For
18602
- * example when this parameter is set to NaN, empty string is parsed as [NaN, undefined] and NaN is formatted
18603
- * as empty string.
18735
+ * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
18736
+ * When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
18737
+ * default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
18738
+ * decimals, shortDecimals, or the 'precision' option itself.
18604
18739
  */
18605
- emptyString?: number;
18740
+ style?: string;
18606
18741
  /**
18607
- * defines a set of custom currencies exclusive to this NumberFormat instance. If custom currencies are
18608
- * defined on the instance, no other currencies can be formatted and parsed by this instance. Globally available
18609
- * custom currencies can be added via the global configuration. See the above examples. See also {@link
18610
- * sap.ui.core.Configuration.FormatSettings#setCustomCurrencies} and {@link sap.ui.core.Configuration.FormatSettings#addCustomCurrencies}.
18742
+ * overrides the global configuration value {@link sap.ui.core.Configuration.FormatSettings#getTrailingCurrencyCode},
18743
+ * which has a default value of `true</>. This is ignored if oFormatOptions.currencyCode` is set to
18744
+ * `false`, or if `oFormatOptions.pattern` is supplied.
18611
18745
  */
18612
- customCurrencies?: Record<string, object>;
18746
+ trailingCurrencyCode?: boolean;
18613
18747
  },
18614
18748
  /**
18615
18749
  * Locale to get the formatter for
@@ -18624,6 +18758,19 @@ declare module "sap/ui/core/format/NumberFormat" {
18624
18758
  *
18625
18759
  * This instance has HALF_AWAY_FROM_ZERO set as default rounding mode. Please set the roundingMode property
18626
18760
  * in oFormatOptions to change the default value.
18761
+ *
18762
+ * The following example shows how grouping is done:
18763
+ * ```javascript
18764
+ *
18765
+ * var oFormat = NumberFormat.getFloatInstance({
18766
+ * "groupingEnabled": true, // grouping is enabled
18767
+ * "groupingSeparator": '.', // grouping separator is '.'
18768
+ * "groupingSize": 3, // the amount of digits to be grouped (here: thousand)
18769
+ * "decimalSeparator": "," // the decimal separator must be different from the grouping separator
18770
+ * });
18771
+ *
18772
+ * oFormat.format(1234.56); // "1.234,56"
18773
+ * ```
18627
18774
  */
18628
18775
  static getFloatInstance(
18629
18776
  /**
@@ -18631,56 +18778,26 @@ declare module "sap/ui/core/format/NumberFormat" {
18631
18778
  * to the type and locale settings are used.
18632
18779
  */
18633
18780
  oFormatOptions?: {
18634
- /**
18635
- * defines minimal number of non-decimal digits
18636
- */
18637
- minIntegerDigits?: int;
18638
- /**
18639
- * defines maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?" characters
18640
- * are shown instead of digits.
18641
- */
18642
- maxIntegerDigits?: int;
18643
- /**
18644
- * defines minimal number of decimal digits
18645
- */
18646
- minFractionDigits?: int;
18647
- /**
18648
- * defines maximum number of decimal digits
18649
- */
18650
- maxFractionDigits?: int;
18651
18781
  /**
18652
18782
  * defines the number of decimal digits
18653
18783
  */
18654
18784
  decimals?: int;
18655
18785
  /**
18656
- * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
18657
- * options is used
18658
- */
18659
- shortDecimals?: int;
18660
- /**
18661
- * only use short number formatting for values above this limit
18662
- */
18663
- shortLimit?: int;
18664
- /**
18665
- * @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
18666
- * The generated scale factor is used for all numbers which are formatted with this format instance. This
18667
- * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
18668
- * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
18669
- */
18670
- shortRefNumber?: int;
18671
- /**
18672
- * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
18673
- * only when the 'style' options is set to either 'short' or 'long'.
18786
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
18787
+ * `groupingSeparator`.
18674
18788
  */
18675
- showScale?: boolean;
18789
+ decimalSeparator?: string;
18676
18790
  /**
18677
- * defines the number precision, number of decimals is calculated dependent on the integer digits
18791
+ * @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
18792
+ * allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
18793
+ * in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as NaN,
18794
+ * and NaN is formatted as an empty string.
18678
18795
  */
18679
- precision?: int;
18796
+ emptyString?: number;
18680
18797
  /**
18681
- * CLDR number pattern which is used to format the number
18798
+ * defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
18682
18799
  */
18683
- pattern?: string;
18800
+ groupingBaseSize?: int;
18684
18801
  /**
18685
18802
  * defines whether grouping is enabled (show the grouping separators)
18686
18803
  */
@@ -18691,61 +18808,91 @@ declare module "sap/ui/core/format/NumberFormat" {
18691
18808
  */
18692
18809
  groupingSeparator?: string;
18693
18810
  /**
18694
- * defines the grouping size in digits, the default is three
18811
+ * defines the grouping size in digits; the default is `3`. It must be a positive number.
18695
18812
  */
18696
18813
  groupingSize?: int;
18697
18814
  /**
18698
- * defines the grouping base size in digits, in case it is different from the grouping size (e.g. indian
18699
- * grouping)
18815
+ * defines the maximum number of decimal digits
18700
18816
  */
18701
- groupingBaseSize?: int;
18817
+ maxFractionDigits?: int;
18702
18818
  /**
18703
- * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
18704
- * `groupingSeparator`.
18819
+ * defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
18820
+ * characters are shown instead of digits.
18705
18821
  */
18706
- decimalSeparator?: string;
18822
+ maxIntegerDigits?: int;
18707
18823
  /**
18708
- * defines the used plus symbol
18824
+ * defines the minimal number of decimal digits
18709
18825
  */
18710
- plusSign?: string;
18826
+ minFractionDigits?: int;
18827
+ /**
18828
+ * defines the minimal number of non-decimal digits
18829
+ */
18830
+ minIntegerDigits?: int;
18711
18831
  /**
18712
18832
  * defines the used minus symbol
18713
18833
  */
18714
18834
  minusSign?: string;
18715
18835
  /**
18716
- * @since 1.28.2 defines whether to output string from parse function in order to keep the precision for
18717
- * big numbers. Numbers in scientific notation are parsed back to the standard notation. For example "5e-3"
18836
+ * @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
18837
+ * for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
18718
18838
  * is parsed to "0.005".
18719
18839
  */
18720
18840
  parseAsString?: boolean;
18841
+ /**
18842
+ * CLDR number pattern which is used to format the number
18843
+ */
18844
+ pattern?: string;
18845
+ /**
18846
+ * defines the used plus symbol
18847
+ */
18848
+ plusSign?: string;
18849
+ /**
18850
+ * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
18851
+ */
18852
+ precision?: int;
18721
18853
  /**
18722
18854
  * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
18723
18855
  * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
18724
18856
  * is rounded to `maxFractionDigits`.
18725
18857
  */
18726
18858
  preserveDecimals?: boolean;
18727
- /**
18728
- * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
18729
- * Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
18730
- * the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
18731
- * decimals, shortDecimals or precision option.
18732
- */
18733
- style?: string;
18734
18859
  /**
18735
18860
  * specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
18736
- * maxFractionDigits. Rounding will only be applied, if the passed value if of type number. This can be
18737
- * assigned by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode} or a function
18738
- * which will be used for rounding the number. The function is called with two parameters: the number and
18739
- * how many decimal digits should be reserved.
18861
+ * maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
18862
+ * assigned
18863
+ * - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
18864
+ * - via a function that is used for rounding the number and takes two parameters: the number itself,
18865
+ * and the number of decimal digits that should be reserved.
18740
18866
  */
18741
18867
  roundingMode?: RoundingMode | keyof typeof RoundingMode;
18742
18868
  /**
18743
- * @since 1.30.0 defines what empty string is parsed as and what is formatted as empty string. The allowed
18744
- * values are "" (empty string), NaN, null or 0. The 'format' and 'parse' are done in a symmetric way. For
18745
- * example when this parameter is set to NaN, empty string is parsed as NaN and NaN is formatted as empty
18746
- * string.
18869
+ * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
18870
+ * options is used
18747
18871
  */
18748
- emptyString?: number;
18872
+ shortDecimals?: int;
18873
+ /**
18874
+ * only use short number formatting for values above this limit
18875
+ */
18876
+ shortLimit?: int;
18877
+ /**
18878
+ * @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
18879
+ * The generated scale factor is used for all numbers which are formatted with this format instance. This
18880
+ * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
18881
+ * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
18882
+ */
18883
+ shortRefNumber?: int;
18884
+ /**
18885
+ * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
18886
+ * only when the 'style' options is set to either 'short' or 'long'.
18887
+ */
18888
+ showScale?: boolean;
18889
+ /**
18890
+ * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
18891
+ * When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
18892
+ * default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
18893
+ * decimals, shortDecimals, or the 'precision' option itself.
18894
+ */
18895
+ style?: string;
18749
18896
  },
18750
18897
  /**
18751
18898
  * Locale to get the formatter for
@@ -18760,6 +18907,18 @@ declare module "sap/ui/core/format/NumberFormat" {
18760
18907
  *
18761
18908
  * This instance has TOWARDS_ZERO set as default rounding mode. Please set the roundingMode property
18762
18909
  * in oFormatOptions to change the default value.
18910
+ *
18911
+ * The following example shows how grouping is done:
18912
+ * ```javascript
18913
+ *
18914
+ * var oFormat = NumberFormat.getIntegerInstance({
18915
+ * "groupingEnabled": true, // grouping is enabled
18916
+ * "groupingSeparator": '.', // grouping separator is '.'
18917
+ * "groupingSize": 3 // the amount of digits to be grouped (here: thousand)
18918
+ * });
18919
+ *
18920
+ * oFormat.format(1234); // "1.234"
18921
+ * ```
18763
18922
  */
18764
18923
  static getIntegerInstance(
18765
18924
  /**
@@ -18767,56 +18926,26 @@ declare module "sap/ui/core/format/NumberFormat" {
18767
18926
  * to the type and locale settings are used.
18768
18927
  */
18769
18928
  oFormatOptions?: {
18770
- /**
18771
- * defines minimal number of non-decimal digits
18772
- */
18773
- minIntegerDigits?: int;
18774
- /**
18775
- * defines maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?" characters
18776
- * are shown instead of digits.
18777
- */
18778
- maxIntegerDigits?: int;
18779
- /**
18780
- * defines minimal number of decimal digits
18781
- */
18782
- minFractionDigits?: int;
18783
- /**
18784
- * defines maximum number of decimal digits
18785
- */
18786
- maxFractionDigits?: int;
18787
18929
  /**
18788
18930
  * defines the number of decimal digits
18789
18931
  */
18790
18932
  decimals?: int;
18791
18933
  /**
18792
- * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
18793
- * options is used
18794
- */
18795
- shortDecimals?: int;
18796
- /**
18797
- * only use short number formatting for values above this limit
18798
- */
18799
- shortLimit?: int;
18800
- /**
18801
- * @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
18802
- * The generated scale factor is used for all numbers which are formatted with this format instance. This
18803
- * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
18804
- * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
18805
- */
18806
- shortRefNumber?: int;
18807
- /**
18808
- * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
18809
- * only when the 'style' options is set to either 'short' or 'long'.
18934
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
18935
+ * `groupingSeparator`.
18810
18936
  */
18811
- showScale?: boolean;
18937
+ decimalSeparator?: string;
18812
18938
  /**
18813
- * defines the number precision, number of decimals is calculated dependent on the integer digits
18939
+ * @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
18940
+ * allowed values are only NaN, null or 0. The 'format' and 'parse' functions are done in a symmetric way.
18941
+ * For example, when this parameter is set to NaN, an empty string is parsed as NaN, and NaN is formatted
18942
+ * as an empty string.
18814
18943
  */
18815
- precision?: int;
18944
+ emptyString?: number;
18816
18945
  /**
18817
- * CLDR number pattern which is used to format the number
18946
+ * defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
18818
18947
  */
18819
- pattern?: string;
18948
+ groupingBaseSize?: int;
18820
18949
  /**
18821
18950
  * defines whether grouping is enabled (show the grouping separators)
18822
18951
  */
@@ -18827,60 +18956,91 @@ declare module "sap/ui/core/format/NumberFormat" {
18827
18956
  */
18828
18957
  groupingSeparator?: string;
18829
18958
  /**
18830
- * defines the grouping size in digits, the default is three
18959
+ * defines the grouping size in digits; the default is `3`. It must be a positive number.
18831
18960
  */
18832
18961
  groupingSize?: int;
18833
18962
  /**
18834
- * defines the grouping base size in digits, in case it is different from the grouping size (e.g. indian
18835
- * grouping)
18963
+ * defines the maximum number of decimal digits
18836
18964
  */
18837
- groupingBaseSize?: int;
18965
+ maxFractionDigits?: int;
18838
18966
  /**
18839
- * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
18840
- * `groupingSeparator`.
18967
+ * defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
18968
+ * characters are shown instead of digits.
18841
18969
  */
18842
- decimalSeparator?: string;
18970
+ maxIntegerDigits?: int;
18843
18971
  /**
18844
- * defines the used plus symbol
18972
+ * defines the minimal number of decimal digits
18845
18973
  */
18846
- plusSign?: string;
18974
+ minFractionDigits?: int;
18975
+ /**
18976
+ * defines the minimal number of non-decimal digits
18977
+ */
18978
+ minIntegerDigits?: int;
18847
18979
  /**
18848
18980
  * defines the used minus symbol
18849
18981
  */
18850
18982
  minusSign?: string;
18851
18983
  /**
18852
- * @since 1.28.2 defines whether to output string from parse function in order to keep the precision for
18853
- * big numbers. Numbers in scientific notation are parsed back to the standard notation. For example "5e+3"
18984
+ * @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
18985
+ * for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e+3"
18854
18986
  * is parsed to "5000".
18855
18987
  */
18856
18988
  parseAsString?: boolean;
18989
+ /**
18990
+ * CLDR number pattern which is used to format the number
18991
+ */
18992
+ pattern?: string;
18993
+ /**
18994
+ * defines the used plus symbol
18995
+ */
18996
+ plusSign?: string;
18997
+ /**
18998
+ * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
18999
+ */
19000
+ precision?: int;
18857
19001
  /**
18858
19002
  * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
18859
19003
  * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
18860
19004
  * is rounded to `maxFractionDigits`.
18861
19005
  */
18862
19006
  preserveDecimals?: boolean;
18863
- /**
18864
- * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
18865
- * Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
18866
- * the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
18867
- * decimals, shortDecimals or precision option.
18868
- */
18869
- style?: string;
18870
19007
  /**
18871
19008
  * specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
18872
- * maxFractionDigits. Rounding will only be applied, if the passed value if of type number. This can be
18873
- * assigned by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode} or a function
18874
- * which will be used for rounding the number. The function is called with two parameters: the number and
18875
- * how many decimal digits should be reserved.
19009
+ * maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
19010
+ * assigned
19011
+ * - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
19012
+ * - via a function that is used for rounding the number and takes two parameters: the number itself,
19013
+ * and the number of decimal digits that should be reserved.
18876
19014
  */
18877
19015
  roundingMode?: RoundingMode | keyof typeof RoundingMode;
18878
19016
  /**
18879
- * @since 1.30.0 defines what empty string is parsed as and what is formatted as empty string. The allowed
18880
- * values are only NaN, null or 0. The 'format' and 'parse' are done in a symmetric way. For example when
18881
- * this parameter is set to NaN, empty string is parsed as NaN and NaN is formatted as empty string.
19017
+ * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
19018
+ * options is used
18882
19019
  */
18883
- emptyString?: number;
19020
+ shortDecimals?: int;
19021
+ /**
19022
+ * only use short number formatting for values above this limit
19023
+ */
19024
+ shortLimit?: int;
19025
+ /**
19026
+ * @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
19027
+ * The generated scale factor is used for all numbers which are formatted with this format instance. This
19028
+ * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
19029
+ * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
19030
+ */
19031
+ shortRefNumber?: int;
19032
+ /**
19033
+ * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
19034
+ * only when the 'style' options is set to either 'short' or 'long'.
19035
+ */
19036
+ showScale?: boolean;
19037
+ /**
19038
+ * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
19039
+ * When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
19040
+ * default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
19041
+ * decimals, shortDecimals, or the 'precision' option itself.
19042
+ */
19043
+ style?: string;
18884
19044
  },
18885
19045
  /**
18886
19046
  * Locale to get the formatter for
@@ -18907,26 +19067,96 @@ declare module "sap/ui/core/format/NumberFormat" {
18907
19067
  */
18908
19068
  oFormatOptions?: {
18909
19069
  /**
18910
- * defines minimal number of non-decimal digits
19070
+ * defines the number of decimal digits
18911
19071
  */
18912
- minIntegerDigits?: int;
19072
+ decimals?: int;
19073
+ /**
19074
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
19075
+ * `groupingSeparator`.
19076
+ */
19077
+ decimalSeparator?: string;
19078
+ /**
19079
+ * @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
19080
+ * allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
19081
+ * in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as NaN,
19082
+ * and NaN is formatted as an empty string.
19083
+ */
19084
+ emptyString?: number;
18913
19085
  /**
18914
- * defines maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?" characters
18915
- * are shown instead of digits.
19086
+ * defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
19087
+ */
19088
+ groupingBaseSize?: int;
19089
+ /**
19090
+ * defines whether grouping is enabled (show the grouping separators)
19091
+ */
19092
+ groupingEnabled?: boolean;
19093
+ /**
19094
+ * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
19095
+ * from `decimalSeparator`.
19096
+ */
19097
+ groupingSeparator?: string;
19098
+ /**
19099
+ * defines the grouping size in digits; the default is `3`. It must be a positive number.
19100
+ */
19101
+ groupingSize?: int;
19102
+ /**
19103
+ * defines the maximum number of decimal digits
19104
+ */
19105
+ maxFractionDigits?: int;
19106
+ /**
19107
+ * defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
19108
+ * characters are shown instead of digits.
18916
19109
  */
18917
19110
  maxIntegerDigits?: int;
18918
19111
  /**
18919
- * defines minimal number of decimal digits
19112
+ * defines the minimal number of decimal digits
18920
19113
  */
18921
19114
  minFractionDigits?: int;
18922
19115
  /**
18923
- * defines maximum number of decimal digits
19116
+ * defines the minimal number of non-decimal digits
18924
19117
  */
18925
- maxFractionDigits?: int;
19118
+ minIntegerDigits?: int;
18926
19119
  /**
18927
- * defines the number of decimal digits
19120
+ * defines the used minus symbol
18928
19121
  */
18929
- decimals?: int;
19122
+ minusSign?: string;
19123
+ /**
19124
+ * @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
19125
+ * for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
19126
+ * is parsed to "0.005".
19127
+ */
19128
+ parseAsString?: boolean;
19129
+ /**
19130
+ * CLDR number pattern which is used to format the number
19131
+ */
19132
+ pattern?: string;
19133
+ /**
19134
+ * defines the used percent symbol
19135
+ */
19136
+ percentSign?: string;
19137
+ /**
19138
+ * defines the used plus symbol
19139
+ */
19140
+ plusSign?: string;
19141
+ /**
19142
+ * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
19143
+ */
19144
+ precision?: int;
19145
+ /**
19146
+ * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
19147
+ * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
19148
+ * is rounded to `maxFractionDigits`.
19149
+ */
19150
+ preserveDecimals?: boolean;
19151
+ /**
19152
+ * specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
19153
+ * maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
19154
+ * assigned
19155
+ * - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
19156
+ * - via a function that is used for rounding the number and takes two parameters: the number itself,
19157
+ * and the number of decimal digits that should be reserved.
19158
+ */
19159
+ roundingMode?: RoundingMode | keyof typeof RoundingMode;
18930
19160
  /**
18931
19161
  * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
18932
19162
  * options is used
@@ -18948,83 +19178,13 @@ declare module "sap/ui/core/format/NumberFormat" {
18948
19178
  * only when the 'style' options is set to either 'short' or 'long'.
18949
19179
  */
18950
19180
  showScale?: boolean;
18951
- /**
18952
- * defines the number precision, number of decimals is calculated dependent on the integer digits
18953
- */
18954
- precision?: int;
18955
- /**
18956
- * CLDR number pattern which is used to format the number
18957
- */
18958
- pattern?: string;
18959
- /**
18960
- * defines whether grouping is enabled (show the grouping separators)
18961
- */
18962
- groupingEnabled?: boolean;
18963
- /**
18964
- * defines the character used as grouping separator. Note: `groupingSeparator` must always be different
18965
- * from `decimalSeparator`.
18966
- */
18967
- groupingSeparator?: string;
18968
- /**
18969
- * defines the grouping size in digits, the default is three
18970
- */
18971
- groupingSize?: int;
18972
- /**
18973
- * defines the grouping base size in digits, in case it is different from the grouping size (e.g. indian
18974
- * grouping)
18975
- */
18976
- groupingBaseSize?: int;
18977
- /**
18978
- * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
18979
- * `groupingSeparator`.
18980
- */
18981
- decimalSeparator?: string;
18982
- /**
18983
- * defines the used plus symbol
18984
- */
18985
- plusSign?: string;
18986
- /**
18987
- * defines the used minus symbol
18988
- */
18989
- minusSign?: string;
18990
- /**
18991
- * defines the used percent symbol
18992
- */
18993
- percentSign?: string;
18994
- /**
18995
- * @since 1.28.2 defines whether to output string from parse function in order to keep the precision for
18996
- * big numbers. Numbers in scientific notation are parsed back to the standard notation. For example "5e-3"
18997
- * is parsed to "0.005".
18998
- */
18999
- parseAsString?: boolean;
19000
- /**
19001
- * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
19002
- * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
19003
- * is rounded to `maxFractionDigits`.
19004
- */
19005
- preserveDecimals?: boolean;
19006
19181
  /**
19007
19182
  * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
19008
- * Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
19009
- * the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
19010
- * decimals, shortDecimals or precision option.
19183
+ * When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
19184
+ * default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
19185
+ * decimals, shortDecimals, or the 'precision' option itself.
19011
19186
  */
19012
19187
  style?: string;
19013
- /**
19014
- * specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
19015
- * maxFractionDigits. Rounding will only be applied, if the passed value if of type number. This can be
19016
- * assigned by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode} or a function
19017
- * which will be used for rounding the number. The function is called with two parameters: the number and
19018
- * how many decimal digits should be reserved.
19019
- */
19020
- roundingMode?: RoundingMode | keyof typeof RoundingMode;
19021
- /**
19022
- * @since 1.30.0 defines what empty string is parsed as and what is formatted as empty string. The allowed
19023
- * values are "" (empty string), NaN, null or 0. The 'format' and 'parse' are done in a symmetric way. For
19024
- * example when this parameter is set to NaN, empty string is parsed as NaN and NaN is formatted as empty
19025
- * string.
19026
- */
19027
- emptyString?: number;
19028
19188
  },
19029
19189
  /**
19030
19190
  * Locale to get the formatter for
@@ -19047,55 +19207,35 @@ declare module "sap/ui/core/format/NumberFormat" {
19047
19207
  */
19048
19208
  oFormatOptions?: {
19049
19209
  /**
19050
- * defines minimal number of non-decimal digits
19051
- */
19052
- minIntegerDigits?: int;
19053
- /**
19054
- * defines maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?" characters
19055
- * are shown instead of digits.
19056
- */
19057
- maxIntegerDigits?: int;
19058
- /**
19059
- * defines minimal number of decimal digits
19210
+ * defines the allowed units for formatting and parsing, e.g. ["size-meter", "volume-liter", ...]
19060
19211
  */
19061
- minFractionDigits?: int;
19212
+ allowedUnits?: any[];
19062
19213
  /**
19063
- * defines maximum number of decimal digits
19214
+ * defines a set of custom units, e.g. {"electric-inductance": { "displayName": "henry", "unitPattern-count-one":
19215
+ * "{0} H", "unitPattern-count-other": "{0} H", "perUnitPattern": "{0}/H", "decimals": 2, "precision": 4
19216
+ * }}
19064
19217
  */
19065
- maxFractionDigits?: int;
19218
+ customUnits?: Record<string, object>;
19066
19219
  /**
19067
19220
  * defines the number of decimal digits
19068
19221
  */
19069
19222
  decimals?: int;
19070
19223
  /**
19071
- * defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
19072
- * options is used
19073
- */
19074
- shortDecimals?: int;
19075
- /**
19076
- * only use short number formatting for values above this limit
19077
- */
19078
- shortLimit?: int;
19079
- /**
19080
- * @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
19081
- * The generated scale factor is used for all numbers which are formatted with this format instance. This
19082
- * option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
19083
- * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
19084
- */
19085
- shortRefNumber?: int;
19086
- /**
19087
- * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
19088
- * only when the 'style' options is set to either 'short' or 'long'.
19224
+ * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
19225
+ * `groupingSeparator`.
19089
19226
  */
19090
- showScale?: boolean;
19227
+ decimalSeparator?: string;
19091
19228
  /**
19092
- * defines the number precision, number of decimals is calculated dependent on the integer digits
19229
+ * @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
19230
+ * allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
19231
+ * in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as [NaN,
19232
+ * undefined], and NaN is formatted as an empty string.
19093
19233
  */
19094
- precision?: int;
19234
+ emptyString?: number;
19095
19235
  /**
19096
- * CLDR number pattern which is used to format the number
19236
+ * defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
19097
19237
  */
19098
- pattern?: string;
19238
+ groupingBaseSize?: int;
19099
19239
  /**
19100
19240
  * defines whether grouping is enabled (show the grouping separators)
19101
19241
  */
@@ -19106,64 +19246,79 @@ declare module "sap/ui/core/format/NumberFormat" {
19106
19246
  */
19107
19247
  groupingSeparator?: string;
19108
19248
  /**
19109
- * defines the grouping size in digits, the default is three
19249
+ * defines the grouping size in digits; the default is `3`. It must be a positive number.
19110
19250
  */
19111
19251
  groupingSize?: int;
19112
19252
  /**
19113
- * defines the grouping base size in digits, in case it is different from the grouping size (e.g. indian
19114
- * grouping)
19253
+ * defines the maximum number of decimal digits
19115
19254
  */
19116
- groupingBaseSize?: int;
19117
- /**
19118
- * defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
19119
- * `groupingSeparator`.
19120
- */
19121
- decimalSeparator?: string;
19255
+ maxFractionDigits?: int;
19122
19256
  /**
19123
- * defines a set of custom units, e.g. {"electric-inductance": { "displayName": "henry", "unitPattern-count-one":
19124
- * "{0} H", "unitPattern-count-other": "{0} H", "perUnitPattern": "{0}/H", "decimals": 2, "precision": 4
19125
- * }}
19257
+ * defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
19258
+ * characters are shown instead of digits.
19126
19259
  */
19127
- customUnits?: Record<string, object>;
19260
+ maxIntegerDigits?: int;
19128
19261
  /**
19129
- * defines the allowed units for formatting and parsing, e.g. ["size-meter", "volume-liter", ...]
19262
+ * defines the minimal number of decimal digits
19130
19263
  */
19131
- allowedUnits?: any[];
19264
+ minFractionDigits?: int;
19132
19265
  /**
19133
- * defines the used plus symbol
19266
+ * defines the minimal number of non-decimal digits
19134
19267
  */
19135
- plusSign?: string;
19268
+ minIntegerDigits?: int;
19136
19269
  /**
19137
19270
  * defines the used minus symbol
19138
19271
  */
19139
19272
  minusSign?: string;
19140
19273
  /**
19141
- * @since 1.28.2 defines whether to output string from parse function in order to keep the precision for
19142
- * big numbers. Numbers in scientific notation are parsed back to the standard notation. For example "5e-3"
19274
+ * @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
19275
+ * for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
19143
19276
  * is parsed to "0.005".
19144
19277
  */
19145
19278
  parseAsString?: boolean;
19279
+ /**
19280
+ * CLDR number pattern which is used to format the number
19281
+ */
19282
+ pattern?: string;
19283
+ /**
19284
+ * defines the used plus symbol
19285
+ */
19286
+ plusSign?: string;
19287
+ /**
19288
+ * defines the numerical precision; the number of decimals is calculated dependent on the integer digits
19289
+ */
19290
+ precision?: int;
19146
19291
  /**
19147
19292
  * Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
19148
19293
  * than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
19149
19294
  * is rounded to `maxFractionDigits`.
19150
19295
  */
19151
19296
  preserveDecimals?: boolean;
19152
- /**
19153
- * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
19154
- * Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
19155
- * the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
19156
- * decimals, shortDecimals or precision option.
19157
- */
19158
- style?: string;
19159
19297
  /**
19160
19298
  * specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
19161
- * maxFractionDigits. Rounding will only be applied, if the passed value if of type number. This can be
19162
- * assigned by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode} or a function
19163
- * which will be used for rounding the number. The function is called with two parameters: the number and
19164
- * how many decimal digits should be reserved.
19299
+ * maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
19300
+ * assigned
19301
+ * - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
19302
+ * - via a function that is used for rounding the number and takes two parameters: the number itself,
19303
+ * and the number of decimal digits that should be reserved.
19165
19304
  */
19166
19305
  roundingMode?: RoundingMode | keyof typeof RoundingMode;
19306
+ /**
19307
+ * defines the number of decimals in the shortened format string. If this option isn't specified, the 'decimals'
19308
+ * option is used instead.
19309
+ */
19310
+ shortDecimals?: int;
19311
+ /**
19312
+ * only use short number formatting for values above this limit
19313
+ */
19314
+ shortLimit?: int;
19315
+ /**
19316
+ * @since 1.40 specifies a number from which the scale factor for the 'short' or 'long' style format is
19317
+ * generated. The generated scale factor is used for all numbers which are formatted with this format instance.
19318
+ * This option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
19319
+ * set with `undefined` which means the scale factor is selected automatically for each number being formatted.
19320
+ */
19321
+ shortRefNumber?: int;
19167
19322
  /**
19168
19323
  * defines whether the unit of measure is shown in the formatted string, e.g. for input 1 and "duration-day"
19169
19324
  * true: "1 day", false: "1". If both `showMeasure` and `showNumber` are false, an empty string is returned
@@ -19178,12 +19333,17 @@ declare module "sap/ui/core/format/NumberFormat" {
19178
19333
  */
19179
19334
  showNumber?: boolean;
19180
19335
  /**
19181
- * @since 1.30.0 defines what empty string is parsed as and what is formatted as empty string. The allowed
19182
- * values are "" (empty string), NaN, null or 0. The 'format' and 'parse' are done in a symmetric way. For
19183
- * example when this parameter is set to NaN, empty string is parsed as [NaN, undefined] and NaN is formatted
19184
- * as empty string.
19336
+ * @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
19337
+ * only when the 'style' options is set to either 'short' or 'long'.
19185
19338
  */
19186
- emptyString?: number;
19339
+ showScale?: boolean;
19340
+ /**
19341
+ * defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
19342
+ * When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
19343
+ * default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
19344
+ * decimals, shortDecimals, or the 'precision' option itself.
19345
+ */
19346
+ style?: string;
19187
19347
  },
19188
19348
  /**
19189
19349
  * Locale to get the formatter for
@@ -19203,6 +19363,19 @@ declare module "sap/ui/core/format/NumberFormat" {
19203
19363
  */
19204
19364
  sMeasure?: string
19205
19365
  ): string;
19366
+ /**
19367
+ * @SINCE 1.100
19368
+ *
19369
+ * Returns the scaling factor which is calculated based on the format options and the current locale being
19370
+ * used.
19371
+ *
19372
+ * This function only returns a meaningful scaling factor when the 'style' formatting option is set to 'short'
19373
+ * or 'long', and the 'shortRefNumber' option for calculating the scale factor is set.
19374
+ *
19375
+ * Consider using this function when the 'showScale' option is set to `false`, which causes the scale factor
19376
+ * not to appear in every formatted number but in a shared place.
19377
+ */
19378
+ getScale(): string | undefined;
19206
19379
  /**
19207
19380
  * Parse a string which is formatted according to the given format options.
19208
19381
  */
@@ -20162,8 +20335,10 @@ declare module "sap/ui/core/Icon" {
20162
20335
  * Icon uses embedded font instead of pixel image. Comparing to image, Icon is easily scalable, color can
20163
20336
  * be altered live and various effects can be added using css.
20164
20337
  *
20165
- * A set of built in Icons is available and they can be fetched by calling sap.ui.core.IconPool.getIconURI
20166
- * and set this value to the src property on the Icon.
20338
+ * A set of built in Icons is available in the Icon
20339
+ * Explorer.
20340
+ *
20341
+ * For further information, see {@link topic:21ea0ea94614480d9a910b2e93431291 Icon and Icon Pool}.
20167
20342
  */
20168
20343
  export default class Icon extends Control implements IFormContent {
20169
20344
  __implements__sap_ui_core_IFormContent: boolean;
@@ -20412,9 +20587,17 @@ declare module "sap/ui/core/Icon" {
20412
20587
  /**
20413
20588
  * Gets current value of property {@link #getSrc src}.
20414
20589
  *
20415
- * This property should be set by the return value of calling sap.ui.core.IconPool.getIconURI with an Icon
20416
- * name parameter and an optional collection parameter which is required when using application extended
20417
- * Icons. A list of standard FontIcon is available here.
20590
+ * This property can be set by following options:
20591
+ *
20592
+ * **Option 1:**
20593
+ * The value has to be matched by following pattern `sap-icon://collection-name/icon-name` where `collection-name`
20594
+ * and `icon-name` have to be replaced by the desired values. In case the default UI5 icons are used the
20595
+ * `collection-name` can be omited.
20596
+ * Example: `sap-icon://accept`
20597
+ *
20598
+ * **Option 2:** The value is determined by using {@link sap.ui.core.IconPool.getIconURI} with an Icon name
20599
+ * parameter and an optional collection parameter which is required when using application extended Icons.
20600
+ * Example: `IconPool.getIconURI("accept")`
20418
20601
  */
20419
20602
  getSrc(): URI;
20420
20603
  /**
@@ -20627,9 +20810,17 @@ declare module "sap/ui/core/Icon" {
20627
20810
  /**
20628
20811
  * Sets a new value for property {@link #getSrc src}.
20629
20812
  *
20630
- * This property should be set by the return value of calling sap.ui.core.IconPool.getIconURI with an Icon
20631
- * name parameter and an optional collection parameter which is required when using application extended
20632
- * Icons. A list of standard FontIcon is available here.
20813
+ * This property can be set by following options:
20814
+ *
20815
+ * **Option 1:**
20816
+ * The value has to be matched by following pattern `sap-icon://collection-name/icon-name` where `collection-name`
20817
+ * and `icon-name` have to be replaced by the desired values. In case the default UI5 icons are used the
20818
+ * `collection-name` can be omited.
20819
+ * Example: `sap-icon://accept`
20820
+ *
20821
+ * **Option 2:** The value is determined by using {@link sap.ui.core.IconPool.getIconURI} with an Icon name
20822
+ * parameter and an optional collection parameter which is required when using application extended Icons.
20823
+ * Example: `IconPool.getIconURI("accept")`
20633
20824
  *
20634
20825
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
20635
20826
  */
@@ -20674,9 +20865,17 @@ declare module "sap/ui/core/Icon" {
20674
20865
 
20675
20866
  export interface $IconSettings extends $ControlSettings {
20676
20867
  /**
20677
- * This property should be set by the return value of calling sap.ui.core.IconPool.getIconURI with an Icon
20678
- * name parameter and an optional collection parameter which is required when using application extended
20679
- * Icons. A list of standard FontIcon is available here.
20868
+ * This property can be set by following options:
20869
+ *
20870
+ * **Option 1:**
20871
+ * The value has to be matched by following pattern `sap-icon://collection-name/icon-name` where `collection-name`
20872
+ * and `icon-name` have to be replaced by the desired values. In case the default UI5 icons are used the
20873
+ * `collection-name` can be omited.
20874
+ * Example: `sap-icon://accept`
20875
+ *
20876
+ * **Option 2:** The value is determined by using {@link sap.ui.core.IconPool.getIconURI} with an Icon name
20877
+ * parameter and an optional collection parameter which is required when using application extended Icons.
20878
+ * Example: `IconPool.getIconURI("accept")`
20680
20879
  */
20681
20880
  src?: URI | PropertyBindingInfo;
20682
20881
 
@@ -25990,6 +26189,13 @@ declare module "sap/ui/core/mvc/XMLView" {
25990
26189
  * On root level, you can only define content for the default aggregation, e.g. without adding the `<content>`
25991
26190
  * tag. If you want to specify content for another aggregation of a view like `dependents`, place it in
25992
26191
  * a child control's dependents aggregation or add it by using {@link sap.ui.core.mvc.XMLView#addDependent}.
26192
+ *
26193
+ * **Note:**
26194
+ * The XML view offers special handling for context binding and style classes. You can specify them via
26195
+ * the `binding` and `class` attributes on a control's XML node. Please be aware that these attributes are
26196
+ * not properties of the respective controls and thus are not supported by a control's constructor. For
26197
+ * more information, see {@link topic:91f05e8b6f4d1014b6dd926db0e91070 Context Binding (Element Binding)}
26198
+ * and {@link topic:b564935324f449209354c7e2f9903f22 Using CSS Style Sheets in XML Views}.
25993
26199
  */
25994
26200
  export default class XMLView extends View {
25995
26201
  /**
@@ -26268,7 +26474,7 @@ declare module "sap/ui/core/Popup" {
26268
26474
 
26269
26475
  import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
26270
26476
 
26271
- import { OpenState } from "sap/ui/core/library";
26477
+ import { OpenState, Collision } from "sap/ui/core/library";
26272
26478
 
26273
26479
  /**
26274
26480
  * Popup Class is a helper class for controls that want themselves or parts of themselves or even other
@@ -26729,7 +26935,7 @@ declare module "sap/ui/core/Popup" {
26729
26935
  * Opens the popup's content at the position either specified here or beforehand via {@link #setPosition}.
26730
26936
  * Content must be capable of being positioned via "position:absolute;" All parameters are optional (open()
26731
26937
  * may be called without any parameters). iDuration may just be omitted, but if any of "at", "of", "offset",
26732
- * "collision" is given, also the preceding positioning parameters ("my", at",...) must be given.
26938
+ * "collision" is given, also the preceding positional parameters ("my", at",...) must be given.
26733
26939
  *
26734
26940
  * If the Popup's OpenState is different from "CLOSED" (i.e. if the Popup is already open, opening or closing),
26735
26941
  * the call is ignored.
@@ -26761,7 +26967,7 @@ declare module "sap/ui/core/Popup" {
26761
26967
  * defines how the position of an element should be adjusted in case it overflows the within area in some
26762
26968
  * direction.
26763
26969
  */
26764
- collision?: string,
26970
+ collision?: Collision,
26765
26971
  /**
26766
26972
  * defines the area the popup should be placed in. This affects the collision detection.
26767
26973
  */
@@ -26769,7 +26975,7 @@ declare module "sap/ui/core/Popup" {
26769
26975
  /**
26770
26976
  * defines whether the popup should follow the dock reference when the reference changes its position.
26771
26977
  */
26772
- followOf?: boolean
26978
+ followOf?: boolean | Function | null
26773
26979
  ): void;
26774
26980
  /**
26775
26981
  * Sets the animation functions to use for opening and closing the Popup. Any null value will be ignored
@@ -26911,9 +27117,9 @@ declare module "sap/ui/core/Popup" {
26911
27117
  offset?: string,
26912
27118
  /**
26913
27119
  * defines how the position of an element should be adjusted in case it overflows the within area in some
26914
- * direction. The valid values that refer to jQuery-UI's position parameters are "flip", "fit" and "none".
27120
+ * direction.
26915
27121
  */
26916
- collision?: string,
27122
+ collision?: Collision,
26917
27123
  /**
26918
27124
  * defines the area the popup should be placed in. This affects the collision detection.
26919
27125
  */
@@ -37593,19 +37799,56 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
37593
37799
  */
37594
37800
  getNodeContexts(
37595
37801
  /**
37596
- * specifying the aggregation level for which contexts shall be fetched. Supported parameters are:
37597
- *
37598
- * - oContext: parent context identifying the requested group of child contexts
37599
- * - level: level number for oContext, because it might occur at multiple levels; context with group ID
37600
- * `"/"` has level 0
37601
- * - numberOfExpandedLevels: number of child levels that shall be fetched automatically
37602
- * - startIndex: index of first child entry to return from the parent context (zero-based)
37603
- * - length: number of entries to return; counting begins at the given start index
37604
- * - threshold: number of additional entries that shall be locally available in the binding for subsequent
37605
- * accesses to child entries of the given parent context.
37802
+ * Parent context identifying the requested group of child contexts
37606
37803
  */
37607
- mParameters: object
37608
- ): any[];
37804
+ oContext: Context,
37805
+ /**
37806
+ * Parameters, specifying the aggregation level for which contexts shall be fetched or (legacy signature
37807
+ * variant) index of first child entry to return from the parent context (zero-based)
37808
+ */
37809
+ mParameters:
37810
+ | {
37811
+ /**
37812
+ * Level number for oContext, because it might occur at multiple levels; context with group ID `"/"` has
37813
+ * level 0
37814
+ */
37815
+ level: int;
37816
+ /**
37817
+ * Number of child levels that shall be fetched automatically
37818
+ */
37819
+ numberOfExpandedLevels?: int;
37820
+ /**
37821
+ * Index of first child entry to return from the parent context (zero-based)
37822
+ */
37823
+ startIndex?: int;
37824
+ /**
37825
+ * Number of entries to return; counting begins at the given start index
37826
+ */
37827
+ length?: int;
37828
+ /**
37829
+ * Number of additional entries that shall be locally available in the binding for subsequent accesses to
37830
+ * child entries of the given parent context
37831
+ */
37832
+ threshold?: int;
37833
+ }
37834
+ | int,
37835
+ /**
37836
+ * Same meaning as `mParameters.length`, legacy signature variant only
37837
+ */
37838
+ iLength?: int,
37839
+ /**
37840
+ * Same meaning as `mParameters.threshold`, legacy signature variant only
37841
+ */
37842
+ iThreshold?: int,
37843
+ /**
37844
+ * Same meaning as `mParameters.level`, legacy signature variant only
37845
+ */
37846
+ iLevel?: int,
37847
+ /**
37848
+ * Same meaning as `mParameters.numberOfExpandedLevels`, legacy signature variant only
37849
+ */
37850
+ iNumberOfExpandedLevels?: int
37851
+ ): Context[];
37609
37852
  /**
37610
37853
  * Gets the metadata of a property with a given name.
37611
37854
  */
@@ -41059,6 +41302,18 @@ declare module "sap/ui/model/CompositeType" {
41059
41302
  */
41060
41303
  aCurrentValues?: any[]
41061
41304
  ): any[] | any;
41305
+ /**
41306
+ * @SINCE 1.100.0
41307
+ *
41308
+ * Processes the types of the parts of this composite type. A concrete composite type may override this
41309
+ * method if it needs to derive information from the types of the parts.
41310
+ */
41311
+ processPartTypes(
41312
+ /**
41313
+ * Types of the composite binding's parts
41314
+ */
41315
+ aPartTypes: SimpleType[]
41316
+ ): void;
41062
41317
  /**
41063
41318
  * Validates whether the given raw values meet the defined constraints. This method does nothing if no constraints
41064
41319
  * are defined.
@@ -42059,24 +42314,24 @@ declare module "sap/ui/model/json/JSONModel" {
42059
42314
  bMerge?: boolean
42060
42315
  ): void;
42061
42316
  /**
42062
- * Sets a new value for the given property `sPropertyName` in the model. If the model value changed all
42063
- * interested parties are informed.
42317
+ * Sets `oValue` as new value for the property defined by the given `sPath` and `oContext`. Once the new
42318
+ * model value has been set, all interested parties are informed.
42064
42319
  */
42065
42320
  setProperty(
42066
42321
  /**
42067
- * path of the property to set
42322
+ * The path of the property to set
42068
42323
  */
42069
42324
  sPath: string,
42070
42325
  /**
42071
- * value to set the property to
42326
+ * The new value to be set for this property
42072
42327
  */
42073
42328
  oValue: any,
42074
42329
  /**
42075
- * the context which will be used to set the property
42330
+ * The context used to set the property
42076
42331
  */
42077
- oContext?: object,
42332
+ oContext?: Context,
42078
42333
  /**
42079
- * whether to update other bindings dependent on this property asynchronously
42334
+ * Whether to update other bindings dependent on this property asynchronously
42080
42335
  */
42081
42336
  bAsyncUpdate?: boolean
42082
42337
  ): boolean;
@@ -47339,16 +47594,20 @@ declare module "sap/ui/model/odata/type/DateTimeWithTimezone" {
47339
47594
  *
47340
47595
  * This class represents the `DateTimeWithTimezone` composite type which has the parts timestamp and time
47341
47596
  * zone. The type formats the timestamp part using the time zone part. For this, the timestamp part has
47342
- * to be provided in the UTC time zone.
47597
+ * to be provided in the UTC time zone. When using this type with the {@link sap.ui.model.odata.v2.ODataModel},
47598
+ * you need to set the parameter `useUndefinedIfUnresolved` for both parts.
47343
47599
  */
47344
47600
  export default class DateTimeWithTimezone extends CompositeType {
47345
47601
  /**
47346
47602
  * Constructor for a `DateTimeWithTimezone` composite type.
47603
+ * See:
47604
+ * {sap.ui.model.odata.v2.ODataModel#bindProperty}
47347
47605
  */
47348
47606
  constructor(
47349
47607
  /**
47350
47608
  * Format options. For a list of all available options, see {@link sap.ui.core.format.DateFormat.getDateTimeWithTimezoneInstance
47351
- * DateFormat}. Format options are immutable, that is, they can only be set once on construction.
47609
+ * DateFormat}. The `strictParsing` format option is set to `true` by default and can be overwritten. Format
47610
+ * options are immutable, that is, they can only be set once on construction.
47352
47611
  */
47353
47612
  oFormatOptions?: object,
47354
47613
  /**
@@ -49339,7 +49598,9 @@ declare module "sap/ui/model/odata/v2/Context" {
49339
49598
  * @SINCE 1.98.0
49340
49599
  *
49341
49600
  * Returns whether this context is inactive. An inactive context will only be sent to the server after the
49342
- * first property update. From then on it behaves like any other created context.
49601
+ * first property update. From then on it behaves like any other created context. The result of this function
49602
+ * can also be accessed via the "@$ui5.context.isInactive" instance annotation at the entity, see {@link
49603
+ * sap.ui.model.odata.v2.ODataModel#getProperty} for details.
49343
49604
  * See:
49344
49605
  * sap.ui.model.odata.v2.ODataListBinding#create
49345
49606
  * sap.ui.model.odata.v2.ODataModel#createEntry
@@ -49350,7 +49611,9 @@ declare module "sap/ui/model/odata/v2/Context" {
49350
49611
  *
49351
49612
  * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry} or {@link sap.ui.model.odata.v2.ODataListBinding#create},
49352
49613
  * the method returns `true` if the context is transient or `false` if the context is not transient. A transient
49353
- * context represents an entity created on the client which has not been persisted in the back end.
49614
+ * context represents an entity created on the client which has not been persisted in the back end. The
49615
+ * result of this function can also be accessed via the "@$ui5.context.isTransient" instance annotation
49616
+ * at the entity, see {@link sap.ui.model.odata.v2.ODataModel#getProperty} for details.
49354
49617
  */
49355
49618
  isTransient(): boolean;
49356
49619
  }
@@ -51122,7 +51385,8 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
51122
51385
  /**
51123
51386
  * Creates a new property binding for this model.
51124
51387
  * See:
51125
- * sap.ui.model.Model.prototype.bindProperty
51388
+ * sap.ui.model.Model#bindProperty
51389
+ * #getProperty
51126
51390
  */
51127
51391
  bindProperty(
51128
51392
  /**
@@ -51142,13 +51406,18 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
51142
51406
  * Whether this binding does not propagate model messages to the control; supported since 1.82.0. Some composite
51143
51407
  * types like {@link sap.ui.model.type.Currency} automatically ignore model messages for some of their parts
51144
51408
  * depending on their format options; setting this parameter to `true` or `false` overrules the automatism
51145
- * of the type.
51409
+ * of the type
51146
51410
  *
51147
51411
  * For example, a binding for a currency code is used in a composite binding for rendering the proper number
51148
51412
  * of decimals, but the currency code is not displayed in the attached control. In that case, messages for
51149
- * the currency code shall not be displayed at that control, only messages for the amount.
51413
+ * the currency code shall not be displayed at that control, only messages for the amount
51150
51414
  */
51151
51415
  ignoreMessages?: boolean;
51416
+ /**
51417
+ * Whether the value of the created property binding is `undefined` if it is unresolved; if not set, its
51418
+ * value is `null`. Supported since 1.100.0
51419
+ */
51420
+ useUndefinedIfUnresolved?: boolean;
51152
51421
  }
51153
51422
  ): PropertyBinding;
51154
51423
  /**
@@ -52185,11 +52454,13 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
52185
52454
  */
52186
52455
  getPendingChanges(): Record<string, object>;
52187
52456
  /**
52188
- * Returns the value for the property with the given `sPath`.
52457
+ * Returns the value for the property with the given `sPath`. Since 1.100, a path starting with "@$ui5."
52458
+ * which represents an instance annotation is supported. The following instance annotations are allowed;
52459
+ * they return information on the given oContext, which must be set and be an {@link sap.ui.model.odata.v2.Context}:
52189
52460
  *
52190
- * If the path points to a navigation property which has been loaded via `$expand` then the `bIncludeExpandEntries`
52191
- * parameter determines if the navigation property should be included in the returned value or not. Please
52192
- * note that this currently works for 1..1 navigation properties only.
52461
+ * - `@$ui5.context.isInactive`: The return value of {@link sap.ui.model.odata.v2.Context#isInactive}
52462
+ *
52463
+ * - `@$ui5.context.isTransient`: The return value of {@link sap.ui.model.odata.v2.Context#isTransient}
52193
52464
  */
52194
52465
  getProperty(
52195
52466
  /**
@@ -52201,11 +52472,9 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
52201
52472
  */
52202
52473
  oContext?: object,
52203
52474
  /**
52204
- * @deprecated Please use {@link #getObject} function with select/expand parameters instead. This parameter
52205
- * should be set when a URI or custom parameter with a `$expand` system query option was used to retrieve
52206
- * associated entries embedded/inline. If true then the `getProperty` function returns a desired property
52207
- * value/entry and includes the associated expand entries (if any). Note: A copy and not a reference of
52208
- * the entry will be returned.
52475
+ * Deprecated, use {@link #getObject} function with 'select' and 'expand' parameters instead. Whether entities
52476
+ * for navigation properties of this property which have been read via `$expand` are part of the return
52477
+ * value.
52209
52478
  */
52210
52479
  bIncludeExpandEntries?: boolean
52211
52480
  ): any;
@@ -54094,8 +54363,10 @@ declare module "sap/ui/model/odata/v4/Context" {
54094
54363
  */
54095
54364
  fnOnBeforeDestroy?: Function,
54096
54365
  /**
54097
- * Whether to request messages for this entity. Only used if `bKeepAlive` is `true`. The binding keeps requesting
54098
- * messages until it is destroyed. Supported since 1.92.0
54366
+ * Whether to request messages for this entity. Only used if `bKeepAlive` is `true`. Determines the messages
54367
+ * property from the annotation "com.sap.vocabularies.Common.v1.Messages" at the entity type. If found,
54368
+ * the binding keeps requesting messages until it is destroyed. Otherwise an error is logged in the console
54369
+ * and no messages are requested. Supported since 1.92.0
54099
54370
  */
54100
54371
  bRequestMessages?: boolean
54101
54372
  ): void;
@@ -54340,10 +54611,10 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
54340
54611
  * entity type, you can bind properties as usual, for example `<Text text="{street}"/>`.
54341
54612
  *
54342
54613
  * Since 1.98.0, a single-valued navigation property can be treated like a function if
54343
- * it has the same type as the operation binding's parent context, that parent context is in the
54344
- * collection (has an index, see {@link sap.ui.model.odata.v4.Context#getIndex}) of a list binding for a
54345
- * top-level entity set, there is a navigation property binding which points to that same entity set,
54346
- * no operation parameters have been set, the `bReplaceWithRVC` parameter is used.
54614
+ * it has the same type as the operation binding's parent context, that parent context is in a list
54615
+ * binding for a top-level entity set, there is a navigation property binding which points to that
54616
+ * same entity set, no operation parameters have been set, the `bReplaceWithRVC` parameter is
54617
+ * used.
54347
54618
  */
54348
54619
  execute(
54349
54620
  /**
@@ -54439,12 +54710,12 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
54439
54710
  hasPendingChanges(
54440
54711
  /**
54441
54712
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
54442
- * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
54443
- * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
54444
- * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding. Since 1.98.0, {@link
54445
- * sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding}
54446
- * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
54447
- * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
54713
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
54714
+ * refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
54715
+ * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
54716
+ * of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
54717
+ * contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
54718
+ * the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
54448
54719
  */
54449
54720
  bIgnoreKeptAlive?: boolean
54450
54721
  ): boolean;
@@ -54475,10 +54746,10 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
54475
54746
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
54476
54747
  * with the given group ID.
54477
54748
  *
54478
- * If there are pending changes, an error is thrown. Use {@link #hasPendingChanges} to check if there are
54479
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
54480
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
54481
- * {@link #refresh}.
54749
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
54750
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
54751
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
54752
+ * calling {@link #refresh}.
54482
54753
  *
54483
54754
  * Use {@link #requestRefresh} if you want to wait for the refresh.
54484
54755
  * See:
@@ -55077,7 +55348,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
55077
55348
  * @SINCE 1.99.0
55078
55349
  *
55079
55350
  * Calls {@link sap.ui.model.odata.v4.Context#setKeepAlive} at the context for the given path and returns
55080
- * it.
55351
+ * it. Since 1.100.0 the function always returns such a context. If none exists yet, it is created without
55352
+ * data and a request for its entity is sent.
55081
55353
  * See:
55082
55354
  * sap.ui.model.odata.v4.Model#getKeepAliveContext
55083
55355
  */
@@ -55089,7 +55361,12 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
55089
55361
  /**
55090
55362
  * Whether to request messages for the context's entity
55091
55363
  */
55092
- bRequestMessages?: boolean
55364
+ bRequestMessages?: boolean,
55365
+ /**
55366
+ * The group ID used for read requests for the context's entity or its properties. If not given, the binding's
55367
+ * {@link #getGroupId group ID} is used. Supported since 1.100.0
55368
+ */
55369
+ sGroupId?: string
55093
55370
  ): Context | undefined;
55094
55371
  /**
55095
55372
  * @SINCE 1.37.0
@@ -55148,12 +55425,12 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
55148
55425
  hasPendingChanges(
55149
55426
  /**
55150
55427
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
55151
- * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
55152
- * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
55153
- * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding. Since 1.98.0, {@link
55154
- * sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding}
55155
- * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
55156
- * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
55428
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
55429
+ * refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
55430
+ * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
55431
+ * of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
55432
+ * contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
55433
+ * the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
55157
55434
  */
55158
55435
  bIgnoreKeptAlive?: boolean
55159
55436
  ): boolean;
@@ -55201,10 +55478,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
55201
55478
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
55202
55479
  * with the given group ID.
55203
55480
  *
55204
- * If there are pending changes, an error is thrown. Use {@link #hasPendingChanges} to check if there are
55205
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
55206
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
55207
- * {@link #refresh}.
55481
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
55482
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
55483
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
55484
+ * calling {@link #refresh}.
55208
55485
  *
55209
55486
  * Use {@link #requestRefresh} if you want to wait for the refresh.
55210
55487
  * See:
@@ -56472,7 +56749,8 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
56472
56749
  $$canonicalPath?: boolean;
56473
56750
  /**
56474
56751
  * Whether this binding is considered for a match when {@link #getKeepAliveContext} is called; only the
56475
- * value `true` is allowed. Supported since 1.99.0
56752
+ * value `true` is allowed. Must not be combined with `$apply`, `$$aggregation`, `$$canonicalPath`, or `$$sharedRequest`.
56753
+ * If the binding is relative, `$$ownRequest` must be set as well. Supported since 1.99.0
56476
56754
  */
56477
56755
  $$getKeepAliveContext?: boolean;
56478
56756
  /**
@@ -56736,10 +57014,19 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
56736
57014
  * @SINCE 1.99.0
56737
57015
  *
56738
57016
  * Returns a context with the given path belonging to a matching list binding that has been marked with
56739
- * `$$getKeepAliveContext` (see {@link #bindList}). If such a context exists, it is returned and kept alive
56740
- * (see {@link sap.ui.model.odata.v4.Context#setKeepAlive}).
56741
- * See:
56742
- * sap.ui.model.odata.v4.ODataListBinding#getKeepAliveContext
57017
+ * `$$getKeepAliveContext` (see {@link #bindList}). If such a matching binding can be found, a context is
57018
+ * returned and kept alive (see {@link sap.ui.model.odata.v4.ODataListBinding#getKeepAliveContext}). Since
57019
+ * 1.100.0 a temporary binding is used if no such binding could be found. If such a binding is created or
57020
+ * resolved later, the context and its data are transferred to it, and the temporary binding is destroyed
57021
+ * again.
57022
+ *
57023
+ * A `$$getKeepAliveContext` binding matches if its resolved binding path is the collection path of the
57024
+ * context. If the context is created using a temporary binding and the parameters of the `$$getKeepAliveContext`
57025
+ * binding differ from the given `mParameters` (except `$$groupId` which is especially used for the context),
57026
+ * that binding later runs into an error when trying to read data.
57027
+ *
57028
+ * **Note**: The context received by this function may change its {@link sap.ui.model.odata.v4.Context#getBinding
57029
+ * binding} during its lifetime.
56743
57030
  */
56744
57031
  getKeepAliveContext(
56745
57032
  /**
@@ -56749,7 +57036,27 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
56749
57036
  /**
56750
57037
  * Whether to request messages for the context's entity
56751
57038
  */
56752
- bRequestMessages?: boolean
57039
+ bRequestMessages?: boolean,
57040
+ /**
57041
+ * Parameters for the context or the temporary binding; supported since 1.100.0. All custom query options
57042
+ * and the following binding-specific parameters for a list binding may be given (see {@link #bindList}
57043
+ * for details).
57044
+ */
57045
+ mParameters?: {
57046
+ /**
57047
+ * The group ID used for read requests for the context's entity or its properties. If not given, the model's
57048
+ * {@link #getGroupId group ID} is used
57049
+ */
57050
+ $$groupId?: string;
57051
+ /**
57052
+ * Whether implicit loading of side effects via PATCH requests is switched off
57053
+ */
57054
+ $$patchWithoutSideEffects?: boolean;
57055
+ /**
57056
+ * The group ID to be used for **update** requests triggered by the context's binding
57057
+ */
57058
+ $$updateGroupId?: string;
57059
+ }
56753
57060
  ): Context | undefined;
56754
57061
  /**
56755
57062
  * @SINCE 1.85.0
@@ -57047,12 +57354,12 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
57047
57354
  hasPendingChanges(
57048
57355
  /**
57049
57356
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
57050
- * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#sort
57051
- * sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend suspend} because they relate to a {@link
57052
- * sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context of this binding. Since 1.98.0, {@link
57053
- * sap.ui.model.odata.v4.Context#isTransient transient} contexts of a {@link #getRootBinding root binding}
57054
- * are treated as kept-alive by this flag. Since 1.99.0, the same happens for bindings using the `$$ownRequest`
57055
- * parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
57357
+ * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
57358
+ * refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
57359
+ * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
57360
+ * of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
57361
+ * contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
57362
+ * the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
57056
57363
  */
57057
57364
  bIgnoreKeptAlive?: boolean
57058
57365
  ): boolean;
@@ -57074,10 +57381,10 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
57074
57381
  * determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
57075
57382
  * with the given group ID.
57076
57383
  *
57077
- * If there are pending changes, an error is thrown. Use {@link #hasPendingChanges} to check if there are
57078
- * pending changes. If there are changes, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit
57079
- * the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before calling
57080
- * {@link #refresh}.
57384
+ * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
57385
+ * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
57386
+ * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
57387
+ * calling {@link #refresh}.
57081
57388
  *
57082
57389
  * Use {@link #requestRefresh} if you want to wait for the refresh.
57083
57390
  * See:
@@ -64013,7 +64320,7 @@ declare module "sap/ui/test/OpaBuilder" {
64013
64320
  /**
64014
64321
  * the type of the target control(s)
64015
64322
  */
64016
- vControlType?: string,
64323
+ sControlType?: string,
64017
64324
  /**
64018
64325
  * if true, only popover and dialogs are searched for
64019
64326
  */
@@ -64269,9 +64576,9 @@ declare module "sap/ui/test/OpaBuilder" {
64269
64576
  */
64270
64577
  sAggregationName: string,
64271
64578
  /**
64272
- * iNumber length to check against
64579
+ * length to check against
64273
64580
  */
64274
- int?: undefined
64581
+ iNumber: int
64275
64582
  ): this;
64276
64583
  /**
64277
64584
  * Adds a matcher to aggregation items checking for certain properties. At least one item must match the
@@ -64369,7 +64676,7 @@ declare module "sap/ui/test/OpaBuilder" {
64369
64676
  /**
64370
64677
  * the type of the target control(s)
64371
64678
  */
64372
- vControlType: string
64679
+ sControlType: string
64373
64680
  ): this;
64374
64681
  /**
64375
64682
  * Defines whether target control is part of a popover or dialog (sets `searchOpenDialogs` property).
@@ -69057,6 +69364,8 @@ declare namespace sap {
69057
69364
 
69058
69365
  "sap/ui/core/format/DateFormat": undefined;
69059
69366
 
69367
+ "sap/ui/core/format/DateFormatTimezoneDisplay": undefined;
69368
+
69060
69369
  "sap/ui/core/format/FileSizeFormat": undefined;
69061
69370
 
69062
69371
  "sap/ui/core/format/ListFormat": undefined;
@@ -69581,6 +69890,8 @@ declare namespace sap {
69581
69890
 
69582
69891
  "sap/ui/performance/trace/FESR": undefined;
69583
69892
 
69893
+ "sap/ui/performance/trace/FESRHelper": undefined;
69894
+
69584
69895
  "sap/ui/performance/trace/initTraces": undefined;
69585
69896
 
69586
69897
  "sap/ui/performance/trace/Interaction": undefined;
@@ -69601,6 +69912,10 @@ declare namespace sap {
69601
69912
 
69602
69913
  "sap/ui/test/actions/Scroll": undefined;
69603
69914
 
69915
+ "sap/ui/test/generic/GenericTestCollection": undefined;
69916
+
69917
+ "sap/ui/test/generic/Utils": undefined;
69918
+
69604
69919
  "sap/ui/test/gherkin/dataTableUtils": undefined;
69605
69920
 
69606
69921
  "sap/ui/test/gherkin/opa5TestHarness": undefined;