@sapui5/sap.ushell 1.120.8 → 1.121.0

package/src/main/js/sap/ushell/components/tiles/indicatorTileUtils/oData4Analytics.js

@@ -31,11 +31,10 @@ sap.ui.define([
     /* eslint-disable block-scoped-var */ // TODO: remove eslint-disable
     /* eslint-disable no-cond-assign */ // TODO: remove eslint-disable
 
-    /*
-     * try { if (typeof sap.ui.model.odata.ODataModel === "undefined")
-     * throw "SAP UI5 library not present. Load it beforehand to avoid this error"; }
-     * catch (error) { throw "SAP UI5 library not present. Load it beforehand to avoid this error"; }
-     */
+    // try { if (typeof sap.ui.model.odata.ODataModel === "undefined")
+    // throw "SAP UI5 library not present. Load it beforehand to avoid this error"; }
+    // catch (error) { throw "SAP UI5 library not present. Load it beforehand to avoid this error"; }
+
     sap = sap || {};
     sap.ushell = sap.ushell || {};
     sap.ushell.components = sap.ushell.components || {};
@@ -106,7 +105,8 @@ sap.ui.define([
      * @param {object} oModelReference An instance of ReferenceByURI, ReferenceByModel
      *   or ReferenceWithWorkaround for locating the OData service.
      * @param {string} sAnnotationJSONDoc A JSON document providing extra annotations to the elements of the structure of the given service
-     * @class Representation of an OData model with analytical annotations defined by OData4SAP.
+     * @class
+     * @classdesc Representation of an OData model with analytical annotations defined by OData4SAP.
      */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Model = function (oModelReference, sAnnotationJSONDoc) {
         this._init(oModelReference, sAnnotationJSONDoc);
@@ -116,7 +116,8 @@ sap.ui.define([
      * Create a reference to an OData model by the URI of the related OData service.
      *
      * @param {string} sURI holding the URI.
-     * @class Handle to an OData model by the URI pointing to it.
+     * @class
+     * @classdesc Handle to an OData model by the URI pointing to it.
      */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Model.ReferenceByURI = function (sURI) {
         return { sServiceURI: sURI };
@@ -126,7 +127,8 @@ sap.ui.define([
      * Create a reference to an OData model already loaded elsewhere with the help of SAP UI5.
      *
      * @param {object} oModel holding the OData model.
-     * @class Handle to an already instantiated SAP UI5 OData model.
+     * @class
+     * @classdesc Handle to an already instantiated SAP UI5 OData model.
      */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Model.ReferenceByModel = function (oModel) {
         return { oModel: oModel };
@@ -147,7 +149,8 @@ sap.ui.define([
      * @param {object} oModelReference holding a reference to the OData model, obtained by
      *   sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Model.ReferenceByModel or by sap.odata4analytics.Model.ReferenceByURI.
      * @param {string[]} aWorkaroundID listing all workarounds to be applied.
-     * @class Handle to an already instantiated SAP UI5 OData model.
+     * @class
+     * @classdesc Handle to an already instantiated SAP UI5 OData model.
      */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Model.ReferenceWithWorkaround = function (oModel, aWorkaroundID) {
         return {
@@ -565,7 +568,7 @@ sap.ui.define([
         /**
          * Get the names of all query results (entity sets) offered by the model
          *
-         * @returns {array(string)} List of all query result names
+         * @returns {string[]} List of all query result names
          */
         getAllQueryResultNames: function () {
             if (this._aQueryResultNames) {
@@ -652,7 +655,8 @@ sap.ui.define([
      * @param {sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Parameterization} oParameterization
      *   The parameterization of this query, if any
      * @this (QueryResult)
-     * @class Representation of an entity type annotated with sap:semantics="aggregate".
+     * @class
+     * @classdesc Representation of an entity type annotated with sap:semantics="aggregate".
      */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.QueryResult = function (oModel, oEntityType, oEntitySet, oParameterization) {
         this._init(oModel, oEntityType, oEntitySet, oParameterization);
@@ -801,7 +805,7 @@ sap.ui.define([
         /**
          * Get the names of all measures included in the query result
          *
-         * @returns {array(string)} List of all measure names
+         * @returns {string[]} List of all measure names
          */
         getAllMeasureNames: function () {
             if (this._aMeasureNames) {
@@ -897,7 +901,8 @@ sap.ui.define([
      *   The OData entity type for this parameterization
      * @param {sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.EntitySet} oEntitySet
      *   The OData entity set for this parameterization offered by the OData service
-     * @class Representation of an entity type annotated with sap:semantics="parameters".
+     * @class
+     * @classdesc Representation of an entity type annotated with sap:semantics="parameters".
      */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Parameterization = function (oEntityType, oEntitySet) {
         this._init(oEntityType, oEntitySet);
@@ -966,7 +971,7 @@ sap.ui.define([
         /**
          * Get the names of all parameters part of the parameterization
          *
-         * @returns {array(string)} List of all parameter names
+         * @returns {string[]} List of all parameter names
          */
         getAllParameterNames: function () {
             if (this._aParameterNames) {
@@ -1039,7 +1044,8 @@ sap.ui.define([
      * @param {sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Parameterization} oParameterization
      *   The parameterization containing this parameter
      * @param {object} oProperty The DataJS object object representing the text property
-     * @class Representation of a property annotated with sap:parameter.
+     * @class
+     * @classdesc Representation of a property annotated with sap:parameter.
      */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Parameter = function (oParameterization, oProperty) {
         this._init(oParameterization, oProperty);
@@ -1367,7 +1373,7 @@ sap.ui.define([
         /**
          * Get the names of all dimensions included in the query result
          *
-         * @returns {String[]} List of all dimension names
+         * @returns {string[]} List of all dimension names
          */
         getAllAttributeNames: function () {
             if (this._aAttributeNames) {
@@ -1541,7 +1547,8 @@ sap.ui.define([
      * @param {sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.QueryResult} oQueryResult
      *   The query result containing this measure
      * @param {object} oProperty The DataJS object object representing the measure
-     * @class Representation of a property annotated with sap:aggregation-role="measure".
+     * @class
+     * @classdesc Representation of a property annotated with sap:aggregation-role="measure".
      */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.Measure = function (oQueryResult, oProperty) {
         this._init(oQueryResult, oProperty);
@@ -1640,15 +1647,15 @@ sap.ui.define([
     /** ******************************************************************** */
 
     /**
-    * Create a representation of an OData entity set in the context of an analytic query
-    *
-    * @param {object} oModel DataJS object for the OData model containing this entity set
-    * @param {object} oSchema DataJS object for the schema surrounding the container of this entity set
-    * @param {object} oContainer DataJS object for the container holding this entity set
-    * @param {object} oEntitySet DataJS object for the entity set
-    *
-    * Representation of a OData entity set.
-    */
+     * Create a representation of an OData entity set in the context of an analytic query
+     *
+     * @param {object} oModel DataJS object for the OData model containing this entity set
+     * @param {object} oSchema DataJS object for the schema surrounding the container of this entity set
+     * @param {object} oContainer DataJS object for the container holding this entity set
+     * @param {object} oEntitySet DataJS object for the entity set
+     *
+     * Representation of a OData entity set.
+     */
     sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.EntitySet = function (oModel, oSchema, oContainer, oEntitySet) {
         this._init(oModel, oSchema, oContainer, oEntitySet);
     };
@@ -1839,7 +1846,7 @@ sap.ui.define([
         /**
          * Get names of properties that can be filtered, that is they can be used in $filter expressions
          *
-         * @returns {array(string)} Array with names of properties that can be filtered.
+         * @returns {string[]} Array with names of properties that can be filtered.
          */
         getFilterablePropertyNames: function () {
             return this._aFilterablePropertyNames;
@@ -1848,7 +1855,7 @@ sap.ui.define([
         /**
          * Get names of properties that can be sorted, that is they can be used in $orderby expressions
          *
-         * @returns {array(string)} Array with names of properties that can be sorted.
+         * @returns {string[]} Array with names of properties that can be sorted.
          */
         getSortablePropertyNames: function () {
             return this._aSortablePropertyNames;
@@ -1857,7 +1864,7 @@ sap.ui.define([
         /**
          * Get names of properties that must be filtered, that is they must appear in every $filter expression
          *
-         * @returns {array(string)} Array with names of properties that must be filtered.
+         * @returns {string[]} Array with names of properties that must be filtered.
          */
         getRequiredFilterPropertyNames: function () {
             return this._aRequiredFilterPropertyNames;
@@ -1866,7 +1873,7 @@ sap.ui.define([
         /**
          * Get the names of all properties with an associated hierarchy
          *
-         * @returns {array(string)} List of all property names
+         * @returns {string[]} List of all property names
          */
         getAllHierarchyPropertyNames: function () {
             if (this._aHierarchyPropertyNames) {
@@ -2112,7 +2119,7 @@ sap.ui.define([
          * It is a convenience method for this particular use case eliminating the need for multiple API calls.
          *
          * @param {string} sPropertyName The name of the property bound in the condition
-         * @param {array} aValues values defining the set
+         * @param {Array<*>} aValues values defining the set
          * @throws Exception if the property is unknown or not filterable
          * @returns {sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.FilterExpression} This object for method chaining
          */
@@ -2247,7 +2254,8 @@ sap.ui.define([
     /** ******************************************************************** */
 
     /**
-     * @class Sort order of a property
+     * Sort order of a property
+     * @namespace
      * @static
      * @public
      */
@@ -2340,7 +2348,7 @@ sap.ui.define([
          * @param {string} sPropertyName The name of the property bound in the condition
          * @param {sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.SortOrder} sSortOrder sorting order used for the condition
          * @throws Exception if the property is unknown, not sortable or already added as sorter
-         * @returns {sap.ushell.components.tiles.indicatorTileUtils.odata4analytics.SortExpression} This object for method chaining
+         * @returns {this} Reference to <code>this</code> for method chaining.
          */
         addSorter: function (sPropertyName, sSortOrder) {
             var oProperty = this._oEntityType.findPropertyByName(sPropertyName);
@@ -2652,7 +2660,7 @@ sap.ui.define([
          * Set the aggregation level for the query result request. By default, the query result will include the properties holding the
          * keys of the given dimensions. This setting can be changed using includeDimensionKeyTextAttributes.
          *
-         * @param {Array} aDimensionName Array of dimension names to be part of the aggregation level.
+         * @param {string[]} aDimensionName Array of dimension names to be part of the aggregation level.
          *   If null, the aggregation level includes all dimensions, if empty, no dimension is included.
          */
         setAggregationLevel: function (aDimensionName) {
@@ -2666,7 +2674,7 @@ sap.ui.define([
         /**
          * Add one or more dimensions to the aggregation level
          *
-         * @param {Array} aDimensionName Array of dimension names to be added to the already defined aggregation level.
+         * @param {string[]} aDimensionName Array of dimension names to be added to the already defined aggregation level.
          */
         addToAggregationLevel: function (aDimensionName) {
             if (!aDimensionName) {
@@ -2688,7 +2696,7 @@ sap.ui.define([
         /**
          * Remove one or more dimensions from the aggregation level. The method also removed a potential sort expression on the dimension.
          *
-         * @param {Array} aDimensionName Array of dimension names to be removed from the already defined aggregation level.
+         * @param {string[]} aDimensionName Array of dimension names to be removed from the already defined aggregation level.
          */
         removeFromAggregationLevel: function (aDimensionName) {
             if (!aDimensionName) {
@@ -2710,7 +2718,7 @@ sap.ui.define([
         /**
          * Get the names of the dimensions included in the aggregation level
          *
-         * @returns {Array} The dimension names included in the aggregation level
+         * @returns {string[]} The dimension names included in the aggregation level
          */
         getAggregationLevel: function () {
             var aDimName = [];
@@ -2740,7 +2748,7 @@ sap.ui.define([
          * Set the measures to be included in the query result request. By default, the query result will include the properties holding the
          * raw values of the given measures. This setting can be changed using includeMeasureRawFormattedValueUnit.
          *
-         * @param {Array} aMeasureName Array of measure names to be part of the query result request.
+         * @param {string[]} aMeasureName Array of measure names to be part of the query result request.
          *   If null, the request includes all measures, if empty, no measure is included.
          */
         setMeasures: function (aMeasureName) {
@@ -2764,7 +2772,7 @@ sap.ui.define([
         /**
          * Get the names of the measures included in the query result request
          *
-         * @returns {Array} The measure names included in the query result request
+         * @returns {string[]} The measure names included in the query result request
          */
         getMeasureNames: function () {
             var aMeasName = [];
@@ -2784,11 +2792,10 @@ sap.ui.define([
          *   Pass null to keep current setting.
          * @param {boolean} bIncludeText Indicator whether or not to include the dimension text (if available)
          *   in the query result. Pass null to keep current setting.
-         * @param {Array} aAttributeName Array of dimension attribute names to be included in the result.
+         * @param {Array<*>} aAttributeName Array of dimension attribute names to be included in the result.
          *   Pass null to keep current setting. This argument is ignored if sDimensionName is null.
          */
-        includeDimensionKeyTextAttributes: function (sDimensionName, bIncludeKey, bIncludeText,
-            aAttributeName) {
+        includeDimensionKeyTextAttributes: function (sDimensionName, bIncludeKey, bIncludeText, aAttributeName) {
             var aDimName = [];
             if (sDimensionName) {
                 if (this._oAggregationLevel[sDimensionName] == undefined) {

package/src/main/js/sap/ushell/components/tiles/indicatorcontribution/ContributionTile.controller.js

@@ -96,7 +96,7 @@ sap.ui.define([
                      * var measure = [];
                      * measure.push(this.oConfig.EVALUATION.COLUMN_NAME);
                      * measure.push(this.oConfig.TILE_PROPERTIES.semanticMeasure);
-                     * */
+                     */
                     measure = this.oConfig.EVALUATION.COLUMN_NAME + "," + this.oConfig.TILE_PROPERTIES.semanticMeasure;
                 } else {
                     measure = this.oConfig.EVALUATION.COLUMN_NAME;

package/src/main/js/sap/ushell/components/tiles/indicatorcontribution/ContributionTile.view.js

@@ -46,24 +46,22 @@ sap.ui.define([
             var that = this;
 
             that.oGenericTileData = {
-                /*
-                subheader : "Lorem Ipsum SubHeader",
-                header : "Lorem Ipsum Header",
-                value: 8888,
-                size: sap.suite.ui.commons.InfoTileSize.Auto,
-                frameType:"OneByOne",
-                state: sap.suite.ui.commons.LoadState.Loading,
-                valueColor:sap.suite.ui.commons.InfoTileValueColor.Error,
-                indicator: sap.suite.ui.commons.DeviationIndicator.None,
-                title : "US Profit Margin",
-                footer : "Current Quarter",
-                description: "Maximum deviation",
-                data: [
-                    { title: "Americas", value: 10, color: "Neutral" },
-                    { title: "EMEA", value: 50, color: "Neutral" },
-                    { title: "APAC", value: -20, color: "Neutral" }
-                ]
-                */
+                // subheader : "Lorem Ipsum SubHeader",
+                // header : "Lorem Ipsum Header",
+                // value: 8888,
+                // size: sap.suite.ui.commons.InfoTileSize.Auto,
+                // frameType:"OneByOne",
+                // state: sap.suite.ui.commons.LoadState.Loading,
+                // valueColor:sap.suite.ui.commons.InfoTileValueColor.Error,
+                // indicator: sap.suite.ui.commons.DeviationIndicator.None,
+                // title : "US Profit Margin",
+                // footer : "Current Quarter",
+                // description: "Maximum deviation",
+                // data: [
+                //     { title: "Americas", value: 10, color: "Neutral" },
+                //     { title: "EMEA", value: 50, color: "Neutral" },
+                //     { title: "APAC", value: -20, color: "Neutral" }
+                // ]
             };
 
             that.oCmprsDataTmpl = new ComparisonMicroChartData({

package/src/main/js/sap/ushell/components/tiles/utils.js

@@ -5,10 +5,12 @@
  *
  */
 sap.ui.define([
+    "sap/base/i18n/Localization",
+    "sap/ui/core/Element",
+    "sap/ui/core/Locale",
     "sap/ushell/services/_ClientSideTargetResolution/PrelaunchOperations",
     "sap/ushell/resources",
     "sap/ui/thirdparty/datajs",
-    "sap/ui/core/Core",
     "sap/ui/core/mvc/View",
     "sap/ui/model/json/JSONModel",
     "sap/ui/core/library",
@@ -31,10 +33,12 @@ sap.ui.define([
     "sap/base/Log",
     "sap/ui/core/format/NumberFormat"
 ], function (
+    Localization,
+    Element,
+    Locale,
     PrelaunchOperations,
     resources,
     OData,
-    Core,
     View,
     JSONModel,
     coreLibrary,
@@ -127,7 +131,7 @@ sap.ui.define([
      *
      * @param {object} oTileApi The instance-specific chip API.
      * @param {boolean} bEdit Edit flag
-     * @returns {array} atileActionsRows Returns tile navigation actions array. Example: [{action: "" icon: "sap-icon://Fiori2/F0101"
+     * @returns {object[]} atileActionsRows Returns tile navigation actions array. Example: [{action: "" icon: "sap-icon://Fiori2/F0101"
      *          isTargetTypeIntent: false menu_title: "action1" navigation_target: "http://google.co.in" target_type: "URL"} {action: "action" icon:
      *          "sap-icon://Fiori2/F0212" isTargetTypeIntent: true menu_title: "action2" navigation_target: "AccessControlRole" target_type:
      *          "Intent"}] Empty row Example: [{menu_title: "" , target_type: "URL", navigation_target: "", action: "", icon: "", isTargetTypeIntent:
@@ -154,7 +158,7 @@ sap.ui.define([
      * This function will be called by runtime Returns tile navigation actions array
      *
      * @param {object} oTileApi The instance-specific chip API.
-     * @returns {array} aTileNavigationActions Returns tile navigation actions array. Actions title text will be translated text Example: [{icon:
+     * @returns {object[]} aTileNavigationActions Returns tile navigation actions array. Actions title text will be translated text Example: [{icon:
      *          "sap-icon://Fiori2/F0211", targetURL: "https://www.google.co.in", text: "action1"}, {icon: "sap-icon://Fiori2/F0210", targetURL:
      *          "#AccessControlRole-action", text: "action2"}]
      */
@@ -212,8 +216,8 @@ sap.ui.define([
     /**
      * This function will be called during save operation. Build the tile actions array according to the entries of the table.
      *
-     * @param {array} aTableContent Tile Navigation Actions array
-     * @returns {array} aTileNavigationActions Returns tile navigation actions array Example for two rows data. First row:Target_Type: URL, second row
+     * @param {object[]} aTableContent Tile Navigation Actions array
+     * @returns {object[]} aTileNavigationActions Returns tile navigation actions array Example for two rows data. First row:Target_Type: URL, second row
      *          Target_Type: Intent: [{icon: "sap-icon://Fiori2/F0211", targetURL: "https://www.google.co.in", text: "action1"}, {icon:
      *          "sap-icon://Fiori2/F0210", targetURL: "#AccessControlRole-action", text: "action2"}]
      */
@@ -252,7 +256,7 @@ sap.ui.define([
      * Saves the tile navigation actions in to the bag.
      *
      * @param {object} tileNavigationActionsBag Bag into which the tile navigation actions has to be saved
-     * @param {Array} aNavigationProperties Array of tile navigation actions
+     * @param {object[]} aNavigationProperties Array of tile navigation actions
      */
     oUtils.populateTileNavigationActionsBag = function (tileNavigationActionsBag, aNavigationProperties) {
         // Stringify the array and populate it to the bag as a property, tile_navigation_actions
@@ -310,7 +314,7 @@ sap.ui.define([
     /**
      * Returns a boolean which indicates if there are invalid sap-prelaunch-operations parameters or not.
      *
-     * @param {array} aTableContent The array of all parameters
+     * @param {object[]} aTableContent The array of all parameters
      * @returns {boolean} Returns true when there are no invalid sap-prelaunch-operations parameters, otherwise returns false
      *
      * @since 1.69.0
@@ -1061,7 +1065,7 @@ sap.ui.define([
 
         // If the flag isTileActions is true, then it's tile actions icon field. read the value from event.
         if (isTileActions) {
-            oTileActionsIcon = Core.byId(oEvent.getParameter("id"));
+            oTileActionsIcon = Element.getElementById(oEvent.getParameter("id"));
             sIcon = oTileActionsIcon.getValue();
         } else {
             sIcon = oModel.getProperty("/config/display_icon_url");
@@ -1149,7 +1153,7 @@ sap.ui.define([
         });
 
         if (isTileActions) {
-            oSemanticObjectSelector = Core.byId(oEvent.getParameter("id"));
+            oSemanticObjectSelector = Element.getElementById(oEvent.getParameter("id"));
         } else {
             // action tile uses 'semantic_objectInput', dynamic/static tile use 'navigation_semantic_objectInput'
             oSemanticObjectSelector = oView.byId("semantic_objectInput") || oView.byId("navigation_semantic_objectInput");
@@ -1207,7 +1211,7 @@ sap.ui.define([
         });
 
         if (isTileActions) {
-            oActionSelector = Core.byId(oEvent.getParameter("id"));
+            oActionSelector = Element.getElementById(oEvent.getParameter("id"));
         } else {
             // action tile uses 'semantic_objectInput', dynamic/static tile use 'navigation_semantic_objectInput'
             oActionSelector = oView.byId("semantic_actionInput") || oView.byId("navigation_semantic_actionInput");
@@ -1446,7 +1450,7 @@ sap.ui.define([
      */
     oUtils.onTargetTypeChange = function (oTargetTypeComboBox) {
         var sId = oTargetTypeComboBox.getParameter("id");
-        var aParentCells = Core.byId(sId).getParent().getCells();
+        var aParentCells = Element.getElementById(sId).getParent().getCells();
 
         var sTargetType = oTargetTypeComboBox.getSource().getSelectedKey(); // ('newValue');
         if (sTargetType === "INT") {
@@ -1968,7 +1972,7 @@ sap.ui.define([
      *
      * @param {object} oConfigController the configuration controller
      * @param {object} oSemanticObjectSelector the view of the selection control
-     * @param {array} aDefaultValuesOverride if given, the default values that are in any case selectable ("*" and "") are overwritten. Must be in
+     * @param {object[]} aDefaultValuesOverride if given, the default values that are in any case selectable ("*" and "") are overwritten. Must be in
      *        form <code>[{targetObject: "{semantic object id}", targetName: "{textual representation}"}]</code>
      * @private
      */
@@ -2763,8 +2767,8 @@ sap.ui.define([
 
             if (bEdit && oTileApi.bag) {
                 var orgLocale = oTileApi.bag.getOriginalLanguage();
-                var localeLogonLanguage = Core.getConfiguration().getLocale().getSAPLogonLanguage();
-                var language = Core.getConfiguration().getLanguage();
+                var localeLogonLanguage = new Locale(Localization.getLanguageTag()).getSAPLogonLanguage();
+                var language = Localization.getLanguage();
                 oConfig.isLocaleSuitable =
                     orgLocale === "" || orgLocale.toLowerCase() === localeLogonLanguage.toLowerCase() || orgLocale.toLowerCase() === language.toLowerCase();
                 oConfig.orgLocale = orgLocale;