@sapui5/ts-types 1.104.2 → 1.106.0

package/types/sap.ui.comp.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.104.0
+// For Library Version: 1.106.0
 
 declare namespace sap {
   namespace ui {
@@ -507,22 +507,16 @@ declare namespace sap {
         }
 
         /**
-         * The control displays filters in a user-friendly manner to populate values for a query. The FilterBar
-         * consists of a row containing the {@link sap.ui.comp.variants.VariantManagement VariantManagement} control,
-         * the related buttons, and an area underneath displaying the filters. The filters are arranged in a logical
-         * row that is divided depending on the space available and the width of the filters. The area containing
-         * the filters can be hidden or shown using the Hide FilterBar / Show FilterBar button. The Go button triggers
-         * the search event, and the Filters button shows the filter dialog.
-         *  In this dialog, the consumer has full control over the FilterBar. The filters in this dialog are displayed
-         * in one column and organized in groups. The filter items of the `filterItems` aggregation are grouped
-         * in the Basic group . Each filter can be marked as visible in the FilterBar by selecting Add to FilterBar.
-         * In addition, the items in the `filterGroupItems` aggregation can be marked as part of the current variant.
-         * The FilterBar also supports a different UI layout when used inside a value help dialog. In this case,
-         * the FilterBar consists of two logical areas, one containing the search field with Go button and one -
-         * the advanced area. The filters are aligned in a grid with labels above each. The number of items per
-         * row depends on the width of the value help dialog. By default, the filter bar will show up to 8 filters.
-         * If there are more than 8 filters, a new button 'Show All Filters' appears in the place of the 8th filter.
-         * Clicking on this button displays all filters.
+         * The `FilterBar` displays filters in a user-friendly manner to populate values for a query. The `FilterBar`
+         * consists of a row containing the {@link sap.ui.comp.variants.VariantManagement `VariantManagement`} control,
+         * the related buttons, and an area underneath displaying the filters.
+         *
+         * The filters are arranged in a logical row that is divided depending on the space available and the width
+         * of the filters. The area containing the filters can be hidden or shown using the **Hide FilterBar** /
+         * **Show FilterBar** button. The **Go** button triggers the search event, and the **Adapt Filters** button
+         * shows the `Adapt Filters Dialog`.
+         *
+         * In this dialog, the user has full control over the `FilterBar`.
          */
         class FilterBar extends sap.ui.layout.Grid {
           /**
@@ -1968,9 +1962,28 @@ declare namespace sap {
           /**
            * Creates and returns the variant representation.
            *
-           * @returns JSON object
+           * @returns An arbitrary Object with an example structure:
+           *
+           * ```javascript
+           * {
+           *   filterBarVariant: any,
+           *   filterbar: [
+           *     {
+           *       group: string,
+           *       name: string,
+           *       partOfCurrentVariant: boolean,
+           *       visible: boolean,
+           *       visibleInFilterBar: boolean
+           *     },
+           *     ...
+           *   ],
+           *   orderedFilterItems: string,
+           *   singleInputsTextArrangementData: string,
+           *   version: string|undefined,
+           *   basicSearch: string|undefined
+           * }```
            */
-          fetchVariant(): object;
+          fetchVariant(): Object;
           /**
            * Fires event {@link #event:afterVariantSave afterVariantSave} to attached listeners.
            *
@@ -2698,13 +2711,24 @@ declare namespace sap {
           retrieveFiltersWithValues(): any[];
           /**
            * Returns a summary string that contains information about the filters currently assigned. The string starts
-           * with "Filtered By", followed by the number of set filters and their labels.
+           * with the number of set filters, followed by "filters active" and their labels.
            *  Example:
-           *  Filtered By (3): Company Code, Fiscal Year, Customer
+           *  (3) filters active: Company Code, Fiscal Year, Customer
            *
            * @returns A string that contains the number of set filters and their names
            */
           retrieveFiltersWithValuesAsText(): string;
+          /**
+           * Returns a summary string that contains information about the filters currently assigned. This string
+           * is intended to be used in expanded state. The string starts with the total number of filters set, followed
+           * by "filters active" and if available non-visible, the number of the non-visible with label "hidden" in
+           * brackets.
+           *  Example:
+           *  (3) filters active (1 hidden)
+           *
+           * @returns A string that contains the number of set filters and their names
+           */
+          retrieveFiltersWithValuesAsTextExpanded(): string;
           /**
            * Executes the search event. Controls of all visible filters will be passed as event-parameters.
            *
@@ -3488,7 +3512,7 @@ declare namespace sap {
           /**
            * Always returns the initially added control.
            */
-          getControl(): void;
+          getControl(): sap.ui.core.Control | null;
           /**
            * @SINCE 1.52.0
            *
@@ -8619,6 +8643,17 @@ declare namespace sap {
             | sap.ui.base.ManagedObject.PropertyBindingInfo
             | `{${string}}`;
 
+          /**
+           * @SINCE 1.106
+           *
+           * Text that is shown for values of an empty string. **Note:** The property does not change the behavior
+           * for charts of type `timeseries`. **Note:** Can only be changed in the XML/JS view. It cannot be changed
+           * once the control has been initialized.
+           */
+          notAssignedText?:
+            | string
+            | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
           /**
            * A custom toolbar that can be specified by the user to define their own buttons, icons, etc. If this is
            * added, the SmartChart control does not create its own toolbar, but uses this one instead. However, if
@@ -10035,6 +10070,20 @@ declare namespace sap {
            * @returns Value of property `noData`
            */
           getNoData(): string;
+          /**
+           * @SINCE 1.106
+           *
+           * Gets current value of property {@link #getNotAssignedText notAssignedText}.
+           *
+           * Text that is shown for values of an empty string. **Note:** The property does not change the behavior
+           * for charts of type `timeseries`. **Note:** Can only be changed in the XML/JS view. It cannot be changed
+           * once the control has been initialized.
+           *
+           * Default value is `empty string`.
+           *
+           * @returns Value of property `notAssignedText`
+           */
+          getNotAssignedText(): string;
           /**
            * Gets current value of property {@link #getPersistencyKey persistencyKey}.
            *
@@ -10715,6 +10764,27 @@ declare namespace sap {
              */
             sNoData?: string
           ): this;
+          /**
+           * @SINCE 1.106
+           *
+           * Sets a new value for property {@link #getNotAssignedText notAssignedText}.
+           *
+           * Text that is shown for values of an empty string. **Note:** The property does not change the behavior
+           * for charts of type `timeseries`. **Note:** Can only be changed in the XML/JS view. It cannot be changed
+           * once the control has been initialized.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `empty string`.
+           *
+           * @returns Reference to `this` in order to allow method chaining
+           */
+          setNotAssignedText(
+            /**
+             * New value for property `notAssignedText`
+             */
+            sNotAssignedText?: string
+          ): this;
           /**
            * Sets a new value for property {@link #getPersistencyKey persistencyKey}.
            *
@@ -11489,15 +11559,16 @@ declare namespace sap {
            * or on the server side - `false`.
            *
            * **Note:** If the {@link sap.ui.comp.smartfield.SmartField#value} property of the `SmartField` control
-           * is bound to an Entity Data Model (EDM) property annotated as `Nullable="false"`, the mandatory validation
-           * is performed on the client side regardless of the `clientSideMandatoryCheck` setting.
+           * is bound to an Entity Data Model (EDM) property of type different from Edm.String annotated as `Nullable="false"`,
+           * the mandatory validation is performed on the client side regardless of the `clientSideMandatoryCheck`
+           * setting.
            *
            * Example:
            *
            *
            * ```javascript
            *
-           *     <Property Name="CategoryID" Type="Edm.String" Nullable="false"/>
+           *     <Property Name="CategoryID" Type="Edm.Decimal" Nullable="false"/>
            * ```
            */
           clientSideMandatoryCheck?:
@@ -13433,15 +13504,16 @@ declare namespace sap {
            * or on the server side - `false`.
            *
            * **Note:** If the {@link sap.ui.comp.smartfield.SmartField#value} property of the `SmartField` control
-           * is bound to an Entity Data Model (EDM) property annotated as `Nullable="false"`, the mandatory validation
-           * is performed on the client side regardless of the `clientSideMandatoryCheck` setting.
+           * is bound to an Entity Data Model (EDM) property of type different from Edm.String annotated as `Nullable="false"`,
+           * the mandatory validation is performed on the client side regardless of the `clientSideMandatoryCheck`
+           * setting.
            *
            * Example:
            *
            *
            * ```javascript
            *
-           *     <Property Name="CategoryID" Type="Edm.String" Nullable="false"/>
+           *     <Property Name="CategoryID" Type="Edm.Decimal" Nullable="false"/>
            * ```
            *
            *
@@ -14153,7 +14225,7 @@ declare namespace sap {
              * The ariaDescribedBy to be removed or its index or ID
              */
             vAriaDescribedBy: int | sap.ui.core.ID | sap.ui.core.Control
-          ): sap.ui.core.ID;
+          ): sap.ui.core.ID | null;
           /**
            * @SINCE 1.34.2
            *
@@ -14166,7 +14238,7 @@ declare namespace sap {
              * The ariaLabelledBy to be removed or its index or ID
              */
             vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
-          ): sap.ui.core.ID;
+          ): sap.ui.core.ID | null;
           /**
            * @SINCE 1.38.3
            *
@@ -14176,15 +14248,16 @@ declare namespace sap {
            * or on the server side - `false`.
            *
            * **Note:** If the {@link sap.ui.comp.smartfield.SmartField#value} property of the `SmartField` control
-           * is bound to an Entity Data Model (EDM) property annotated as `Nullable="false"`, the mandatory validation
-           * is performed on the client side regardless of the `clientSideMandatoryCheck` setting.
+           * is bound to an Entity Data Model (EDM) property of type different from Edm.String annotated as `Nullable="false"`,
+           * the mandatory validation is performed on the client side regardless of the `clientSideMandatoryCheck`
+           * setting.
            *
            * Example:
            *
            *
            * ```javascript
            *
-           *     <Property Name="CategoryID" Type="Edm.String" Nullable="false"/>
+           *     <Property Name="CategoryID" Type="Edm.Decimal" Nullable="false"/>
            * ```
            *
            *
@@ -15226,6 +15299,14 @@ declare namespace sap {
            * a performance issue depending on the number of the smart fields.
            */
           ValueListNoValidation = "ValueListNoValidation",
+          /**
+           * The same behavior as ValueListNoValidation but for values that are considered invalid a warning message
+           * will be created.
+           *
+           * NOTE: In this mode when the value is sent to the backend there might be 2 messages for the same field
+           * from both frontend and backend validation.
+           */
+          ValueListWarning = "ValueListWarning",
         }
 
         type checkValuesValidityInfo = {
@@ -21255,7 +21336,7 @@ declare namespace sap {
              * The ariaLabelledBy to be removed or its index or ID
              */
             vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
-          ): sap.ui.core.ID;
+          ): sap.ui.core.ID | null;
           /**
            * Removes a group from the aggregation {@link #getGroups groups}.
            *
@@ -23754,7 +23835,7 @@ declare namespace sap {
              * The ariaLabelledBy to be removed or its index or ID
              */
             vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
