@sapui5/ts-types 1.92.1 → 1.93.2

package/types/sap.zen.dsh.d.ts

@@ -1,10 +1,8 @@
-// For Library Version: 1.92.0
+// For Library Version: 1.93.0
 
 declare namespace sap {
   namespace zen {
     /**
-     * @EXPERIMENTAL (since 1.89)
-     *
      * Design Studio Runtime Library. Intended only to be used within S/4 HANA Fiori applications.
      */
     namespace dsh {
@@ -83,6 +81,10 @@ declare namespace sap {
              */
             FNMetaImpl?: Function
           ): Function;
+          /**
+           * Returns a metadata object for class sap.zen.dsh.InACard.Component.
+           */
+          static getMetadata(): sap.ui.core.ComponentMetadata;
           /**
            * Gets current value of property {@link #getContentFragment contentFragment}.
            *
@@ -114,10 +116,6 @@ declare namespace sap {
            * Default value is `empty string`.
            */
           getFooterFragment(): string;
-          /**
-           * Returns a metadata object for class sap.zen.dsh.InACard.Component.
-           */
-          static getMetadata(): sap.ui.core.ComponentMetadata;
           /**
            * Gets current value of property {@link #getWidgetType widgetType}.
            *
@@ -205,8 +203,6 @@ declare namespace sap {
 
       namespace olap {
         /**
-         * @EXPERIMENTAL (since 1.89)
-         *
          * A `DataProvider` is referencing a CDS view that is annotated as an AnalyitcQuery.
          *
          * Instances of this class should only be created by the {sap.zen.dsh.olap.OlapModel}. The `OlapModel` populates
@@ -679,8 +675,6 @@ declare namespace sap {
           transferValue(): Promise<this>;
         }
         /**
-         * @EXPERIMENTAL (since 1.89)
-         *
          * List binding implementation for `OlapModel`.
          */
         class OlapListBinding extends sap.ui.model.ListBinding {
@@ -720,8 +714,6 @@ declare namespace sap {
           static getMetadata(): sap.ui.base.Metadata;
         }
         /**
-         * @EXPERIMENTAL (since 1.89)
-         *
          * List binding implementation for `OlapModel`.
          */
         class OlapListGridBinding extends sap.ui.model.ListBinding {
@@ -735,8 +727,6 @@ declare namespace sap {
           constructor();
         }
         /**
-         * @EXPERIMENTAL (since 1.89)
-         *
          * Model implementation for InA provider
          *
          * The OlapModel can populate it's exposed data via Binding to Controls. The structure of the exposed data
@@ -769,8 +759,31 @@ declare namespace sap {
           );
 
           /**
+           * Creates a new subclass of class sap.zen.dsh.olap.OlapModel with name `sClassName` and enriches it with
+           * the information contained in `oClassInfo`.
            *
+           * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
            */
+          static extend<T extends Record<string, unknown>>(
+            /**
+             * Name of the class being created
+             */
+            sClassName: string,
+            /**
+             * Object literal with information about the class
+             */
+            oClassInfo?: sap.ClassInfo<T, sap.zen.dsh.olap.OlapModel>,
+            /**
+             * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+             * used by this class
+             */
+            FNMetaImpl?: Function
+          ): Function;
+          /**
+           * Returns a metadata object for class sap.zen.dsh.olap.OlapModel.
+           */
+          static getMetadata(): sap.ui.base.Metadata;
+
           addFunction(
             /**
              * the name of the data function
@@ -810,7 +823,7 @@ declare namespace sap {
              * the name of the type of the datasource
              */
             sType?: string
-          ): Promise</* was: sap.zen.dsh.DataProvider */ any>;
+          ): Promise<sap.zen.dsh.olap.DataProvider>;
           /**
            * adds a new query as a new System to the System Landscape . The parameter should have the following properties:
            *
@@ -825,7 +838,7 @@ declare namespace sap {
              * The Definition of the system
              */
             mSystem: object
-          ): Promise</* was: sap.zen.dsh.DataProvider */ any>;
+          ): Promise<sap.zen.dsh.olap.DataProvider>;
           /**
            * Attaches event handler `fnFunction` to the {@link #event:metadataFailed metadataFailed} event of this
            * `sap.zen.dsh.olap.OlapModel`.
@@ -895,27 +908,6 @@ declare namespace sap {
              */
             WorkbookName: string
           ): Promise<this>;
-          /**
-           * Creates a new subclass of class sap.zen.dsh.olap.OlapModel with name `sClassName` and enriches it with
-           * the information contained in `oClassInfo`.
-           *
-           * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.model.Model.extend}.
-           */
-          static extend<T extends Record<string, unknown>>(
-            /**
-             * Name of the class being created
-             */
-            sClassName: string,
-            /**
-             * Object literal with information about the class
-             */
-            oClassInfo?: sap.ClassInfo<T, sap.zen.dsh.olap.OlapModel>,
-            /**
-             * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
-             * used by this class
-             */
-            FNMetaImpl?: Function
-          ): Function;
           /**
            * Fires event {@link #event:metadataFailed metadataFailed} to attached listeners.
            */
@@ -933,15 +925,9 @@ declare namespace sap {
              * the name of the `DataProvider`.
              */
             sDataProviderName: string
-          ): /* was: sap.zen.dsh.DataProvider */ any;
-          /**
-           *
-           */
+          ): sap.zen.dsh.olap.DataProvider;
+
           getLimit(): object;
