@openui5/sap.ui.mdc 1.102.1 → 1.103.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/sap.ui.mdc",
-  "version": "1.102.1",
+  "version": "1.103.0",
   "description": "OpenUI5 UI Library sap.ui.mdc",
   "author": "SAP SE (https://www.sap.com)",
   "license": "Apache-2.0",
@@ -14,8 +14,8 @@
     "url": "https://github.com/SAP/openui5.git"
   },
   "dependencies": {
-    "@openui5/sap.m": "1.102.1",
-    "@openui5/sap.ui.core": "1.102.1",
-    "@openui5/sap.ui.layout": "1.102.1"
+    "@openui5/sap.m": "1.103.0",
+    "@openui5/sap.ui.core": "1.103.0",
+    "@openui5/sap.ui.layout": "1.103.0"
   }
 }

package/src/sap/ui/mdc/.library

@@ -6,7 +6,7 @@
 	<copyright>OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.</copyright>
-	<version>1.102.1</version>
+	<version>1.103.0</version>
 
 	<documentation>UI5 library: sap.ui.mdc</documentation>
 

package/src/sap/ui/mdc/ActionToolbar.js

@@ -31,7 +31,7 @@ sap.ui.define([
 	 * @class The column for the metadata driven table, that hold the template to be shown when the rows has data.
 	 * @extends sap.m.OverflowToolbar
 	 * @author SAP SE
-	 * @version 1.102.1
+	 * @version 1.103.0
 	 * @constructor
 	 * @private
 	 * @since 1.58

package/src/sap/ui/mdc/AggregationBaseDelegate.js

@@ -101,6 +101,17 @@ sap.ui.define(['sap/ui/mdc/BaseDelegate', 'sap/ui/core/library'], function (Base
 				/* Please provide a meaningful message here. */
 				message: undefined
 			};
+		},
+
+		/**
+		 * Hook that will be executed is called when changes are done applying to controls during the XML flexibility change appliance process.
+		 *
+		 * @param {Object<sap.ui.mdc.Control>} oControl Instance of an MDC control
+		 * @param {Object} mPropertyBag Property bag from SAPUI5 flexibility
+		 *
+		 */
+		onAfterXMLChangeProcessing: function(oControl, mPropertyBag) {
+			//Neccessary cleanups can be implemented here
 		}
 
 

package/src/sap/ui/mdc/Chart.js

@@ -57,12 +57,12 @@ sap.ui.define([
         /**
          * Constructor for a new Chart.
          *
-         * @param {string} [sId] id for the new control, generated automatically if no id is given
-         * @param {object} [mSettings] initial settings for the new control
+         * @param {string} [sId] ID for the new control, generated automatically if no id is given
+         * @param {object} [mSettings] Initial settings for the new control
          * @class The Chart control creates a chart based on metadata and the configuration specified.
          * @extends sap.ui.mdc.Control
          * @author SAP SE
-         * @version 1.102.1
+         * @version 1.103.0
          * @constructor
          * @experimental As of version ...
          * @private
@@ -70,7 +70,6 @@ sap.ui.define([
          * @MDC_PUBLIC_CANDIDATE
          * @since 1.88
          * @alias sap.ui.mdc.Chart
-         * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
          */
         var Chart = Control.extend("sap.ui.mdc.Chart", /** @lends sap.ui.mdc.Chart.prototype */ {
             metadata: {
@@ -225,13 +224,16 @@ sap.ui.define([
                         group: "Misc",
                         defaultValue: "column"
                     },
+                    /**
+                     * Enables the Details button in the chart toolbar.
+                     */
                     showSelectionDetails: {
                         type: "boolean",
                         group: "Misc",
                         defaultValue: true
                     },
                     /**
-                     * Specifies the filter metadata.<br>
+                     * Specifies the chart metadata.<br>
                      * <b>Note</b>: This property must not be bound.<br>
                      * <b>Note</b>: This property is used exclusively for SAPUI5 flexibility/ Fiori Elements. Do not use it otherwise.
                      *
@@ -243,10 +245,18 @@ sap.ui.define([
                     }
                 },
                 aggregations: {
+                    /**
+                     * This property describes the measures and dimensions visible in the chart.
+                     * Changes in the personalization are also reflected here.
+                     */
                     items: {
                         type: "sap.ui.mdc.chart.Item",
                         multiple: true
                     },
+                    /**
+                     * This aggregation describes actions that are added to the chart toolbar.
+                     * See {@link sap.ui.mdc.actiontoolbar.ActionToolbarAction} for more information.
+                     */
                     actions: {
                         type: "sap.ui.core.Control",
                         multiple: true,
@@ -275,7 +285,7 @@ sap.ui.define([
                         multiple: false
                     },
                     /**
-                     * <code>VariantManagement<code> control for the chart.
+                     * Reference to a {@link sap.ui.fl.variants.VariantManagement} control for the chart.
                      */
                     variant: {
                         type: "sap.ui.fl.variants.VariantManagement",
@@ -284,7 +294,7 @@ sap.ui.define([
                 },
                 associations: {
                     /**
-                     * Control or object which enables the chart to do filtering, such as {@link sap.ui.mdc.FilterBar}.
+                     * Control or object that enables the chart to do filtering, such as {@link sap.ui.mdc.FilterBar}.
                      * Also see {@link sap.ui.mdc.IFilter}.
                      *
                      * @since 1.88
@@ -364,6 +374,16 @@ sap.ui.define([
             this._setPropertyHelperClass(PropertyHelper);
         };
 
+        /**
+         * Defines which personalization options are available in the chart.
+         * Valid options are: "Item", "Sort", "Type".
+         * @param {array} aMode String array containing the p13n options that are available
+         * @returns {sap.ui.mdc.Chart} Reference to <code>this</code> for method chaining
+         *
+         * @experimental
+         * @private
+         * @ui5-restricted Fiori Elements
+         */
         Chart.prototype.setP13nMode = function(aMode) {
             var aSortedKeys = null;
             if (aMode && aMode.length >= 1){
@@ -426,11 +446,6 @@ sap.ui.define([
 
         };
 
-
-        Chart.prototype.isFilteringEnabled = function() {
-            return this.getP13nMode().indexOf("Filter") > -1;
-        };
-
         Chart.prototype.setFilterConditions = function(mConditions) {
             this.setProperty("filterConditions", mConditions, true);
 
@@ -442,6 +457,14 @@ sap.ui.define([
             return this;
         };
 
+        /**
+         * Getter for <code>filterConditions</code> set in the personalization settings.
+         * @returns {array} Filters set in the chart
+         *
+         * @experimental
+         * @private
+         * @ui5-restricted Fiori Elements
+         */
         Chart.prototype.getConditions = function() {
             //may only return conditions if the inner FilterBar has already been initialized
             return this.getInbuiltFilter() ? this.getInbuiltFilter().getConditions() : [];
@@ -454,7 +477,7 @@ sap.ui.define([
         };
 
         /**
-         * Applies given settings onto the MDC Chart, loads the delegate and initializes the MDC Chart
+         * Applies given settings onto the MDC chart, loads the delegate and initializes the MDC chart
          *
          * @param {*} mSettings settings to apply
          *
@@ -501,7 +524,7 @@ sap.ui.define([
         };
 
         /**
-         * Initializes the inner controls of the MDC Chart (toolbar, inner chart)
+         * Initializes the inner controls of the MDC chart (toolbar, inner chart)
          * Inner chart is initialized via the delegate
          */
         Chart.prototype._initInnerControls = function () {
@@ -554,7 +577,7 @@ sap.ui.define([
                         ]
                     });
 
-                    //Sync MDC Chart properties with inner chart
+                    //Sync MDC chart properties with inner chart
                     this._propagatePropertiesToInnerChart();
 
                     this._fnResolveInnerChartBound();
@@ -562,6 +585,15 @@ sap.ui.define([
             }.bind(this));
         };
 
+        /**
+         * Defines the height of the chart.
+         * @param {sap.ui.core.CSSSize} iHeight New height for the chart.
+         * @returns {sap.ui.mdc.Chart} Reference to <code>this</code> for method chaining
+         *
+         * @experimental
+         * @private
+         * @ui5-restricted Fiori Elements
+         */
         Chart.prototype.setHeight = function(iHeight) {
             try {
                 this.getControlDelegate().adjustChartHeight(this);
@@ -587,7 +619,7 @@ sap.ui.define([
         };
 
         /**
-         * Loads the delegate for the MDC Chart
+         * Loads the delegate for the MDC chart
          * @returns {Promise} resolved when delegate is loaded
          */
         Chart.prototype._loadDelegate = function () {
@@ -604,7 +636,8 @@ sap.ui.define([
 
         };
         /**
-         * Gets whether filtering is enabled for p13n
+         * Gets whether filtering is enabled in the personalization dialog.
+         * @returns {boolean} <code>true</code> if filtering enabled, <code>false</code> if otherwise
          *
          * @experimental
          * @private
@@ -615,8 +648,13 @@ sap.ui.define([
         };
 
         /**
-         * Gets the adaption UI for the p13n dialog
-         * @returns {Prmoise} promise that resolves with UI
+         * Gets the adaptation panel for the p13n dialog.
+         * <b>Note:</b> This is only used for  personalization, do not use it otherwise.
+         * @returns {Promise} <code>Promise</code> that resolves with the adaptation panel control
+         *
+         * @experimental
+         * @private
+         * @ui5-restricted sap.ui.mdc
          */
         Chart.prototype.getAdaptationUI = function () {
             return this.getControlDelegate().getAdaptionUI(this);
@@ -739,30 +777,11 @@ sap.ui.define([
             }
         };
 
-        //TODO: Think of a good name
-        Chart.prototype._addItems = function () {
-
-        };
-
         /**
-         * Gets the collection model from the binding information
-         * @returns {object} Object containing the binding information
-         *
-         * @experimental
-         * @private
-         * @ui5-restricted Fiori Elements
-         */
-        Chart.prototype.getCollectionModel = function () {
-            var oBindingInfo = this.getBindingInfo("data");
-            return oBindingInfo ? this.getModel(oBindingInfo.model) : null;
-        };
-
-
-        /**
-         * Can be used to check whether the chart is initialized
-         * After initialization the delegate should be loaded and (in case of autoBindOnInit=true) the inner chart has been created
-         * This does not include the inner chart to be bound. Use <code>innerChartBound</code> for it.
-         * @returns {Promise} Promise that resolves once MDC Chart is initialized. Contains reference to MDC Chart
+         * Checks whether the chart is initialized.
+         * After initialization the delegate is loaded and (in case of <code>autoBindOnInit=true</code>) the inner chart is created.
+         * The inner chart is not bound yet. Use <code>innerChartBound</code> for it.
+         * @returns {Promise} <code>Promise</code> that resolves once MDC chart is initialized. Contains reference to MDC chart
          *
          * @experimental
          * @private
@@ -773,8 +792,8 @@ sap.ui.define([
         };
 
         /**
-         * Can be used to check whether the inner chart is initialized and bound
-         * @returns {Promise} Promise that resolves once MDC Chart is bound
+         * Can be used to check whether the inner chart is initialized and bound.
+         * @returns {Promise} Promise that resolves once MDC chart is bound
          *
          * @experimental
          * @private
@@ -785,7 +804,7 @@ sap.ui.define([
         };
 
         /**
-         * Zooms in the inner chart
+         * Zooms in the inner chart.
          * @param {int} iValue how much steps should be zoomed in
          *
          * @experimental
@@ -801,7 +820,7 @@ sap.ui.define([
         };
 
         /**
-         * Zooms out the inner chart
+         * Zooms out the inner chart.
          * @param {int} iValue how much steps should be zoomed out
          *
          * @experimental
@@ -833,22 +852,49 @@ sap.ui.define([
             return this.getControlDelegate().getZoomState(this);
         };
 
+        /**
+         * Retrieves the selection handler of the inner chart.
+         * @returns {object} Selection handler of the inner chart
+         *
+         * @experimental
+         * @private
+         * @ui5-restricted sap.ui.mdc, sap.fe
+         */
         Chart.prototype.getSelectionHandler = function () {
             return this.getControlDelegate().getInnerChartSelectionHandler(this);
         };
 
+        /**
+         * Retrieves the chart type layout configuration.
+         * <b>Note:</b> This is only used inside personalization.
+         * @returns {object} Layout configuration
+         *
+         * @experimental
+         * @private
+         * @ui5-restricted sap.ui.mdc
+         */
         Chart.prototype.getChartTypeLayoutConfig = function() {
             return this.getControlDelegate().getChartTypeLayoutConfig();
         };
 
+        /**
+         * Retrieves the allowed chart roles for the chart types.
+         * <b>Note:</b> This is only used inside the personalization.
+         * @returns {object} Allowed roles
+         *
+         * @experimental
+         * @private
+         * @ui5-restricted sap.ui.mdc
+         */
         Chart.prototype.getAllowedRolesForKinds = function() {
             return this.getControlDelegate().getAllowedRolesForKinds();
         };
 
         /**
-         * Sets the visibility of the legend
-         * Calls the Delegates <code>setLegendVisible</code>. Never call the delegates function directly as it would not update the Chart Toolbar!
-         * @param {boolean} bVisible true to show legend, false to hide
+         * Sets the visibility of the legend.
+         * Calls <code>setLegendVisible</code> on the delegate.
+         * @param {boolean} bVisible <code>true</code> to show legend, <code>false</code> to hide
+         * @returns {sap.ui.mdc.Chart} Reference to <code>this</code> for method chaining
          *
          * @experimental
          * @private
@@ -871,7 +917,7 @@ sap.ui.define([
         /**
          * Sets the ShowChartTooltip Property
          * @param {boolean} bValue true for visible; false for invisible
-         * @returns {sap.ui.mdc.Chart} the MDC Chart
+         * @returns {sap.ui.mdc.Chart} the MDC chart
          */
         Chart.prototype.setShowChartTooltip = function (bValue) {
             this.setProperty("showChartTooltip", bValue);
@@ -931,7 +977,7 @@ sap.ui.define([
         };
 
         /**
-         * If some properties are set on the MDC Chart while the inner chart is not yet initialized, they need to eb set after initialaization.
+         * If some properties are set on the MDC chart while the inner chart is not yet initialized, they need to eb set after initialaization.
          * This methods gets called after inner chart is ready and takes care of that
          *
          * @private
@@ -946,7 +992,7 @@ sap.ui.define([
         /**
          * Gets information about the current chart type.
          *
-         * @returns {sap.ui.mdc.Chart.ChartTypeInfo} Object containing information about the chart type
+         * @returns {object} object containing information about the chart type
          *
          * @experimental
          * @private
@@ -986,7 +1032,7 @@ sap.ui.define([
 
 
         /**
-         * Sets the MDC Chart to a specific chart type
+         * Sets the MDC chart to a specific chart type
          * @param {string} sChartType the name of the new chart type
          * @returns {sap.ui.mdc.chart} reference to <code>this</code> for method chaining
          */
@@ -1008,7 +1054,7 @@ sap.ui.define([
          *
          * @experimental
          * @private
-         * @ui5-restricted Fiori Elements
+         * @ui5-restricted sap.ui.mdc
          */
         Chart.prototype.getManagedObjectModel = function () {
             return this._oManagedObjectModel;
@@ -1137,7 +1183,7 @@ sap.ui.define([
 
         /**
 		 * Callback for when fuilters changed
-		 * Activates the overlay on the MDC Chart
+		 * Activates the overlay on the MDC chart
 		 *
 		 * @param oEvent filter changed event
 		 *
@@ -1185,6 +1231,16 @@ sap.ui.define([
 			}
 		};
 
+        /**
+         * Adds an action to the <code>actions</code> aggregation of the chart.
+         * If the given control is not of type {@link sap.ui.mdc.actiontoolbar.ActionToolbarAction}, a container is created for the control before passing it on to the {@link sap.ui.mdc.ActionToolbar}.
+         * @param {sap.ui.core.Control} oControl to add to the aggregation
+         * @return {sap.ui.mdc.Chart} Reference to <code>this</code> for method chaining.
+         *
+         * @experimental
+         * @private
+         * @ui5-restricted sap.ui.mdc, sap.fe
+         */
         Chart.prototype.addAction = function(oControl) {
             if (oControl.getMetadata().getName() !== "sap.ui.mdc.actiontoolbar.ActionToolbarAction") {
                 oControl = new ActionToolbarAction(oControl.getId() + "-action", {