-          ): sap.ui.core.ID;
+          ): sap.ui.core.ID | null;
           /**
            * Sets a new value for property {@link #getChartBindingPath chartBindingPath}.
            *
@@ -24224,7 +24305,7 @@ declare namespace sap {
              * The ariaLabelledBy to be removed or its index or ID
              */
             vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
-          ): sap.ui.core.ID;
+          ): sap.ui.core.ID | null;
           /**
            * Sets a new value for property {@link #getChartBindingPath chartBindingPath}.
            *
@@ -24796,12 +24877,19 @@ declare namespace sap {
            */
           getErroneousFieldsAndTokens(): Promise<any>;
           /**
-           * Collects all instances of {@link sap.ui.comp.smartmultiedit.Field} scattered across the smart form ({@link
-           * sap.ui.comp.smartform.SmartForm}) layout.
+           * Collects all instances of {@link sap.ui.comp.smartmultiedit.Field} and/or {@link sap.ui.core.Control}
+           * scattered across the smart form ({@link sap.ui.comp.smartform.SmartForm}) layout.
            *
-           * @returns An array of {@link sap.ui.comp.smartmultiedit.Field} fields.
+           * @returns An array of {@link sap.ui.comp.smartmultiedit.Field} and/or {@link sap.ui.core.Control}.
            */
