@sapui5/ts-types 1.98.0 → 1.99.0

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   /**
@@ -1335,6 +1335,158 @@ declare namespace sap {
       }
     }
 
+    namespace FlexibleColumnLayoutSemanticHelper {
+      /**
+       * The configuration of the navigation actions in the columns.
+       */
+      type ColumnsNavigationActions = {
+        /**
+         * Configuration of the navigation actions of the mid column.
+         */
+        midColumn?: sap.f.FlexibleColumnLayoutSemanticHelper.NavigationActionsTargets;
+        /**
+         * Configuration of the navigation actions of the end column.
+         */
+        endColumn?: sap.f.FlexibleColumnLayoutSemanticHelper.NavigationActionsTargets;
+      };
+
+      /**
+       * Represents the relative percentage sizes of all columns as integers.
+       */
+      type ColumnsSizes = {
+        /**
+         * The relative percentage width of the begin column as integer.
+         */
+        beginColumn?: number;
+        /**
+         * The relative percentage width of the mid column as integer.
+         */
+        midColumn?: number;
+        /**
+         * The relative percentage width of the end column as integer.
+         */
+        endColumn?: number;
+      };
+
+      /**
+       * Represents the visibility of the columns.
+       */
+      type ColumnsVisibility = {
+        /**
+         * The visibility of the begin column.
+         */
+        beginColumn?: boolean;
+        /**
+         * The visibility of the mid column.
+         */
+        midColumn?: boolean;
+        /**
+         * The visibility of the end column.
+         */
+        endColumn?: boolean;
+      };
+
+      /**
+       * Configures the target layouts of the navigation acion buttons in a column.
+       */
+      type NavigationActionsTargets = {
+        /**
+         * The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `fullscreen` navigation action
+         * button is pressed. If null, then the respective action button should not be shown.
+         */
+        fullScreen?: string | null;
+        /**
+         * The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `exitFullScreen` navigation action
+         * button is pressed. If null, then the respective action button should not be shown.
+         */
+        exitFullScreen?: string | null;
+        /**
+         * The target {@link sap.f.FlexibleColumnLayout#getLayout layout} when the `closeColumn` navigation action
+         * button is pressed. If null, then the respective action button should not be shown.
+         */
+        closeColumn?: string | null;
+      };
+
+      /**
+       * Configuration of the state of the `FlexibleColumnLayout` control and the expected action buttons for
+       * each column.
+       *
+       * Example value:
+       *
+       *
+       * ```javascript
+       *
+       *
+       *  {
+       * 	   "layout":"ThreeColumnsMidExpanded",
+       * 	   "maxColumnsCount":3,
+       * 	   "columnsSizes":{
+       * 		  "beginColumn":25,
+       * 		  "midColumn":50,
+       * 		  "endColumn":25
+       * 	   },
+       * 	   "columnsVisibility":{
+       * 		  "beginColumn":true,
+       * 		  "midColumn":true,
+       * 		  "endColumn":true
+       * 	   },
+       * 	   "isFullScreen":false,
+       * 	   "isLogicallyFullScreen":false,
+       * 	   "actionButtonsInfo":{
+       * 		  "midColumn":{
+       * 			 "fullScreen":null,
+       * 			 "exitFullScreen":null,
+       * 			 "closeColumn":null
+       * 		  },
+       * 		  "endColumn":{
+       * 			 "fullScreen":"EndColumnFullScreen",
+       * 			 "exitFullScreen":null,
+       * 			 "closeColumn":"TwoColumnsBeginExpanded"
+       * 		  }
+       * 	   }
+       * 	}
+       *
+       *  ```
+       */
+      type UIState = {
+        /**
+         * The value of the {@link sap.f.FlexibleColumnLayout#getLayout layout} property.
+         */
+        layout?: string;
+        /**
+         * The maximum number of columns that can be displayed at once based on the control width. See {@link sap.f.FlexibleColumnLayout#getMaxColumnsCount}
+         */
+        maxColumnsCount?: number;
+        /**
+         * Represents the relative percentage sizes of all columns as integers.
+         */
+        columnsSizes?: sap.f.FlexibleColumnLayoutSemanticHelper.ColumnsSizes;
+        /**
+         * Represents the visibility of the columns.
+         */
+        columnsVisibility?: sap.f.FlexibleColumnLayoutSemanticHelper.ColumnsVisibility;
+        /**
+         * The value is `true` if only one column is visible at the moment, `false` otherwise.
+         *
+         * **Note:** This may be due to small screen size (phone) or due to a layout, for which a single column
+         * takes up the whole width.
+         */
+        isFullScreen?: boolean;
+        /**
+         * The value is `true` if the current `layout` is one of the following: `sap.f.LayoutType.OneColumn, sap.f.LayoutType.MidColumnFullScreen,
+         * sap.f.LayoutType.EndColumnFullScreen`, `false` otherwise.
+         *
+         * **Note:** While `isFullScreen` can be `true` for any layout, due to small screen size, `isLogicallyFullScreen`
+         * will only be `true` for the layout values, listed above.
+         */
+        isLogicallyFullScreen?: boolean;
+        /**
+         * The configuration of the navigation actions in the columns.
+         */
+        actionButtonsInfo?: sap.f.FlexibleColumnLayoutSemanticHelper.ColumnsNavigationActions;
+      };
+    }
+
     namespace routing {
       /**
        * @SINCE 1.46
@@ -11991,72 +12143,14 @@ declare namespace sap {
         oSettings?: object
       ): sap.f.FlexibleColumnLayoutSemanticHelper;
       /**
-       * Returns an object, describing the current state of the control and the expected action buttons for each
+       * Returns an object describing the current state of the control and the expected action buttons for each
        * column.
        *
-       * The returned object has the following structure:
-       * 	 - layout - the value of the `layout` property
-       * 	 - maxColumnsCount - the maximum number of columns that can be displayed at once based on the control
-       * 			width. See {@link sap.f.FlexibleColumnLayout#getMaxColumnsCount}
-       * 	 - columnsSizes - an object with fields `beginColumn, midColumn, endColumn`, representing the relative
-       * 			percentage sizes of the three columns as integers
-       * 	 - columnsVisibility - an object with fields `beginColumn, midColumn, endColumn`, representing the visibility
-       * 			of the three columns
-       * 	 - isFullScreen - `true` if only one column is visible at the moment, `false` otherwise **Note:** This
-       * 			may be due to small screen size (phone) or due to a layout, for which a single column takes up the whole
-       * 			width
-       * 	 - isLogicallyFullScreen - `true` if the current `layout` is one of the following: `sap.f.LayoutType.OneColumn,
-       * 			sap.f.LayoutType.MidColumnFullScreen, sap.f.LayoutType.EndColumnFullScreen`, `false` otherwise **Note:**
-       * 			While `isFullScreen` can be `true` for any layout, due to small screen size, `isLogicallyFullScreen`
-       * 			will only be `true` for the layout values, listed above.
-       * 	 - actionButtonsInfo - an object with fields `midColumn, endColumn`, each containing an object, telling
-       * 			whether action buttons should be shown in the `mid` and `end` columns, and what value of the `layout`
-       * 			property should be set upon clicking these buttons. Each of these objects has the following fields: `closeColumn,
-       * 			fullScreen, exitFullScreen`. If `null`, then the respective action button should not be shown, otherwise
-       * 			provides the value of `layout` property for the action button.
-       *
        * **Note:** This method relies on the internal `FlexibleColumnLayout` reference to be rendered in the DOM
        * tree. For convenience, use methods {@link sap.f.FlexibleColumnLayoutSemanticHelper#isDOMReady} and {@link
        * sap.f.FlexibleColumnLayoutSemanticHelper#whenDOMReady}.
-       *
-       * Example value:
-       *
-       *
-       * ```javascript
-       *
-       *
-       *  {
-       * 	   "layout":"ThreeColumnsMidExpanded",
-       * 	   "maxColumnsCount":3,
-       * 	   "columnsSizes":{
-       * 		  "beginColumn":25,
-       * 		  "midColumn":50,
-       * 		  "endColumn":25
-       * 	   },
-       * 	   "columnsVisibility":{
-       * 		  "beginColumn":true,
-       * 		  "midColumn":true,
-       * 		  "endColumn":true
-       * 	   },
-       * 	   "isFullScreen":false,
-       * 	   "isLogicallyFullScreen":false,
-       * 	   "actionButtonsInfo":{
-       * 		  "midColumn":{
-       * 			 "fullScreen":null,
-       * 			 "exitFullScreen":null,
-       * 			 "closeColumn":null
-       * 		  },
-       * 		  "endColumn":{
-       * 			 "fullScreen":"EndColumnFullScreen",
-       * 			 "exitFullScreen":null,
-       * 			 "closeColumn":"TwoColumnsBeginExpanded"
-       * 		  }
-       * 	   }
-       * 	}
-       *
-       *  ```
        */
-      getCurrentUIState(): object;
+      getCurrentUIState(): sap.f.FlexibleColumnLayoutSemanticHelper.UIState;
       /**
        * Returns the default layout types for the different numbers of columns.
        *
@@ -12072,8 +12166,6 @@ declare namespace sap {
       /**
        * Returns an object, describing the state that the control will have after navigating to a different view
        * level.
-       *
-       * About the format of return value, see: {@link sap.f.FlexibleColumnLayoutSemanticHelper#getCurrentUIState}
        */
       getNextUIState(
         /**
@@ -12081,7 +12173,7 @@ declare namespace sap {
          * 3 and above - subsequent views
          */
         iNextLevel: int
-      ): object;
+      ): sap.f.FlexibleColumnLayoutSemanticHelper.UIState;
       /**
        * @SINCE 1.72
        *

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   /**
@@ -219,9 +219,13 @@ declare namespace sap {
              */
             mParameters?: {
               /**
-               * Path pointing to the context on which 'Create' action is triggered
+               * Path pointing to the context on which Create action is triggered
                */
               contextPath?: string;
+              /**
+               * Array of values that are filled in the Action Parameter Dialog
+               */
+              createParameters?: any[];
             }
           ): Promise<any>;
           /**
@@ -516,6 +520,19 @@ declare namespace sap {
              */
             oContext: sap.ui.model.odata.v4.Context
           ): void;
