@sapui5/ts-types 1.100.2 → 1.102.0

package/types/sap.fe.macros.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.100.0
+// For Library Version: 1.102.0
 
 declare namespace sap {
   namespace fe {
@@ -15,6 +15,10 @@ declare namespace sap {
            * Reference to the key of another action already displayed in the toolbar to properly place this one
            */
           anchor: string;
+          /**
+           * Enables or disables the action
+           */
+          enabled: boolean;
           /**
            * Unique identifier of the action
            */
@@ -51,6 +55,11 @@ declare namespace sap {
            * The text that will be displayed for this column header
            */
           header: string;
+          /**
+           * Defines the column importance
+           * You can define which columns should be automatically moved to the pop-in area based on their importance
+           */
+          importance: string;
           /**
            * Unique identifier of the column
            */
@@ -90,7 +99,8 @@ declare namespace sap {
         personalization?:
           | boolean
           | string
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Specifies the selection mode
@@ -110,7 +120,8 @@ declare namespace sap {
          */
         formatOptions?:
           | sap.fe.macros.FieldFormatOptions
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * The identifier of the Field control.
@@ -127,7 +138,10 @@ declare namespace sap {
          * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
          * current state.
          */
-        readOnly?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        readOnly?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Option to add semantic objects to a field.
@@ -171,6 +185,11 @@ declare namespace sap {
          * Defines the relative path of the property in the metamodel, based on the current contextPath.
          */
         metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * The title of the form control.
+         */
+        title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
       interface $MacroAPISettings extends sap.ui.core.$ControlSettings {
@@ -190,7 +209,10 @@ declare namespace sap {
         /**
          * An expression that allows you to control the 'busy' state of the table.
          */
-        busy?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        busy?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Defines the path of the context used in the current page or block.
@@ -203,27 +225,35 @@ declare namespace sap {
          */
         enableAutoColumnWidth?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Controls if the export functionality of the table is enabled or not.
          */
-        enableExport?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        enableExport?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Controls whether the table can be opened in fullscreen mode or not.
          */
         enableFullScreen?:
           | boolean
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Controls if the paste functionality of the table is enabled or not.
          */
-        enablePaste?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        enablePaste?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
-         * Id of the FilterBar building block associated with the table.
+         * ID of the FilterBar building block associated with the table.
          */
         filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
@@ -235,13 +265,24 @@ declare namespace sap {
         /**
          * Controls if the header text should be shown or not.
          */
-        headerVisible?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        headerVisible?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * The identifier of the table control.
          */
         id?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * Defines whether to display the search action.
+         */
+        isSearchable?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * Groups menu actions by key.
          */
@@ -274,14 +315,18 @@ declare namespace sap {
         personalization?:
           | boolean
           | string
-          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * An expression that allows you to control the 'read-only' state of the table.
          * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
          * current state.
          */
-        readOnly?: boolean | sap.ui.base.ManagedObject.PropertyBindingInfo;
+        readOnly?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
 
         /**
          * Defines the selection mode to be used by the table.
@@ -290,7 +335,7 @@ declare namespace sap {
         selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
-         * Defines the type of table that will be used by the macro to render the data.
+         * Defines the type of table that will be used by the building block to render the data.
          * Allowed values are `GridTable` and `ResponsiveTable`
          */
         type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
@@ -326,7 +371,8 @@ declare namespace sap {
        * <macro:FlexibleColumnLayoutActions />
        * ```
        */
-      class FlexibleColumnLayoutActions extends sap.fe.macros.MacroMetadata {
+      class FlexibleColumnLayoutActions
+        /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -334,16 +380,7 @@ declare namespace sap {
        *
        * Building block used to create a form element containing a label and a field.
        */
-      class FormElement extends sap.fe.macros.MacroMetadata {
-        constructor();
-      }
-      /**
-       * @SINCE 1.90.0
-       *
-       * Base class for all SAP Fiori elements building blocks. This class is not meant to be used as a stand-alone
-       * class.
-       */
-      class MacroMetadata {
+      class FormElement /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -351,7 +388,7 @@ declare namespace sap {
        *
        * Building block used to create a MicroChart based on the metadata provided by OData V4.
        */
-      class MicroChart extends sap.fe.macros.MacroMetadata {
+      class MicroChart /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -365,7 +402,7 @@ declare namespace sap {
        * <macro:Paginator />
        * ```
        */
-      class Paginator extends sap.fe.macros.MacroMetadata {
+      class Paginator /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -386,7 +423,7 @@ declare namespace sap {
        * />
        * ```
        */
-      class Share extends sap.fe.macros.MacroMetadata {
+      class Share /* was: sap.fe.macros.MacroMetadata */ extends Object {
         constructor();
       }
       /**
@@ -422,6 +459,8 @@ declare namespace sap {
 
         /**
          * Adds a message to the field.
+         *
+         * @returns The id of the message
          */
         addMessage(
           /**
@@ -443,11 +482,13 @@ declare namespace sap {
             /**
              * Type of the message
              */
-            type?: /* was: sap.ui.core.library.MessageType */ any;
+            type?: sap.ui.core.MessageType;
           }
         ): string;
         /**
          * Retrieves the current value of the Field.
+         *
+         * @returns The current value of the field
          */
         getValue(): string | boolean;
         /**
@@ -476,11 +517,11 @@ declare namespace sap {
         constructor();
 
         /**
-         * @EXPERIMENTAL
-         *
          * Set the filter values for the given property in the filter bar.
          * The filter values can be either a single value or an array of values.
-         * Each filter value must be represented as a string corresponding to the given operator.
+         * Each filter value must be represented as a primitive value.
+         *
+         * @returns A promise for asynchronous handling
          */
         setFilterValues(
           /**
@@ -490,23 +531,31 @@ declare namespace sap {
           /**
            * The operator to be used (optional) - if not set, the default operator (EQ) will be used
            */
-          sOperator: any,
+          sOperator: undefined | string,
           /**
            * The values to be applied
            */
-          vValues: any
-        ): any;
+          vValues:
+            | undefined
+            | string
+            | number
+            | boolean
+            | string[]
+            | number[]
+            | boolean[]
+        ): void;
       }
       /**
        * Building block for creating a Form based on the metadata provided by OData V4.
        *
        *
-       * Usually, a ReferenceFacet or CollectionFacet is expected
+       * It is designed to work based on a FieldGroup annotation but can also work if you provide a ReferenceFacet
+       * or a CollectionFacet
        * Usage example:
        *
        * ```javascript
        *
-       * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.Facets/0" />
+       * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
        * ```
        */
       class Form extends sap.fe.macros.MacroAPI {
@@ -537,6 +586,9 @@ declare namespace sap {
         /**
          * Adds a message to the table.
          * The message applies to the whole table and not to an individual table row.
+         *
+         *
+         * @returns The ID of the message
          */
         addMessage(
           /**
@@ -558,11 +610,13 @@ declare namespace sap {
             /**
              * Message type
              */
-            type?: /* was: sap.ui.core.library.MessageType */ any;
+            type?: sap.ui.core.MessageType;
           }
         ): string;
         /**
          * Gets contexts from the table that have been selected by the user.
+         *
+         * @returns Contexts of the rows selected by the user
          */
         getSelectedContexts(): sap.ui.model.odata.v4.Context[];
         /**
@@ -663,8 +717,6 @@ declare namespace sap {
 
     "sap/fe/macros/MacroAPI": undefined;
 
-    "sap/fe/macros/MacroMetadata": undefined;
-
     "sap/fe/macros/MicroChart.metadata": undefined;
 
     "sap/fe/macros/Paginator.metadata": undefined;