-          getFields(): any[];
+          getFields(
+            /**
+             * A boolean indicating whether or not to include {@link sap.ui.core.Control} in resultant array. By default
+             * or if it is set to false, only instances of {@link sap.ui.comp.smartmultiedit.Field} are included in
+             * resultant array.
+             */
+            bFetchAllControls: boolean
+          ): any[];
           /**
            * Gets content of aggregation {@link #getLayout layout}.
            *
@@ -26699,14 +26787,20 @@ declare namespace sap {
            *
            * ```javascript
            *
-           * <!-- Define extra 3rem space to the automatic content width calcuation -->
+           * <!-- Define extra 3rem space to the automatic content width calculation -->
            * <Column customdata:p13nData='\{"autoColumnWidth": \{ "gap": 3 }, "leadingProperty": "PropA", "columnKey": "PropA"}' >
            * ```
            *
            * ```javascript
            *
-           * <!-- Define the visible fields that need to be calculated -->
-           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "visibleField": "PropC" }, "leadingProperty": "PropA", "additionalProperty": "PropB,PropC", "columnKey": "PropA"}' >
+           * <!-- Define the visible properties that should be considered for the calculation. Multiple property names can be specified here as comma-separated values. The first property is the leading property. -->
+           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "visibleProperty": "PropC" }, "leadingProperty": "PropA", "additionalProperty": "PropB,PropC", "columnKey": "PropA"}' >
+           * ```
+           *
+           * ```javascript
+           *
+           * <!-- The calculated column width must not be smaller than the column header -->
+           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "truncateLabel": false }, "leadingProperty": "PropA", "columnKey": "PropA"}' >
            * ```
            *
            *
@@ -28436,6 +28530,16 @@ declare namespace sap {
            * by applications in the {@link #event:beforeRebindTable beforeRebindTable} event.
            */
           getDataStateIndicator(): sap.m.plugins.DataStateIndicator;
