@sapui5/ts-types-esm 1.136.2 → 1.138.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare module "sap/fe/macros/Chart" {
   import {
@@ -327,7 +327,7 @@ declare module "sap/fe/macros/CollectionBindingInfo" {
   import Sorter from "sap/ui/model/Sorter";
 
   /**
-   * API to add parameters to the collection binding infos.
+   * API to add parameters to the collection binding info.
    */
   export default class CollectionBindingInfo {
     /**
@@ -357,6 +357,27 @@ declare module "sap/fe/macros/CollectionBindingInfo" {
        */
       sorter: Sorter
     ): void;
+    /**
+     * Attach the events to the table binding.
+     */
+    attachEvent(
+      /**
+       * The event ID to attach the callback to
+       */
+      eventId: string,
+      /**
+       * The callback function to be executed when the event is triggered
+       */
+      callback: Function,
+      /**
+       * The listener object that will be used as the context for the callback function
+       */
+      listener?: object,
+      /**
+       * Data that will be passed to the callback function when the event is triggered
+       */
+      data?: object
+    ): void;
     /**
      * Retrieve the 'serialized' binding info, useful if you want to create your own binding
      *
@@ -556,6 +577,58 @@ declare module "sap/fe/macros/Field" {
   >;
 }
 
+declare module "sap/fe/macros/FormElement" {
+  import {
+    default as FormElement1,
+    $FormElementSettings as $FormElementSettings1,
+  } from "sap/ui/layout/form/FormElement";
+
+  import {
+    PropertyBindingInfo,
+    AggregationBindingInfo,
+  } from "sap/ui/base/ManagedObject";
+
+  import Control from "sap/ui/core/Control";
+
+  /**
+   * Building block used to create a form element based on the metadata provided by OData V4.
+   *
+   * @since 1.90.0
+   */
+  export default class FormElement extends FormElement1 {}
+  /**
+   * Describes the settings that can be provided to the FormElement constructor.
+   */
+  export interface $FormElementSettings extends $FormElementSettings1 {
+    /**
+     * Defines the path of the context used in the current page or block.
+     * This setting is defined by the framework.
+     */
+    contextPath?: string | PropertyBindingInfo;
+
+    /**
+     * Label shown for the field. If not set, the label from the annotations will be shown.
+     */
+    label?: string | PropertyBindingInfo;
+
+    /**
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
+     */
+    metaPath?: string | PropertyBindingInfo;
+
+    /**
+     * If set to false, the FormElement is not rendered.
+     */
+    visible?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Optional aggregation of controls that should be displayed inside the FormElement.
+     * If not set, a default Field building block will be rendered
+     */
+    fields?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
+  }
+}
+
 declare module "sap/fe/macros/KPITag" {
   import {
     default as BuildingBlock,
@@ -878,7 +951,7 @@ declare module "sap/fe/macros/MultiValueField" {
     contextPath?: string | PropertyBindingInfo;
 
     /**
-     * Property added to be able to add data / items to the multi value field via a different model
+     * Property added to be able to add data / items to the multi-input field using a different model
      */
     items?: any | PropertyBindingInfo | `{${string}}`;
 
@@ -2042,6 +2115,9 @@ declare module "sap/fe/macros/filterBar/FilterBar" {
     getFilters(): object;
     /**
      * Get the selection variant from the filter bar.
+     * Note: This method returns all the filter values that are set in the filter bar, including the text from
+     * the search field (with $search as the property name). However, it doesn't return any filter field condition
+     * that uses a custom operator.
      *
      *
      * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
@@ -2119,6 +2195,8 @@ declare module "sap/fe/macros/filterBar/FilterBar" {
     /**
      * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
      * existing filters and then apply the SelectionVariant values.
+     * Note: This method cannot set the search field text or any filter field condition that relies on a custom
+     * operator.
      *
      *
      * @returns A promise for asynchronous handling
@@ -2310,6 +2388,9 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
     getFilters(): object;
     /**
      * Get the selection variant from the filter bar.
+     * Note: This method returns all the filter values that are set in the filter bar, including the text from
+     * the search field (with $search as the property name). However, it doesn't return any filter field condition
+     * that uses a custom operator.
      *
      *
      * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
@@ -2387,6 +2468,8 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
     /**
      * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
      * existing filters and then apply the SelectionVariant values.
+     * Note: This method cannot set the search field text or any filter field condition that relies on a custom
+     * operator.
      *
      *
      * @returns A promise for asynchronous handling
@@ -2601,67 +2684,6 @@ declare module "sap/fe/macros/form/Form.block" {
   }
 }
 
-declare module "sap/fe/macros/form/FormElement.block" {
-  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
-
-  import Context from "sap/ui/model/Context";
-
-  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
-
-  import Event from "sap/ui/base/Event";
-
-  /**
-   * Building block used to create a form element based on the metadata provided by OData V4.
-   *
-   * @since 1.90.0
-   */
-  export default class FormElement extends Control {}
-  /**
-   * Describes the settings that can be provided to the FormElement constructor.
-   */
-  export interface $FormElementSettings extends $ControlSettings {
-    /**
-     * Defines the path of the context used in the current page or block.
-     * This setting is defined by the framework.
-     */
-    contextPath?: Context | PropertyBindingInfo | `{${string}}`;
-
-    /**
-     * Label shown for the field. If not set, the label from the annotations will be shown.
-     */
-    label?: string | PropertyBindingInfo;
-
-    /**
-     * Defines the relative path of the property in the metamodel, based on the current contextPath.
-     */
-    metaPath?: Context | PropertyBindingInfo | `{${string}}`;
-
-    /**
-     * If set to false, the FormElement is not rendered.
-     */
-    visible?: boolean | PropertyBindingInfo | `{${string}}`;
-
-    /**
-     * Optional aggregation of controls that should be displayed inside the FormElement.
-     * If not set, a default Field building block will be rendered
-     */
-    fields?: Control;
-  }
-
-  /**
-   * Parameters of the FormElement#change event.
-   */
-  export interface FormElement$ChangeEventParameters {}
-
-  /**
-   * Event object of the FormElement#change event.
-   */
-  export type FormElement$ChangeEvent = Event<
-    FormElement$ChangeEventParameters,
-    FormElement
-  >;
-}
-
 declare module "sap/fe/macros/microchart/MicroChart" {
   import {
     default as MicroChart1,
@@ -2924,6 +2946,11 @@ declare module "sap/fe/macros/table/Action" {
      */
     enableOnSelect?: string | PropertyBindingInfo;
 
+    /**
+     * Displays the AI Icon on the action button.
+     */
+    isAIOperation?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Unique identifier of the action
      */
@@ -3126,6 +3153,11 @@ declare module "sap/fe/macros/table/ActionOverride" {
      */
     enableOnSelect?: string | PropertyBindingInfo;
 
+    /**
+     * Displays the AI Icon on the action button.
+     */
+    isAIOperation?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Unique identifier of the action to overridden.
      */
@@ -3198,6 +3230,12 @@ declare module "sap/fe/macros/table/Column" {
      */
     anchor?: string | PropertyBindingInfo;
 
+    /**
+     * The column availability
+     * Allowed values are `Default`, `Adaptation`, `Hidden`
+     */
+    availability?: string | PropertyBindingInfo;
+
     /**
      * The text that will be displayed for this column header
      */
@@ -3231,6 +3269,16 @@ declare module "sap/fe/macros/table/Column" {
      */
     properties?: string[] | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Determines if the information in the column is required.
+     */
+    required?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Determines the text displayed for the column tooltip
+     */
+    tooltip?: string | PropertyBindingInfo;
+
     /**
      * Determines the column's width.
      * Allowed values are 'auto', 'value', and 'inherit', according to {@link sap.ui.core.CSSSize }
@@ -3312,6 +3360,12 @@ declare module "sap/fe/macros/table/ColumnOverride" {
    */
   export interface $ColumnOverrideSettings
     extends $BuildingBlockObjectPropertySettings {
+    /**
+     * The column availability
+     * Allowed values are `Default`, `Adaptation`, `Hidden``
+     */
+    availability?: string | PropertyBindingInfo;
+
     /**
      * Aligns the header as well as the content horizontally
      */
@@ -3476,7 +3530,7 @@ declare module "sap/fe/macros/table/Table.block" {
    * <macros:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
    * ```
    *
-   * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table Overview of Table Building Blocks}
+   * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/tableDefault Overview of Table Building Blocks}
    */
   export default class Table extends MacroAPI {
     /**
@@ -3510,6 +3564,13 @@ declare module "sap/fe/macros/table/Table.block" {
         type?: /* was: sap.ui.core.message.MessageType */ any;
       }
     ): Promise<string>;
+    /**
+     * Get the count of the row binding of the table.
+     *
+     *
+     * @returns The count of the row binding
+     */
+    getCount(): number | undefined;
     /**
      * Get the variant management applied to the table.
      *
@@ -3666,6 +3727,12 @@ declare module "sap/fe/macros/table/Table.block" {
      */
     creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Determines whether the number of fixed columns can be configured in the Column Settings dialog.
+     * This property doesn't apply for responsive tables
+     */
+    disableColumnFreeze?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Controls if the copy functionality of the table is disabled or not.
      */
@@ -3835,6 +3902,11 @@ declare module "sap/fe/macros/table/Table.block" {
      */
     selectionMode?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the number of records to be initially requested from the back end.
+     */
+    threshold?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the type of table that will be used by the building block to render the data.
      * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
@@ -4066,6 +4138,13 @@ declare module "sap/fe/macros/table/Table" {
         type?: /* was: sap.ui.core.message.MessageType */ any;
       }
     ): Promise<string>;
+    /**
+     * Get the count of the row binding of the table.
+     *
+     *
+     * @returns The count of the row binding
+     */
+    getCount(): number | undefined;
     /**
      * Get the variant management applied to the table.
      *
@@ -4275,6 +4354,12 @@ declare module "sap/fe/macros/table/Table" {
      */
     creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Determines whether the number of fixed columns can be configured in the Column Settings dialog.
+     * This property doesn't apply for responsive tables
+     */
+    disableColumnFreeze?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Controls if the copy functionality of the table is disabled or not.
      */
@@ -4444,6 +4529,11 @@ declare module "sap/fe/macros/table/Table" {
      */
     selectionMode?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the number of records to be initially requested from the back end.
+     */
+    threshold?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the type of table that will be used by the building block to render the data.
      * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
@@ -4693,6 +4783,13 @@ declare module "sap/fe/macros/table/TreeTable.block" {
         type?: /* was: sap.ui.core.message.MessageType */ any;
       }
     ): Promise<string>;
+    /**
+     * Get the count of the row binding of the table.
+     *
+     *
+     * @returns The count of the row binding
+     */
+    getCount(): number | undefined;
     /**
      * Get the variant management applied to the table.
      *
@@ -4852,6 +4949,12 @@ declare module "sap/fe/macros/table/TreeTable.block" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * Determines whether the number of fixed columns can be configured in the Column Settings dialog.
+     * This property doesn't apply for responsive tables
+     */
+    disableColumnFreeze?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Controls if the copy functionality of the table is disabled or not.
      */
@@ -5046,6 +5149,11 @@ declare module "sap/fe/macros/table/TreeTable.block" {
      */
     selectionMode?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the number of records to be initially requested from the back end.
+     */
+    threshold?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the type of table that will be used by the building block to render the data. This setting is
      * defined by the framework.
@@ -5281,6 +5389,13 @@ declare module "sap/fe/macros/table/TreeTable" {
         type?: /* was: sap.ui.core.message.MessageType */ any;
       }
     ): Promise<string>;
+    /**
+     * Get the count of the row binding of the table.
+     *
+     *
+     * @returns The count of the row binding
+     */
+    getCount(): number | undefined;
     /**
      * Get the variant management applied to the table.
      *
@@ -5494,6 +5609,12 @@ declare module "sap/fe/macros/table/TreeTable" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * Determines whether the number of fixed columns can be configured in the Column Settings dialog.
+     * This property doesn't apply for responsive tables
+     */
+    disableColumnFreeze?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Controls if the copy functionality of the table is disabled or not.
      */
@@ -5688,6 +5809,11 @@ declare module "sap/fe/macros/table/TreeTable" {
      */
     selectionMode?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the number of records to be initially requested from the back end.
+     */
+    threshold?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the type of table that will be used by the building block to render the data. This setting is
      * defined by the framework.
@@ -5998,7 +6124,7 @@ declare namespace sap {
 
     "sap/fe/macros/form/Form.block": undefined;
 
-    "sap/fe/macros/form/FormElement.block": undefined;
+    "sap/fe/macros/FormElement": undefined;
 
     "sap/fe/macros/KPITag": undefined;
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare module "sap/fe/navigation/library" {
   /**

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare namespace sap {}

package/types/sap.fe.plugins.managecache.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare module "sap/fe/plugins/managecache/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare module "sap/fe/templates/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare module "sap/fe/test/library" {}
 
@@ -1079,6 +1079,7 @@ declare module "sap/fe/test/api/FilterBarAssertions" {
     iCheckFilterAdaptation(): object;
     /**
      * Checks a filter field. If `vConditionValues` is `undefined`, the current condition values are ignored.
+     * Only the value of the field itself is considered, i.e. text arrangements are not part of the check.
      *
      *
      * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
@@ -3356,7 +3357,7 @@ declare module "sap/fe/test/JourneyRunner" {
        * ```javascript
        * .run(mSettings, Journey1, Journey2, ...)```
        */
-      _vJourneys: Array<() => void> | string[]
+      _vJourneys: Array<Function> | string[]
     ): object;
     /**
      * Executes the journeys in the given order.
@@ -3374,7 +3375,7 @@ declare module "sap/fe/test/JourneyRunner" {
        * ```javascript
        * .run(mSettings, Journey1, Journey2, ...)```
        */
-      _vJourneys: Array<() => void> | string[]
+      _vJourneys: Array<Function> | string[]
     ): object;
   }
 }

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare namespace sap {}

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.136.0
+// For Library Version: 1.138.0
 
 declare namespace sap {}

package/types/sap.gantt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare module "sap/gantt/library" {
   import ChartScheme from "sap/gantt/config/ChartScheme";

package/types/sap.insights.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.1
+// For Library Version: 1.138.0
 
 declare module "sap/insights/library" {}