@sapui5/ts-types 1.113.0 → 1.115.0

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

@@ -14,6 +14,30 @@ declare namespace sap {
        * can override to allow more flexibility.
        */
       namespace controllerextensions {
+        namespace ViewState {
+          /**
+           * Definition of a custom action to be used inside the table toolbar
+           */
+          type NavigationParameter = {
+            /**
+             *  The actual navigation type.
+             */
+            navigationType: string;
+            /**
+             * Defines whether the standard variant must be used in variant management
+             */
+            requiresStandardVariant: boolean;
+            /**
+             * The selectionVariant from the navigation.
+             */
+            selectionVariant: object;
+            /**
+             * The selectionVariant defaults from the navigation
+             */
+            selectionVariantDefaults: object;
+          };
+        }
+
         /**
          * @SINCE 1.90.0
          *
@@ -33,7 +57,7 @@ declare namespace sap {
             /**
              * Context of the document
              */
-            oContext: object
+            oContext: sap.ui.model.odata.v4.Context
           ): Promise<void>;
           /**
            * @SINCE 1.90.0
@@ -54,7 +78,7 @@ declare namespace sap {
               /**
                * This is the control used to open the discard popover
                */
-              control: object;
+              control?: object;
               /**
                * Optional, supresses the discard popover and allows custom handling
                */
@@ -443,7 +467,7 @@ declare namespace sap {
              * Identifier to locate the outbound definition in the manifest.
              * This provides the semantic object and action for the intent-based navigation.
              * Additionally, the outbound definition can be used to provide parameters for intent-based navigation.
-             * See {@link topic:be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries}
+             * See {@link https://ui5.sap.com/#/topic/be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries }
              * for more information.
              */
             sOutbound: string,
@@ -584,7 +608,11 @@ declare namespace sap {
            * @SINCE 1.86.0
            *
            * This function can be used to intercept the routing event happening during the normal process of navigating
-           * from one page to another.
+           * from one page to another (like clicking on the table row to navigate, or when pagination buttons are
+           * clicked).
+           * The function is NOT called during other means of external outbound navigation (like a navigation configured
+           * via a link, or by using navigation buttons).
+           *
            * If declared as an extension, it allows you to intercept and change the normal navigation flow.
            * If you decide to do your own navigation processing, you can return `true` to prevent the default routing
            * behavior.
@@ -851,7 +879,7 @@ declare namespace sap {
             /**
              * The current navigation parameter
              */
-            oNavParameter: /* was: sap.fe.core.NavigationParameter */ any
+            oNavParameter: sap.fe.core.controllerextensions.ViewState.NavigationParameter
           ): Promise<any>;
           /**
            * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
@@ -877,7 +905,11 @@ declare namespace sap {
             /**
              * Extensible array of promises to be resolved before continuing
              */
-            aPromises: Promise<any>
+            aPromises: Promise<any>,
+            /**
+             * Navigation type responsible for the applying the state
+             */
+            navigationType?: string
           ): void;
           /**
            * Called when the application is restored due to keep-alive mode.
@@ -910,28 +942,6 @@ declare namespace sap {
            */
           retrieveViewState(): Promise<any>;
         }
-
-        /**
-         * Definition of a custom action to be used inside the table toolbar
-         */
-        type NavigationParameter = {
-          /**
-           *  The actual navigation type.
-           */
-          navigationType: string;
-          /**
-           * Defines whether the standard variant must be used in variant management
-           */
-          requiresStandardVariant: boolean;
-          /**
-           * The selectionVariant from the navigation.
-           */
-          selectionVariant: object;
-          /**
-           * The selectionVariant defaults from the navigation
-           */
-          selectionVariantDefaults: object;
-        };
       }
       /**
        * Collection of classes provided by SAP Fiori elements for the Flexible Programming Model
@@ -979,7 +989,8 @@ declare namespace sap {
          * and
          * you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
          */
-        class Fcl /* was: sap.fe.core.RootViewBaseController */ extends Object {
+        class Fcl
+          /* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
           constructor();
 
           /**
@@ -988,49 +999,6 @@ declare namespace sap {
            * @returns A promise that creates a Page to display the error
            */
           displayErrorPage(): Promise<boolean>;
-          /**
-           * @SINCE 1.91.0
-           *
-           * Returns the current app component.
-           *
-           * @returns The app component or, if not found, null
-           */
-          getAppComponent(): sap.fe.core.AppComponent;
-          /**
-           * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
-           * name into each controller.
-           *
-           * @returns The model instance
-           */
-          getModel(
-            /**
-             * The model name
-             */
-            sName?: string
-          ): sap.ui.model.Model;
-          /**
-           * Convenience method for getting the resource bundle.
-           *
-           * @returns The resourceModel of the component
-           */
-          getResourceBundle():
-            | Promise</* was: sap.base.i18n.ResourceBundle */ any>
-            | /* was: sap.base.i18n.ResourceBundle */ any;
-          /**
-           * Convenience method for setting the view model in every controller of the application.
-           *
-           * @returns The view instance
-           */
-          setModel(
-            /**
-             * The model instance
-             */
-            oModel: sap.ui.model.Model,
-            /**
-             * The model name
-             */
-            sName: string
-          ): sap.ui.core.mvc.View;
         }
         /**
          * @SINCE 1.108.0
@@ -1041,7 +1009,7 @@ declare namespace sap {
          * you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
          */
         class NavContainer
-          /* was: sap.fe.core.RootViewBaseController */ extends Object {
+          /* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
           constructor();
 
           /**
@@ -1050,49 +1018,6 @@ declare namespace sap {
            * @returns A promise that creates a Page to display the error
            */
           displayErrorPage(): Promise<boolean>;
-          /**
-           * @SINCE 1.91.0
-           *
-           * Returns the current app component.
-           *
-           * @returns The app component or, if not found, null
-           */
-          getAppComponent(): sap.fe.core.AppComponent;
-          /**
-           * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
-           * name into each controller.
-           *
-           * @returns The model instance
-           */
-          getModel(
-            /**
-             * The model name
-             */
-            sName?: string
-          ): sap.ui.model.Model;
-          /**
-           * Convenience method for getting the resource bundle.
-           *
-           * @returns The resourceModel of the component
-           */
-          getResourceBundle():
-            | Promise</* was: sap.base.i18n.ResourceBundle */ any>
-            | /* was: sap.base.i18n.ResourceBundle */ any;
-          /**
-           * Convenience method for setting the view model in every controller of the application.
-           *
-           * @returns The view instance
-           */
-          setModel(
-            /**
-             * The model instance
-             */
-            oModel: sap.ui.model.Model,
-            /**
-             * The model name
-             */
-            sName: string
-          ): sap.ui.core.mvc.View;
         }
       }
 