+          /**
+           * Navigate to another target.
+           */
+          navigateToRoute(
+            /**
+             * Name of the target route
+             */
+            sTargetRouteName: string,
+            /**
+             * Parameters to be used with route to create the target hash
+             */
+            oParameters?: object
+          ): Promise<any>;
           /**
            * @SINCE 1.90.0
            *

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   namespace fe {
@@ -31,6 +31,18 @@ declare namespace sap {
        */
       export const Field: undefined;
 
+      /**
+       * Building block for creating a Form based on the metadata provided by OData V4.
+       *  Usually, a ReferenceFacet or CollectionFacet is expected
+       *
+       * Usage example:
+       * ```javascript
+       *
+       * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.Facets/0" />
+       * ```
+       */
+      export const Form: undefined;
+
       /**
        * Building block used to create a table based on the metadata provided by OData V4.
        *  Usually, a LineItem or PresentationVariant annotation is expected, but the Table building block can

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   namespace fe {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   namespace fe {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   namespace fe {
@@ -162,6 +162,10 @@ declare namespace sap {
         class DialogMessageActions extends sap.fe.test.api.DialogActions {
           constructor();
 
+          /**
+           * Confirms the draft message with Discard Draft when navigating back to the list-report.
+           */
+          iConfirmDiscardDraft(): object;
           /**
            * Executes the `Back` action on the message dialog.
            */