-          /**
-           * Returns a metadata object for class sap.zen.dsh.olap.OlapModel.
-           */
-          static getMetadata(): sap.ui.base.Metadata;
           /**
            * retreive the list of data functions matching a given text
            */
@@ -988,9 +974,7 @@ declare namespace sap {
              */
             sServiceName: string
           ): Promise<this>;
-          /**
-           *
-           */
+
           removeFunction(
             /**
              * the name of the data function
@@ -1010,9 +994,7 @@ declare namespace sap {
            * such Object.
            */
           serialize(): object;
-          /**
-           *
-           */
+
           setLimit(
             /**
              * the limit of the rows and columns that are exposed for bindings
@@ -1039,8 +1021,6 @@ declare namespace sap {
           undo(): Promise<this>;
         }
         /**
-         * @EXPERIMENTAL (since 1.89)
-         *
          * Property binding implementation for `OlapModel`.
          */
         class OlapPropertyBinding extends sap.ui.model.ListBinding {
@@ -1159,6 +1139,10 @@ declare namespace sap {
              */
             FNMetaImpl?: Function
           ): Function;
+          /**
+           * Returns a metadata object for class sap.zen.dsh.rsrt.Component.
+           */
+          static getMetadata(): sap.ui.core.ComponentMetadata;
           /**
            * Gets current value of property {@link #getClient client}.
            *
@@ -1184,10 +1168,6 @@ declare namespace sap {
            * the host of the datasource, falsy means use the origin of the website as domain
            */
           getHost(): string;
-          /**
-           * Returns a metadata object for class sap.zen.dsh.rsrt.Component.
-           */
-          static getMetadata(): sap.ui.core.ComponentMetadata;
           /**
            * Gets current value of property {@link #getPackageName packageName}.
            *
@@ -1472,12 +1452,12 @@ declare namespace sap {
         /**
          * Event is triggered when the state of the AnalyticGrid is changed.
          */
-        stateChange?: Function;
+        stateChange?: (oEvent: sap.ui.base.Event) => void;
 
         /**
          * Event is triggered when the selection is changed.
          */
-        selectionChange?: Function;
+        selectionChange?: (oEvent: sap.ui.base.Event) => void;
       }
 
       interface $dialogsSettings extends sap.ui.core.$UIComponentSettings {}
@@ -1638,7 +1618,7 @@ declare namespace sap {
         /**
          * Fired when a user launches a navigation command
          */
-        navigationCmd?: Function;
+        navigationCmd?: (oEvent: sap.ui.base.Event) => void;
       }
 
       interface $ValueHelpDialogSettings extends sap.m.$DialogSettings {
@@ -1753,14 +1733,14 @@ declare namespace sap {
          *
          * This event is fired when the OK button is pressed.
          */
-        ok?: Function;
+        ok?: (oEvent: sap.ui.base.Event) => void;
 
         /**
          * @SINCE 1.24
          *
          * This event is fired when the Cancel button is pressed.
          */
-        cancel?: Function;
+        cancel?: (oEvent: sap.ui.base.Event) => void;
 
         /**
          * @SINCE 1.32
@@ -1769,7 +1749,7 @@ declare namespace sap {
          *
          * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
          */
-        selectionChange?: Function;
+        selectionChange?: (oEvent: sap.ui.base.Event) => void;
 
         /**
          * @SINCE 1.32
@@ -1778,7 +1758,7 @@ declare namespace sap {
          *
          * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
          */
-        tokenRemove?: Function;
+        tokenRemove?: (oEvent: sap.ui.base.Event) => void;
 
         /**
          * @SINCE 1.32
@@ -1787,7 +1767,7 @@ declare namespace sap {
          *
          * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`.
          */
-        updateSelection?: Function;
+        updateSelection?: (oEvent: sap.ui.base.Event) => void;
       }
 
       /**
@@ -1829,6 +1809,31 @@ declare namespace sap {
           mSettings?: sap.zen.dsh.$AnalyticGridSettings
         );
 
+        /**
+         * Creates a new subclass of class sap.zen.dsh.AnalyticGrid with name `sClassName` and enriches it with
+         * the information contained in `oClassInfo`.
+         *
+         * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.zen.dsh.AnalyticGrid>,
+          /**
+           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+           * used by this class
+           */
+          FNMetaImpl?: Function
+        ): Function;
+        /**
+         * Returns a metadata object for class sap.zen.dsh.AnalyticGrid.
+         */
+        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this
          * `sap.zen.dsh.AnalyticGrid`.
@@ -1944,27 +1949,6 @@ declare namespace sap {
            */
           oListener?: object
         ): this;
-        /**
-         * Creates a new subclass of class sap.zen.dsh.AnalyticGrid with name `sClassName` and enriches it with
-         * the information contained in `oClassInfo`.
-         *
-         * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
-         */
-        static extend<T extends Record<string, unknown>>(
-          /**
-           * Name of the class being created
-           */
-          sClassName: string,
-          /**
-           * Object literal with information about the class
-           */
-          oClassInfo?: sap.ClassInfo<T, sap.zen.dsh.AnalyticGrid>,
-          /**
-           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
-           * used by this class
-           */
-          FNMetaImpl?: Function
-        ): Function;
         /**
          * Fires event {@link #event:selectionChange selectionChange} to attached listeners.
          */
@@ -1999,10 +1983,6 @@ declare namespace sap {
          * Desired width of the AnalyticGrid control
          */
         getHeight(): sap.ui.core.CSSSize;
-        /**
-         * Returns a metadata object for class sap.zen.dsh.AnalyticGrid.
-         */
-        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Gets current value of property {@link #getQueryName queryName}.
          *
@@ -2123,7 +2103,7 @@ declare namespace sap {
 
       class dialogs extends sap.ui.core.UIComponent {
         /**
-         * Dialogs for navigating the Data of a `sap.zen.dsh.DataProvider`
+         * Dialogs for navigating the Data of a `sap.zen.dsh.olap.DataProvider`
          *
          * This `UIComponent` provides all the dialogs for navigating the data provided via a `DataProvider`. Don't
          * use the this component directly, but call the corresponding methods of the `DataProvider` **List of dialogs**
@@ -2180,32 +2160,6 @@ declare namespace sap {
           mSettings?: sap.zen.dsh.$DshSettings
         );
 
-        /**
-         *
-         */
-        addParameter(
-          /**
-           * the name of the parameter
-           */
-          sName: string,
-          /**
-           * the value of the parameter
-           */
-          sValue: string
-        ): string;
-        /**
-         *
-         */
-        createPage(): void;
-        /**
-         *
-         */
-        executeScript(
-          /**
-           * the content of the script
-           */
-          sScript: string
-        ): void;
         /**
          * Creates a new subclass of class sap.zen.dsh.Dsh with name `sClassName` and enriches it with the information
          * contained in `oClassInfo`.
@@ -2227,6 +2181,30 @@ declare namespace sap {
            */
           FNMetaImpl?: Function
         ): Function;
+        /**
+         * Returns a metadata object for class sap.zen.dsh.Dsh.
+         */
+        static getMetadata(): sap.ui.core.ElementMetadata;
+
+        addParameter(
+          /**
+           * the name of the parameter
+           */
+          sName: string,
+          /**
+           * the value of the parameter
+           */
+          sValue: string
+        ): string;
+
+        createPage(): void;
+
+        executeScript(
+          /**
+           * the content of the script
+           */
+          sScript: string
+        ): void;
         /**
          * Gets current value of property {@link #getAppComponent appComponent}.
          *
@@ -2239,18 +2217,14 @@ declare namespace sap {
          * the client
          */
         getClient(): string;
-        /**
-         *
-         */
+
         getComponent(
           /**
            * the Name of the Component
            */
           sName: string
         ): object;
-        /**
-         *
-         */
+
         getDataSource(
           /**
            * the namw of the data source
@@ -2293,13 +2267,7 @@ declare namespace sap {
          * the language
          */
         getLanguage(): string;
-        /**
-         * Returns a metadata object for class sap.zen.dsh.Dsh.
-         */
-        static getMetadata(): sap.ui.core.ElementMetadata;
-        /**
-         *
-         */
+
         getPage(): object;
         /**
          * Gets current value of property {@link #getProtocol protocol}.
@@ -2578,6 +2546,10 @@ declare namespace sap {
            */
           FNMetaImpl?: Function
         ): Function;
+        /**
+         * Returns a metadata object for class sap.zen.dsh.InATile.
+         */
+        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Gets current value of property {@link #getClient client}.
          *
@@ -2603,10 +2575,6 @@ declare namespace sap {
          * the host of the datasource, falsy means use the origin of the website as domain
          */
         getHost(): string;
-        /**
-         * Returns a metadata object for class sap.zen.dsh.InATile.
-         */
-        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Gets current value of property {@link #getPackageName packageName}.
          *
@@ -2826,8 +2794,6 @@ declare namespace sap {
         ): this;
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
        * Enables users to view, navigate and change multidimensional data exposed via InA in a PivotTable.
        *
        * Overview:
@@ -2873,6 +2839,31 @@ declare namespace sap {
           mSettings?: sap.zen.dsh.$PivotTableSettings
         );
 
+        /**
+         * Creates a new subclass of class sap.zen.dsh.PivotTable with name `sClassName` and enriches it with the
+         * information contained in `oClassInfo`.
+         *
+         * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.zen.dsh.PivotTable>,
+          /**
+           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+           * used by this class
+           */
+          FNMetaImpl?: Function
+        ): Function;
+        /**
+         * Returns a metadata object for class sap.zen.dsh.PivotTable.
+         */
+        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Attaches event handler `fnFunction` to the {@link #event:navigationCmd navigationCmd} event of this `sap.zen.dsh.PivotTable`.
          *
@@ -2930,27 +2921,6 @@ declare namespace sap {
            */
           oListener?: object
         ): this;
-        /**
-         * Creates a new subclass of class sap.zen.dsh.PivotTable with name `sClassName` and enriches it with the
-         * information contained in `oClassInfo`.
-         *
-         * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
-         */
-        static extend<T extends Record<string, unknown>>(
-          /**
-           * Name of the class being created
-           */
-          sClassName: string,
-          /**
-           * Object literal with information about the class
-           */
-          oClassInfo?: sap.ClassInfo<T, sap.zen.dsh.PivotTable>,
-          /**
-           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
-           * used by this class
-           */
-          FNMetaImpl?: Function
-        ): Function;
         /**
          * Fires event {@link #event:navigationCmd navigationCmd} to attached listeners.
          */
@@ -2995,10 +2965,6 @@ declare namespace sap {
          * Default value is `ExcelStyle`.
          */
         getFormat(): sap.zen.commons.Format;
-        /**
-         * Returns a metadata object for class sap.zen.dsh.PivotTable.
-         */
-        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * Sets a new value for property {@link #getDataProviderName dataProviderName}.
          *
@@ -3068,6 +3034,31 @@ declare namespace sap {
           mSettings?: sap.zen.dsh.$ValueHelpDialogSettings
         );
 
+        /**
+         * Creates a new subclass of class sap.zen.dsh.ValueHelpDialog with name `sClassName` and enriches it with
+         * the information contained in `oClassInfo`.
+         *
+         * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
+         */
+        static extend<T extends Record<string, unknown>>(
+          /**
+           * Name of the class being created
+           */
+          sClassName: string,
+          /**
+           * Object literal with information about the class
+           */
+          oClassInfo?: sap.ClassInfo<T, sap.zen.dsh.ValueHelpDialog>,
+          /**
+           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+           * used by this class
+           */
+          FNMetaImpl?: Function
+        ): Function;
+        /**
+         * Returns a metadata object for class sap.zen.dsh.ValueHelpDialog.
+         */
+        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * @SINCE 1.24
          *
@@ -3400,27 +3391,6 @@ declare namespace sap {
            */
           oListener?: object
         ): this;
-        /**
-         * Creates a new subclass of class sap.zen.dsh.ValueHelpDialog with name `sClassName` and enriches it with
-         * the information contained in `oClassInfo`.
-         *
-         * `oClassInfo` might contain the same kind of information as described in {@link sap.m.Dialog.extend}.
-         */
-        static extend<T extends Record<string, unknown>>(
-          /**
-           * Name of the class being created
-           */
-          sClassName: string,
-          /**
-           * Object literal with information about the class
-           */
-          oClassInfo?: sap.ClassInfo<T, sap.zen.dsh.ValueHelpDialog>,
-          /**
-           * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
-           * used by this class
-           */
-          FNMetaImpl?: Function
-        ): Function;
         /**
          * @SINCE 1.24
          *
@@ -3595,10 +3565,6 @@ declare namespace sap {
          * Default value is `"-1"`.
          */
         getMaxIncludeRanges(): string;
-        /**
-         * Returns a metadata object for class sap.zen.dsh.ValueHelpDialog.
-         */
-        static getMetadata(): sap.ui.core.ElementMetadata;
         /**
          * @SINCE 1.24
          *
@@ -3865,8 +3831,6 @@ declare namespace sap {
         update(): void;
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
        * Axis of a multidimensional Result Set
        */
       enum Axis {
@@ -3965,8 +3929,6 @@ declare namespace sap {
         SEARCH = "undefined",
       }
       /**
-       * @EXPERIMENTAL (since 1.91)
-       *
        * Type of a DataSource
        */
       enum DataSourceType {
@@ -3992,8 +3954,6 @@ declare namespace sap {
         view = "view",
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
        * Type of a Dimension
        */
       enum DimensionType {
@@ -4079,8 +4039,6 @@ declare namespace sap {
         VersionDimension = "VersionDimension",
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
        * Display Type of a Dimension Member
        */
       enum DisplayType {
@@ -4106,8 +4064,6 @@ declare namespace sap {
         TextKey = "TextKey",
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
        * Type of a Member
        */
       enum MemberType {
@@ -4225,8 +4181,6 @@ declare namespace sap {
         Variance = "Variance",
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
        * Types of navigation commands.
        */
       enum NavigationCommandType {
@@ -4252,8 +4206,6 @@ declare namespace sap {
         RowRequest = "RowRequest",
       }
       /**
-       * @EXPERIMENTAL (since 1.91)
-       *
        * Protocol Type
        */
       enum ProtocolType {
@@ -4271,8 +4223,27 @@ declare namespace sap {
         WASABI = "WASABI",
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
+       * Semanitc Role of a Dimension Member
+       */
+      enum SemanticRole {
+        /**
+         * Actual Data
+         */
+        Actual = "Actual",
+        /**
+         * Budget Data
+         */
+        Budget = "Budget",
+        /**
+         * Forecast Data
+         */
+        Forecast = "Forecast",
+        /**
+         * Previous Data
+         */
+        Previous = "Previous",
+      }
+      /**
        * Sort Direction
        */
       enum SortDirection {
@@ -4290,8 +4261,6 @@ declare namespace sap {
         NONE = "NONE",
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
        * Sort Type
        */
       enum SortType {
@@ -4313,8 +4282,6 @@ declare namespace sap {
         unset = "unset",
       }
       /**
-       * @EXPERIMENTAL (since 1.91)
-       *
        * System Type of an InA System
        */
       enum SystemType {
@@ -4380,8 +4347,6 @@ declare namespace sap {
         StartsWith = "StartsWith",
       }
       /**
-       * @EXPERIMENTAL (since 1.89)
-       *
        * Sort Type
        */
       enum ValueType {
@@ -4579,8 +4544,6 @@ declare namespace sap {
         Variable = "Variable",
       }
       /**
-       * @EXPERIMENTAL
-       *
        * Widget Type of an InACard
        */
       enum WidgetType {
@@ -4655,6 +4618,8 @@ declare namespace sap {
 
     "sap/zen/dsh/rsrt/Component": undefined;
 
+    "sap/zen/dsh/SemanticRole": undefined;
+
     "sap/zen/dsh/SortDirection": undefined;
 
     "sap/zen/dsh/SortType": undefined;