@@ -1170,7 +1095,7 @@ declare namespace sap {
            * The model name
            */
           sName?: string
-        ): sap.ui.model.Model;
+        ): sap.ui.model.Model | undefined;
         /**
          * Convenience method for setting the view model in every controller of the application.
          *
@@ -1212,13 +1137,13 @@ declare namespace sap {
          *
          * @returns The editFlow controller extension
          */
-        getEditFlow(): /* was: sap.fe.core.EditFlow */ any;
+        getEditFlow(): sap.fe.core.controllerextensions.EditFlow;
         /**
          * Retrieves the intentBasedNavigation controller extension for this page.
          *
          * @returns The intentBasedNavigation controller extension
          */
-        getIntentBasedNavigation(): /* was: sap.fe.core.IntentBasedNavigation */ any;
+        getIntentBasedNavigation(): sap.fe.core.controllerextensions.IntentBasedNavigation;
         /**
          * Get access to models managed by SAP Fiori elements.
          *
@@ -1251,7 +1176,7 @@ declare namespace sap {
          *
          * @returns The routing controller extension
          */
-        getRouting(): /* was: sap.fe.core.Routing */ any;
+        getRouting(): sap.fe.core.controllerextensions.Routing;
         /**
          * Load a fragment and go through the template preprocessor with the current page context.
          *
@@ -1324,47 +1249,12 @@ declare namespace sap {
       class PageController extends sap.fe.core.BaseController {
         constructor();
 
-        /**
-         * @SINCE 1.91.0
-         *
-         * Returns the current app component.
-         *
-         * @returns The app component or, if not found, null
-         */
-        getAppComponent(): sap.fe.core.AppComponent;
         /**
          * Get the extension API for the current page.
          *
          * @returns The extension API.
          */
         getExtensionAPI(): sap.fe.core.ExtensionAPI;
-        /**
-         * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
-         * name into each controller.
-         *
-         * @returns The model instance
-         */
-        getModel(
-          /**
-           * The model name
-           */
-          sName?: string
-        ): sap.ui.model.Model;
-        /**
-         * Convenience method for setting the view model in every controller of the application.
-         *
-         * @returns The view instance
-         */
-        setModel(
-          /**
-           * The model instance
-           */
-          oModel: sap.ui.model.Model,
-          /**
-           * The model name
-           */
-          sName: string
-        ): sap.ui.core.mvc.View;
       }
       /**
        * @SINCE 1.86.0

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

@@ -162,7 +162,7 @@ declare namespace sap {
           /**
            * Aligns the header as well as the content horizontally
            */