+          /**
+           * @SINCE 1.105.0
+           *
+           * Returns the deactivated column keys.
+           *
+           * See {@link sap.ui.comp.smarttable.SmartTable#deactivateColumns}
+           *
+           * @returns array of column keys
+           */
+          getDeactivatedColumns(): string[];
           /**
            * @SINCE 1.30.0
            *
@@ -28554,14 +28658,20 @@ declare namespace sap {
            *
            * ```javascript
            *
-           * <!-- Define extra 3rem space to the automatic content width calcuation -->
+           * <!-- Define extra 3rem space to the automatic content width calculation -->
            * <Column customdata:p13nData='\{"autoColumnWidth": \{ "gap": 3 }, "leadingProperty": "PropA", "columnKey": "PropA"}' >
            * ```
            *
            * ```javascript
            *
-           * <!-- Define the visible fields that need to be calculated -->
-           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "visibleField": "PropC" }, "leadingProperty": "PropA", "additionalProperty": "PropB,PropC", "columnKey": "PropA"}' >
+           * <!-- Define the visible properties that should be considered for the calculation. Multiple property names can be specified here as comma-separated values. The first property is the leading property. -->
+           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "visibleProperty": "PropC" }, "leadingProperty": "PropA", "additionalProperty": "PropB,PropC", "columnKey": "PropA"}' >
+           * ```
+           *
+           * ```javascript
+           *
+           * <!-- The calculated column width must not be smaller than the column header -->
+           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "truncateLabel": false }, "leadingProperty": "PropA", "columnKey": "PropA"}' >
            * ```
            *
            *
@@ -29355,14 +29465,20 @@ declare namespace sap {
            *
            * ```javascript
            *
-           * <!-- Define extra 3rem space to the automatic content width calcuation -->
+           * <!-- Define extra 3rem space to the automatic content width calculation -->
            * <Column customdata:p13nData='\{"autoColumnWidth": \{ "gap": 3 }, "leadingProperty": "PropA", "columnKey": "PropA"}' >
            * ```
            *
            * ```javascript
            *
-           * <!-- Define the visible fields that need to be calculated -->
-           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "visibleField": "PropC" }, "leadingProperty": "PropA", "additionalProperty": "PropB,PropC", "columnKey": "PropA"}' >
+           * <!-- Define the visible properties that should be considered for the calculation. Multiple property names can be specified here as comma-separated values. The first property is the leading property. -->
+           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "visibleProperty": "PropC" }, "leadingProperty": "PropA", "additionalProperty": "PropB,PropC", "columnKey": "PropA"}' >
+           * ```
+           *
+           * ```javascript
+           *
+           * <!-- The calculated column width must not be smaller than the column header -->
+           * <Column customdata:p13nData='\{"autoColumnWidth": \{ "truncateLabel": false }, "leadingProperty": "PropA", "columnKey": "PropA"}' >
            * ```
            *
            *
@@ -34618,7 +34734,7 @@ declare namespace sap {
 
           /**
            * @SINCE 1.22.0
-           * @deprecated (since 1.26.0) - Replaced by association `variantItems`
+           * @deprecated (since 1.26) - replaced by the `variantItems` aggregation
            *
            * Items displayed by the `VariantManagement` control.
            */