@@ -1345,10 +1349,6 @@ declare namespace sap {
              */
             vAction: string | object
           ): object;
-          /**
-           * Executes the `Paste` action on the table.
-           */
-          iExecutePaste(): object;
           /**
            * Executes the `Show/Hide details` action on the table.
            */
@@ -1788,14 +1788,9 @@ declare namespace sap {
             mProperty?: object
           ): object;
           /**
-           * Checks the `Paste` action of the table.
+           * Checks whether the paste button is available for the table.
            */
-          iCheckPaste(
-            /**
-             * Defines the expected state of the button
-             */
-            mState?: object
-          ): object;
+          iCheckPaste(): object;
           /**
            * Checks the quick filter action of the table.
            */
@@ -2097,6 +2092,10 @@ declare namespace sap {
            * The name of the navigation property used for the table
            */
           property: string;
+          /**
+           * The name of a qualifier for the table
+           */
+          qualifier?: string;
         };
       }
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.gantt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   /**
@@ -20221,6 +20221,26 @@ declare namespace sap {
          * The titleSpacing property defines the space between the start of the shape and the shape title in pixels
          */
         titleSpacing?: int | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * @SINCE 1.99
+         *
+         * The selectedFill property defines the color (or any SVG paint servers like gradients or patterns) of
+         * the shape when it is selected.
+         */
+        selectedFill?:
+          | sap.gantt.ValueSVGPaintServer
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * @SINCE 1.99
+         *
+         * The selectedTitleColor property defines the color (or any SVG paint servers like gradients or patterns)
+         * of the shape's title when it is selected.
+         */
+        selectedTitleColor?:
+          | sap.gantt.ValueSVGPaintServer
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
       interface $BaseTextSettings extends sap.gantt.simple.$BaseShapeSettings {
@@ -25135,6 +25155,24 @@ declare namespace sap {
          * Default value is `false`.
          */
         getSelected(): boolean;
+        /**
+         * @SINCE 1.99
+         *
+         * Gets current value of property {@link #getSelectedFill selectedFill}.
+         *
+         * The selectedFill property defines the color (or any SVG paint servers like gradients or patterns) of
+         * the shape when it is selected.
+         */
+        getSelectedFill(): sap.gantt.ValueSVGPaintServer;
+        /**
+         * @SINCE 1.99
+         *
+         * Gets current value of property {@link #getSelectedTitleColor selectedTitleColor}.
+         *
+         * The selectedTitleColor property defines the color (or any SVG paint servers like gradients or patterns)
+         * of the shape's title when it is selected.
+         */
+        getSelectedTitleColor(): sap.gantt.ValueSVGPaintServer;
         /**
          * Gets current value of property {@link #getShapeId shapeId}.
          *
@@ -25641,6 +25679,38 @@ declare namespace sap {
            */
           bSelected?: boolean
         ): this;
+        /**
+         * @SINCE 1.99
+         *
+         * Sets a new value for property {@link #getSelectedFill selectedFill}.
+         *
+         * The selectedFill property defines the color (or any SVG paint servers like gradients or patterns) of
+         * the shape when it is selected.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         */
+        setSelectedFill(
+          /**
+           * New value for property `selectedFill`
+           */
+          sSelectedFill: sap.gantt.ValueSVGPaintServer
+        ): this;
+        /**
+         * @SINCE 1.99
+         *
+         * Sets a new value for property {@link #getSelectedTitleColor selectedTitleColor}.
+         *
+         * The selectedTitleColor property defines the color (or any SVG paint servers like gradients or patterns)
+         * of the shape's title when it is selected.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         */
+        setSelectedTitleColor(
+          /**
+           * New value for property `selectedTitleColor`
+           */
+          sSelectedTitleColor: sap.gantt.ValueSVGPaintServer
+        ): this;
         /**
          * Sets a new value for property {@link #getShapeId shapeId}.
          *

package/types/sap.landvisz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.98.0
+// For Library Version: 1.99.0
 
 declare namespace sap {
   /**