@openui5/ts-types-esm 1.98.0 → 1.101.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.
- package/package.json +6 -2
- package/types/sap.f.d.ts +389 -89
- package/types/sap.m.d.ts +1692 -176
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1489 -752
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +11 -5
- package/types/sap.ui.integration.d.ts +29 -11
- package/types/sap.ui.layout.d.ts +4 -1
- package/types/sap.ui.mdc.d.ts +64 -8
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +10 -12
- package/types/sap.ui.table.d.ts +13 -49
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +2836 -860
- package/types/sap.ui.webc.main.d.ts +3346 -1034
- package/types/sap.uxap.d.ts +2 -2
package/types/sap.ui.core.d.ts
CHANGED
|
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
|
|
|
264
264
|
): jQuery;
|
|
265
265
|
}
|
|
266
266
|
|
|
267
|
-
// For Library Version: 1.
|
|
267
|
+
// For Library Version: 1.101.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
|
-
|
|
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.
|
|
@@ -2405,9 +2405,14 @@ declare module "sap/ui/dom/includeStylesheet" {
|
|
|
2405
2405
|
/**
|
|
2406
2406
|
* @SINCE 1.58
|
|
2407
2407
|
*
|
|
2408
|
-
* Includes the specified stylesheet via a <link>-tag in the head of the current document.
|
|
2409
|
-
*
|
|
2410
|
-
*
|
|
2408
|
+
* Includes the specified stylesheet via a <link>-tag in the head of the current document.
|
|
2409
|
+
*
|
|
2410
|
+
* If `includeStylesheet` is called with an `sId` of an already included stylesheet and:
|
|
2411
|
+
* - either `fnLoadCallback` or `fnErrorCallback` is given: the old stylesheet is deleted and a new one
|
|
2412
|
+
* is inserted
|
|
2413
|
+
* - `vUrl` is different from the existing one's: the old stylesheet is deleted and a new one is inserted
|
|
2414
|
+
*
|
|
2415
|
+
* - otherwise: no action
|
|
2411
2416
|
*/
|
|
2412
2417
|
export default function includeStylesheet(
|
|
2413
2418
|
/**
|
|
@@ -3238,6 +3243,54 @@ declare module "sap/ui/performance/Measurement" {
|
|
|
3238
3243
|
};
|
|
3239
3244
|
}
|
|
3240
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
|
+
|
|
3241
3294
|
declare module "sap/ui/performance/trace/Interaction" {
|
|
3242
3295
|
/**
|
|
3243
3296
|
* @SINCE 1.76
|
|
@@ -3349,6 +3402,49 @@ declare module "sap/ui/test/opaQunit" {
|
|
|
3349
3402
|
*/
|
|
3350
3403
|
async?: boolean
|
|
3351
3404
|
): void;
|
|
3405
|
+
/**
|
|
3406
|
+
* QUnit test adapter for OPA: add a test to be executed by QUnit Has the same signature as QUnit.test (QUnit
|
|
3407
|
+
* version is also considered) Suggested usage:
|
|
3408
|
+
* ```javascript
|
|
3409
|
+
*
|
|
3410
|
+
* sap.ui.require(["sap/ui/test/Opa5", "sap/ui/test/opaQunit"], function (Opa5, opaTest) {
|
|
3411
|
+
*
|
|
3412
|
+
* Opa5.extendConfig({
|
|
3413
|
+
* assertions: new Opa5({
|
|
3414
|
+
* checkIfSomethingIsOk : function () {
|
|
3415
|
+
* this.waitFor({
|
|
3416
|
+
* success: function () {
|
|
3417
|
+
* Opa5.assert.ok(true, "Everything is fine");
|
|
3418
|
+
* }
|
|
3419
|
+
* });
|
|
3420
|
+
* }
|
|
3421
|
+
* })
|
|
3422
|
+
* });
|
|
3423
|
+
*
|
|
3424
|
+
* opaTest("Should test something", function (Given, When, Then) {
|
|
3425
|
+
* // Implementation of the test
|
|
3426
|
+
* Then.checkIfSomethingIsOk();
|
|
3427
|
+
* });
|
|
3428
|
+
*
|
|
3429
|
+
* });
|
|
3430
|
+
* ```
|
|
3431
|
+
*/
|
|
3432
|
+
export default function opaQunit(
|
|
3433
|
+
/**
|
|
3434
|
+
* name of the QUnit test.
|
|
3435
|
+
*/
|
|
3436
|
+
testName: string,
|
|
3437
|
+
/**
|
|
3438
|
+
* the test function. Expects 3 arguments, in order: {@link sap.ui.test.Opa.config}.arrangements, {@link
|
|
3439
|
+
* sap.ui.test.Opa.config}.actions, {@link sap.ui.test.Opa.config}.assertions. These arguments will be prefilled
|
|
3440
|
+
* by OPA
|
|
3441
|
+
*/
|
|
3442
|
+
callback: Function,
|
|
3443
|
+
/**
|
|
3444
|
+
* available only in QUnit v1.x. Indicates whether the test is asynchronous. False by default.
|
|
3445
|
+
*/
|
|
3446
|
+
async?: boolean
|
|
3447
|
+
): void;
|
|
3352
3448
|
}
|
|
3353
3449
|
|
|
3354
3450
|
declare module "sap/ui/util/Mobile" {
|
|
@@ -3617,24 +3713,25 @@ declare module "sap/ui/VersionInfo" {
|
|
|
3617
3713
|
/**
|
|
3618
3714
|
* @SINCE 1.56.0
|
|
3619
3715
|
*
|
|
3620
|
-
* Loads the version info
|
|
3621
|
-
* returned Promise resolves with the version info files content.
|
|
3716
|
+
* Loads the version info asynchronously from resource "sap-ui-version.json".
|
|
3622
3717
|
*
|
|
3623
|
-
*
|
|
3718
|
+
* By default, the returned promise will resolve with the whole version info file's content. If a library
|
|
3719
|
+
* name is specified in the options, then the promise will resolve with the version info for that library
|
|
3720
|
+
* only or with `undefined`, if the named library is not listed in the version info file.
|
|
3624
3721
|
*
|
|
3625
|
-
*
|
|
3722
|
+
* If loading the version info file fails, the promise will be rejected with the corresponding error.
|
|
3626
3723
|
*/
|
|
3627
3724
|
load(
|
|
3628
3725
|
/**
|
|
3629
|
-
*
|
|
3726
|
+
* Map of options
|
|
3630
3727
|
*/
|
|
3631
|
-
mOptions
|
|
3728
|
+
mOptions?: {
|
|
3632
3729
|
/**
|
|
3633
|
-
*
|
|
3730
|
+
* Name of a library (e.g. "sap.ui.core")
|
|
3634
3731
|
*/
|
|
3635
|
-
library
|
|
3732
|
+
library?: string;
|
|
3636
3733
|
}
|
|
3637
|
-
): Promise<
|
|
3734
|
+
): Promise<object | undefined>;
|
|
3638
3735
|
}
|
|
3639
3736
|
const VersionInfo: VersionInfo;
|
|
3640
3737
|
export default VersionInfo;
|
|
@@ -5550,34 +5647,9 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
5550
5647
|
*/
|
|
5551
5648
|
bindObject(
|
|
5552
5649
|
/**
|
|
5553
|
-
*
|
|
5650
|
+
* Binding info
|
|
5554
5651
|
*/
|
|
5555
|
-
oBindingInfo:
|
|
5556
|
-
/**
|
|
5557
|
-
* Path in the model to bind to, either an absolute path or relative to the binding context for the corresponding
|
|
5558
|
-
* model; when the path contains a '>' sign, the string preceding it will override the `model` property
|
|
5559
|
-
* and the remainder after the '>' will be used as binding path
|
|
5560
|
-
*/
|
|
5561
|
-
path: string;
|
|
5562
|
-
/**
|
|
5563
|
-
* Name of the model to bind against; when `undefined` or omitted, the default model is used
|
|
5564
|
-
*/
|
|
5565
|
-
model?: string;
|
|
5566
|
-
/**
|
|
5567
|
-
* Map of additional parameters for this binding; the names and value ranges of the supported parameters
|
|
5568
|
-
* depend on the model implementation, they should be documented with the `bindContext` method of the corresponding
|
|
5569
|
-
* model class or with the model specific subclass of `sap.ui.model.ContextBinding`
|
|
5570
|
-
*/
|
|
5571
|
-
parameters?: object;
|
|
5572
|
-
/**
|
|
5573
|
-
* Whether the binding should be suspended initially
|
|
5574
|
-
*/
|
|
5575
|
-
suspended?: boolean;
|
|
5576
|
-
/**
|
|
5577
|
-
* Map of event handler functions keyed by the name of the binding events that they should be attached to
|
|
5578
|
-
*/
|
|
5579
|
-
events?: object;
|
|
5580
|
-
}
|
|
5652
|
+
oBindingInfo: ObjectBindingInfo
|
|
5581
5653
|
): this;
|
|
5582
5654
|
/**
|
|
5583
5655
|
* Binds a property to the model.
|
|
@@ -6400,11 +6472,7 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
6400
6472
|
/**
|
|
6401
6473
|
* name of the aggregation to refresh
|
|
6402
6474
|
*/
|
|
6403
|
-
sName: string
|
|
6404
|
-
/**
|
|
6405
|
-
* the change reason
|
|
6406
|
-
*/
|
|
6407
|
-
sChangeReason: ChangeReason
|
|
6475
|
+
sName: string
|
|
6408
6476
|
): void;
|
|
6409
6477
|
/**
|
|
6410
6478
|
* Removes an object from the aggregation named `sAggregationName` with cardinality 0..n.
|
|
@@ -6908,6 +6976,38 @@ declare module "sap/ui/base/ManagedObject" {
|
|
|
6908
6976
|
events?: Record<string, Function>;
|
|
6909
6977
|
};
|
|
6910
6978
|
|
|
6979
|
+
/**
|
|
6980
|
+
* Configuration for the binding of a managed object
|
|
6981
|
+
*
|
|
6982
|
+
* `path` is the only mandatory property, all others are optional.
|
|
6983
|
+
*/
|
|
6984
|
+
export type ObjectBindingInfo = {
|
|
6985
|
+
/**
|
|
6986
|
+
* Path in the model to bind to, either an absolute path or relative to the binding context for the corresponding
|
|
6987
|
+
* model. If the path contains a '>' sign, the string preceding it will override the `model` property,
|
|
6988
|
+
* and the remainder after the '>' sign will be used as binding path
|
|
6989
|
+
*/
|
|
6990
|
+
path: string;
|
|
6991
|
+
/**
|
|
6992
|
+
* Name of the model to bind against; when `undefined` or omitted, the default model is used
|
|
6993
|
+
*/
|
|
6994
|
+
model?: string;
|
|
6995
|
+
/**
|
|
6996
|
+
* Whether the binding is initially suspended
|
|
6997
|
+
*/
|
|
6998
|
+
suspended?: boolean;
|
|
6999
|
+
/**
|
|
7000
|
+
* Map of additional parameters for this binding; the names and value ranges of the supported parameters
|
|
7001
|
+
* depend on the model implementation and should be documented with the `bindContext` method of the corresponding
|
|
7002
|
+
* model class or with the model-specific subclass of `sap.ui.model.ContextBinding`
|
|
7003
|
+
*/
|
|
7004
|
+
parameters?: object;
|
|
7005
|
+
/**
|
|
7006
|
+
* Map of event handler functions keyed by the name of the binding events that they are attached to
|
|
7007
|
+
*/
|
|
7008
|
+
events?: Record<string, Function>;
|
|
7009
|
+
};
|
|
7010
|
+
|
|
6911
7011
|
/**
|
|
6912
7012
|
* Configuration for the binding of a managed property.
|
|
6913
7013
|
*
|
|
@@ -8386,8 +8486,10 @@ declare module "sap/ui/core/library" {
|
|
|
8386
8486
|
* Collision behavior: horizontal/vertical.
|
|
8387
8487
|
*
|
|
8388
8488
|
* Defines how the position of an element should be adjusted in case it overflows the window in some direction.
|
|
8389
|
-
* For both directions this can be "flip", "fit" or "none". If only one behavior is provided
|
|
8390
|
-
* to both directions.
|
|
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"
|
|
8391
8493
|
*/
|
|
8392
8494
|
export type Collision = string;
|
|
8393
8495
|
|
|
@@ -8526,7 +8628,7 @@ declare module "sap/ui/core/library" {
|
|
|
8526
8628
|
* Marker interface for subclasses of `sap.ui.core.UIComponent`.
|
|
8527
8629
|
*
|
|
8528
8630
|
* Implementing this interface allows a {@link sap.ui.core.UIComponent} to be created fully asynchronously.
|
|
8529
|
-
* This interface will
|
|
8631
|
+
* This interface will implicitly set the component's rootView and router configuration to async. Nested
|
|
8530
8632
|
* views will also be handled asynchronously. Additionally the error handling during the processing of views
|
|
8531
8633
|
* is stricter and will fail if a view definition contains errors, e.g. broken binding strings.
|
|
8532
8634
|
*
|
|
@@ -9314,6 +9416,25 @@ declare module "sap/ui/core/library" {
|
|
|
9314
9416
|
*/
|
|
9315
9417
|
OnOrBetween = "OnOrBetween",
|
|
9316
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
|
+
}
|
|
9317
9438
|
}
|
|
9318
9439
|
|
|
9319
9440
|
export namespace mvc {
|
|
@@ -11243,7 +11364,7 @@ declare module "sap/ui/core/ComponentMetadata" {
|
|
|
11243
11364
|
/**
|
|
11244
11365
|
* Static info to construct the metadata from
|
|
11245
11366
|
*/
|
|
11246
|
-
|
|
11367
|
+
oClassInfo: object
|
|
11247
11368
|
);
|
|
11248
11369
|
|
|
11249
11370
|
/**
|
|
@@ -11544,8 +11665,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
11544
11665
|
/**
|
|
11545
11666
|
* @SINCE 1.27.0
|
|
11546
11667
|
*
|
|
11547
|
-
* Returns whether the framework automatically adds
|
|
11548
|
-
* body or not.
|
|
11668
|
+
* Returns whether the framework automatically adds the ARIA role 'application' to the HTML body or not.
|
|
11549
11669
|
*/
|
|
11550
11670
|
getAutoAriaBodyRole(): boolean;
|
|
11551
11671
|
/**
|
|
@@ -11593,7 +11713,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
11593
11713
|
/**
|
|
11594
11714
|
* Returns a string that identifies the current language.
|
|
11595
11715
|
*
|
|
11596
|
-
* The value returned by this
|
|
11716
|
+
* The value returned by this method in most cases corresponds to the exact value that has been configured
|
|
11597
11717
|
* by the user or application or that has been determined from the user agent settings. It has not been
|
|
11598
11718
|
* normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt
|
|
11599
11719
|
* BCP47}, allowing underscores ('_') instead of the suggested dashes ('-') and not taking the case of letters
|
|
@@ -11681,6 +11801,13 @@ declare module "sap/ui/core/Configuration" {
|
|
|
11681
11801
|
* Returns the theme name
|
|
11682
11802
|
*/
|
|
11683
11803
|
getTheme(): string;
|
|
11804
|
+
/**
|
|
11805
|
+
* @SINCE 1.99.0
|
|
11806
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11807
|
+
*
|
|
11808
|
+
* Retrieves the configured IANA timezone ID
|
|
11809
|
+
*/
|
|
11810
|
+
getTimezone(): string;
|
|
11684
11811
|
/**
|
|
11685
11812
|
* Prefix to be used for automatically generated control IDs. Default is a double underscore "__".
|
|
11686
11813
|
*/
|
|
@@ -11841,6 +11968,22 @@ declare module "sap/ui/core/Configuration" {
|
|
|
11841
11968
|
*/
|
|
11842
11969
|
aSecurityTokenHandlers: Function[]
|
|
11843
11970
|
): void;
|
|
11971
|
+
/**
|
|
11972
|
+
* @SINCE 1.99.0
|
|
11973
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
11974
|
+
*
|
|
11975
|
+
* Sets the timezone such that all date and time based calculations use this timezone.
|
|
11976
|
+
*
|
|
11977
|
+
* When the timezone has changed, the Core will fire its {@link sap.ui.core.Core#event:localizationChanged
|
|
11978
|
+
* localizationChanged} event.
|
|
11979
|
+
*/
|
|
11980
|
+
setTimezone(
|
|
11981
|
+
/**
|
|
11982
|
+
* IANA timezone ID, e.g. "America/New_York". Use `null` to reset the timezone to the browser's local timezone.
|
|
11983
|
+
* An invalid IANA timezone ID will fall back to the browser's timezone.
|
|
11984
|
+
*/
|
|
11985
|
+
sTimezone?: string | null
|
|
11986
|
+
): this;
|
|
11844
11987
|
}
|
|
11845
11988
|
/**
|
|
11846
11989
|
* @SINCE 1.50.0
|
|
@@ -11978,7 +12121,9 @@ declare module "sap/ui/core/Configuration" {
|
|
|
11978
12121
|
* To replace the CLDR currency digits completely ` { "DEFAULT": {"digits": 2}, "ADP": {"digits": 0}, ...
|
|
11979
12122
|
* "XPF": {"digits": 0} } `
|
|
11980
12123
|
*
|
|
11981
|
-
* 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.
|
|
11982
12127
|
*/
|
|
11983
12128
|
setCustomCurrencies(
|
|
11984
12129
|
/**
|
|
@@ -12113,7 +12258,7 @@ declare module "sap/ui/core/Configuration" {
|
|
|
12113
12258
|
/**
|
|
12114
12259
|
* must be one of decimal, group, plusSign, minusSign.
|
|
12115
12260
|
*/
|
|
12116
|
-
|
|
12261
|
+
sType: string,
|
|
12117
12262
|
/**
|
|
12118
12263
|
* will be used to represent the given symbol type
|
|
12119
12264
|
*/
|
|
@@ -12481,24 +12626,6 @@ declare module "sap/ui/core/Control" {
|
|
|
12481
12626
|
*/
|
|
12482
12627
|
vFieldGroupIds?: string | string[]
|
|
12483
12628
|
): boolean;
|
|
12484
|
-
/**
|
|
12485
|
-
* Overrides {@link sap.ui.core.Element#clone Element.clone} to clone additional internal state.
|
|
12486
|
-
*
|
|
12487
|
-
* The additionally cloned information contains:
|
|
12488
|
-
* - browser event handlers attached with {@link #attachBrowserEvent}
|
|
12489
|
-
* - text selection behavior
|
|
12490
|
-
* - style classes added with {@link #addStyleClass}
|
|
12491
|
-
*/
|
|
12492
|
-
clone(
|
|
12493
|
-
/**
|
|
12494
|
-
* a suffix to be appended to the cloned element id
|
|
12495
|
-
*/
|
|
12496
|
-
sIdSuffix?: string,
|
|
12497
|
-
/**
|
|
12498
|
-
* an array of local IDs within the cloned hierarchy (internally used)
|
|
12499
|
-
*/
|
|
12500
|
-
aLocalIds?: string[]
|
|
12501
|
-
): this;
|
|
12502
12629
|
/**
|
|
12503
12630
|
* Removes event handlers which have been previously attached using {@link #attachBrowserEvent}.
|
|
12504
12631
|
*
|
|
@@ -13125,6 +13252,28 @@ declare module "sap/ui/core/Core" {
|
|
|
13125
13252
|
*/
|
|
13126
13253
|
oListener?: object
|
|
13127
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;
|
|
13128
13277
|
/**
|
|
13129
13278
|
* Attaches event handler `fnFunction` to the {@link #event:formatError formatError} event of `sap.ui.core.Core`.
|
|
13130
13279
|
*
|
|
@@ -13433,7 +13582,7 @@ declare module "sap/ui/core/Core" {
|
|
|
13433
13582
|
* the settings object for the component
|
|
13434
13583
|
*/
|
|
13435
13584
|
mSettings?: object
|
|
13436
|
-
): Component
|
|
13585
|
+
): Component | Promise<Component>;
|
|
13437
13586
|
/**
|
|
13438
13587
|
* Returns a new instance of the RenderManager for exclusive use by the caller.
|
|
13439
13588
|
*
|
|
@@ -13824,8 +13973,10 @@ declare module "sap/ui/core/Core" {
|
|
|
13824
13973
|
): Model;
|
|
13825
13974
|
/**
|
|
13826
13975
|
* @deprecated (since 0.15.0) - Replaced by `createRenderManager()`
|
|
13976
|
+
*
|
|
13977
|
+
* Creates a new `RenderManager` instance for use by the caller.
|
|
13827
13978
|
*/
|
|
13828
|
-
getRenderManager():
|
|
13979
|
+
getRenderManager(): RenderManager;
|
|
13829
13980
|
/**
|
|
13830
13981
|
* @deprecated (since 1.95) - Please use {@link module:sap/ui/core/ComponentSupport} instead. See also {@link
|
|
13831
13982
|
* topic:82a0fcecc3cb427c91469bc537ebdddf Declarative API for Initial Components}.
|
|
@@ -13986,7 +14137,7 @@ declare module "sap/ui/core/Core" {
|
|
|
13986
14137
|
*/
|
|
13987
14138
|
extensions?: object;
|
|
13988
14139
|
}
|
|
13989
|
-
):
|
|
14140
|
+
): object | undefined;
|
|
13990
14141
|
/**
|
|
13991
14142
|
* Returns true if the Core has already been initialized. This means that instances of RenderManager etc.
|
|
13992
14143
|
* do already exist and the init event has already been fired (and will not be fired again).
|
|
@@ -14001,9 +14152,14 @@ declare module "sap/ui/core/Core" {
|
|
|
14001
14152
|
*/
|
|
14002
14153
|
isMobile(): boolean;
|
|
14003
14154
|
/**
|
|
14004
|
-
*
|
|
14155
|
+
* Checks whether the given DOM element is the root of the static area.
|
|
14005
14156
|
*/
|
|
14006
|
-
isStaticAreaRef(
|
|
14157
|
+
isStaticAreaRef(
|
|
14158
|
+
/**
|
|
14159
|
+
* DOM element to check
|
|
14160
|
+
*/
|
|
14161
|
+
oDomRef: Element
|
|
14162
|
+
): boolean;
|
|
14007
14163
|
/**
|
|
14008
14164
|
* Returns true, if the styles of the current theme are already applied, false otherwise.
|
|
14009
14165
|
*
|
|
@@ -14943,18 +15099,18 @@ declare module "sap/ui/core/delegate/ScrollEnablement" {
|
|
|
14943
15099
|
/**
|
|
14944
15100
|
* Horizontal position of the scrollbar
|
|
14945
15101
|
*/
|
|
14946
|
-
|
|
15102
|
+
x: int,
|
|
14947
15103
|
/**
|
|
14948
15104
|
* Vertical position of the scrollbar
|
|
14949
15105
|
*/
|
|
14950
|
-
|
|
15106
|
+
y: int,
|
|
14951
15107
|
/**
|
|
14952
15108
|
* The duration of animated scrolling in milliseconds. To scroll immediately without animation, give 0 as
|
|
14953
15109
|
* value.
|
|
14954
15110
|
*/
|
|
14955
|
-
|
|
15111
|
+
time: int,
|
|
14956
15112
|
|
|
14957
|
-
|
|
15113
|
+
fnScrollEndCallback: Function
|
|
14958
15114
|
): this;
|
|
14959
15115
|
/**
|
|
14960
15116
|
* Scrolls to a specific position in scroll container.
|
|
@@ -14963,13 +15119,13 @@ declare module "sap/ui/core/delegate/ScrollEnablement" {
|
|
|
14963
15119
|
/**
|
|
14964
15120
|
* Horizontal position of the scrollbar
|
|
14965
15121
|
*/
|
|
14966
|
-
|
|
15122
|
+
x: int,
|
|
14967
15123
|
/**
|
|
14968
15124
|
* Vertical position of the scrollbar
|
|
14969
15125
|
*/
|
|
14970
|
-
|
|
15126
|
+
y: int,
|
|
14971
15127
|
|
|
14972
|
-
|
|
15128
|
+
fnScrollEndCallback: Function
|
|
14973
15129
|
): this;
|
|
14974
15130
|
/**
|
|
14975
15131
|
* Scrolls to an element within a container.
|
|
@@ -15084,7 +15240,6 @@ declare module "sap/ui/core/dnd/DragDropBase" {
|
|
|
15084
15240
|
*
|
|
15085
15241
|
* Provides the base class for all drag-and-drop configurations. This feature enables a native HTML5 drag-and-drop
|
|
15086
15242
|
* API for the controls, therefore it is limited to browser support. Restrictions:
|
|
15087
|
-
* - There is no mobile device that supports drag and drop.
|
|
15088
15243
|
* - There is no accessible alternative for drag and drop. Applications which use the drag-and-drop functionality
|
|
15089
15244
|
* must provide an accessible alternative UI (for example, action buttons or menus) to perform the same
|
|
15090
15245
|
* operations.
|
|
@@ -15784,6 +15939,8 @@ declare module "sap/ui/core/dnd/DragAndDrop" {
|
|
|
15784
15939
|
|
|
15785
15940
|
import DropInfo from "sap/ui/core/dnd/DropInfo";
|
|
15786
15941
|
|
|
15942
|
+
import { dnd } from "sap/ui/core/library";
|
|
15943
|
+
|
|
15787
15944
|
/**
|
|
15788
15945
|
* When a user requests to drag some controls that can be dragged, a drag session is started. The drag session
|
|
15789
15946
|
* can be used to transfer data between applications or between dragged and dropped controls. Please see
|
|
@@ -15831,7 +15988,9 @@ declare module "sap/ui/core/dnd/DragAndDrop" {
|
|
|
15831
15988
|
/**
|
|
15832
15989
|
* Returns the calculated position of the drop action relative to the valid dropped control.
|
|
15833
15990
|
*/
|
|
15834
|
-
getDropPosition():
|
|
15991
|
+
getDropPosition():
|
|
15992
|
+
| dnd.RelativeDropPosition
|
|
15993
|
+
| keyof typeof dnd.RelativeDropPosition;
|
|
15835
15994
|
/**
|
|
15836
15995
|
* Returns the drop indicator.
|
|
15837
15996
|
*/
|
|
@@ -16328,6 +16487,7 @@ declare module "sap/ui/core/dnd/DropInfo" {
|
|
|
16328
16487
|
declare module "sap/ui/core/Element" {
|
|
16329
16488
|
import {
|
|
16330
16489
|
default as ManagedObject,
|
|
16490
|
+
ObjectBindingInfo,
|
|
16331
16491
|
$ManagedObjectSettings,
|
|
16332
16492
|
PropertyBindingInfo,
|
|
16333
16493
|
AggregationBindingInfo,
|
|
@@ -16701,30 +16861,11 @@ declare module "sap/ui/core/Element" {
|
|
|
16701
16861
|
/**
|
|
16702
16862
|
* the binding path or an object with more detailed binding options
|
|
16703
16863
|
*/
|
|
16704
|
-
vPath:
|
|
16705
|
-
| string
|
|
16706
|
-
| {
|
|
16707
|
-
/**
|
|
16708
|
-
* the binding path
|
|
16709
|
-
*/
|
|
16710
|
-
path: string;
|
|
16711
|
-
/**
|
|
16712
|
-
* map of additional parameters for this binding
|
|
16713
|
-
*/
|
|
16714
|
-
parameters?: object;
|
|
16715
|
-
/**
|
|
16716
|
-
* name of the model
|
|
16717
|
-
*/
|
|
16718
|
-
model?: string;
|
|
16719
|
-
/**
|
|
16720
|
-
* map of event listeners for the binding events
|
|
16721
|
-
*/
|
|
16722
|
-
events?: object;
|
|
16723
|
-
},
|
|
16864
|
+
vPath: string | ObjectBindingInfo,
|
|
16724
16865
|
/**
|
|
16725
|
-
* map of additional parameters for this binding
|
|
16726
|
-
* case it corresponds to
|
|
16727
|
-
* implementation of `sap.ui.model.ContextBinding`.
|
|
16866
|
+
* map of additional parameters for this binding. Only taken into account when `vPath` is a string. In that
|
|
16867
|
+
* case it corresponds to `mParameters` of {@link sap.ui.base.ManagedObject.ObjectBindingInfo}. The supported
|
|
16868
|
+
* parameters are listed in the corresponding model-specific implementation of `sap.ui.model.ContextBinding`.
|
|
16728
16869
|
*/
|
|
16729
16870
|
mParameters?: object
|
|
16730
16871
|
): this;
|
|
@@ -17797,6 +17938,9 @@ declare module "sap/ui/core/format/DateFormat" {
|
|
|
17797
17938
|
* The DateFormat is a static class for formatting and parsing single date and time values or date and time
|
|
17798
17939
|
* intervals according to a set of format options.
|
|
17799
17940
|
*
|
|
17941
|
+
* Important: Every Date is converted with the timezone taken from {@link sap.ui.core.Configuration#getTimezone}.
|
|
17942
|
+
* The timezone falls back to the browser's local timezone.
|
|
17943
|
+
*
|
|
17800
17944
|
* Supported format options are pattern based on Unicode LDML Date Format notation. Please note that only
|
|
17801
17945
|
* a subset of the LDML date symbols is supported. If no pattern is specified a default pattern according
|
|
17802
17946
|
* to the locale settings is used.
|
|
@@ -17911,84 +18055,163 @@ declare module "sap/ui/core/format/DateFormat" {
|
|
|
17911
18055
|
*/
|
|
17912
18056
|
strictParsing?: boolean;
|
|
17913
18057
|
/**
|
|
17914
|
-
* if true, the date is formatted relatively to
|
|
17915
|
-
* "yesterday", "in 5 days"
|
|
17916
|
-
|
|
17917
|
-
|
|
17918
|
-
|
|
17919
|
-
|
|
17920
|
-
* the
|
|
17921
|
-
*
|
|
17922
|
-
*
|
|
17923
|
-
|
|
17924
|
-
|
|
17925
|
-
|
|
17926
|
-
|
|
17927
|
-
*
|
|
17928
|
-
|
|
17929
|
-
|
|
17930
|
-
|
|
17931
|
-
|
|
17932
|
-
|
|
17933
|
-
|
|
17934
|
-
|
|
17935
|
-
|
|
17936
|
-
*
|
|
17937
|
-
*
|
|
17938
|
-
*
|
|
17939
|
-
|
|
17940
|
-
|
|
17941
|
-
|
|
17942
|
-
|
|
17943
|
-
*
|
|
17944
|
-
|
|
17945
|
-
|
|
17946
|
-
|
|
17947
|
-
|
|
17948
|
-
|
|
17949
|
-
|
|
17950
|
-
|
|
17951
|
-
|
|
17952
|
-
*
|
|
17953
|
-
|
|
17954
|
-
|
|
17955
|
-
|
|
17956
|
-
|
|
17957
|
-
|
|
17958
|
-
|
|
17959
|
-
|
|
17960
|
-
|
|
17961
|
-
|
|
17962
|
-
|
|
17963
|
-
*
|
|
17964
|
-
|
|
17965
|
-
|
|
17966
|
-
|
|
17967
|
-
|
|
17968
|
-
|
|
17969
|
-
|
|
17970
|
-
|
|
17971
|
-
|
|
17972
|
-
|
|
17973
|
-
*
|
|
17974
|
-
*
|
|
17975
|
-
|
|
17976
|
-
|
|
17977
|
-
|
|
17978
|
-
|
|
17979
|
-
|
|
17980
|
-
|
|
17981
|
-
|
|
17982
|
-
|
|
17983
|
-
|
|
17984
|
-
|
|
17985
|
-
|
|
17986
|
-
|
|
17987
|
-
|
|
17988
|
-
|
|
17989
|
-
|
|
17990
|
-
|
|
17991
|
-
|
|
18058
|
+
* if true, the date is formatted relatively to today's date if it is within the given day range, e.g. "today",
|
|
18059
|
+
* "yesterday", "in 5 days"
|
|
18060
|
+
*/
|
|
18061
|
+
relative?: boolean;
|
|
18062
|
+
/**
|
|
18063
|
+
* the day range used for relative formatting. If `oFormatOptions.relativeScale` is set to default value
|
|
18064
|
+
* 'day', the relativeRange is by default [-6, 6], which means only the last 6 days, today and the next
|
|
18065
|
+
* 6 days are formatted relatively. Otherwise when `oFormatOptions.relativeScale` is set to 'auto', all
|
|
18066
|
+
* dates are formatted relatively.
|
|
18067
|
+
*/
|
|
18068
|
+
relativeRange?: int[];
|
|
18069
|
+
/**
|
|
18070
|
+
* if 'auto' is set, new relative time format is switched on for all Date/Time Instances. The relative scale
|
|
18071
|
+
* is chosen depending on the difference between the given date and now.
|
|
18072
|
+
*/
|
|
18073
|
+
relativeScale?: string;
|
|
18074
|
+
/**
|
|
18075
|
+
* @since 1.32.10, 1.34.4 the style of the relative format. The valid values are "wide", "short", "narrow"
|
|
18076
|
+
*/
|
|
18077
|
+
relativeStyle?: string;
|
|
18078
|
+
/**
|
|
18079
|
+
* @since 1.48.0 if true, the {@link sap.ui.core.format.DateFormat#format format} method expects an array
|
|
18080
|
+
* with two dates as the first argument and formats them as interval. Further interval "Jan 10, 2008 - Jan
|
|
18081
|
+
* 12, 2008" will be formatted as "Jan 10-12, 2008" if the 'format' option is set with necessary symbols.
|
|
18082
|
+
* Otherwise the two given dates are formatted separately and concatenated with local dependent pattern.
|
|
18083
|
+
*/
|
|
18084
|
+
interval?: boolean;
|
|
18085
|
+
/**
|
|
18086
|
+
* Only relevant if oFormatOptions.interval is set to 'true'. This allows to pass an array with only one
|
|
18087
|
+
* date object to the {@link sap.ui.core.format.DateFormat#format format} method.
|
|
18088
|
+
*/
|
|
18089
|
+
singleIntervalValue?: boolean;
|
|
18090
|
+
/**
|
|
18091
|
+
* if true, the date is formatted and parsed as UTC instead of the local timezone
|
|
18092
|
+
*/
|
|
18093
|
+
UTC?: boolean;
|
|
18094
|
+
/**
|
|
18095
|
+
* The calender type which is used to format and parse the date. This value is by default either set in
|
|
18096
|
+
* configuration or calculated based on current locale.
|
|
18097
|
+
*/
|
|
18098
|
+
calendarType?: CalendarType | keyof typeof CalendarType;
|
|
18099
|
+
},
|
|
18100
|
+
/**
|
|
18101
|
+
* Locale to ask for locale specific texts/settings
|
|
18102
|
+
*/
|
|
18103
|
+
oLocale?: Locale
|
|
18104
|
+
): DateFormat;
|
|
18105
|
+
/**
|
|
18106
|
+
* @SINCE 1.99.0
|
|
18107
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
18108
|
+
*
|
|
18109
|
+
* Get a datetimeWithTimezone instance of the DateFormat, which can be used for formatting.
|
|
18110
|
+
*/
|
|
18111
|
+
static getDateTimeWithTimezoneInstance(
|
|
18112
|
+
/**
|
|
18113
|
+
* An object which defines the format options
|
|
18114
|
+
*/
|
|
18115
|
+
oFormatOptions?: {
|
|
18116
|
+
/**
|
|
18117
|
+
* A string containing pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into a pattern for
|
|
18118
|
+
* the used locale that matches the wanted symbols best. The symbols must be in canonical order, that is:
|
|
18119
|
+
* Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
|
|
18120
|
+
* Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
|
|
18121
|
+
*/
|
|
18122
|
+
format?: string;
|
|
18123
|
+
/**
|
|
18124
|
+
* a datetime pattern in LDML format. It is not verified whether the pattern represents a full datetime.
|
|
18125
|
+
*/
|
|
18126
|
+
pattern?: string;
|
|
18127
|
+
/**
|
|
18128
|
+
* Specifies if the date should be displayed. It is ignored for formatting when an options pattern or a
|
|
18129
|
+
* format are supplied.
|
|
18130
|
+
*/
|
|
18131
|
+
showDate?: boolean;
|
|
18132
|
+
/**
|
|
18133
|
+
* Specifies if the time should be displayed. It is ignored for formatting when an options pattern or a
|
|
18134
|
+
* format are supplied.
|
|
18135
|
+
*/
|
|
18136
|
+
showTime?: boolean;
|
|
18137
|
+
/**
|
|
18138
|
+
* Specifies if the timezone should be displayed. It is ignored for formatting when an options pattern or
|
|
18139
|
+
* a format are supplied.
|
|
18140
|
+
*/
|
|
18141
|
+
showTimezone?: boolean;
|
|
18142
|
+
/**
|
|
18143
|
+
* Can be either 'short, 'medium', 'long' or 'full'. For datetime you can also define mixed styles, separated
|
|
18144
|
+
* with a slash, where the first part is the date style and the second part is the time style (e.g. "medium/short").
|
|
18145
|
+
* If no pattern is given, a locale-dependent default datetime pattern of that style from the LocaleData
|
|
18146
|
+
* class is used.
|
|
18147
|
+
*/
|
|
18148
|
+
style?: string;
|
|
18149
|
+
/**
|
|
18150
|
+
* Whether to check by parsing if the value is a valid datetime
|
|
18151
|
+
*/
|
|
18152
|
+
strictParsing?: boolean;
|
|
18153
|
+
/**
|
|
18154
|
+
* Whether the date is formatted relatively to today's date if it is within the given day range, e.g. "today",
|
|
18155
|
+
* "yesterday", "in 5 days"
|
|
18156
|
+
*/
|
|
18157
|
+
relative?: boolean;
|
|
18158
|
+
/**
|
|
18159
|
+
* The day range used for relative formatting. If `oFormatOptions.relativeScale` is set to the default value
|
|
18160
|
+
* 'day', the `relativeRange is by default [-6, 6], which means that only the previous 6 and the following
|
|
18161
|
+
* 6 days are formatted relatively. If oFormatOptions.relativeScale` is set to 'auto', all dates are
|
|
18162
|
+
* formatted relatively.
|
|
18163
|
+
*/
|
|
18164
|
+
relativeRange?: int[];
|
|
18165
|
+
/**
|
|
18166
|
+
* If 'auto' is set, a new relative time format is switched on for all Date/Time instances. The default
|
|
18167
|
+
* value depends on `showDate` and `showTime` options.
|
|
18168
|
+
*/
|
|
18169
|
+
relativeScale?: string;
|
|
18170
|
+
/**
|
|
18171
|
+
* The style of the relative format. The valid values are "wide", "short", "narrow"
|
|
18172
|
+
*/
|
|
18173
|
+
relativeStyle?: string;
|
|
18174
|
+
/**
|
|
18175
|
+
* The calendar type which is used to format and parse the date. This value is by default either set in
|
|
18176
|
+
* the configuration or calculated based on the current locale.
|
|
18177
|
+
*/
|
|
18178
|
+
calendarType?: CalendarType | keyof typeof CalendarType;
|
|
18179
|
+
},
|
|
18180
|
+
/**
|
|
18181
|
+
* Locale to ask for locale-specific texts/settings
|
|
18182
|
+
*/
|
|
18183
|
+
oLocale?: Locale
|
|
18184
|
+
): DateTimeWithTimezone;
|
|
18185
|
+
/**
|
|
18186
|
+
* Get a time instance of the DateFormat, which can be used for formatting.
|
|
18187
|
+
*/
|
|
18188
|
+
static getTimeInstance(
|
|
18189
|
+
/**
|
|
18190
|
+
* Object which defines the format options
|
|
18191
|
+
*/
|
|
18192
|
+
oFormatOptions?: {
|
|
18193
|
+
/**
|
|
18194
|
+
* @since 1.34.0 contains pattern symbols (e.g. "yMMMd" or "Hms") which will be converted into the pattern
|
|
18195
|
+
* in the used locale, which matches the wanted symbols best. The symbols must be in canonical order, that
|
|
18196
|
+
* is: Era (G), Year (y/Y), Quarter (q/Q), Month (M/L), Week (w), Day-Of-Week (E/e/c), Day (d), Hour (h/H/k/K/j/J),
|
|
18197
|
+
* Minute (m), Second (s), Timezone (z/Z/v/V/O/X/x) See http://unicode.org/reports/tr35/tr35-dates.html#availableFormats_appendItems
|
|
18198
|
+
*/
|
|
18199
|
+
format?: string;
|
|
18200
|
+
/**
|
|
18201
|
+
* a time pattern in LDML format. It is not verified whether the pattern only represents a time.
|
|
18202
|
+
*/
|
|
18203
|
+
pattern?: string;
|
|
18204
|
+
/**
|
|
18205
|
+
* can be either 'short, 'medium', 'long' or 'full'. If no pattern is given, a locale dependent default
|
|
18206
|
+
* time pattern of that style is used from the LocaleData class.
|
|
18207
|
+
*/
|
|
18208
|
+
style?: string;
|
|
18209
|
+
/**
|
|
18210
|
+
* if true, by parsing it is checked if the value is a valid time
|
|
18211
|
+
*/
|
|
18212
|
+
strictParsing?: boolean;
|
|
18213
|
+
/**
|
|
18214
|
+
* if true, the date is formatted relatively to todays date if it is within the given day range, e.g. "today",
|
|
17992
18215
|
* "yesterday", "in 5 days"
|
|
17993
18216
|
*/
|
|
17994
18217
|
relative?: boolean;
|
|
@@ -18037,6 +18260,12 @@ declare module "sap/ui/core/format/DateFormat" {
|
|
|
18037
18260
|
): DateFormat;
|
|
18038
18261
|
/**
|
|
18039
18262
|
* Format a date according to the given format options.
|
|
18263
|
+
*
|
|
18264
|
+
* Uses the timezone from {@link sap.ui.core.Configuration#getTimezone}, which falls back to the browser's
|
|
18265
|
+
* local timezone to convert the given date.
|
|
18266
|
+
*
|
|
18267
|
+
* When using instances from getDateTimeWithTimezoneInstance, please see the corresponding documentation:
|
|
18268
|
+
* {@link sap.ui.core.format.DateFormat.getDateTimeWithTimezoneInstance#format}.
|
|
18040
18269
|
*/
|
|
18041
18270
|
format(
|
|
18042
18271
|
/**
|
|
@@ -18050,6 +18279,12 @@ declare module "sap/ui/core/format/DateFormat" {
|
|
|
18050
18279
|
): string;
|
|
18051
18280
|
/**
|
|
18052
18281
|
* Parse a string which is formatted according to the given format options.
|
|
18282
|
+
*
|
|
18283
|
+
* Uses the timezone from {@link sap.ui.core.Configuration#getTimezone}, which falls back to the browser's
|
|
18284
|
+
* local timezone to convert the given date.
|
|
18285
|
+
*
|
|
18286
|
+
* When using instances from getDateTimeWithTimezoneInstance, please see the corresponding documentation:
|
|
18287
|
+
* {@link sap.ui.core.format.DateFormat.getDateTimeWithTimezoneInstance#parse}.
|
|
18053
18288
|
*/
|
|
18054
18289
|
parse(
|
|
18055
18290
|
/**
|
|
@@ -18057,15 +18292,96 @@ declare module "sap/ui/core/format/DateFormat" {
|
|
|
18057
18292
|
*/
|
|
18058
18293
|
sValue: string,
|
|
18059
18294
|
/**
|
|
18060
|
-
* whether to use UTC
|
|
18295
|
+
* whether to use UTC
|
|
18061
18296
|
*/
|
|
18062
18297
|
bUTC: boolean,
|
|
18063
18298
|
/**
|
|
18064
|
-
* to use strict value check
|
|
18299
|
+
* whether to use strict value check
|
|
18065
18300
|
*/
|
|
18066
18301
|
bStrict: boolean
|
|
18067
18302
|
): Date | Date[];
|
|
18068
18303
|
}
|
|
18304
|
+
/**
|
|
18305
|
+
* @SINCE 1.99
|
|
18306
|
+
*
|
|
18307
|
+
* Interface for a timezone-specific DateFormat, which is able to format and parse a date based on a given
|
|
18308
|
+
* timezone. The timezone is used to convert the given date, and also for timezone-related pattern symbols.
|
|
18309
|
+
* The timezone is an IANA timezone ID, e.g. "America/New_York".
|
|
18310
|
+
* See:
|
|
18311
|
+
* sap.ui.core.format.DateFormat
|
|
18312
|
+
*/
|
|
18313
|
+
export interface DateTimeWithTimezone {
|
|
18314
|
+
__implements__sap_ui_core_format_DateFormat_DateTimeWithTimezone: boolean;
|
|
18315
|
+
|
|
18316
|
+
/**
|
|
18317
|
+
* @SINCE 1.99
|
|
18318
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
18319
|
+
*
|
|
18320
|
+
* Format a date object to a string according to the given timezone and format options.
|
|
18321
|
+
*/
|
|
18322
|
+
format(
|
|
18323
|
+
/**
|
|
18324
|
+
* The date to format
|
|
18325
|
+
*/
|
|
18326
|
+
oJSDate: Date,
|
|
18327
|
+
/**
|
|
18328
|
+
* The IANA timezone ID in which the date will be calculated and formatted e.g. "America/New_York". If the
|
|
18329
|
+
* parameter is omitted, `null` or an empty string, the timezone will be taken from {@link sap.ui.core.Configuration#getTimezone}.
|
|
18330
|
+
* For an invalid IANA timezone ID, an empty string will be returned.
|
|
18331
|
+
*/
|
|
18332
|
+
sTimezone?: string
|
|
18333
|
+
): string;
|
|
18334
|
+
/**
|
|
18335
|
+
* @SINCE 1.99
|
|
18336
|
+
* @EXPERIMENTAL (since 1.99.0)
|
|
18337
|
+
*
|
|
18338
|
+
* Parse a string which is formatted according to the given format options to an array containing a date
|
|
18339
|
+
* object and the timezone.
|
|
18340
|
+
*/
|
|
18341
|
+
parse(
|
|
18342
|
+
/**
|
|
18343
|
+
* the string containing a formatted date/time value
|
|
18344
|
+
*/
|
|
18345
|
+
sValue: string,
|
|
18346
|
+
/**
|
|
18347
|
+
* The IANA timezone ID which should be used to convert the date e.g. "America/New_York". If the parameter
|
|
18348
|
+
* is omitted, `null` or an empty string, the timezone will be taken from {@link sap.ui.core.Configuration#getTimezone}.
|
|
18349
|
+
* For an invalid IANA timezone ID, `null` will be returned.
|
|
18350
|
+
*/
|
|
18351
|
+
sTimezone?: string,
|
|
18352
|
+
/**
|
|
18353
|
+
* Whether to be strict with regards to the value ranges of date fields, e.g. for a month pattern of `MM`
|
|
18354
|
+
* and a value range of [1-12] `strict` ensures that the value is within the range; if it is larger than
|
|
18355
|
+
* `12` it cannot be parsed and `null` is returned
|
|
18356
|
+
*/
|
|
18357
|
+
bStrict?: boolean
|
|
18358
|
+
): any[];
|
|
18359
|
+
}
|
|
18360
|
+
}
|
|
18361
|
+
|
|
18362
|
+
declare module "sap/ui/core/format/DateFormatTimezoneDisplay" {
|
|
18363
|
+
/**
|
|
18364
|
+
* @SINCE 1.99.0
|
|
18365
|
+
* @deprecated (since 1.101) - replaced by `DateFormat#getDateTimeWithTimezoneInstance` with the `showDate`,
|
|
18366
|
+
* `showTime` and `showTimezone` format options.
|
|
18367
|
+
*
|
|
18368
|
+
* Configuration options for the `showTimezone` format option of `DateFormat#getDateTimeWithTimezoneInstance`.
|
|
18369
|
+
*/
|
|
18370
|
+
enum DateFormatTimezoneDisplay {
|
|
18371
|
+
/**
|
|
18372
|
+
* Do not add the IANA timezone ID to the format output.
|
|
18373
|
+
*/
|
|
18374
|
+
Hide = "Hide",
|
|
18375
|
+
/**
|
|
18376
|
+
* Only output the IANA timezone ID.
|
|
18377
|
+
*/
|
|
18378
|
+
Only = "Only",
|
|
18379
|
+
/**
|
|
18380
|
+
* Add the IANA timezone ID to the format output.
|
|
18381
|
+
*/
|
|
18382
|
+
Show = "Show",
|
|
18383
|
+
}
|
|
18384
|
+
export default DateFormatTimezoneDisplay;
|
|
18069
18385
|
}
|
|
18070
18386
|
|
|
18071
18387
|
declare module "sap/ui/core/format/FileSizeFormat" {
|
|
@@ -18295,115 +18611,122 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18295
18611
|
*/
|
|
18296
18612
|
oFormatOptions?: {
|
|
18297
18613
|
/**
|
|
18298
|
-
* defines
|
|
18299
|
-
|
|
18300
|
-
minIntegerDigits?: int;
|
|
18301
|
-
/**
|
|
18302
|
-
* defines maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?" characters
|
|
18303
|
-
* are shown instead of digits.
|
|
18614
|
+
* defines whether the currency is shown as a code in currency format. The currency symbol is displayed
|
|
18615
|
+
* when this option is set to `false` and a symbol has been defined for the given currency code.
|
|
18304
18616
|
*/
|
|
18305
|
-
|
|
18617
|
+
currencyCode?: boolean;
|
|
18306
18618
|
/**
|
|
18307
|
-
*
|
|
18619
|
+
* can be set either to 'standard' (the default value) or to 'accounting' for an accounting-specific currency
|
|
18620
|
+
* display
|
|
18308
18621
|
*/
|
|
18309
|
-
|
|
18622
|
+
currencyContext?: string;
|
|
18310
18623
|
/**
|
|
18311
|
-
* defines
|
|
18624
|
+
* defines a set of custom currencies exclusive to this NumberFormat instance. Custom currencies must not
|
|
18625
|
+
* only consist of digits. If custom currencies are defined on the instance, no other currencies can be
|
|
18626
|
+
* formatted and parsed by this instance. Globally available custom currencies can be added via the global
|
|
18627
|
+
* configuration. See the above examples. See also {@link sap.ui.core.Configuration.FormatSettings#setCustomCurrencies}
|
|
18628
|
+
* and {@link sap.ui.core.Configuration.FormatSettings#addCustomCurrencies}.
|
|
18312
18629
|
*/
|
|
18313
|
-
|
|
18630
|
+
customCurrencies?: Record<string, object>;
|
|
18314
18631
|
/**
|
|
18315
18632
|
* defines the number of decimal digits
|
|
18316
18633
|
*/
|
|
18317
18634
|
decimals?: int;
|
|
18318
18635
|
/**
|
|
18319
|
-
* defines the
|
|
18320
|
-
*
|
|
18321
|
-
*/
|
|
18322
|
-
shortDecimals?: int;
|
|
18323
|
-
/**
|
|
18324
|
-
* only use short number formatting for values above this limit
|
|
18636
|
+
* defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
|
|
18637
|
+
* `groupingSeparator`.
|
|
18325
18638
|
*/
|
|
18326
|
-
|
|
18327
|
-
/**
|
|
18328
|
-
* @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
|
|
18329
|
-
* The generated scale factor is used for all numbers which are formatted with this format instance. This
|
|
18330
|
-
* option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
|
|
18331
|
-
* set with `undefined` which means the scale factor is selected automatically for each number being formatted.
|
|
18332
|
-
*/
|
|
18333
|
-
shortRefNumber?: int;
|
|
18639
|
+
decimalSeparator?: string;
|
|
18334
18640
|
/**
|
|
18335
|
-
* @since 1.
|
|
18336
|
-
*
|
|
18641
|
+
* @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
|
|
18642
|
+
* allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
|
|
18643
|
+
* in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as [NaN,
|
|
18644
|
+
* undefined], and NaN is formatted as an empty string.
|
|
18337
18645
|
*/
|
|
18338
|
-
|
|
18646
|
+
emptyString?: number;
|
|
18339
18647
|
/**
|
|
18340
|
-
*
|
|
18648
|
+
* defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
|
|
18341
18649
|
*/
|
|
18342
|
-
|
|
18650
|
+
groupingBaseSize?: int;
|
|
18343
18651
|
/**
|
|
18344
18652
|
* defines whether grouping is enabled (show the grouping separators)
|
|
18345
18653
|
*/
|
|
18346
18654
|
groupingEnabled?: boolean;
|
|
18347
18655
|
/**
|
|
18348
|
-
* defines the used grouping separator
|
|
18349
|
-
*
|
|
18656
|
+
* defines the character used as grouping separator. Note: `groupingSeparator` must always be different
|
|
18657
|
+
* from `decimalSeparator`.
|
|
18350
18658
|
*/
|
|
18351
18659
|
groupingSeparator?: string;
|
|
18352
18660
|
/**
|
|
18353
|
-
* defines the grouping size in digits
|
|
18661
|
+
* defines the grouping size in digits; the default is `3`. It must be a positive number.
|
|
18354
18662
|
*/
|
|
18355
18663
|
groupingSize?: int;
|
|
18356
18664
|
/**
|
|
18357
|
-
* defines the
|
|
18358
|
-
* grouping)
|
|
18665
|
+
* defines the maximum number of decimal digits
|
|
18359
18666
|
*/
|
|
18360
|
-
|
|
18667
|
+
maxFractionDigits?: int;
|
|
18361
18668
|
/**
|
|
18362
|
-
* defines the
|
|
18363
|
-
*
|
|
18669
|
+
* defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
|
|
18670
|
+
* characters are shown instead of digits.
|
|
18364
18671
|
*/
|
|
18365
|
-
|
|
18672
|
+
maxIntegerDigits?: int;
|
|
18366
18673
|
/**
|
|
18367
|
-
* defines the
|
|
18674
|
+
* defines the minimal number of decimal digits
|
|
18368
18675
|
*/
|
|
18369
|
-
|
|
18676
|
+
minFractionDigits?: int;
|
|
18677
|
+
/**
|
|
18678
|
+
* defines the minimal number of non-decimal digits
|
|
18679
|
+
*/
|
|
18680
|
+
minIntegerDigits?: int;
|
|
18370
18681
|
/**
|
|
18371
18682
|
* defines the used minus symbol
|
|
18372
18683
|
*/
|
|
18373
18684
|
minusSign?: string;
|
|
18374
18685
|
/**
|
|
18375
|
-
* @since 1.28.2 defines whether to output string from parse function in order to keep the precision
|
|
18376
|
-
* big numbers. Numbers in scientific notation are parsed back to
|
|
18686
|
+
* @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
|
|
18687
|
+
* for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
|
|
18377
18688
|
* is parsed to "0.005".
|
|
18378
18689
|
*/
|
|
18379
18690
|
parseAsString?: boolean;
|
|
18691
|
+
/**
|
|
18692
|
+
* CLDR number pattern which is used to format the number
|
|
18693
|
+
*/
|
|
18694
|
+
pattern?: string;
|
|
18695
|
+
/**
|
|
18696
|
+
* defines the used plus symbol
|
|
18697
|
+
*/
|
|
18698
|
+
plusSign?: string;
|
|
18380
18699
|
/**
|
|
18381
18700
|
* Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
|
|
18382
18701
|
* than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
|
|
18383
18702
|
* is rounded to `maxFractionDigits`.
|
|
18384
18703
|
*/
|
|
18385
18704
|
preserveDecimals?: boolean;
|
|
18386
|
-
/**
|
|
18387
|
-
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
18388
|
-
* Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
|
|
18389
|
-
* the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
18390
|
-
* decimals, shortDecimals or precision option.
|
|
18391
|
-
*/
|
|
18392
|
-
style?: string;
|
|
18393
18705
|
/**
|
|
18394
18706
|
* specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
|
|
18395
|
-
* maxFractionDigits. Rounding will only be applied
|
|
18396
|
-
* assigned
|
|
18397
|
-
*
|
|
18398
|
-
*
|
|
18707
|
+
* maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
|
|
18708
|
+
* assigned
|
|
18709
|
+
* - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
|
|
18710
|
+
* - via a function that is used for rounding the number and takes two parameters: the number itself,
|
|
18711
|
+
* and the number of decimal digits that should be reserved.
|
|
18399
18712
|
*/
|
|
18400
18713
|
roundingMode?: RoundingMode | keyof typeof RoundingMode;
|
|
18401
18714
|
/**
|
|
18402
|
-
*
|
|
18403
|
-
*
|
|
18404
|
-
* or if `oFormatOptions.pattern` is supplied
|
|
18715
|
+
* defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
|
|
18716
|
+
* options is used
|
|
18405
18717
|
*/
|
|
18406
|
-
|
|
18718
|
+
shortDecimals?: int;
|
|
18719
|
+
/**
|
|
18720
|
+
* only use short number formatting for values above this limit
|
|
18721
|
+
*/
|
|
18722
|
+
shortLimit?: int;
|
|
18723
|
+
/**
|
|
18724
|
+
* @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
|
|
18725
|
+
* The generated scale factor is used for all numbers which are formatted with this format instance. This
|
|
18726
|
+
* option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
|
|
18727
|
+
* set with `undefined` which means the scale factor is selected automatically for each number being formatted.
|
|
18728
|
+
*/
|
|
18729
|
+
shortRefNumber?: int;
|
|
18407
18730
|
/**
|
|
18408
18731
|
* defines whether the currency code/symbol is shown in the formatted string, e.g. true: "1.00 EUR", false:
|
|
18409
18732
|
* "1.00" for locale "en" If both `showMeasure` and `showNumber` are false, an empty string is returned
|
|
@@ -18416,29 +18739,23 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18416
18739
|
*/
|
|
18417
18740
|
showNumber?: boolean;
|
|
18418
18741
|
/**
|
|
18419
|
-
*
|
|
18420
|
-
*
|
|
18421
|
-
*/
|
|
18422
|
-
currencyCode?: boolean;
|
|
18423
|
-
/**
|
|
18424
|
-
* It can be set either with 'standard' (the default value) or with 'accounting' for an accounting specific
|
|
18425
|
-
* currency display
|
|
18742
|
+
* @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
|
|
18743
|
+
* only when the 'style' options is set to either 'short' or 'long'.
|
|
18426
18744
|
*/
|
|
18427
|
-
|
|
18745
|
+
showScale?: boolean;
|
|
18428
18746
|
/**
|
|
18429
|
-
*
|
|
18430
|
-
*
|
|
18431
|
-
*
|
|
18432
|
-
*
|
|
18747
|
+
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
18748
|
+
* When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
|
|
18749
|
+
* default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
18750
|
+
* decimals, shortDecimals, or the 'precision' option itself.
|
|
18433
18751
|
*/
|
|
18434
|
-
|
|
18752
|
+
style?: string;
|
|
18435
18753
|
/**
|
|
18436
|
-
*
|
|
18437
|
-
*
|
|
18438
|
-
*
|
|
18439
|
-
* sap.ui.core.Configuration.FormatSettings#setCustomCurrencies} and {@link sap.ui.core.Configuration.FormatSettings#addCustomCurrencies}.
|
|
18754
|
+
* overrides the global configuration value {@link sap.ui.core.Configuration.FormatSettings#getTrailingCurrencyCode},
|
|
18755
|
+
* which has a default value of `true</>. This is ignored if oFormatOptions.currencyCode` is set to
|
|
18756
|
+
* `false`, or if `oFormatOptions.pattern` is supplied.
|
|
18440
18757
|
*/
|
|
18441
|
-
|
|
18758
|
+
trailingCurrencyCode?: boolean;
|
|
18442
18759
|
},
|
|
18443
18760
|
/**
|
|
18444
18761
|
* Locale to get the formatter for
|
|
@@ -18453,6 +18770,19 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18453
18770
|
*
|
|
18454
18771
|
* This instance has HALF_AWAY_FROM_ZERO set as default rounding mode. Please set the roundingMode property
|
|
18455
18772
|
* in oFormatOptions to change the default value.
|
|
18773
|
+
*
|
|
18774
|
+
* The following example shows how grouping is done:
|
|
18775
|
+
* ```javascript
|
|
18776
|
+
*
|
|
18777
|
+
* var oFormat = NumberFormat.getFloatInstance({
|
|
18778
|
+
* "groupingEnabled": true, // grouping is enabled
|
|
18779
|
+
* "groupingSeparator": '.', // grouping separator is '.'
|
|
18780
|
+
* "groupingSize": 3, // the amount of digits to be grouped (here: thousand)
|
|
18781
|
+
* "decimalSeparator": "," // the decimal separator must be different from the grouping separator
|
|
18782
|
+
* });
|
|
18783
|
+
*
|
|
18784
|
+
* oFormat.format(1234.56); // "1.234,56"
|
|
18785
|
+
* ```
|
|
18456
18786
|
*/
|
|
18457
18787
|
static getFloatInstance(
|
|
18458
18788
|
/**
|
|
@@ -18461,26 +18791,92 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18461
18791
|
*/
|
|
18462
18792
|
oFormatOptions?: {
|
|
18463
18793
|
/**
|
|
18464
|
-
* defines
|
|
18794
|
+
* defines the number of decimal digits
|
|
18465
18795
|
*/
|
|
18466
|
-
|
|
18796
|
+
decimals?: int;
|
|
18797
|
+
/**
|
|
18798
|
+
* defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
|
|
18799
|
+
* `groupingSeparator`.
|
|
18800
|
+
*/
|
|
18801
|
+
decimalSeparator?: string;
|
|
18802
|
+
/**
|
|
18803
|
+
* @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
|
|
18804
|
+
* allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
|
|
18805
|
+
* in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as NaN,
|
|
18806
|
+
* and NaN is formatted as an empty string.
|
|
18807
|
+
*/
|
|
18808
|
+
emptyString?: number;
|
|
18809
|
+
/**
|
|
18810
|
+
* defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
|
|
18811
|
+
*/
|
|
18812
|
+
groupingBaseSize?: int;
|
|
18813
|
+
/**
|
|
18814
|
+
* defines whether grouping is enabled (show the grouping separators)
|
|
18815
|
+
*/
|
|
18816
|
+
groupingEnabled?: boolean;
|
|
18817
|
+
/**
|
|
18818
|
+
* defines the character used as grouping separator. Note: `groupingSeparator` must always be different
|
|
18819
|
+
* from `decimalSeparator`.
|
|
18820
|
+
*/
|
|
18821
|
+
groupingSeparator?: string;
|
|
18467
18822
|
/**
|
|
18468
|
-
* defines
|
|
18469
|
-
|
|
18823
|
+
* defines the grouping size in digits; the default is `3`. It must be a positive number.
|
|
18824
|
+
*/
|
|
18825
|
+
groupingSize?: int;
|
|
18826
|
+
/**
|
|
18827
|
+
* defines the maximum number of decimal digits
|
|
18828
|
+
*/
|
|
18829
|
+
maxFractionDigits?: int;
|
|
18830
|
+
/**
|
|
18831
|
+
* defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
|
|
18832
|
+
* characters are shown instead of digits.
|
|
18470
18833
|
*/
|
|
18471
18834
|
maxIntegerDigits?: int;
|
|
18472
18835
|
/**
|
|
18473
|
-
* defines minimal number of decimal digits
|
|
18836
|
+
* defines the minimal number of decimal digits
|
|
18474
18837
|
*/
|
|
18475
18838
|
minFractionDigits?: int;
|
|
18476
18839
|
/**
|
|
18477
|
-
* defines
|
|
18840
|
+
* defines the minimal number of non-decimal digits
|
|
18478
18841
|
*/
|
|
18479
|
-
|
|
18842
|
+
minIntegerDigits?: int;
|
|
18480
18843
|
/**
|
|
18481
|
-
* defines the
|
|
18844
|
+
* defines the used minus symbol
|
|
18482
18845
|
*/
|
|
18483
|
-
|
|
18846
|
+
minusSign?: string;
|
|
18847
|
+
/**
|
|
18848
|
+
* @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
|
|
18849
|
+
* for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
|
|
18850
|
+
* is parsed to "0.005".
|
|
18851
|
+
*/
|
|
18852
|
+
parseAsString?: boolean;
|
|
18853
|
+
/**
|
|
18854
|
+
* CLDR number pattern which is used to format the number
|
|
18855
|
+
*/
|
|
18856
|
+
pattern?: string;
|
|
18857
|
+
/**
|
|
18858
|
+
* defines the used plus symbol
|
|
18859
|
+
*/
|
|
18860
|
+
plusSign?: string;
|
|
18861
|
+
/**
|
|
18862
|
+
* defines the numerical precision; the number of decimals is calculated dependent on the integer digits
|
|
18863
|
+
*/
|
|
18864
|
+
precision?: int;
|
|
18865
|
+
/**
|
|
18866
|
+
* Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
|
|
18867
|
+
* than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
|
|
18868
|
+
* is rounded to `maxFractionDigits`.
|
|
18869
|
+
*/
|
|
18870
|
+
preserveDecimals?: boolean;
|
|
18871
|
+
/**
|
|
18872
|
+
* specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
|
|
18873
|
+
* maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
|
|
18874
|
+
* assigned
|
|
18875
|
+
* - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
|
|
18876
|
+
* - via a function that is used for rounding the number and takes two parameters: the number itself,
|
|
18877
|
+
* and the number of decimal digits that should be reserved.
|
|
18878
|
+
*/
|
|
18879
|
+
roundingMode?: RoundingMode | keyof typeof RoundingMode;
|
|
18484
18880
|
/**
|
|
18485
18881
|
* defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
|
|
18486
18882
|
* options is used
|
|
@@ -18503,78 +18899,160 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18503
18899
|
*/
|
|
18504
18900
|
showScale?: boolean;
|
|
18505
18901
|
/**
|
|
18506
|
-
* defines the
|
|
18902
|
+
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
18903
|
+
* When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
|
|
18904
|
+
* default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
18905
|
+
* decimals, shortDecimals, or the 'precision' option itself.
|
|
18507
18906
|
*/
|
|
18508
|
-
|
|
18907
|
+
style?: string;
|
|
18908
|
+
},
|
|
18909
|
+
/**
|
|
18910
|
+
* Locale to get the formatter for
|
|
18911
|
+
*/
|
|
18912
|
+
oLocale?: Locale
|
|
18913
|
+
): NumberFormat;
|
|
18914
|
+
/**
|
|
18915
|
+
* Get an integer instance of the NumberFormat, which can be used for formatting.
|
|
18916
|
+
*
|
|
18917
|
+
* If no locale is given, the currently configured {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale
|
|
18918
|
+
* formatLocale} will be used.
|
|
18919
|
+
*
|
|
18920
|
+
* This instance has TOWARDS_ZERO set as default rounding mode. Please set the roundingMode property
|
|
18921
|
+
* in oFormatOptions to change the default value.
|
|
18922
|
+
*
|
|
18923
|
+
* The following example shows how grouping is done:
|
|
18924
|
+
* ```javascript
|
|
18925
|
+
*
|
|
18926
|
+
* var oFormat = NumberFormat.getIntegerInstance({
|
|
18927
|
+
* "groupingEnabled": true, // grouping is enabled
|
|
18928
|
+
* "groupingSeparator": '.', // grouping separator is '.'
|
|
18929
|
+
* "groupingSize": 3 // the amount of digits to be grouped (here: thousand)
|
|
18930
|
+
* });
|
|
18931
|
+
*
|
|
18932
|
+
* oFormat.format(1234); // "1.234"
|
|
18933
|
+
* ```
|
|
18934
|
+
*/
|
|
18935
|
+
static getIntegerInstance(
|
|
18936
|
+
/**
|
|
18937
|
+
* The option object which support the following parameters. If no options is given, default values according
|
|
18938
|
+
* to the type and locale settings are used.
|
|
18939
|
+
*/
|
|
18940
|
+
oFormatOptions?: {
|
|
18509
18941
|
/**
|
|
18510
|
-
*
|
|
18942
|
+
* defines the number of decimal digits
|
|
18511
18943
|
*/
|
|
18512
|
-
|
|
18944
|
+
decimals?: int;
|
|
18945
|
+
/**
|
|
18946
|
+
* defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
|
|
18947
|
+
* `groupingSeparator`.
|
|
18948
|
+
*/
|
|
18949
|
+
decimalSeparator?: string;
|
|
18950
|
+
/**
|
|
18951
|
+
* @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
|
|
18952
|
+
* allowed values are only NaN, null or 0. The 'format' and 'parse' functions are done in a symmetric way.
|
|
18953
|
+
* For example, when this parameter is set to NaN, an empty string is parsed as NaN, and NaN is formatted
|
|
18954
|
+
* as an empty string.
|
|
18955
|
+
*/
|
|
18956
|
+
emptyString?: number;
|
|
18957
|
+
/**
|
|
18958
|
+
* defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
|
|
18959
|
+
*/
|
|
18960
|
+
groupingBaseSize?: int;
|
|
18513
18961
|
/**
|
|
18514
18962
|
* defines whether grouping is enabled (show the grouping separators)
|
|
18515
18963
|
*/
|
|
18516
18964
|
groupingEnabled?: boolean;
|
|
18517
18965
|
/**
|
|
18518
|
-
* defines the used grouping separator
|
|
18519
|
-
*
|
|
18966
|
+
* defines the character used as grouping separator. Note: `groupingSeparator` must always be different
|
|
18967
|
+
* from `decimalSeparator`.
|
|
18520
18968
|
*/
|
|
18521
18969
|
groupingSeparator?: string;
|
|
18522
18970
|
/**
|
|
18523
|
-
* defines the grouping size in digits
|
|
18971
|
+
* defines the grouping size in digits; the default is `3`. It must be a positive number.
|
|
18524
18972
|
*/
|
|
18525
18973
|
groupingSize?: int;
|
|
18526
18974
|
/**
|
|
18527
|
-
* defines the
|
|
18528
|
-
* grouping)
|
|
18975
|
+
* defines the maximum number of decimal digits
|
|
18529
18976
|
*/
|
|
18530
|
-
|
|
18977
|
+
maxFractionDigits?: int;
|
|
18531
18978
|
/**
|
|
18532
|
-
* defines the
|
|
18533
|
-
*
|
|
18979
|
+
* defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
|
|
18980
|
+
* characters are shown instead of digits.
|
|
18534
18981
|
*/
|
|
18535
|
-
|
|
18982
|
+
maxIntegerDigits?: int;
|
|
18536
18983
|
/**
|
|
18537
|
-
* defines the
|
|
18984
|
+
* defines the minimal number of decimal digits
|
|
18538
18985
|
*/
|
|
18539
|
-
|
|
18986
|
+
minFractionDigits?: int;
|
|
18987
|
+
/**
|
|
18988
|
+
* defines the minimal number of non-decimal digits
|
|
18989
|
+
*/
|
|
18990
|
+
minIntegerDigits?: int;
|
|
18540
18991
|
/**
|
|
18541
18992
|
* defines the used minus symbol
|
|
18542
18993
|
*/
|
|
18543
18994
|
minusSign?: string;
|
|
18544
18995
|
/**
|
|
18545
|
-
* @since 1.28.2 defines whether to output string from parse function in order to keep the precision
|
|
18546
|
-
* big numbers. Numbers in scientific notation are parsed back to
|
|
18547
|
-
* is parsed to "
|
|
18996
|
+
* @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
|
|
18997
|
+
* for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e+3"
|
|
18998
|
+
* is parsed to "5000".
|
|
18548
18999
|
*/
|
|
18549
19000
|
parseAsString?: boolean;
|
|
19001
|
+
/**
|
|
19002
|
+
* CLDR number pattern which is used to format the number
|
|
19003
|
+
*/
|
|
19004
|
+
pattern?: string;
|
|
19005
|
+
/**
|
|
19006
|
+
* defines the used plus symbol
|
|
19007
|
+
*/
|
|
19008
|
+
plusSign?: string;
|
|
19009
|
+
/**
|
|
19010
|
+
* defines the numerical precision; the number of decimals is calculated dependent on the integer digits
|
|
19011
|
+
*/
|
|
19012
|
+
precision?: int;
|
|
18550
19013
|
/**
|
|
18551
19014
|
* Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
|
|
18552
19015
|
* than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
|
|
18553
19016
|
* is rounded to `maxFractionDigits`.
|
|
18554
19017
|
*/
|
|
18555
19018
|
preserveDecimals?: boolean;
|
|
18556
|
-
/**
|
|
18557
|
-
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
18558
|
-
* Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
|
|
18559
|
-
* the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
18560
|
-
* decimals, shortDecimals or precision option.
|
|
18561
|
-
*/
|
|
18562
|
-
style?: string;
|
|
18563
19019
|
/**
|
|
18564
19020
|
* specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
|
|
18565
|
-
* maxFractionDigits. Rounding will only be applied
|
|
18566
|
-
* assigned
|
|
18567
|
-
*
|
|
18568
|
-
*
|
|
19021
|
+
* maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
|
|
19022
|
+
* assigned
|
|
19023
|
+
* - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
|
|
19024
|
+
* - via a function that is used for rounding the number and takes two parameters: the number itself,
|
|
19025
|
+
* and the number of decimal digits that should be reserved.
|
|
18569
19026
|
*/
|
|
18570
19027
|
roundingMode?: RoundingMode | keyof typeof RoundingMode;
|
|
18571
19028
|
/**
|
|
18572
|
-
*
|
|
18573
|
-
*
|
|
18574
|
-
* example when this parameter is set to NaN, empty string is parsed as NaN and NaN is formatted as empty
|
|
18575
|
-
* string.
|
|
19029
|
+
* defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
|
|
19030
|
+
* options is used
|
|
18576
19031
|
*/
|
|
18577
|
-
|
|
19032
|
+
shortDecimals?: int;
|
|
19033
|
+
/**
|
|
19034
|
+
* only use short number formatting for values above this limit
|
|
19035
|
+
*/
|
|
19036
|
+
shortLimit?: int;
|
|
19037
|
+
/**
|
|
19038
|
+
* @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
|
|
19039
|
+
* The generated scale factor is used for all numbers which are formatted with this format instance. This
|
|
19040
|
+
* option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
|
|
19041
|
+
* set with `undefined` which means the scale factor is selected automatically for each number being formatted.
|
|
19042
|
+
*/
|
|
19043
|
+
shortRefNumber?: int;
|
|
19044
|
+
/**
|
|
19045
|
+
* @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
|
|
19046
|
+
* only when the 'style' options is set to either 'short' or 'long'.
|
|
19047
|
+
*/
|
|
19048
|
+
showScale?: boolean;
|
|
19049
|
+
/**
|
|
19050
|
+
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
19051
|
+
* When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
|
|
19052
|
+
* default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
19053
|
+
* decimals, shortDecimals, or the 'precision' option itself.
|
|
19054
|
+
*/
|
|
19055
|
+
style?: string;
|
|
18578
19056
|
},
|
|
18579
19057
|
/**
|
|
18580
19058
|
* Locale to get the formatter for
|
|
@@ -18582,41 +19060,115 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18582
19060
|
oLocale?: Locale
|
|
18583
19061
|
): NumberFormat;
|
|
18584
19062
|
/**
|
|
18585
|
-
*
|
|
19063
|
+
* Returns a metadata object for class sap.ui.core.format.NumberFormat.
|
|
19064
|
+
*/
|
|
19065
|
+
static getMetadata(): Metadata;
|
|
19066
|
+
/**
|
|
19067
|
+
* Get a percent instance of the NumberFormat, which can be used for formatting.
|
|
18586
19068
|
*
|
|
18587
19069
|
* If no locale is given, the currently configured {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale
|
|
18588
19070
|
* formatLocale} will be used.
|
|
18589
19071
|
*
|
|
18590
|
-
* This instance has
|
|
19072
|
+
* This instance has HALF_AWAY_FROM_ZERO set as default rounding mode. Please set the roundingMode property
|
|
18591
19073
|
* in oFormatOptions to change the default value.
|
|
18592
19074
|
*/
|
|
18593
|
-
static
|
|
19075
|
+
static getPercentInstance(
|
|
18594
19076
|
/**
|
|
18595
19077
|
* The option object which support the following parameters. If no options is given, default values according
|
|
18596
19078
|
* to the type and locale settings are used.
|
|
18597
19079
|
*/
|
|
18598
19080
|
oFormatOptions?: {
|
|
18599
19081
|
/**
|
|
18600
|
-
* defines
|
|
19082
|
+
* defines the number of decimal digits
|
|
19083
|
+
*/
|
|
19084
|
+
decimals?: int;
|
|
19085
|
+
/**
|
|
19086
|
+
* defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
|
|
19087
|
+
* `groupingSeparator`.
|
|
18601
19088
|
*/
|
|
18602
|
-
|
|
19089
|
+
decimalSeparator?: string;
|
|
19090
|
+
/**
|
|
19091
|
+
* @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
|
|
19092
|
+
* allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
|
|
19093
|
+
* in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as NaN,
|
|
19094
|
+
* and NaN is formatted as an empty string.
|
|
19095
|
+
*/
|
|
19096
|
+
emptyString?: number;
|
|
19097
|
+
/**
|
|
19098
|
+
* defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
|
|
19099
|
+
*/
|
|
19100
|
+
groupingBaseSize?: int;
|
|
19101
|
+
/**
|
|
19102
|
+
* defines whether grouping is enabled (show the grouping separators)
|
|
19103
|
+
*/
|
|
19104
|
+
groupingEnabled?: boolean;
|
|
18603
19105
|
/**
|
|
18604
|
-
* defines
|
|
18605
|
-
*
|
|
19106
|
+
* defines the character used as grouping separator. Note: `groupingSeparator` must always be different
|
|
19107
|
+
* from `decimalSeparator`.
|
|
19108
|
+
*/
|
|
19109
|
+
groupingSeparator?: string;
|
|
19110
|
+
/**
|
|
19111
|
+
* defines the grouping size in digits; the default is `3`. It must be a positive number.
|
|
19112
|
+
*/
|
|
19113
|
+
groupingSize?: int;
|
|
19114
|
+
/**
|
|
19115
|
+
* defines the maximum number of decimal digits
|
|
19116
|
+
*/
|
|
19117
|
+
maxFractionDigits?: int;
|
|
19118
|
+
/**
|
|
19119
|
+
* defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
|
|
19120
|
+
* characters are shown instead of digits.
|
|
18606
19121
|
*/
|
|
18607
19122
|
maxIntegerDigits?: int;
|
|
18608
19123
|
/**
|
|
18609
|
-
* defines minimal number of decimal digits
|
|
19124
|
+
* defines the minimal number of decimal digits
|
|
18610
19125
|
*/
|
|
18611
19126
|
minFractionDigits?: int;
|
|
18612
19127
|
/**
|
|
18613
|
-
* defines
|
|
19128
|
+
* defines the minimal number of non-decimal digits
|
|
18614
19129
|
*/
|
|
18615
|
-
|
|
19130
|
+
minIntegerDigits?: int;
|
|
18616
19131
|
/**
|
|
18617
|
-
* defines the
|
|
19132
|
+
* defines the used minus symbol
|
|
18618
19133
|
*/
|
|
18619
|
-
|
|
19134
|
+
minusSign?: string;
|
|
19135
|
+
/**
|
|
19136
|
+
* @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
|
|
19137
|
+
* for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
|
|
19138
|
+
* is parsed to "0.005".
|
|
19139
|
+
*/
|
|
19140
|
+
parseAsString?: boolean;
|
|
19141
|
+
/**
|
|
19142
|
+
* CLDR number pattern which is used to format the number
|
|
19143
|
+
*/
|
|
19144
|
+
pattern?: string;
|
|
19145
|
+
/**
|
|
19146
|
+
* defines the used percent symbol
|
|
19147
|
+
*/
|
|
19148
|
+
percentSign?: string;
|
|
19149
|
+
/**
|
|
19150
|
+
* defines the used plus symbol
|
|
19151
|
+
*/
|
|
19152
|
+
plusSign?: string;
|
|
19153
|
+
/**
|
|
19154
|
+
* defines the numerical precision; the number of decimals is calculated dependent on the integer digits
|
|
19155
|
+
*/
|
|
19156
|
+
precision?: int;
|
|
19157
|
+
/**
|
|
19158
|
+
* Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
|
|
19159
|
+
* than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
|
|
19160
|
+
* is rounded to `maxFractionDigits`.
|
|
19161
|
+
*/
|
|
19162
|
+
preserveDecimals?: boolean;
|
|
19163
|
+
/**
|
|
19164
|
+
* specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
|
|
19165
|
+
* maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
|
|
19166
|
+
* assigned
|
|
19167
|
+
* - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
|
|
19168
|
+
* - via a function that is used for rounding the number and takes two parameters: the number itself,
|
|
19169
|
+
* and the number of decimal digits that should be reserved.
|
|
19170
|
+
*/
|
|
19171
|
+
roundingMode?: RoundingMode | keyof typeof RoundingMode;
|
|
18620
19172
|
/**
|
|
18621
19173
|
* defines the number of decimal in the shortened format string. If this isn't specified, the 'decimals'
|
|
18622
19174
|
* options is used
|
|
@@ -18638,78 +19190,13 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18638
19190
|
* only when the 'style' options is set to either 'short' or 'long'.
|
|
18639
19191
|
*/
|
|
18640
19192
|
showScale?: boolean;
|
|
18641
|
-
/**
|
|
18642
|
-
* defines the number precision, number of decimals is calculated dependent on the integer digits
|
|
18643
|
-
*/
|
|
18644
|
-
precision?: int;
|
|
18645
|
-
/**
|
|
18646
|
-
* CLDR number pattern which is used to format the number
|
|
18647
|
-
*/
|
|
18648
|
-
pattern?: string;
|
|
18649
|
-
/**
|
|
18650
|
-
* defines whether grouping is enabled (show the grouping separators)
|
|
18651
|
-
*/
|
|
18652
|
-
groupingEnabled?: boolean;
|
|
18653
|
-
/**
|
|
18654
|
-
* defines the used grouping separator, note that the groupingSeparator must always be different than the
|
|
18655
|
-
* used decimalSeparator.
|
|
18656
|
-
*/
|
|
18657
|
-
groupingSeparator?: string;
|
|
18658
|
-
/**
|
|
18659
|
-
* defines the grouping size in digits, the default is three
|
|
18660
|
-
*/
|
|
18661
|
-
groupingSize?: int;
|
|
18662
|
-
/**
|
|
18663
|
-
* defines the grouping base size in digits, in case it is different from the grouping size (e.g. indian
|
|
18664
|
-
* grouping)
|
|
18665
|
-
*/
|
|
18666
|
-
groupingBaseSize?: int;
|
|
18667
|
-
/**
|
|
18668
|
-
* defines the used decimal separator, note that the decimalSeparator must always be different than the
|
|
18669
|
-
* used groupingSeparator.
|
|
18670
|
-
*/
|
|
18671
|
-
decimalSeparator?: string;
|
|
18672
|
-
/**
|
|
18673
|
-
* defines the used plus symbol
|
|
18674
|
-
*/
|
|
18675
|
-
plusSign?: string;
|
|
18676
|
-
/**
|
|
18677
|
-
* defines the used minus symbol
|
|
18678
|
-
*/
|
|
18679
|
-
minusSign?: string;
|
|
18680
|
-
/**
|
|
18681
|
-
* @since 1.28.2 defines whether to output string from parse function in order to keep the precision for
|
|
18682
|
-
* big numbers. Numbers in scientific notation are parsed back to the standard notation. For example "5e+3"
|
|
18683
|
-
* is parsed to "5000".
|
|
18684
|
-
*/
|
|
18685
|
-
parseAsString?: boolean;
|
|
18686
|
-
/**
|
|
18687
|
-
* Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
|
|
18688
|
-
* than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
|
|
18689
|
-
* is rounded to `maxFractionDigits`.
|
|
18690
|
-
*/
|
|
18691
|
-
preserveDecimals?: boolean;
|
|
18692
19193
|
/**
|
|
18693
19194
|
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
18694
|
-
*
|
|
18695
|
-
*
|
|
18696
|
-
* decimals, shortDecimals or precision option.
|
|
19195
|
+
* When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
|
|
19196
|
+
* default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
19197
|
+
* decimals, shortDecimals, or the 'precision' option itself.
|
|
18697
19198
|
*/
|
|
18698
19199
|
style?: string;
|
|
18699
|
-
/**
|
|
18700
|
-
* specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
|
|
18701
|
-
* maxFractionDigits. Rounding will only be applied, if the passed value if of type number. This can be
|
|
18702
|
-
* assigned by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode} or a function
|
|
18703
|
-
* which will be used for rounding the number. The function is called with two parameters: the number and
|
|
18704
|
-
* how many decimal digits should be reserved.
|
|
18705
|
-
*/
|
|
18706
|
-
roundingMode?: RoundingMode | keyof typeof RoundingMode;
|
|
18707
|
-
/**
|
|
18708
|
-
* @since 1.30.0 defines what empty string is parsed as and what is formatted as empty string. The allowed
|
|
18709
|
-
* values are only NaN, null or 0. The 'format' and 'parse' are done in a symmetric way. For example when
|
|
18710
|
-
* this parameter is set to NaN, empty string is parsed as NaN and NaN is formatted as empty string.
|
|
18711
|
-
*/
|
|
18712
|
-
emptyString?: number;
|
|
18713
19200
|
},
|
|
18714
19201
|
/**
|
|
18715
19202
|
* Locale to get the formatter for
|
|
@@ -18717,11 +19204,7 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18717
19204
|
oLocale?: Locale
|
|
18718
19205
|
): NumberFormat;
|
|
18719
19206
|
/**
|
|
18720
|
-
*
|
|
18721
|
-
*/
|
|
18722
|
-
static getMetadata(): Metadata;
|
|
18723
|
-
/**
|
|
18724
|
-
* Get a percent instance of the NumberFormat, which can be used for formatting.
|
|
19207
|
+
* Get a unit instance of the NumberFormat, which can be used for formatting units.
|
|
18725
19208
|
*
|
|
18726
19209
|
* If no locale is given, the currently configured {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale
|
|
18727
19210
|
* formatLocale} will be used.
|
|
@@ -18729,176 +19212,112 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18729
19212
|
* This instance has HALF_AWAY_FROM_ZERO set as default rounding mode. Please set the roundingMode property
|
|
18730
19213
|
* in oFormatOptions to change the default value.
|
|
18731
19214
|
*/
|
|
18732
|
-
static
|
|
19215
|
+
static getUnitInstance(
|
|
18733
19216
|
/**
|
|
18734
19217
|
* The option object which support the following parameters. If no options is given, default values according
|
|
18735
19218
|
* to the type and locale settings are used.
|
|
18736
19219
|
*/
|
|
18737
19220
|
oFormatOptions?: {
|
|
18738
19221
|
/**
|
|
18739
|
-
* defines
|
|
18740
|
-
*/
|
|
18741
|
-
minIntegerDigits?: int;
|
|
18742
|
-
/**
|
|
18743
|
-
* defines maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?" characters
|
|
18744
|
-
* are shown instead of digits.
|
|
18745
|
-
*/
|
|
18746
|
-
maxIntegerDigits?: int;
|
|
18747
|
-
/**
|
|
18748
|
-
* defines minimal number of decimal digits
|
|
19222
|
+
* defines the allowed units for formatting and parsing, e.g. ["size-meter", "volume-liter", ...]
|
|
18749
19223
|
*/
|
|
18750
|
-
|
|
19224
|
+
allowedUnits?: any[];
|
|
18751
19225
|
/**
|
|
18752
|
-
* defines
|
|
19226
|
+
* defines a set of custom units, e.g. {"electric-inductance": { "displayName": "henry", "unitPattern-count-one":
|
|
19227
|
+
* "{0} H", "unitPattern-count-other": "{0} H", "perUnitPattern": "{0}/H", "decimals": 2, "precision": 4
|
|
19228
|
+
* }}
|
|
18753
19229
|
*/
|
|
18754
|
-
|
|
19230
|
+
customUnits?: Record<string, object>;
|
|
18755
19231
|
/**
|
|
18756
19232
|
* defines the number of decimal digits
|
|
18757
19233
|
*/
|
|
18758
19234
|
decimals?: int;
|
|
18759
19235
|
/**
|
|
18760
|
-
* defines the
|
|
18761
|
-
*
|
|
18762
|
-
*/
|
|
18763
|
-
shortDecimals?: int;
|
|
18764
|
-
/**
|
|
18765
|
-
* only use short number formatting for values above this limit
|
|
18766
|
-
*/
|
|
18767
|
-
shortLimit?: int;
|
|
18768
|
-
/**
|
|
18769
|
-
* @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is generated.
|
|
18770
|
-
* The generated scale factor is used for all numbers which are formatted with this format instance. This
|
|
18771
|
-
* option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
|
|
18772
|
-
* set with `undefined` which means the scale factor is selected automatically for each number being formatted.
|
|
18773
|
-
*/
|
|
18774
|
-
shortRefNumber?: int;
|
|
18775
|
-
/**
|
|
18776
|
-
* @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
|
|
18777
|
-
* only when the 'style' options is set to either 'short' or 'long'.
|
|
19236
|
+
* defines the character used as decimal separator. Note: `decimalSeparator` must always be different from
|
|
19237
|
+
* `groupingSeparator`.
|
|
18778
19238
|
*/
|
|
18779
|
-
|
|
19239
|
+
decimalSeparator?: string;
|
|
18780
19240
|
/**
|
|
18781
|
-
* defines
|
|
19241
|
+
* @since 1.30.0 defines what an empty string is parsed as, and what is formatted as an empty string. The
|
|
19242
|
+
* allowed values are "" (empty string), NaN, `null`, or 0. The 'format' and 'parse' functions are done
|
|
19243
|
+
* in a symmetric way. For example, when this parameter is set to NaN, an empty string is parsed as [NaN,
|
|
19244
|
+
* undefined], and NaN is formatted as an empty string.
|
|
18782
19245
|
*/
|
|
18783
|
-
|
|
19246
|
+
emptyString?: number;
|
|
18784
19247
|
/**
|
|
18785
|
-
*
|
|
19248
|
+
* defines the grouping base size in digits if it is different from the grouping size (e.g. Indian grouping)
|
|
18786
19249
|
*/
|
|
18787
|
-
|
|
19250
|
+
groupingBaseSize?: int;
|
|
18788
19251
|
/**
|
|
18789
19252
|
* defines whether grouping is enabled (show the grouping separators)
|
|
18790
19253
|
*/
|
|
18791
19254
|
groupingEnabled?: boolean;
|
|
18792
19255
|
/**
|
|
18793
|
-
* defines the used grouping separator
|
|
18794
|
-
*
|
|
19256
|
+
* defines the character used as grouping separator. Note: `groupingSeparator` must always be different
|
|
19257
|
+
* from `decimalSeparator`.
|
|
18795
19258
|
*/
|
|
18796
19259
|
groupingSeparator?: string;
|
|
18797
19260
|
/**
|
|
18798
|
-
* defines the grouping size in digits
|
|
19261
|
+
* defines the grouping size in digits; the default is `3`. It must be a positive number.
|
|
18799
19262
|
*/
|
|
18800
19263
|
groupingSize?: int;
|
|
18801
19264
|
/**
|
|
18802
|
-
* defines the
|
|
18803
|
-
* grouping)
|
|
19265
|
+
* defines the maximum number of decimal digits
|
|
18804
19266
|
*/
|
|
18805
|
-
|
|
19267
|
+
maxFractionDigits?: int;
|
|
18806
19268
|
/**
|
|
18807
|
-
* defines the
|
|
18808
|
-
*
|
|
19269
|
+
* defines the maximum number of non-decimal digits. If the number exceeds this maximum, e.g. 1e+120, "?"
|
|
19270
|
+
* characters are shown instead of digits.
|
|
18809
19271
|
*/
|
|
18810
|
-
|
|
19272
|
+
maxIntegerDigits?: int;
|
|
18811
19273
|
/**
|
|
18812
|
-
* defines the
|
|
19274
|
+
* defines the minimal number of decimal digits
|
|
18813
19275
|
*/
|
|
18814
|
-
|
|
19276
|
+
minFractionDigits?: int;
|
|
18815
19277
|
/**
|
|
18816
|
-
* defines the
|
|
19278
|
+
* defines the minimal number of non-decimal digits
|
|
18817
19279
|
*/
|
|
18818
|
-
|
|
19280
|
+
minIntegerDigits?: int;
|
|
18819
19281
|
/**
|
|
18820
|
-
* defines the used
|
|
19282
|
+
* defines the used minus symbol
|
|
18821
19283
|
*/
|
|
18822
|
-
|
|
19284
|
+
minusSign?: string;
|
|
18823
19285
|
/**
|
|
18824
|
-
* @since 1.28.2 defines whether to output string from parse function in order to keep the precision
|
|
18825
|
-
* big numbers. Numbers in scientific notation are parsed back to
|
|
19286
|
+
* @since 1.28.2 defines whether to output the string from the parse function in order to keep the precision
|
|
19287
|
+
* for big numbers. Numbers in scientific notation are parsed back to standard notation. For example, "5e-3"
|
|
18826
19288
|
* is parsed to "0.005".
|
|
18827
19289
|
*/
|
|
18828
19290
|
parseAsString?: boolean;
|
|
18829
19291
|
/**
|
|
18830
|
-
*
|
|
18831
|
-
* than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
|
|
18832
|
-
* is rounded to `maxFractionDigits`.
|
|
18833
|
-
*/
|
|
18834
|
-
preserveDecimals?: boolean;
|
|
18835
|
-
/**
|
|
18836
|
-
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
18837
|
-
* Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
|
|
18838
|
-
* the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
18839
|
-
* decimals, shortDecimals or precision option.
|
|
18840
|
-
*/
|
|
18841
|
-
style?: string;
|
|
18842
|
-
/**
|
|
18843
|
-
* specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
|
|
18844
|
-
* maxFractionDigits. Rounding will only be applied, if the passed value if of type number. This can be
|
|
18845
|
-
* assigned by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode} or a function
|
|
18846
|
-
* which will be used for rounding the number. The function is called with two parameters: the number and
|
|
18847
|
-
* how many decimal digits should be reserved.
|
|
18848
|
-
*/
|
|
18849
|
-
roundingMode?: RoundingMode | keyof typeof RoundingMode;
|
|
18850
|
-
/**
|
|
18851
|
-
* @since 1.30.0 defines what empty string is parsed as and what is formatted as empty string. The allowed
|
|
18852
|
-
* values are "" (empty string), NaN, null or 0. The 'format' and 'parse' are done in a symmetric way. For
|
|
18853
|
-
* example when this parameter is set to NaN, empty string is parsed as NaN and NaN is formatted as empty
|
|
18854
|
-
* string.
|
|
18855
|
-
*/
|
|
18856
|
-
emptyString?: number;
|
|
18857
|
-
},
|
|
18858
|
-
/**
|
|
18859
|
-
* Locale to get the formatter for
|
|
18860
|
-
*/
|
|
18861
|
-
oLocale?: Locale
|
|
18862
|
-
): NumberFormat;
|
|
18863
|
-
/**
|
|
18864
|
-
* Get a unit instance of the NumberFormat, which can be used for formatting units.
|
|
18865
|
-
*
|
|
18866
|
-
* If no locale is given, the currently configured {@link sap.ui.core.Configuration.FormatSettings#getFormatLocale
|
|
18867
|
-
* formatLocale} will be used.
|
|
18868
|
-
*
|
|
18869
|
-
* This instance has HALF_AWAY_FROM_ZERO set as default rounding mode. Please set the roundingMode property
|
|
18870
|
-
* in oFormatOptions to change the default value.
|
|
18871
|
-
*/
|
|
18872
|
-
static getUnitInstance(
|
|
18873
|
-
/**
|
|
18874
|
-
* The option object which support the following parameters. If no options is given, default values according
|
|
18875
|
-
* to the type and locale settings are used.
|
|
18876
|
-
*/
|
|
18877
|
-
oFormatOptions?: {
|
|
18878
|
-
/**
|
|
18879
|
-
* defines minimal number of non-decimal digits
|
|
19292
|
+
* CLDR number pattern which is used to format the number
|
|
18880
19293
|
*/
|
|
18881
|
-
|
|
19294
|
+
pattern?: string;
|
|
18882
19295
|
/**
|
|
18883
|
-
* defines
|
|
18884
|
-
* are shown instead of digits.
|
|
19296
|
+
* defines the used plus symbol
|
|
18885
19297
|
*/
|
|
18886
|
-
|
|
19298
|
+
plusSign?: string;
|
|
18887
19299
|
/**
|
|
18888
|
-
* defines
|
|
19300
|
+
* defines the numerical precision; the number of decimals is calculated dependent on the integer digits
|
|
18889
19301
|
*/
|
|
18890
|
-
|
|
19302
|
+
precision?: int;
|
|
18891
19303
|
/**
|
|
18892
|
-
*
|
|
19304
|
+
* Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
|
|
19305
|
+
* than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
|
|
19306
|
+
* is rounded to `maxFractionDigits`.
|
|
18893
19307
|
*/
|
|
18894
|
-
|
|
19308
|
+
preserveDecimals?: boolean;
|
|
18895
19309
|
/**
|
|
18896
|
-
*
|
|
19310
|
+
* specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
|
|
19311
|
+
* maxFractionDigits. Rounding will only be applied if the passed value is of type `number`. This can be
|
|
19312
|
+
* assigned
|
|
19313
|
+
* - by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode},
|
|
19314
|
+
* - via a function that is used for rounding the number and takes two parameters: the number itself,
|
|
19315
|
+
* and the number of decimal digits that should be reserved.
|
|
18897
19316
|
*/
|
|
18898
|
-
|
|
19317
|
+
roundingMode?: RoundingMode | keyof typeof RoundingMode;
|
|
18899
19318
|
/**
|
|
18900
|
-
* defines the number of
|
|
18901
|
-
*
|
|
19319
|
+
* defines the number of decimals in the shortened format string. If this option isn't specified, the 'decimals'
|
|
19320
|
+
* option is used instead.
|
|
18902
19321
|
*/
|
|
18903
19322
|
shortDecimals?: int;
|
|
18904
19323
|
/**
|
|
@@ -18906,93 +19325,12 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
18906
19325
|
*/
|
|
18907
19326
|
shortLimit?: int;
|
|
18908
19327
|
/**
|
|
18909
|
-
* @since 1.40 specifies a number from which the scale factor for 'short' or 'long' style format is
|
|
18910
|
-
* The generated scale factor is used for all numbers which are formatted with this format instance.
|
|
18911
|
-
* option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
|
|
19328
|
+
* @since 1.40 specifies a number from which the scale factor for the 'short' or 'long' style format is
|
|
19329
|
+
* generated. The generated scale factor is used for all numbers which are formatted with this format instance.
|
|
19330
|
+
* This option has effect only when the option 'style' is set to 'short' or 'long'. This option is by default
|
|
18912
19331
|
* set with `undefined` which means the scale factor is selected automatically for each number being formatted.
|
|
18913
19332
|
*/
|
|
18914
19333
|
shortRefNumber?: int;
|
|
18915
|
-
/**
|
|
18916
|
-
* @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
|
|
18917
|
-
* only when the 'style' options is set to either 'short' or 'long'.
|
|
18918
|
-
*/
|
|
18919
|
-
showScale?: boolean;
|
|
18920
|
-
/**
|
|
18921
|
-
* defines the number precision, number of decimals is calculated dependent on the integer digits
|
|
18922
|
-
*/
|
|
18923
|
-
precision?: int;
|
|
18924
|
-
/**
|
|
18925
|
-
* CLDR number pattern which is used to format the number
|
|
18926
|
-
*/
|
|
18927
|
-
pattern?: string;
|
|
18928
|
-
/**
|
|
18929
|
-
* defines whether grouping is enabled (show the grouping separators)
|
|
18930
|
-
*/
|
|
18931
|
-
groupingEnabled?: boolean;
|
|
18932
|
-
/**
|
|
18933
|
-
* defines the used grouping separator, note that the groupingSeparator must always be different than the
|
|
18934
|
-
* used decimalSeparator.
|
|
18935
|
-
*/
|
|
18936
|
-
groupingSeparator?: string;
|
|
18937
|
-
/**
|
|
18938
|
-
* defines the grouping size in digits, the default is three
|
|
18939
|
-
*/
|
|
18940
|
-
groupingSize?: int;
|
|
18941
|
-
/**
|
|
18942
|
-
* defines the grouping base size in digits, in case it is different from the grouping size (e.g. indian
|
|
18943
|
-
* grouping)
|
|
18944
|
-
*/
|
|
18945
|
-
groupingBaseSize?: int;
|
|
18946
|
-
/**
|
|
18947
|
-
* defines the used decimal separator, note that the decimalSeparator must always be different than the
|
|
18948
|
-
* used groupingSeparator.
|
|
18949
|
-
*/
|
|
18950
|
-
decimalSeparator?: string;
|
|
18951
|
-
/**
|
|
18952
|
-
* defines a set of custom units, e.g. {"electric-inductance": { "displayName": "henry", "unitPattern-count-one":
|
|
18953
|
-
* "{0} H", "unitPattern-count-other": "{0} H", "perUnitPattern": "{0}/H", "decimals": 2, "precision": 4
|
|
18954
|
-
* }}
|
|
18955
|
-
*/
|
|
18956
|
-
customUnits?: Record<string, object>;
|
|
18957
|
-
/**
|
|
18958
|
-
* defines the allowed units for formatting and parsing, e.g. ["size-meter", "volume-liter", ...]
|
|
18959
|
-
*/
|
|
18960
|
-
allowedUnits?: any[];
|
|
18961
|
-
/**
|
|
18962
|
-
* defines the used plus symbol
|
|
18963
|
-
*/
|
|
18964
|
-
plusSign?: string;
|
|
18965
|
-
/**
|
|
18966
|
-
* defines the used minus symbol
|
|
18967
|
-
*/
|
|
18968
|
-
minusSign?: string;
|
|
18969
|
-
/**
|
|
18970
|
-
* @since 1.28.2 defines whether to output string from parse function in order to keep the precision for
|
|
18971
|
-
* big numbers. Numbers in scientific notation are parsed back to the standard notation. For example "5e-3"
|
|
18972
|
-
* is parsed to "0.005".
|
|
18973
|
-
*/
|
|
18974
|
-
parseAsString?: boolean;
|
|
18975
|
-
/**
|
|
18976
|
-
* Whether {@link #format} preserves decimal digits except trailing zeros in case there are more decimals
|
|
18977
|
-
* than the `maxFractionDigits` format option allows. If decimals are not preserved, the formatted number
|
|
18978
|
-
* is rounded to `maxFractionDigits`.
|
|
18979
|
-
*/
|
|
18980
|
-
preserveDecimals?: boolean;
|
|
18981
|
-
/**
|
|
18982
|
-
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
18983
|
-
* Numbers are formatted into compact forms when it's set to 'short' or 'long'. When this option is set,
|
|
18984
|
-
* the default value of option 'precision' is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
18985
|
-
* decimals, shortDecimals or precision option.
|
|
18986
|
-
*/
|
|
18987
|
-
style?: string;
|
|
18988
|
-
/**
|
|
18989
|
-
* specifies a rounding behavior for discarding the digits after the maximum fraction digits defined by
|
|
18990
|
-
* maxFractionDigits. Rounding will only be applied, if the passed value if of type number. This can be
|
|
18991
|
-
* assigned by value in {@link sap.ui.core.format.NumberFormat.RoundingMode RoundingMode} or a function
|
|
18992
|
-
* which will be used for rounding the number. The function is called with two parameters: the number and
|
|
18993
|
-
* how many decimal digits should be reserved.
|
|
18994
|
-
*/
|
|
18995
|
-
roundingMode?: RoundingMode | keyof typeof RoundingMode;
|
|
18996
19334
|
/**
|
|
18997
19335
|
* defines whether the unit of measure is shown in the formatted string, e.g. for input 1 and "duration-day"
|
|
18998
19336
|
* true: "1 day", false: "1". If both `showMeasure` and `showNumber` are false, an empty string is returned
|
|
@@ -19007,12 +19345,17 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
19007
19345
|
*/
|
|
19008
19346
|
showNumber?: boolean;
|
|
19009
19347
|
/**
|
|
19010
|
-
* @since 1.
|
|
19011
|
-
*
|
|
19012
|
-
* example when this parameter is set to NaN, empty string is parsed as [NaN, undefined] and NaN is formatted
|
|
19013
|
-
* as empty string.
|
|
19348
|
+
* @since 1.40 specifies whether the scale factor is shown in the formatted number. This option takes effect
|
|
19349
|
+
* only when the 'style' options is set to either 'short' or 'long'.
|
|
19014
19350
|
*/
|
|
19015
|
-
|
|
19351
|
+
showScale?: boolean;
|
|
19352
|
+
/**
|
|
19353
|
+
* defines the style of format. Valid values are 'short, 'long' or 'standard' (based on CLDR decimalFormat).
|
|
19354
|
+
* When set to 'short' or 'long', numbers are formatted into compact forms. When this option is set, the
|
|
19355
|
+
* default value of the 'precision' option is set to 2. This can be changed by setting either min/maxFractionDigits,
|
|
19356
|
+
* decimals, shortDecimals, or the 'precision' option itself.
|
|
19357
|
+
*/
|
|
19358
|
+
style?: string;
|
|
19016
19359
|
},
|
|
19017
19360
|
/**
|
|
19018
19361
|
* Locale to get the formatter for
|
|
@@ -19032,6 +19375,19 @@ declare module "sap/ui/core/format/NumberFormat" {
|
|
|
19032
19375
|
*/
|
|
19033
19376
|
sMeasure?: string
|
|
19034
19377
|
): string;
|
|
19378
|
+
/**
|
|
19379
|
+
* @SINCE 1.100
|
|
19380
|
+
*
|
|
19381
|
+
* Returns the scaling factor which is calculated based on the format options and the current locale being
|
|
19382
|
+
* used.
|
|
19383
|
+
*
|
|
19384
|
+
* This function only returns a meaningful scaling factor when the 'style' formatting option is set to 'short'
|
|
19385
|
+
* or 'long', and the 'shortRefNumber' option for calculating the scale factor is set.
|
|
19386
|
+
*
|
|
19387
|
+
* Consider using this function when the 'showScale' option is set to `false`, which causes the scale factor
|
|
19388
|
+
* not to appear in every formatted number but in a shared place.
|
|
19389
|
+
*/
|
|
19390
|
+
getScale(): string | undefined;
|
|
19035
19391
|
/**
|
|
19036
19392
|
* Parse a string which is formatted according to the given format options.
|
|
19037
19393
|
*/
|
|
@@ -19991,8 +20347,10 @@ declare module "sap/ui/core/Icon" {
|
|
|
19991
20347
|
* Icon uses embedded font instead of pixel image. Comparing to image, Icon is easily scalable, color can
|
|
19992
20348
|
* be altered live and various effects can be added using css.
|
|
19993
20349
|
*
|
|
19994
|
-
* A set of built in Icons is available
|
|
19995
|
-
*
|
|
20350
|
+
* A set of built in Icons is available in the Icon
|
|
20351
|
+
* Explorer.
|
|
20352
|
+
*
|
|
20353
|
+
* For further information, see {@link topic:21ea0ea94614480d9a910b2e93431291 Icon and Icon Pool}.
|
|
19996
20354
|
*/
|
|
19997
20355
|
export default class Icon extends Control implements IFormContent {
|
|
19998
20356
|
__implements__sap_ui_core_IFormContent: boolean;
|
|
@@ -20241,9 +20599,17 @@ declare module "sap/ui/core/Icon" {
|
|
|
20241
20599
|
/**
|
|
20242
20600
|
* Gets current value of property {@link #getSrc src}.
|
|
20243
20601
|
*
|
|
20244
|
-
* This property
|
|
20245
|
-
*
|
|
20246
|
-
*
|
|
20602
|
+
* This property can be set by following options:
|
|
20603
|
+
*
|
|
20604
|
+
* **Option 1:**
|
|
20605
|
+
* The value has to be matched by following pattern `sap-icon://collection-name/icon-name` where `collection-name`
|
|
20606
|
+
* and `icon-name` have to be replaced by the desired values. In case the default UI5 icons are used the
|
|
20607
|
+
* `collection-name` can be omited.
|
|
20608
|
+
* Example: `sap-icon://accept`
|
|
20609
|
+
*
|
|
20610
|
+
* **Option 2:** The value is determined by using {@link sap.ui.core.IconPool.getIconURI} with an Icon name
|
|
20611
|
+
* parameter and an optional collection parameter which is required when using application extended Icons.
|
|
20612
|
+
* Example: `IconPool.getIconURI("accept")`
|
|
20247
20613
|
*/
|
|
20248
20614
|
getSrc(): URI;
|
|
20249
20615
|
/**
|
|
@@ -20456,9 +20822,17 @@ declare module "sap/ui/core/Icon" {
|
|
|
20456
20822
|
/**
|
|
20457
20823
|
* Sets a new value for property {@link #getSrc src}.
|
|
20458
20824
|
*
|
|
20459
|
-
* This property
|
|
20460
|
-
*
|
|
20461
|
-
*
|
|
20825
|
+
* This property can be set by following options:
|
|
20826
|
+
*
|
|
20827
|
+
* **Option 1:**
|
|
20828
|
+
* The value has to be matched by following pattern `sap-icon://collection-name/icon-name` where `collection-name`
|
|
20829
|
+
* and `icon-name` have to be replaced by the desired values. In case the default UI5 icons are used the
|
|
20830
|
+
* `collection-name` can be omited.
|
|
20831
|
+
* Example: `sap-icon://accept`
|
|
20832
|
+
*
|
|
20833
|
+
* **Option 2:** The value is determined by using {@link sap.ui.core.IconPool.getIconURI} with an Icon name
|
|
20834
|
+
* parameter and an optional collection parameter which is required when using application extended Icons.
|
|
20835
|
+
* Example: `IconPool.getIconURI("accept")`
|
|
20462
20836
|
*
|
|
20463
20837
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
20464
20838
|
*/
|
|
@@ -20503,9 +20877,17 @@ declare module "sap/ui/core/Icon" {
|
|
|
20503
20877
|
|
|
20504
20878
|
export interface $IconSettings extends $ControlSettings {
|
|
20505
20879
|
/**
|
|
20506
|
-
* This property
|
|
20507
|
-
*
|
|
20508
|
-
*
|
|
20880
|
+
* This property can be set by following options:
|
|
20881
|
+
*
|
|
20882
|
+
* **Option 1:**
|
|
20883
|
+
* The value has to be matched by following pattern `sap-icon://collection-name/icon-name` where `collection-name`
|
|
20884
|
+
* and `icon-name` have to be replaced by the desired values. In case the default UI5 icons are used the
|
|
20885
|
+
* `collection-name` can be omited.
|
|
20886
|
+
* Example: `sap-icon://accept`
|
|
20887
|
+
*
|
|
20888
|
+
* **Option 2:** The value is determined by using {@link sap.ui.core.IconPool.getIconURI} with an Icon name
|
|
20889
|
+
* parameter and an optional collection parameter which is required when using application extended Icons.
|
|
20890
|
+
* Example: `IconPool.getIconURI("accept")`
|
|
20509
20891
|
*/
|
|
20510
20892
|
src?: URI | PropertyBindingInfo;
|
|
20511
20893
|
|
|
@@ -22042,7 +22424,7 @@ declare module "sap/ui/core/LocaleData" {
|
|
|
22042
22424
|
iWeekNumber: int
|
|
22043
22425
|
): string;
|
|
22044
22426
|
/**
|
|
22045
|
-
* Get combined datetime pattern with given date and
|
|
22427
|
+
* Get combined datetime pattern with given date and time style.
|
|
22046
22428
|
*/
|
|
22047
22429
|
getCombinedDateTimePattern(
|
|
22048
22430
|
/**
|
|
@@ -25819,6 +26201,13 @@ declare module "sap/ui/core/mvc/XMLView" {
|
|
|
25819
26201
|
* On root level, you can only define content for the default aggregation, e.g. without adding the `<content>`
|
|
25820
26202
|
* tag. If you want to specify content for another aggregation of a view like `dependents`, place it in
|
|
25821
26203
|
* a child control's dependents aggregation or add it by using {@link sap.ui.core.mvc.XMLView#addDependent}.
|
|
26204
|
+
*
|
|
26205
|
+
* **Note:**
|
|
26206
|
+
* The XML view offers special handling for context binding and style classes. You can specify them via
|
|
26207
|
+
* the `binding` and `class` attributes on a control's XML node. Please be aware that these attributes are
|
|
26208
|
+
* not properties of the respective controls and thus are not supported by a control's constructor. For
|
|
26209
|
+
* more information, see {@link topic:91f05e8b6f4d1014b6dd926db0e91070 Context Binding (Element Binding)}
|
|
26210
|
+
* and {@link topic:b564935324f449209354c7e2f9903f22 Using CSS Style Sheets in XML Views}.
|
|
25822
26211
|
*/
|
|
25823
26212
|
export default class XMLView extends View {
|
|
25824
26213
|
/**
|
|
@@ -26097,7 +26486,7 @@ declare module "sap/ui/core/Popup" {
|
|
|
26097
26486
|
|
|
26098
26487
|
import ManagedObjectMetadata from "sap/ui/base/ManagedObjectMetadata";
|
|
26099
26488
|
|
|
26100
|
-
import { OpenState } from "sap/ui/core/library";
|
|
26489
|
+
import { OpenState, Collision } from "sap/ui/core/library";
|
|
26101
26490
|
|
|
26102
26491
|
/**
|
|
26103
26492
|
* Popup Class is a helper class for controls that want themselves or parts of themselves or even other
|
|
@@ -26558,7 +26947,7 @@ declare module "sap/ui/core/Popup" {
|
|
|
26558
26947
|
* Opens the popup's content at the position either specified here or beforehand via {@link #setPosition}.
|
|
26559
26948
|
* Content must be capable of being positioned via "position:absolute;" All parameters are optional (open()
|
|
26560
26949
|
* may be called without any parameters). iDuration may just be omitted, but if any of "at", "of", "offset",
|
|
26561
|
-
* "collision" is given, also the preceding
|
|
26950
|
+
* "collision" is given, also the preceding positional parameters ("my", at",...) must be given.
|
|
26562
26951
|
*
|
|
26563
26952
|
* If the Popup's OpenState is different from "CLOSED" (i.e. if the Popup is already open, opening or closing),
|
|
26564
26953
|
* the call is ignored.
|
|
@@ -26590,7 +26979,7 @@ declare module "sap/ui/core/Popup" {
|
|
|
26590
26979
|
* defines how the position of an element should be adjusted in case it overflows the within area in some
|
|
26591
26980
|
* direction.
|
|
26592
26981
|
*/
|
|
26593
|
-
collision?:
|
|
26982
|
+
collision?: Collision,
|
|
26594
26983
|
/**
|
|
26595
26984
|
* defines the area the popup should be placed in. This affects the collision detection.
|
|
26596
26985
|
*/
|
|
@@ -26598,7 +26987,7 @@ declare module "sap/ui/core/Popup" {
|
|
|
26598
26987
|
/**
|
|
26599
26988
|
* defines whether the popup should follow the dock reference when the reference changes its position.
|
|
26600
26989
|
*/
|
|
26601
|
-
followOf?: boolean
|
|
26990
|
+
followOf?: boolean | Function | null
|
|
26602
26991
|
): void;
|
|
26603
26992
|
/**
|
|
26604
26993
|
* Sets the animation functions to use for opening and closing the Popup. Any null value will be ignored
|
|
@@ -26740,9 +27129,9 @@ declare module "sap/ui/core/Popup" {
|
|
|
26740
27129
|
offset?: string,
|
|
26741
27130
|
/**
|
|
26742
27131
|
* defines how the position of an element should be adjusted in case it overflows the within area in some
|
|
26743
|
-
* direction.
|
|
27132
|
+
* direction.
|
|
26744
27133
|
*/
|
|
26745
|
-
collision?:
|
|
27134
|
+
collision?: Collision,
|
|
26746
27135
|
/**
|
|
26747
27136
|
* defines the area the popup should be placed in. This affects the collision detection.
|
|
26748
27137
|
*/
|
|
@@ -35004,9 +35393,9 @@ declare module "sap/ui/core/util/MockServer" {
|
|
|
35004
35393
|
*/
|
|
35005
35394
|
attachAfter(
|
|
35006
35395
|
/**
|
|
35007
|
-
* type according to HTTP Method
|
|
35396
|
+
* event type according to HTTP Method
|
|
35008
35397
|
*/
|
|
35009
|
-
|
|
35398
|
+
sHttpMethod: string,
|
|
35010
35399
|
/**
|
|
35011
35400
|
* the name of the function that will be called at this exit The callback function exposes an event with
|
|
35012
35401
|
* parameters, depending on the type of the request. oEvent.getParameters() lists the parameters as per
|
|
@@ -35025,9 +35414,9 @@ declare module "sap/ui/core/util/MockServer" {
|
|
|
35025
35414
|
*/
|
|
35026
35415
|
attachBefore(
|
|
35027
35416
|
/**
|
|
35028
|
-
* type according to HTTP Method
|
|
35417
|
+
* event type according to HTTP Method
|
|
35029
35418
|
*/
|
|
35030
|
-
|
|
35419
|
+
sHttpMethod: string,
|
|
35031
35420
|
/**
|
|
35032
35421
|
* the name of the function that will be called at this exit. The callback function exposes an event with
|
|
35033
35422
|
* parameters, depending on the type of the request. oEvent.getParameters() lists the parameters as per
|
|
@@ -35060,9 +35449,9 @@ declare module "sap/ui/core/util/MockServer" {
|
|
|
35060
35449
|
*/
|
|
35061
35450
|
detachAfter(
|
|
35062
35451
|
/**
|
|
35063
|
-
* type according to HTTP Method
|
|
35452
|
+
* event type according to HTTP Method
|
|
35064
35453
|
*/
|
|
35065
|
-
|
|
35454
|
+
sHttpMethod: string,
|
|
35066
35455
|
/**
|
|
35067
35456
|
* the name of the function that will be called at this exit
|
|
35068
35457
|
*/
|
|
@@ -35077,9 +35466,9 @@ declare module "sap/ui/core/util/MockServer" {
|
|
|
35077
35466
|
*/
|
|
35078
35467
|
detachBefore(
|
|
35079
35468
|
/**
|
|
35080
|
-
* type according to HTTP Method
|
|
35469
|
+
* event type according to HTTP Method
|
|
35081
35470
|
*/
|
|
35082
|
-
|
|
35471
|
+
sHttpMethod: string,
|
|
35083
35472
|
/**
|
|
35084
35473
|
* the name of the function that will be called at this exit
|
|
35085
35474
|
*/
|
|
@@ -35477,9 +35866,6 @@ declare module "sap/ui/core/util/XMLPreprocessor" {
|
|
|
35477
35866
|
* refers to ".../Value". This means, the root formatter can access the ith part of the composite binding
|
|
35478
35867
|
* at will (since 1.31.0); see also {@link #.getInterface getInterface}. The function `foo` is called with
|
|
35479
35868
|
* arguments such that ` oInterface.getModel(i).getObject(oInterface.getPath(i)) === arguments[i + 1]` holds.
|
|
35480
|
-
* This use is not supported within an expression binding, that is, `<Text text="{= ${parts: [{path:
|
|
35481
|
-
* 'Label'}, {path: 'Value'}], formatter: 'foo'} }"/>` does not work as expected because the property `requiresIContext
|
|
35482
|
-
* = true` is ignored.
|
|
35483
35869
|
*
|
|
35484
35870
|
* To distinguish those two use cases, just check whether `oInterface.getModel() === undefined`, in which
|
|
35485
35871
|
* case the formatter is called on root level of a composite binding. To find out the number of parts, probe
|
|
@@ -37425,19 +37811,56 @@ declare module "sap/ui/model/analytics/AnalyticalBinding" {
|
|
|
37425
37811
|
*/
|
|
37426
37812
|
getNodeContexts(
|
|
37427
37813
|
/**
|
|
37428
|
-
*
|
|
37429
|
-
*
|
|
37430
|
-
* - oContext: parent context identifying the requested group of child contexts
|
|
37431
|
-
* - level: level number for oContext, because it might occur at multiple levels; context with group ID
|
|
37432
|
-
* `"/"` has level 0
|
|
37433
|
-
* - numberOfExpandedLevels: number of child levels that shall be fetched automatically
|
|
37434
|
-
* - startIndex: index of first child entry to return from the parent context (zero-based)
|
|
37435
|
-
* - length: number of entries to return; counting begins at the given start index
|
|
37436
|
-
* - threshold: number of additional entries that shall be locally available in the binding for subsequent
|
|
37437
|
-
* accesses to child entries of the given parent context.
|
|
37814
|
+
* Parent context identifying the requested group of child contexts
|
|
37438
37815
|
*/
|
|
37439
|
-
|
|
37440
|
-
|
|
37816
|
+
oContext: Context,
|
|
37817
|
+
/**
|
|
37818
|
+
* Parameters, specifying the aggregation level for which contexts shall be fetched or (legacy signature
|
|
37819
|
+
* variant) index of first child entry to return from the parent context (zero-based)
|
|
37820
|
+
*/
|
|
37821
|
+
mParameters:
|
|
37822
|
+
| {
|
|
37823
|
+
/**
|
|
37824
|
+
* Level number for oContext, because it might occur at multiple levels; context with group ID `"/"` has
|
|
37825
|
+
* level 0
|
|
37826
|
+
*/
|
|
37827
|
+
level: int;
|
|
37828
|
+
/**
|
|
37829
|
+
* Number of child levels that shall be fetched automatically
|
|
37830
|
+
*/
|
|
37831
|
+
numberOfExpandedLevels?: int;
|
|
37832
|
+
/**
|
|
37833
|
+
* Index of first child entry to return from the parent context (zero-based)
|
|
37834
|
+
*/
|
|
37835
|
+
startIndex?: int;
|
|
37836
|
+
/**
|
|
37837
|
+
* Number of entries to return; counting begins at the given start index
|
|
37838
|
+
*/
|
|
37839
|
+
length?: int;
|
|
37840
|
+
/**
|
|
37841
|
+
* Number of additional entries that shall be locally available in the binding for subsequent accesses to
|
|
37842
|
+
* child entries of the given parent context
|
|
37843
|
+
*/
|
|
37844
|
+
threshold?: int;
|
|
37845
|
+
}
|
|
37846
|
+
| int,
|
|
37847
|
+
/**
|
|
37848
|
+
* Same meaning as `mParameters.length`, legacy signature variant only
|
|
37849
|
+
*/
|
|
37850
|
+
iLength?: int,
|
|
37851
|
+
/**
|
|
37852
|
+
* Same meaning as `mParameters.threshold`, legacy signature variant only
|
|
37853
|
+
*/
|
|
37854
|
+
iThreshold?: int,
|
|
37855
|
+
/**
|
|
37856
|
+
* Same meaning as `mParameters.level`, legacy signature variant only
|
|
37857
|
+
*/
|
|
37858
|
+
iLevel?: int,
|
|
37859
|
+
/**
|
|
37860
|
+
* Same meaning as `mParameters.numberOfExpandedLevels`, legacy signature variant only
|
|
37861
|
+
*/
|
|
37862
|
+
iNumberOfExpandedLevels?: int
|
|
37863
|
+
): Context[];
|
|
37441
37864
|
/**
|
|
37442
37865
|
* Gets the metadata of a property with a given name.
|
|
37443
37866
|
*/
|
|
@@ -39382,6 +39805,17 @@ declare module "sap/ui/model/base/ManagedObjectModel" {
|
|
|
39382
39805
|
*/
|
|
39383
39806
|
fnFilter: Function
|
|
39384
39807
|
): void;
|
|
39808
|
+
/**
|
|
39809
|
+
* Private method iterating the registered bindings of this model instance and initiating their check for
|
|
39810
|
+
* update
|
|
39811
|
+
*/
|
|
39812
|
+
checkUpdate(
|
|
39813
|
+
bAsync: boolean,
|
|
39814
|
+
/**
|
|
39815
|
+
* an optional test function to filter the binding
|
|
39816
|
+
*/
|
|
39817
|
+
fnFilter: Function
|
|
39818
|
+
): void;
|
|
39385
39819
|
/**
|
|
39386
39820
|
* Inserts the user-defined custom data into the model.
|
|
39387
39821
|
*/
|
|
@@ -39763,7 +40197,7 @@ declare module "sap/ui/model/Binding" {
|
|
|
39763
40197
|
/**
|
|
39764
40198
|
* Update the bound control even if no data has been changed
|
|
39765
40199
|
*/
|
|
39766
|
-
bForceUpdate
|
|
40200
|
+
bForceUpdate?: boolean
|
|
39767
40201
|
): void;
|
|
39768
40202
|
/**
|
|
39769
40203
|
* Resumes the binding update. Change events will be fired again.
|
|
@@ -40880,6 +41314,18 @@ declare module "sap/ui/model/CompositeType" {
|
|
|
40880
41314
|
*/
|
|
40881
41315
|
aCurrentValues?: any[]
|
|
40882
41316
|
): any[] | any;
|
|
41317
|
+
/**
|
|
41318
|
+
* @SINCE 1.100.0
|
|
41319
|
+
*
|
|
41320
|
+
* Processes the types of the parts of this composite type. A concrete composite type may override this
|
|
41321
|
+
* method if it needs to derive information from the types of the parts.
|
|
41322
|
+
*/
|
|
41323
|
+
processPartTypes(
|
|
41324
|
+
/**
|
|
41325
|
+
* Types of the composite binding's parts
|
|
41326
|
+
*/
|
|
41327
|
+
aPartTypes: SimpleType[]
|
|
41328
|
+
): void;
|
|
40883
41329
|
/**
|
|
40884
41330
|
* Validates whether the given raw values meet the defined constraints. This method does nothing if no constraints
|
|
40885
41331
|
* are defined.
|
|
@@ -41880,24 +42326,24 @@ declare module "sap/ui/model/json/JSONModel" {
|
|
|
41880
42326
|
bMerge?: boolean
|
|
41881
42327
|
): void;
|
|
41882
42328
|
/**
|
|
41883
|
-
* Sets
|
|
41884
|
-
* interested parties are informed.
|
|
42329
|
+
* Sets `oValue` as new value for the property defined by the given `sPath` and `oContext`. Once the new
|
|
42330
|
+
* model value has been set, all interested parties are informed.
|
|
41885
42331
|
*/
|
|
41886
42332
|
setProperty(
|
|
41887
42333
|
/**
|
|
41888
|
-
* path of the property to set
|
|
42334
|
+
* The path of the property to set
|
|
41889
42335
|
*/
|
|
41890
42336
|
sPath: string,
|
|
41891
42337
|
/**
|
|
41892
|
-
* value to set
|
|
42338
|
+
* The new value to be set for this property
|
|
41893
42339
|
*/
|
|
41894
42340
|
oValue: any,
|
|
41895
42341
|
/**
|
|
41896
|
-
*
|
|
42342
|
+
* The context used to set the property
|
|
41897
42343
|
*/
|
|
41898
|
-
oContext?:
|
|
42344
|
+
oContext?: Context,
|
|
41899
42345
|
/**
|
|
41900
|
-
*
|
|
42346
|
+
* Whether to update other bindings dependent on this property asynchronously
|
|
41901
42347
|
*/
|
|
41902
42348
|
bAsyncUpdate?: boolean
|
|
41903
42349
|
): boolean;
|
|
@@ -47145,6 +47591,136 @@ declare module "sap/ui/model/odata/type/DateTimeOffset" {
|
|
|
47145
47591
|
}
|
|
47146
47592
|
}
|
|
47147
47593
|
|
|
47594
|
+
declare module "sap/ui/model/odata/type/DateTimeWithTimezone" {
|
|
47595
|
+
import CompositeType from "sap/ui/model/CompositeType";
|
|
47596
|
+
|
|
47597
|
+
import FormatException from "sap/ui/model/FormatException";
|
|
47598
|
+
|
|
47599
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
47600
|
+
|
|
47601
|
+
import ParseException from "sap/ui/model/ParseException";
|
|
47602
|
+
|
|
47603
|
+
/**
|
|
47604
|
+
* @SINCE 1.99.0
|
|
47605
|
+
* @EXPERIMENTAL
|
|
47606
|
+
*
|
|
47607
|
+
* This class represents the `DateTimeWithTimezone` composite type which has the parts timestamp and time
|
|
47608
|
+
* zone. The type formats the timestamp part using the time zone part. For this, the timestamp part has
|
|
47609
|
+
* to be provided in the UTC time zone. When using this type with the {@link sap.ui.model.odata.v2.ODataModel},
|
|
47610
|
+
* you need to set the parameter `useUndefinedIfUnresolved` for both parts.
|
|
47611
|
+
*/
|
|
47612
|
+
export default class DateTimeWithTimezone extends CompositeType {
|
|
47613
|
+
/**
|
|
47614
|
+
* Constructor for a `DateTimeWithTimezone` composite type.
|
|
47615
|
+
* See:
|
|
47616
|
+
* {sap.ui.model.odata.v2.ODataModel#bindProperty}
|
|
47617
|
+
*/
|
|
47618
|
+
constructor(
|
|
47619
|
+
/**
|
|
47620
|
+
* Format options. For a list of all available options, see {@link sap.ui.core.format.DateFormat.getDateTimeWithTimezoneInstance
|
|
47621
|
+
* DateFormat}. The `strictParsing` format option is set to `true` by default and can be overwritten. Format
|
|
47622
|
+
* options are immutable, that is, they can only be set once on construction.
|
|
47623
|
+
*/
|
|
47624
|
+
oFormatOptions?: object,
|
|
47625
|
+
/**
|
|
47626
|
+
* Constraints are not supported
|
|
47627
|
+
*/
|
|
47628
|
+
oConstraints?: object
|
|
47629
|
+
);
|
|
47630
|
+
|
|
47631
|
+
/**
|
|
47632
|
+
* Creates a new subclass of class sap.ui.model.odata.type.DateTimeWithTimezone with name `sClassName` and
|
|
47633
|
+
* enriches it with the information contained in `oClassInfo`.
|
|
47634
|
+
*
|
|
47635
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.CompositeType.extend}.
|
|
47636
|
+
*/
|
|
47637
|
+
static extend<T extends Record<string, unknown>>(
|
|
47638
|
+
/**
|
|
47639
|
+
* Name of the class being created
|
|
47640
|
+
*/
|
|
47641
|
+
sClassName: string,
|
|
47642
|
+
/**
|
|
47643
|
+
* Object literal with information about the class
|
|
47644
|
+
*/
|
|
47645
|
+
oClassInfo?: sap.ClassInfo<T, DateTimeWithTimezone>,
|
|
47646
|
+
/**
|
|
47647
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
47648
|
+
* used by this class
|
|
47649
|
+
*/
|
|
47650
|
+
FNMetaImpl?: Function
|
|
47651
|
+
): Function;
|
|
47652
|
+
/**
|
|
47653
|
+
* Returns a metadata object for class sap.ui.model.odata.type.DateTimeWithTimezone.
|
|
47654
|
+
*/
|
|
47655
|
+
static getMetadata(): Metadata;
|
|
47656
|
+
/**
|
|
47657
|
+
* Formats the given values of the parts of the `DateTimeWithTimezone` composite type to the given target
|
|
47658
|
+
* type.
|
|
47659
|
+
*/
|
|
47660
|
+
formatValue(
|
|
47661
|
+
/**
|
|
47662
|
+
* The array of the part values to be formatted; the first entry has to be a `Date` object for the timestamp,
|
|
47663
|
+
* and the second entry has to be a string representing a time zone ID
|
|
47664
|
+
*/
|
|
47665
|
+
aValues: any[],
|
|
47666
|
+
/**
|
|
47667
|
+
* The target type, must be "object", "string", or a type with one of these types as its {@link sap.ui.base.DataType#getPrimitiveType
|
|
47668
|
+
* primitive type}; see {@link sap.ui.model.odata.type} for more information
|
|
47669
|
+
*/
|
|
47670
|
+
sTargetType: string
|
|
47671
|
+
): any;
|
|
47672
|
+
/**
|
|
47673
|
+
* Returns the type's name.
|
|
47674
|
+
*/
|
|
47675
|
+
getName(): string;
|
|
47676
|
+
/**
|
|
47677
|
+
* Gets an array of indices that determine which parts of this type shall not propagate their model messages
|
|
47678
|
+
* to the attached control. Prerequisite is that the corresponding binding supports this feature, see {@link
|
|
47679
|
+
* sap.ui.model.Binding#supportsIgnoreMessages}. If the `showTimezone` format option is set to `false`,
|
|
47680
|
+
* the time zone is not shown in the control, and the part for the time zone shall not propagate model messages
|
|
47681
|
+
* to the control. Analogously, if the format option `showDate` and `showTime` are both set to `false`,
|
|
47682
|
+
* the date and time are not shown in the control, and the parts for the date and time shall not propagate
|
|
47683
|
+
* model messages to the control.
|
|
47684
|
+
* See:
|
|
47685
|
+
* sap.ui.model.Binding#supportsIgnoreMessages
|
|
47686
|
+
*/
|
|
47687
|
+
getPartsIgnoringMessages(): number[];
|
|
47688
|
+
/**
|
|
47689
|
+
* Parses the given value.
|
|
47690
|
+
*/
|
|
47691
|
+
parseValue(
|
|
47692
|
+
/**
|
|
47693
|
+
* The value to be parsed
|
|
47694
|
+
*/
|
|
47695
|
+
vValue: string | Date,
|
|
47696
|
+
/**
|
|
47697
|
+
* The source type (the expected type of `vValue`); must be "object", "string", or a type with one of these
|
|
47698
|
+
* types as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}; see {@link sap.ui.model.odata.type}
|
|
47699
|
+
* for more information
|
|
47700
|
+
*/
|
|
47701
|
+
sSourceType: string,
|
|
47702
|
+
/**
|
|
47703
|
+
* The array of current part values; the first entry has to be a `Date` object for the timestamp, and the
|
|
47704
|
+
* second entry has to be a string representing a time zone ID; **Note:** This parameter is required, see
|
|
47705
|
+
* definition of this parameter in {@link sap.ui.model.CompositeType#parseValue}
|
|
47706
|
+
*/
|
|
47707
|
+
aCurrentValues?: any[]
|
|
47708
|
+
): any[];
|
|
47709
|
+
/**
|
|
47710
|
+
* Validates whether the given raw values meet the defined constraints. This method does nothing as no constraints
|
|
47711
|
+
* are supported.
|
|
47712
|
+
* See:
|
|
47713
|
+
* sap.ui.model.SimpleType#validateValue
|
|
47714
|
+
*/
|
|
47715
|
+
validateValue(
|
|
47716
|
+
/**
|
|
47717
|
+
* The set of values to be validated
|
|
47718
|
+
*/
|
|
47719
|
+
aValues: any[]
|
|
47720
|
+
): void;
|
|
47721
|
+
}
|
|
47722
|
+
}
|
|
47723
|
+
|
|
47148
47724
|
declare module "sap/ui/model/odata/type/Decimal" {
|
|
47149
47725
|
import ODataType from "sap/ui/model/odata/type/ODataType";
|
|
47150
47726
|
|
|
@@ -49030,11 +49606,39 @@ declare module "sap/ui/model/odata/v2/Context" {
|
|
|
49030
49606
|
* and the entity for this context has been stored in the back end, {@link #created} returns `undefined`.
|
|
49031
49607
|
*/
|
|
49032
49608
|
created(): Promise<any>;
|
|
49609
|
+
/**
|
|
49610
|
+
* @SINCE 1.101
|
|
49611
|
+
*
|
|
49612
|
+
* Deletes the OData entity this context points to. **Note:** The context must not be used anymore after
|
|
49613
|
+
* successful deletion.
|
|
49614
|
+
*/
|
|
49615
|
+
delete(
|
|
49616
|
+
/**
|
|
49617
|
+
* For a persistent context, a map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#remove}
|
|
49618
|
+
*/
|
|
49619
|
+
mParameters?: {
|
|
49620
|
+
/**
|
|
49621
|
+
* ID of a request group; requests belonging to the same group will be bundled in one batch request
|
|
49622
|
+
*/
|
|
49623
|
+
groupId?: string;
|
|
49624
|
+
/**
|
|
49625
|
+
* ID of the `ChangeSet` that this request should belong to
|
|
49626
|
+
*/
|
|
49627
|
+
changeSetId?: string;
|
|
49628
|
+
/**
|
|
49629
|
+
* Defines whether to update all bindings after submitting this change operation, see {@link #setRefreshAfterChange}.
|
|
49630
|
+
* If given, this overrules the model-wide `refreshAfterChange` flag for this operation only.
|
|
49631
|
+
*/
|
|
49632
|
+
refreshAfterChange?: boolean;
|
|
49633
|
+
}
|
|
49634
|
+
): Promise<any>;
|
|
49033
49635
|
/**
|
|
49034
49636
|
* @SINCE 1.98.0
|
|
49035
49637
|
*
|
|
49036
49638
|
* Returns whether this context is inactive. An inactive context will only be sent to the server after the
|
|
49037
|
-
* first property update. From then on it behaves like any other created context.
|
|
49639
|
+
* first property update. From then on it behaves like any other created context. The result of this function
|
|
49640
|
+
* can also be accessed via the "@$ui5.context.isInactive" instance annotation at the entity, see {@link
|
|
49641
|
+
* sap.ui.model.odata.v2.ODataModel#getProperty} for details.
|
|
49038
49642
|
* See:
|
|
49039
49643
|
* sap.ui.model.odata.v2.ODataListBinding#create
|
|
49040
49644
|
* sap.ui.model.odata.v2.ODataModel#createEntry
|
|
@@ -49045,7 +49649,9 @@ declare module "sap/ui/model/odata/v2/Context" {
|
|
|
49045
49649
|
*
|
|
49046
49650
|
* For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry} or {@link sap.ui.model.odata.v2.ODataListBinding#create},
|
|
49047
49651
|
* the method returns `true` if the context is transient or `false` if the context is not transient. A transient
|
|
49048
|
-
* context represents an entity created on the client which has not been persisted in the back end.
|
|
49652
|
+
* context represents an entity created on the client which has not been persisted in the back end. The
|
|
49653
|
+
* result of this function can also be accessed via the "@$ui5.context.isTransient" instance annotation
|
|
49654
|
+
* at the entity, see {@link sap.ui.model.odata.v2.ODataModel#getProperty} for details.
|
|
49049
49655
|
*/
|
|
49050
49656
|
isTransient(): boolean;
|
|
49051
49657
|
}
|
|
@@ -49860,7 +50466,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
49860
50466
|
*
|
|
49861
50467
|
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
49862
50468
|
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
49863
|
-
* parameter.
|
|
50469
|
+
* parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
|
|
50470
|
+
* Entities documentation} for comprehensive information on the topic.
|
|
49864
50471
|
*
|
|
49865
50472
|
* Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
|
|
49866
50473
|
*/
|
|
@@ -49891,7 +50498,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
49891
50498
|
error?: Function;
|
|
49892
50499
|
/**
|
|
49893
50500
|
* A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
|
|
49894
|
-
* sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
50501
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry}; **Note:** if no expand parameter is given, the expand
|
|
50502
|
+
* parameter of this binding is used; see {@link sap.ui.model.odata.v2.ODataModel#bindList}
|
|
49895
50503
|
*/
|
|
49896
50504
|
expand?: string;
|
|
49897
50505
|
/**
|
|
@@ -49914,7 +50522,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
49914
50522
|
*
|
|
49915
50523
|
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
49916
50524
|
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
49917
|
-
* parameter.
|
|
50525
|
+
* parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
|
|
50526
|
+
* Entities documentation} for comprehensive information on the topic.
|
|
49918
50527
|
*
|
|
49919
50528
|
* Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
|
|
49920
50529
|
*/
|
|
@@ -49938,7 +50547,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
49938
50547
|
error?: Function;
|
|
49939
50548
|
/**
|
|
49940
50549
|
* A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
|
|
49941
|
-
* sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
50550
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry}; **Note:** if no expand parameter is given, the expand
|
|
50551
|
+
* parameter of this binding is used; see {@link sap.ui.model.odata.v2.ODataModel#bindList}
|
|
49942
50552
|
*/
|
|
49943
50553
|
expand?: string;
|
|
49944
50554
|
/**
|
|
@@ -49961,7 +50571,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
49961
50571
|
*
|
|
49962
50572
|
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
49963
50573
|
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
49964
|
-
* parameter.
|
|
50574
|
+
* parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
|
|
50575
|
+
* Entities documentation} for comprehensive information on the topic.
|
|
49965
50576
|
*
|
|
49966
50577
|
* Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
|
|
49967
50578
|
*/
|
|
@@ -49988,7 +50599,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
49988
50599
|
error?: Function;
|
|
49989
50600
|
/**
|
|
49990
50601
|
* A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
|
|
49991
|
-
* sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
50602
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry}; **Note:** if no expand parameter is given, the expand
|
|
50603
|
+
* parameter of this binding is used; see {@link sap.ui.model.odata.v2.ODataModel#bindList}
|
|
49992
50604
|
*/
|
|
49993
50605
|
expand?: string;
|
|
49994
50606
|
/**
|
|
@@ -50011,7 +50623,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
50011
50623
|
*
|
|
50012
50624
|
* Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
50013
50625
|
* using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
|
|
50014
|
-
* parameter.
|
|
50626
|
+
* parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
|
|
50627
|
+
* Entities documentation} for comprehensive information on the topic.
|
|
50015
50628
|
*
|
|
50016
50629
|
* Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
|
|
50017
50630
|
*/
|
|
@@ -50031,7 +50644,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
|
|
|
50031
50644
|
error?: Function;
|
|
50032
50645
|
/**
|
|
50033
50646
|
* A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
|
|
50034
|
-
* sap.ui.model.odata.v2.ODataModel#createEntry}
|
|
50647
|
+
* sap.ui.model.odata.v2.ODataModel#createEntry}; **Note:** if no expand parameter is given, the expand
|
|
50648
|
+
* parameter of this binding is used; see {@link sap.ui.model.odata.v2.ODataModel#bindList}
|
|
50035
50649
|
*/
|
|
50036
50650
|
expand?: string;
|
|
50037
50651
|
/**
|
|
@@ -50813,7 +51427,8 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
50813
51427
|
/**
|
|
50814
51428
|
* Creates a new property binding for this model.
|
|
50815
51429
|
* See:
|
|
50816
|
-
* sap.ui.model.Model
|
|
51430
|
+
* sap.ui.model.Model#bindProperty
|
|
51431
|
+
* #getProperty
|
|
50817
51432
|
*/
|
|
50818
51433
|
bindProperty(
|
|
50819
51434
|
/**
|
|
@@ -50833,13 +51448,18 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
50833
51448
|
* Whether this binding does not propagate model messages to the control; supported since 1.82.0. Some composite
|
|
50834
51449
|
* types like {@link sap.ui.model.type.Currency} automatically ignore model messages for some of their parts
|
|
50835
51450
|
* depending on their format options; setting this parameter to `true` or `false` overrules the automatism
|
|
50836
|
-
* of the type
|
|
51451
|
+
* of the type
|
|
50837
51452
|
*
|
|
50838
51453
|
* For example, a binding for a currency code is used in a composite binding for rendering the proper number
|
|
50839
51454
|
* of decimals, but the currency code is not displayed in the attached control. In that case, messages for
|
|
50840
|
-
* the currency code shall not be displayed at that control, only messages for the amount
|
|
51455
|
+
* the currency code shall not be displayed at that control, only messages for the amount
|
|
50841
51456
|
*/
|
|
50842
51457
|
ignoreMessages?: boolean;
|
|
51458
|
+
/**
|
|
51459
|
+
* Whether the value of the created property binding is `undefined` if it is unresolved; if not set, its
|
|
51460
|
+
* value is `null`. Supported since 1.100.0
|
|
51461
|
+
*/
|
|
51462
|
+
useUndefinedIfUnresolved?: boolean;
|
|
50843
51463
|
}
|
|
50844
51464
|
): PropertyBinding;
|
|
50845
51465
|
/**
|
|
@@ -51111,7 +51731,9 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
51111
51731
|
*/
|
|
51112
51732
|
canonicalRequestsEnabled(): boolean;
|
|
51113
51733
|
/**
|
|
51114
|
-
* Trigger a `POST` request to the OData service that was specified in the model constructor
|
|
51734
|
+
* Trigger a `POST` request to the OData service that was specified in the model constructor; see {@link
|
|
51735
|
+
* topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating Entities documentation}
|
|
51736
|
+
* for comprehensive information on the topic.
|
|
51115
51737
|
*
|
|
51116
51738
|
* Please note that deep creates are not supported and may not work.
|
|
51117
51739
|
*/
|
|
@@ -51229,7 +51851,9 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
51229
51851
|
): Context1 | undefined;
|
|
51230
51852
|
/**
|
|
51231
51853
|
* Creates a new entry object which is described by the metadata of the entity type of the specified `sPath`
|
|
51232
|
-
* Name. A context object is returned which can be used to bind against the newly created object.
|
|
51854
|
+
* Name. A context object is returned which can be used to bind against the newly created object. See {@link
|
|
51855
|
+
* topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating Entities documentation}
|
|
51856
|
+
* for comprehensive information on the topic.
|
|
51233
51857
|
*
|
|
51234
51858
|
* For each created entry a request is created and stored in a request queue. The request queue can be submitted
|
|
51235
51859
|
* by calling {@link #submitChanges}. As long as the context is transient (see {@link sap.ui.model.odata.v2.Context#isTransient}),
|
|
@@ -51872,11 +52496,13 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
51872
52496
|
*/
|
|
51873
52497
|
getPendingChanges(): Record<string, object>;
|
|
51874
52498
|
/**
|
|
51875
|
-
* Returns the value for the property with the given `sPath`.
|
|
52499
|
+
* Returns the value for the property with the given `sPath`. Since 1.100, a path starting with "@$ui5."
|
|
52500
|
+
* which represents an instance annotation is supported. The following instance annotations are allowed;
|
|
52501
|
+
* they return information on the given oContext, which must be set and be an {@link sap.ui.model.odata.v2.Context}:
|
|
51876
52502
|
*
|
|
51877
|
-
*
|
|
51878
|
-
*
|
|
51879
|
-
*
|
|
52503
|
+
* - `@$ui5.context.isInactive`: The return value of {@link sap.ui.model.odata.v2.Context#isInactive}
|
|
52504
|
+
*
|
|
52505
|
+
* - `@$ui5.context.isTransient`: The return value of {@link sap.ui.model.odata.v2.Context#isTransient}
|
|
51880
52506
|
*/
|
|
51881
52507
|
getProperty(
|
|
51882
52508
|
/**
|
|
@@ -51888,11 +52514,9 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
|
|
|
51888
52514
|
*/
|
|
51889
52515
|
oContext?: object,
|
|
51890
52516
|
/**
|
|
51891
|
-
*
|
|
51892
|
-
*
|
|
51893
|
-
*
|
|
51894
|
-
* value/entry and includes the associated expand entries (if any). Note: A copy and not a reference of
|
|
51895
|
-
* the entry will be returned.
|
|
52517
|
+
* Deprecated, use {@link #getObject} function with 'select' and 'expand' parameters instead. Whether entities
|
|
52518
|
+
* for navigation properties of this property which have been read via `$expand` are part of the return
|
|
52519
|
+
* value.
|
|
51896
52520
|
*/
|
|
51897
52521
|
bIncludeExpandEntries?: boolean
|
|
51898
52522
|
): any;
|
|
@@ -52872,16 +53496,16 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
52872
53496
|
* ```javascript
|
|
52873
53497
|
*
|
|
52874
53498
|
* <Annotations Target="com.sap.gateway.default.iwbep.tea_busi.v0001.EQUIPMENT">
|
|
52875
|
-
*
|
|
52876
|
-
*
|
|
52877
|
-
*
|
|
52878
|
-
*
|
|
52879
|
-
*
|
|
52880
|
-
*
|
|
52881
|
-
*
|
|
53499
|
+
* <Annotation Term="com.sap.vocabularies.UI.v1.Facets">
|
|
53500
|
+
* <Collection>
|
|
53501
|
+
* <Record Type="com.sap.vocabularies.UI.v1.ReferenceFacet">
|
|
53502
|
+
* <PropertyValue Property="Target" AnnotationPath="EQUIPMENT_2_PRODUCT/@com.sap.vocabularies.Common.v1.QuickInfo" />
|
|
53503
|
+
* </Record>
|
|
53504
|
+
* </Collection>
|
|
53505
|
+
* </Annotation>
|
|
52882
53506
|
* </Annotations>
|
|
52883
53507
|
* <Annotations Target="com.sap.gateway.default.iwbep.tea_busi_product.v0001.Product">
|
|
52884
|
-
*
|
|
53508
|
+
* <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="Name" />
|
|
52885
53509
|
* </Annotations>
|
|
52886
53510
|
* ```
|
|
52887
53511
|
*
|
|
@@ -52895,16 +53519,16 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" {
|
|
|
52895
53519
|
* ```javascript
|
|
52896
53520
|
*
|
|
52897
53521
|
* <Annotations Target="com.sap.gateway.default.iwbep.tea_busi.v0001.EQUIPMENT">
|
|
52898
|
-
*
|
|
52899
|
-
*
|
|
52900
|
-
*
|
|
52901
|
-
*
|
|
52902
|
-
*
|
|
52903
|
-
*
|
|
52904
|
-
*
|
|
53522
|
+
* <Annotation Term="com.sap.vocabularies.UI.v1.LineItem">
|
|
53523
|
+
* <Collection>
|
|
53524
|
+
* <Record Type="com.sap.vocabularies.UI.v1.DataField">
|
|
53525
|
+
* <PropertyValue Property="Value" Path="EQUIPMENT_2_PRODUCT/Name" />
|
|
53526
|
+
* </Record>
|
|
53527
|
+
* </Collection>
|
|
53528
|
+
* </Annotation>
|
|
52905
53529
|
* </Annotations>
|
|
52906
53530
|
* <Annotations Target="com.sap.gateway.default.iwbep.tea_busi_product.v0001.Product/Name">
|
|
52907
|
-
*
|
|
53531
|
+
* <Annotation Term="com.sap.vocabularies.Common.v1.QuickInfo" Path="PRODUCT_2_SUPPLIER/Supplier_Name" />
|
|
52908
53532
|
* </Annotations>
|
|
52909
53533
|
* ```
|
|
52910
53534
|
*
|
|
@@ -53401,8 +54025,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
53401
54025
|
*
|
|
53402
54026
|
* Returns a promise that is resolved without data when the entity represented by this context has been
|
|
53403
54027
|
* created in the back end and all selected properties of this entity are available. Expanded navigation
|
|
53404
|
-
* properties are only available if the context's binding is refreshable. {@link sap.ui.model.odata.v4.
|
|
53405
|
-
*
|
|
54028
|
+
* properties are only available if the context's binding is refreshable. {@link sap.ui.model.odata.v4.ODataContextBinding#refresh}
|
|
54029
|
+
* and {@link sap.ui.model.odata.v4.ODataListBinding#refresh} describe which bindings are refreshable.
|
|
53406
54030
|
*
|
|
53407
54031
|
* As long as the promise is not yet resolved or rejected, the entity represented by this context is transient.
|
|
53408
54032
|
*
|
|
@@ -53484,7 +54108,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
53484
54108
|
* is added via {@link sap.ui.model.odata.v4.ODataListBinding#create} without `bAtEnd`, and when a context
|
|
53485
54109
|
* representing a created entity is deleted again.
|
|
53486
54110
|
*/
|
|
53487
|
-
getIndex(): number;
|
|
54111
|
+
getIndex(): number | undefined;
|
|
53488
54112
|
/**
|
|
53489
54113
|
* @SINCE 1.39.0
|
|
53490
54114
|
*
|
|
@@ -53495,6 +54119,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
53495
54119
|
*
|
|
53496
54120
|
* Returns `undefined` if the data is not (yet) available; no request is triggered. Use {@link #requestObject}
|
|
53497
54121
|
* for asynchronous access.
|
|
54122
|
+
*
|
|
54123
|
+
* The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
|
|
53498
54124
|
* See:
|
|
53499
54125
|
* sap.ui.model.Context#getObject
|
|
53500
54126
|
*/
|
|
@@ -53538,7 +54164,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
53538
54164
|
*
|
|
53539
54165
|
* Returns whether there are pending changes for bindings dependent on this context, or for unresolved bindings
|
|
53540
54166
|
* (see {@link sap.ui.model.Binding#isResolved}) which were dependent on this context at the time the pending
|
|
53541
|
-
* change was created. This includes the context itself being
|
|
54167
|
+
* change was created. This includes the context itself being {@link #isTransient transient}. Since 1.98.0,
|
|
54168
|
+
* {@link #isInactive inactive} contexts are ignored.
|
|
53542
54169
|
*/
|
|
53543
54170
|
hasPendingChanges(): boolean;
|
|
53544
54171
|
/**
|
|
@@ -53556,6 +54183,7 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
53556
54183
|
* Returns whether this context is inactive. The result of this function can also be accessed via instance
|
|
53557
54184
|
* annotation "@$ui5.context.isInactive" at the entity.
|
|
53558
54185
|
* See:
|
|
54186
|
+
* #isTransient
|
|
53559
54187
|
* sap.ui.model.odata.v4.ODataListBinding#create
|
|
53560
54188
|
* sap.ui.model.odata.v4.ODataListBinding#event:createActivate
|
|
53561
54189
|
*/
|
|
@@ -53575,6 +54203,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
53575
54203
|
* `true` if the context is transient, meaning that the promise returned by {@link #created} is not yet
|
|
53576
54204
|
* resolved or rejected, and returns `false` if the context is not transient. The result of this function
|
|
53577
54205
|
* can also be accessed via instance annotation "@$ui5.context.isTransient" at the entity.
|
|
54206
|
+
* See:
|
|
54207
|
+
* #isInactive
|
|
53578
54208
|
*/
|
|
53579
54209
|
isTransient(): boolean;
|
|
53580
54210
|
/**
|
|
@@ -53634,6 +54264,8 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
53634
54264
|
* "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link
|
|
53635
54265
|
* sap.ui.model.odata.v4.Context#setProperty}.
|
|
53636
54266
|
*
|
|
54267
|
+
* The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
|
|
54268
|
+
*
|
|
53637
54269
|
* If you want {@link #requestObject} to read fresh data, call {@link #refresh} first.
|
|
53638
54270
|
* See:
|
|
53639
54271
|
* #getBinding
|
|
@@ -53773,8 +54405,10 @@ declare module "sap/ui/model/odata/v4/Context" {
|
|
|
53773
54405
|
*/
|
|
53774
54406
|
fnOnBeforeDestroy?: Function,
|
|
53775
54407
|
/**
|
|
53776
|
-
* Whether to request messages for this entity. Only used if `bKeepAlive` is `true`.
|
|
53777
|
-
*
|
|
54408
|
+
* Whether to request messages for this entity. Only used if `bKeepAlive` is `true`. Determines the messages
|
|
54409
|
+
* property from the annotation "com.sap.vocabularies.Common.v1.Messages" at the entity type. If found,
|
|
54410
|
+
* the binding keeps requesting messages until it is destroyed. Otherwise an error is logged in the console
|
|
54411
|
+
* and no messages are requested. Supported since 1.92.0
|
|
53778
54412
|
*/
|
|
53779
54413
|
bRequestMessages?: boolean
|
|
53780
54414
|
): void;
|
|
@@ -54019,10 +54653,10 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
54019
54653
|
* entity type, you can bind properties as usual, for example `<Text text="{street}"/>`.
|
|
54020
54654
|
*
|
|
54021
54655
|
* Since 1.98.0, a single-valued navigation property can be treated like a function if
|
|
54022
|
-
* it has the same type as the operation binding's parent context, that parent context is in
|
|
54023
|
-
*
|
|
54024
|
-
*
|
|
54025
|
-
*
|
|
54656
|
+
* it has the same type as the operation binding's parent context, that parent context is in a list
|
|
54657
|
+
* binding for a top-level entity set, there is a navigation property binding which points to that
|
|
54658
|
+
* same entity set, no operation parameters have been set, the `bReplaceWithRVC` parameter is
|
|
54659
|
+
* used.
|
|
54026
54660
|
*/
|
|
54027
54661
|
execute(
|
|
54028
54662
|
/**
|
|
@@ -54108,7 +54742,8 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
54108
54742
|
* Returns `true` if this binding or its dependent bindings have pending property changes or created entities
|
|
54109
54743
|
* which have not been sent successfully to the server. This function does not take into account the deletion
|
|
54110
54744
|
* of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
|
|
54111
|
-
* (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
|
|
54745
|
+
* (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive
|
|
54746
|
+
* inactive} contexts are ignored.
|
|
54112
54747
|
*
|
|
54113
54748
|
* Note: If this binding is relative, its data is cached separately for each parent context path. This method
|
|
54114
54749
|
* returns `true` if there are pending changes for the current parent context path of this binding. If this
|
|
@@ -54117,9 +54752,12 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
54117
54752
|
hasPendingChanges(
|
|
54118
54753
|
/**
|
|
54119
54754
|
* Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
|
|
54120
|
-
* changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#
|
|
54121
|
-
*
|
|
54122
|
-
* sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
|
|
54755
|
+
* changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
|
|
54756
|
+
* refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
|
|
54757
|
+
* suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
|
|
54758
|
+
* of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
|
|
54759
|
+
* contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
|
|
54760
|
+
* the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
|
|
54123
54761
|
*/
|
|
54124
54762
|
bIgnoreKeptAlive?: boolean
|
|
54125
54763
|
): boolean;
|
|
@@ -54138,21 +54776,6 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
54138
54776
|
* Method not supported
|
|
54139
54777
|
*/
|
|
54140
54778
|
isInitial(): boolean;
|
|
54141
|
-
/**
|
|
54142
|
-
* @SINCE 1.95.0
|
|
54143
|
-
* @deprecated (since 1.96.5)
|
|
54144
|
-
* @EXPERIMENTAL
|
|
54145
|
-
*
|
|
54146
|
-
* Moves the bound entity into the given list binding. This binding loses its data. The method may only
|
|
54147
|
-
* be called when this binding has finished loading. You can verify this by calling `oBinding.getBoundContext().requestObject()`.
|
|
54148
|
-
* If that promise resolves, the binding has finished loading.
|
|
54149
|
-
*/
|
|
54150
|
-
moveEntityTo(
|
|
54151
|
-
/**
|
|
54152
|
-
* The list binding to take the entity
|
|
54153
|
-
*/
|
|
54154
|
-
oListBinding: ODataListBinding
|
|
54155
|
-
): void;
|
|
54156
54779
|
/**
|
|
54157
54780
|
* @SINCE 1.37.0
|
|
54158
54781
|
*
|
|
@@ -54165,10 +54788,10 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
54165
54788
|
* determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
|
|
54166
54789
|
* with the given group ID.
|
|
54167
54790
|
*
|
|
54168
|
-
* If there are pending changes, an error is thrown. Use {@link #hasPendingChanges}
|
|
54169
|
-
* pending changes. If there are
|
|
54170
|
-
* the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
|
|
54171
|
-
* {@link #refresh}.
|
|
54791
|
+
* If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
|
|
54792
|
+
* to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
|
|
54793
|
+
* to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
|
|
54794
|
+
* calling {@link #refresh}.
|
|
54172
54795
|
*
|
|
54173
54796
|
* Use {@link #requestRefresh} if you want to wait for the refresh.
|
|
54174
54797
|
* See:
|
|
@@ -54258,7 +54881,8 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" {
|
|
|
54258
54881
|
* Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
|
|
54259
54882
|
* requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
|
|
54260
54883
|
* threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
|
|
54261
|
-
* kept-alive} context of this binding.
|
|
54884
|
+
* kept-alive} context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
|
|
54885
|
+
* contexts of a {@link #getRootBinding root binding} do not count as pending changes.
|
|
54262
54886
|
* See:
|
|
54263
54887
|
* {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
|
|
54264
54888
|
* sap.ui.model.Binding#suspend
|
|
@@ -54453,9 +55077,9 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
54453
55077
|
* For creating the new entity, the binding's update group ID is used, see {@link #getUpdateGroupId}.
|
|
54454
55078
|
*
|
|
54455
55079
|
* You can call {@link sap.ui.model.odata.v4.Context#delete} to delete the created context again. As long
|
|
54456
|
-
* as the context is
|
|
54457
|
-
* and a call to {@link sap.ui.model.odata.v4.ODataModel#resetChanges} with
|
|
54458
|
-
* also delete the created context together with other changes.
|
|
55080
|
+
* as the context is {@link sap.ui.model.odata.v4.Context#isTransient transient} and {@link sap.ui.model.odata.v4.Context#isInactive
|
|
55081
|
+
* active}, {@link #resetChanges} and a call to {@link sap.ui.model.odata.v4.ODataModel#resetChanges} with
|
|
55082
|
+
* the update group ID as parameter also delete the created context together with other changes.
|
|
54459
55083
|
*
|
|
54460
55084
|
* If the creation of the entity on the server failed, the creation is repeated automatically. If the binding's
|
|
54461
55085
|
* update group ID has {@link sap.ui.model.odata.v4.SubmitMode.API}, it is repeated with the next call of
|
|
@@ -54501,14 +55125,19 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
54501
55125
|
*/
|
|
54502
55126
|
bSkipRefresh?: boolean,
|
|
54503
55127
|
/**
|
|
54504
|
-
* Whether the entity is inserted at the end of the list.
|
|
54505
|
-
*
|
|
55128
|
+
* Whether the entity is inserted at the end of the list. Supported since 1.66.0. Since 1.99.0 the first
|
|
55129
|
+
* insertion determines the overall position of created contexts within the binding's context list. Every
|
|
55130
|
+
* succeeding insertion is relative to the created contexts within this list.
|
|
54506
55131
|
*/
|
|
54507
55132
|
bAtEnd?: boolean,
|
|
54508
55133
|
/**
|
|
54509
55134
|
* Create an inactive context. Such a context will only be sent to the server after the first property update.
|
|
54510
55135
|
* From then on it behaves like any other created context. This parameter is experimental and its implementation
|
|
54511
|
-
* may still change. Do not use it in productive code yet. Supported since 1.97.0
|
|
55136
|
+
* may still change. Do not use it in productive code yet. Supported since 1.97.0 Since 1.98.0, when
|
|
55137
|
+
* the first property updates happens, the context is no longer {@link sap.ui.model.odata.v4.Context#isInactive
|
|
55138
|
+
* inactive} and the {@link sap.ui.model.odata.v4.ODataListBinding#event:createActivate createActivate}
|
|
55139
|
+
* event is fired. While inactive, it does not count as a {@link #hasPendingChanges pending change} and
|
|
55140
|
+
* does not contribute to the {@link #getCount count}.
|
|
54512
55141
|
*/
|
|
54513
55142
|
bInactive?: boolean
|
|
54514
55143
|
): Context;
|
|
@@ -54687,7 +55316,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
54687
55316
|
* Returns the count of elements.
|
|
54688
55317
|
*
|
|
54689
55318
|
* If known, the value represents the sum of the element count of the collection on the server and the number
|
|
54690
|
-
* of
|
|
55319
|
+
* of {@link sap.ui.model.odata.v4.Context#isInactive active} {@link sap.ui.model.odata.v4.Context#isTransient
|
|
55320
|
+
* transient} entities created on the client. Otherwise, it is `undefined`. The value is a number of type
|
|
54691
55321
|
* `Edm.Int64`. Since 1.91.0, in case of data aggregation with group levels, the count is the leaf count
|
|
54692
55322
|
* on the server; it is only determined if the `$count` system query option is given.
|
|
54693
55323
|
*
|
|
@@ -54756,6 +55386,30 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
54756
55386
|
* #getCount
|
|
54757
55387
|
*/
|
|
54758
55388
|
getHeaderContext(): Context;
|
|
55389
|
+
/**
|
|
55390
|
+
* @SINCE 1.99.0
|
|
55391
|
+
*
|
|
55392
|
+
* Calls {@link sap.ui.model.odata.v4.Context#setKeepAlive} at the context for the given path and returns
|
|
55393
|
+
* it. Since 1.100.0 the function always returns such a context. If none exists yet, it is created without
|
|
55394
|
+
* data and a request for its entity is sent.
|
|
55395
|
+
* See:
|
|
55396
|
+
* sap.ui.model.odata.v4.Model#getKeepAliveContext
|
|
55397
|
+
*/
|
|
55398
|
+
getKeepAliveContext(
|
|
55399
|
+
/**
|
|
55400
|
+
* The path of the context to be kept alive
|
|
55401
|
+
*/
|
|
55402
|
+
sPath: string,
|
|
55403
|
+
/**
|
|
55404
|
+
* Whether to request messages for the context's entity
|
|
55405
|
+
*/
|
|
55406
|
+
bRequestMessages?: boolean,
|
|
55407
|
+
/**
|
|
55408
|
+
* The group ID used for read requests for the context's entity or its properties. If not given, the binding's
|
|
55409
|
+
* {@link #getGroupId group ID} is used. Supported since 1.100.0
|
|
55410
|
+
*/
|
|
55411
|
+
sGroupId?: string
|
|
55412
|
+
): Context;
|
|
54759
55413
|
/**
|
|
54760
55414
|
* @SINCE 1.37.0
|
|
54761
55415
|
*
|
|
@@ -54803,7 +55457,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
54803
55457
|
* Returns `true` if this binding or its dependent bindings have pending property changes or created entities
|
|
54804
55458
|
* which have not been sent successfully to the server. This function does not take into account the deletion
|
|
54805
55459
|
* of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
|
|
54806
|
-
* (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
|
|
55460
|
+
* (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive
|
|
55461
|
+
* inactive} contexts are ignored.
|
|
54807
55462
|
*
|
|
54808
55463
|
* Note: If this binding is relative, its data is cached separately for each parent context path. This method
|
|
54809
55464
|
* returns `true` if there are pending changes for the current parent context path of this binding. If this
|
|
@@ -54812,9 +55467,12 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
54812
55467
|
hasPendingChanges(
|
|
54813
55468
|
/**
|
|
54814
55469
|
* Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
|
|
54815
|
-
* changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#
|
|
54816
|
-
*
|
|
54817
|
-
* sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
|
|
55470
|
+
* changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
|
|
55471
|
+
* refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
|
|
55472
|
+
* suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
|
|
55473
|
+
* of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
|
|
55474
|
+
* contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
|
|
55475
|
+
* the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
|
|
54818
55476
|
*/
|
|
54819
55477
|
bIgnoreKeptAlive?: boolean
|
|
54820
55478
|
): boolean;
|
|
@@ -54828,6 +55486,13 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
54828
55486
|
* #getRootBinding
|
|
54829
55487
|
*/
|
|
54830
55488
|
initialize(): void;
|
|
55489
|
+
/**
|
|
55490
|
+
* @SINCE 1.99.0
|
|
55491
|
+
*
|
|
55492
|
+
* Returns whether the overall position of created entries is at the end of the list; this is determined
|
|
55493
|
+
* by the first call to {@link #create}.
|
|
55494
|
+
*/
|
|
55495
|
+
isFirstCreateAtEnd(): boolean | undefined;
|
|
54831
55496
|
/**
|
|
54832
55497
|
* @SINCE 1.37.0
|
|
54833
55498
|
*
|
|
@@ -54855,10 +55520,10 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
54855
55520
|
* determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
|
|
54856
55521
|
* with the given group ID.
|
|
54857
55522
|
*
|
|
54858
|
-
* If there are pending changes, an error is thrown. Use {@link #hasPendingChanges}
|
|
54859
|
-
* pending changes. If there are
|
|
54860
|
-
* the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
|
|
54861
|
-
* {@link #refresh}.
|
|
55523
|
+
* If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
|
|
55524
|
+
* to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
|
|
55525
|
+
* to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
|
|
55526
|
+
* calling {@link #refresh}.
|
|
54862
55527
|
*
|
|
54863
55528
|
* Use {@link #requestRefresh} if you want to wait for the refresh.
|
|
54864
55529
|
* See:
|
|
@@ -55063,7 +55728,8 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" {
|
|
|
55063
55728
|
* Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
|
|
55064
55729
|
* requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
|
|
55065
55730
|
* threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
|
|
55066
|
-
* kept-alive} context of this binding.
|
|
55731
|
+
* kept-alive} context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
|
|
55732
|
+
* contexts of a {@link #getRootBinding root binding} do not count as pending changes.
|
|
55067
55733
|
* See:
|
|
55068
55734
|
* {@link topic:b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
|
|
55069
55735
|
* sap.ui.model.Binding#suspend
|
|
@@ -55942,7 +56608,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
55942
56608
|
*/
|
|
55943
56609
|
synchronizationMode: string;
|
|
55944
56610
|
/**
|
|
55945
|
-
* The group ID that is used for update requests. If no update group ID is specified, `
|
|
56611
|
+
* The group ID that is used for update requests. If no update group ID is specified, `mParameters.groupId`
|
|
55946
56612
|
* is used. Valid update group IDs are `undefined`, '$auto', '$direct' or an application group ID.
|
|
55947
56613
|
*/
|
|
55948
56614
|
updateGroupId?: string;
|
|
@@ -56123,6 +56789,12 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
56123
56789
|
* from its context's path for data service requests; only the value `true` is allowed.
|
|
56124
56790
|
*/
|
|
56125
56791
|
$$canonicalPath?: boolean;
|
|
56792
|
+
/**
|
|
56793
|
+
* Whether this binding is considered for a match when {@link #getKeepAliveContext} is called; only the
|
|
56794
|
+
* value `true` is allowed. Must not be combined with `$apply`, `$$aggregation`, `$$canonicalPath`, or `$$sharedRequest`.
|
|
56795
|
+
* If the binding is relative, `$$ownRequest` must be set as well. Supported since 1.99.0
|
|
56796
|
+
*/
|
|
56797
|
+
$$getKeepAliveContext?: boolean;
|
|
56126
56798
|
/**
|
|
56127
56799
|
* The group ID to be used for **read** requests triggered by this binding; if not specified, either the
|
|
56128
56800
|
* parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link sap.ui.model.odata.v4.ODataModel#constructor}.
|
|
@@ -56380,6 +57052,54 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
56380
57052
|
*/
|
|
56381
57053
|
bIncludeContextId?: boolean
|
|
56382
57054
|
): object;
|
|
57055
|
+
/**
|
|
57056
|
+
* @SINCE 1.99.0
|
|
57057
|
+
*
|
|
57058
|
+
* Returns a context with the given path belonging to a matching list binding that has been marked with
|
|
57059
|
+
* `$$getKeepAliveContext` (see {@link #bindList}). If such a matching binding can be found, a context is
|
|
57060
|
+
* returned and kept alive (see {@link sap.ui.model.odata.v4.ODataListBinding#getKeepAliveContext}). Since
|
|
57061
|
+
* 1.100.0 a temporary binding is used if no such binding could be found. If such a binding is created or
|
|
57062
|
+
* resolved later, the context and its data are transferred to it, and the temporary binding is destroyed
|
|
57063
|
+
* again.
|
|
57064
|
+
*
|
|
57065
|
+
* A `$$getKeepAliveContext` binding matches if its resolved binding path is the collection path of the
|
|
57066
|
+
* context. If the context is created using a temporary binding and the parameters of the `$$getKeepAliveContext`
|
|
57067
|
+
* binding differ from the given `mParameters` (except `$$groupId` which is especially used for the context),
|
|
57068
|
+
* that binding later runs into an error when trying to read data.
|
|
57069
|
+
*
|
|
57070
|
+
* **Note**: The context received by this function may change its {@link sap.ui.model.odata.v4.Context#getBinding
|
|
57071
|
+
* binding} during its lifetime.
|
|
57072
|
+
*/
|
|
57073
|
+
getKeepAliveContext(
|
|
57074
|
+
/**
|
|
57075
|
+
* A list context path to an entity
|
|
57076
|
+
*/
|
|
57077
|
+
sPath: string,
|
|
57078
|
+
/**
|
|
57079
|
+
* Whether to request messages for the context's entity
|
|
57080
|
+
*/
|
|
57081
|
+
bRequestMessages?: boolean,
|
|
57082
|
+
/**
|
|
57083
|
+
* Parameters for the context or the temporary binding; supported since 1.100.0. All custom query options
|
|
57084
|
+
* and the following binding-specific parameters for a list binding may be given (see {@link #bindList}
|
|
57085
|
+
* for details).
|
|
57086
|
+
*/
|
|
57087
|
+
mParameters?: {
|
|
57088
|
+
/**
|
|
57089
|
+
* The group ID used for read requests for the context's entity or its properties. If not given, the model's
|
|
57090
|
+
* {@link #getGroupId group ID} is used
|
|
57091
|
+
*/
|
|
57092
|
+
$$groupId?: string;
|
|
57093
|
+
/**
|
|
57094
|
+
* Whether implicit loading of side effects via PATCH requests is switched off
|
|
57095
|
+
*/
|
|
57096
|
+
$$patchWithoutSideEffects?: boolean;
|
|
57097
|
+
/**
|
|
57098
|
+
* The group ID to be used for **update** requests triggered by the context's binding
|
|
57099
|
+
*/
|
|
57100
|
+
$$updateGroupId?: string;
|
|
57101
|
+
}
|
|
57102
|
+
): Context;
|
|
56383
57103
|
/**
|
|
56384
57104
|
* @SINCE 1.85.0
|
|
56385
57105
|
*
|
|
@@ -56440,7 +57160,8 @@ declare module "sap/ui/model/odata/v4/ODataModel" {
|
|
|
56440
57160
|
* @SINCE 1.39.0
|
|
56441
57161
|
*
|
|
56442
57162
|
* Returns `true` if there are pending changes, meaning updates or created entities (see {@link sap.ui.model.odata.v4.ODataListBinding#create})
|
|
56443
|
-
* that have not yet been successfully sent to the server.
|
|
57163
|
+
* that have not yet been successfully sent to the server. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive
|
|
57164
|
+
* inactive} contexts are ignored.
|
|
56444
57165
|
*/
|
|
56445
57166
|
hasPendingChanges(
|
|
56446
57167
|
/**
|
|
@@ -56665,7 +57386,8 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
|
|
|
56665
57386
|
* Returns `true` if this binding or its dependent bindings have pending property changes or created entities
|
|
56666
57387
|
* which have not been sent successfully to the server. This function does not take into account the deletion
|
|
56667
57388
|
* of entities (see {@link sap.ui.model.odata.v4.Context#delete}) and the execution of OData operations
|
|
56668
|
-
* (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
|
|
57389
|
+
* (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isInactive
|
|
57390
|
+
* inactive} contexts are ignored.
|
|
56669
57391
|
*
|
|
56670
57392
|
* Note: If this binding is relative, its data is cached separately for each parent context path. This method
|
|
56671
57393
|
* returns `true` if there are pending changes for the current parent context path of this binding. If this
|
|
@@ -56674,9 +57396,12 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
|
|
|
56674
57396
|
hasPendingChanges(
|
|
56675
57397
|
/**
|
|
56676
57398
|
* Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
|
|
56677
|
-
* changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#
|
|
56678
|
-
*
|
|
56679
|
-
* sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
|
|
57399
|
+
* changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
|
|
57400
|
+
* refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
|
|
57401
|
+
* suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
|
|
57402
|
+
* of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
|
|
57403
|
+
* contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
|
|
57404
|
+
* the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
|
|
56680
57405
|
*/
|
|
56681
57406
|
bIgnoreKeptAlive?: boolean
|
|
56682
57407
|
): boolean;
|
|
@@ -56698,10 +57423,10 @@ declare module "sap/ui/model/odata/v4/ODataPropertyBinding" {
|
|
|
56698
57423
|
* determines the binding's data; it is **independent** of the order of calls to {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
|
|
56699
57424
|
* with the given group ID.
|
|
56700
57425
|
*
|
|
56701
|
-
* If there are pending changes, an error is thrown. Use {@link #hasPendingChanges}
|
|
56702
|
-
* pending changes. If there are
|
|
56703
|
-
* the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
|
|
56704
|
-
* {@link #refresh}.
|
|
57426
|
+
* If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
|
|
57427
|
+
* to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
|
|
57428
|
+
* to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
|
|
57429
|
+
* calling {@link #refresh}.
|
|
56705
57430
|
*
|
|
56706
57431
|
* Use {@link #requestRefresh} if you want to wait for the refresh.
|
|
56707
57432
|
* See:
|
|
@@ -63637,7 +64362,7 @@ declare module "sap/ui/test/OpaBuilder" {
|
|
|
63637
64362
|
/**
|
|
63638
64363
|
* the type of the target control(s)
|
|
63639
64364
|
*/
|
|
63640
|
-
|
|
64365
|
+
sControlType?: string,
|
|
63641
64366
|
/**
|
|
63642
64367
|
* if true, only popover and dialogs are searched for
|
|
63643
64368
|
*/
|
|
@@ -63893,9 +64618,9 @@ declare module "sap/ui/test/OpaBuilder" {
|
|
|
63893
64618
|
*/
|
|
63894
64619
|
sAggregationName: string,
|
|
63895
64620
|
/**
|
|
63896
|
-
*
|
|
64621
|
+
* length to check against
|
|
63897
64622
|
*/
|
|
63898
|
-
int
|
|
64623
|
+
iNumber: int
|
|
63899
64624
|
): this;
|
|
63900
64625
|
/**
|
|
63901
64626
|
* Adds a matcher to aggregation items checking for certain properties. At least one item must match the
|
|
@@ -63993,7 +64718,7 @@ declare module "sap/ui/test/OpaBuilder" {
|
|
|
63993
64718
|
/**
|
|
63994
64719
|
* the type of the target control(s)
|
|
63995
64720
|
*/
|
|
63996
|
-
|
|
64721
|
+
sControlType: string
|
|
63997
64722
|
): this;
|
|
63998
64723
|
/**
|
|
63999
64724
|
* Defines whether target control is part of a popover or dialog (sets `searchOpenDialogs` property).
|
|
@@ -68681,12 +69406,16 @@ declare namespace sap {
|
|
|
68681
69406
|
|
|
68682
69407
|
"sap/ui/core/format/DateFormat": undefined;
|
|
68683
69408
|
|
|
69409
|
+
"sap/ui/core/format/DateFormatTimezoneDisplay": undefined;
|
|
69410
|
+
|
|
68684
69411
|
"sap/ui/core/format/FileSizeFormat": undefined;
|
|
68685
69412
|
|
|
68686
69413
|
"sap/ui/core/format/ListFormat": undefined;
|
|
68687
69414
|
|
|
68688
69415
|
"sap/ui/core/format/NumberFormat": undefined;
|
|
68689
69416
|
|
|
69417
|
+
"sap/ui/core/format/TimezoneUtil": undefined;
|
|
69418
|
+
|
|
68690
69419
|
"sap/ui/core/Fragment": undefined;
|
|
68691
69420
|
|
|
68692
69421
|
"sap/ui/core/History": undefined;
|
|
@@ -69071,6 +69800,8 @@ declare namespace sap {
|
|
|
69071
69800
|
|
|
69072
69801
|
"sap/ui/model/odata/type/DateTimeOffset": undefined;
|
|
69073
69802
|
|
|
69803
|
+
"sap/ui/model/odata/type/DateTimeWithTimezone": undefined;
|
|
69804
|
+
|
|
69074
69805
|
"sap/ui/model/odata/type/Decimal": undefined;
|
|
69075
69806
|
|
|
69076
69807
|
"sap/ui/model/odata/type/Double": undefined;
|
|
@@ -69201,6 +69932,8 @@ declare namespace sap {
|
|
|
69201
69932
|
|
|
69202
69933
|
"sap/ui/performance/trace/FESR": undefined;
|
|
69203
69934
|
|
|
69935
|
+
"sap/ui/performance/trace/FESRHelper": undefined;
|
|
69936
|
+
|
|
69204
69937
|
"sap/ui/performance/trace/initTraces": undefined;
|
|
69205
69938
|
|
|
69206
69939
|
"sap/ui/performance/trace/Interaction": undefined;
|
|
@@ -69221,6 +69954,10 @@ declare namespace sap {
|
|
|
69221
69954
|
|
|
69222
69955
|
"sap/ui/test/actions/Scroll": undefined;
|
|
69223
69956
|
|
|
69957
|
+
"sap/ui/test/generic/GenericTestCollection": undefined;
|
|
69958
|
+
|
|
69959
|
+
"sap/ui/test/generic/Utils": undefined;
|
|
69960
|
+
|
|
69224
69961
|
"sap/ui/test/gherkin/dataTableUtils": undefined;
|
|
69225
69962
|
|
|
69226
69963
|
"sap/ui/test/gherkin/opa5TestHarness": undefined;
|