-          horizontalAlign: /* was: sap.fe.core.HorizontalAlign */ any;
+          horizontalAlign: /* was: sap.fe.core.converters.ManifestSettings.HorizontalAlign */ any;
           /**
            * Defines the column importance.
            * You can define which columns should be automatically moved to the pop-in area based on their importance
@@ -233,7 +233,25 @@ declare namespace sap {
         metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
-         * Parameter which sets the personalization of the MDC_Chart
+         * Controls which options should be enabled for the chart personalization dialog.
+         * If it is set to `true`, all possible options for this kind of chart are enabled.
+         *
+         * If it is set to `false`, personalization is disabled.
+         *
+         *
+         *
+         * You can also provide a more granular control for the personalization by providing a comma-separated list
+         * with the options you want to be available.
+         *
+         * Available options are:
+         *
+         *  - Sort
+         *
+         *  - Type
+         *
+         *  - Item
+         *
+         *  - Filter
          */
         personalization?:
           | boolean
@@ -242,12 +260,19 @@ declare namespace sap {
           | `{${string}}`;
 
         /**
-         * Specifies the selection mode
+         * Defines the selection mode to be used by the chart.
+         * Allowed values are `None`, `Single` or `Multiple`
          */
         selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
         /**
-         * This is the parameter that specifies variant management for chart
+         * Controls the kind of variant management that should be enabled for the chart.
+         * Allowed value is `Control`.
+         *
+         * If set with value `Control`, a variant management control is seen within the chart and the chart is linked
+         * to this.
+         *
+         * If not set with any value, variant management control is not available for this chart.
          */
         variantManagement?:
           | string
@@ -256,7 +281,11 @@ declare namespace sap {
         /**
          * Aggregate actions of the chart.
          */
-        actions?: sap.fe.macros.chart.Action;
+        actions?:
+          | sap.fe.macros.chart.Action[]
+          | sap.fe.macros.chart.Action
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
       }
 
       interface $FieldSettings extends sap.fe.macros.$MacroAPISettings {
@@ -494,6 +523,15 @@ declare namespace sap {
          */
         filterBar?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
+         * This property is not relevant for Responsive tables
+         */
+        frozenColumnCount?:
+          | number
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * Specifies the header text that is shown in the table.
          */
@@ -567,7 +605,8 @@ declare namespace sap {
 
         /**
          * Defines the selection mode to be used by the table.
-         * Allowed values are `None`, `Single`, `Multi` or `Auto`
+         * Allowed values are `None`, `Single`, `Multi` or `Auto`. If not set to 'None', SAP Fiori elements hooks
+         * into the standard lifecycle to determine the consistent selection mode.
          */
         selectionMode?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
@@ -593,18 +632,44 @@ declare namespace sap {
         /**
          * Aggregate actions of the table.
          */
-        actions?: sap.fe.macros.table.Action;
+        actions?:
+          | sap.fe.macros.table.Action[]
+          | sap.fe.macros.table.Action
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
 
         /**
          * Aggregate columns of the table.
          */
-        columns?: sap.fe.macros.table.Column;
+        columns?:
+          | sap.fe.macros.table.Column[]
+          | sap.fe.macros.table.Column
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
       }
 
+      interface $ChartSelectionChangeEventParameters {}
+
+      interface $FieldChangeEventParameters {}
+
+      interface $FilterBarAfterClearEventParameters {}
+
+      interface $FilterBarFilterChangedEventParameters {}
+
+      interface $FilterBarSearchEventParameters {}
+
+      interface $TableRowPressEventParameters {}
+
+      interface $TableSelectionChangeEventParameters {}
+
       /**
        * Base API control for building blocks.
        */
-      class MacroAPI extends sap.ui.core.Control {
+      class MacroAPI
+        extends sap.ui.core.Control
+        implements sap.ui.core.IFormContent {
+        __implements__sap_ui_core_IFormContent: boolean;
+
         constructor();
       }
       /**
@@ -738,6 +803,12 @@ declare namespace sap {
            */
           vValues?: boolean | boolean[] | number | number[] | string | string[]
         ): Promise<void>;
+        /**
+         * Triggers the API search on the filter bar.
+         *
+         * @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
+         */
+        triggerSearch(): Promise<any>;
       }
       /**
        * Building block for creating a Form based on the metadata provided by OData V4.