@@ -35469,7 +35585,7 @@ declare namespace sap {
           static getMetadata(): sap.ui.core.ElementMetadata;
           /**
            * @SINCE 1.22.0
-           * @deprecated (since 1.26.0) - Replaced by association `variantItems`
+           * @deprecated (since 1.26) - replaced by the `variantItems` aggregation
            *
            * Adds some item to the aggregation {@link #getItems items}.
            *
@@ -35670,7 +35786,7 @@ declare namespace sap {
           ): void;
           /**
            * @SINCE 1.22.0
-           * @deprecated (since 1.26.0) - Replaced by association `variantItems`
+           * @deprecated (since 1.26) - replaced by the `variantItems` aggregation
            *
            * Destroys all the items in the aggregation {@link #getItems items}.
            *
@@ -35885,7 +36001,7 @@ declare namespace sap {
           getInitialSelectionKey(): string;
           /**
            * @SINCE 1.22.0
-           * @deprecated (since 1.26.0) - Replaced by association `variantItems`
+           * @deprecated (since 1.26) - replaced by the `variantItems` aggregation
            *
            * Gets content of aggregation {@link #getItems items}.
            *
@@ -36030,7 +36146,7 @@ declare namespace sap {
           getVariantItems(): sap.ui.comp.variants.VariantItem[];
           /**
            * @SINCE 1.22.0
-           * @deprecated (since 1.26.0) - Replaced by association `variantItems`
+           * @deprecated (since 1.26) - replaced by the `variantItems` aggregation
            *
            * Checks for the provided `sap.ui.core.Item` in the aggregation {@link #getItems items}. and returns its
            * index if found or -1 otherwise.
@@ -36059,7 +36175,7 @@ declare namespace sap {
           ): int;
           /**
            * @SINCE 1.22.0
-           * @deprecated (since 1.26.0) - Replaced by association `variantItems`
+           * @deprecated (since 1.26) - replaced by the `variantItems` aggregation
            *
            * Inserts a item into the aggregation {@link #getItems items}.
            *
@@ -36098,7 +36214,7 @@ declare namespace sap {
           ): this;
           /**
            * @SINCE 1.22.0
-           * @deprecated (since 1.26.0) - Replaced by association `variantItems`
+           * @deprecated (since 1.26) - replaced by the `variantItems` aggregation
            *
            * Removes all the controls from the aggregation {@link #getItems items}.
            *
@@ -36119,7 +36235,7 @@ declare namespace sap {
           removeAllVariantItems(): sap.ui.comp.variants.VariantItem[];
           /**
            * @SINCE 1.22.0
-           * @deprecated (since 1.26.0) - Replaced by association `variantItems`
+           * @deprecated (since 1.26) - replaced by the `variantItems` aggregation
            *
            * Removes a item from the aggregation {@link #getItems items}.
            *
@@ -36159,6 +36275,15 @@ declare namespace sap {
              */
             bFlag: boolean
           ): void;
+          /**
+           * Sets the new selected variant.
+           */
+          setCurrentVariantKey(
+            /**
+             * Key of the variant that should be selected.
+             */
+            sKey: string
+          ): void;
           /**
            * @SINCE 1.22.0
            *