@openui5/sap.ui.mdc 1.97.1 → 1.100.0

package/src/sap/ui/mdc/odata/v4/ChartDelegate.js

@@ -1,489 +1,35 @@
-/*!
- * OpenUI5
+/*
+ * ! OpenUI5
  * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
 sap.ui.define([
-	"sap/ui/mdc/library",
-	"sap/ui/mdc/ChartDelegate",
-	"sap/ui/base/SyncPromise",
-	"./ODataMetaModelUtil",
-	"sap/base/util/merge",
-	'sap/ui/core/Core',
-	'sap/ui/mdc/util/FilterUtil',
-	'sap/ui/mdc/odata/v4/util/DelegateUtil',
-	'sap/ui/mdc/odata/v4/TypeUtil'
-], function(
-	MDCLib,
-	BaseChartDelegate,
-	SyncPromise,
-	MetaModelUtil,
-	merge,
-	Core,
-	FilterUtil,
-	DelegateUtil,
-	TypeUtil
+    "../../ChartDelegate",
+    "../../util/loadModules",
+    "../../library",
+    "sap/ui/core/Core"
+], function (
+    ChartDelegate,
+    loadModules,
+    library,
+    Core
 ) {
-	"use strict";
-
-	/**
-	 * @readonly
-	 * @const {string}
-	 */
-	var AGGREGATION_ANNO = "@Org.OData.Aggregation.V1";
-
-	function fillHeadData(aHeadData) {
-		this.name = aHeadData[0];
-		this.label = aHeadData[1] instanceof Object ? aHeadData[1]["$Path"] : aHeadData[1] || this.name;
-		this.textProperty = aHeadData[2];
-		this.type = TypeUtil.getPrimitiveType(aHeadData[3]);
-
-		if (aHeadData[4] || aHeadData[5]) {
-			var sCalendarTag = aHeadData[4], sFiscalTag = aHeadData[5];
-
-			if (sFiscalTag) {
-
-				//fiscal tag is stronger than calendarTag
-				switch (sFiscalTag) {
-
-					case "year":
-						this.timeUnit = "fiscalyear";
-						break;
-
-					case "yearPeriod":
-						this.timeUnit = "fiscalyearperiod";
-						break;
-
-					default:
-						this.timeUnit = undefined;
-						break;
-				}
-			}
-
-			if (sCalendarTag && !this.timeUnit) {
-
-				switch (sCalendarTag) {
-
-					case "yearMonth":
-						this.timeUnit = "yearmonth";
-						break;
-
-					case "date":
-						this.timeUnit = "yearmonthday";
-						break;
-
-					case "yearQuarter":
-						this.timeUnit = "yearquarter";
-						break;
-
-					case "yearWeek":
-						this.timeUnit = "yearweek";
-						break;
-
-					default:
-						this.timeUnit = undefined;
-						break;
-				}
-			}
-
-		}
-
-		this.criticality = aHeadData[6];
-		return this;
-	}
-
-	function handleProperty(aResults) {
-		var bGroupable = aResults[0], bAggregatable = aResults[1];
-		var oHeadItem = {}, oProperty = {}, oItem;
-
-		oProperty.inChart = bGroupable || bAggregatable || false;
-
-		if (oProperty.inChart) {
-			oProperty.chartItems = [];
-
-			if (bGroupable) {
-				oHeadItem.kind = MDCLib.ChartItemType.Dimension;
-				oHeadItem.role = MDCLib.ChartItemRoleType.category;
-				oItem = merge({}, oHeadItem);
-				oProperty.chartItems.push(oItem);
-			}
-
-			if (bAggregatable) {
-				oHeadItem.kind = MDCLib.ChartItemType.Measure;
-				oHeadItem.role = MDCLib.ChartItemRoleType.axis1;
-				oHeadItem.contextDefiningProperties = aResults[4] || [];
-
-				var aSupportedAggregationMethods = aResults[2] || [],
-					sDefaultAggregationMethod = aResults[3];
-
-				for (var i = 0; i < aSupportedAggregationMethods.length; i++) {
-					oItem = merge({}, oHeadItem);
-					oItem.aggregationMethod = aSupportedAggregationMethods[i] instanceof Object ? aSupportedAggregationMethods[i]["$Path"] : aSupportedAggregationMethods[i];
-					oItem.default = oItem.aggregationMethod == sDefaultAggregationMethod instanceof Object ? sDefaultAggregationMethod[i]["$Path"] : sDefaultAggregationMethod[i];
-					oProperty.chartItems.push(oItem);
-				}
-			}
-		}
-
-		var oMetaModel = this.getModel();
-
-		return Promise.all([
-			oMetaModel.requestObject("@sapui.name", this),
-			oMetaModel.requestObject("@com.sap.vocabularies.Common.v1.Label", this),
-			oMetaModel.requestObject("@com.sap.vocabularies.Common.v1.Text/$Path", this),
-			oMetaModel.requestObject("$Type", this),
-			MetaModelUtil.fetchCalendarTag(oMetaModel,this),
-			MetaModelUtil.fetchFiscalTag(oMetaModel, this),
-			MetaModelUtil.fetchCriticality(oMetaModel, this)
-		]).then(fillHeadData.bind(oProperty));
-	}
-
-	function retrieveItems(oEntity, sPath, oMetaModel, mAnnos) {
-		var sKey, oProperty, aPropertyPromise = [], aItems = [], sPrefix, aProperties = [], bSetFilterable,
-			bSetSortable,  mKnownAggregatableProps = {};
-
-		var mCustomAggregates = MetaModelUtil.getAllCustomAggregates(mAnnos);
-
-		// collect custom aggregates
-		for (var sCustom in mCustomAggregates) {
-
-			aItems.push(merge({}, mCustomAggregates[sCustom], {
-				propertyPath: sCustom,
-				kind: MDCLib.ChartItemType.Measure,
-				role: MDCLib.ChartItemRoleType.axis1,
-				sortable: mCustomAggregates[sCustom].sortable,
-				filterable: mCustomAggregates[sCustom].filterable
-			}));
-		}
-
-		var mTypeAggregatableProps = MetaModelUtil.getAllAggregatableProperties(mAnnos);
-
-		for (var sAggregatable in mTypeAggregatableProps) {
-			sKey = mTypeAggregatableProps[sAggregatable].propertyPath;
-			mKnownAggregatableProps[sKey] = mKnownAggregatableProps[sKey] || {};
-
-			mKnownAggregatableProps[sKey][mTypeAggregatableProps[sAggregatable].aggregationMethod] = {
-				name: mTypeAggregatableProps[sAggregatable].name,
-				label: mTypeAggregatableProps[sAggregatable].label
-			};
-		}
-
-		var oSortRestrictionsInfo = MetaModelUtil.getSortRestrictionsInfo(mAnnos["@Org.OData.Capabilities.V1.SortRestrictions"]),
-			oFilterRestrictionsInfo = MetaModelUtil.getFilterRestrictionsInfo(mAnnos["@Org.OData.Capabilities.V1.FilterRestrictions"]);
-
-		function push(oProperty) {
-			aProperties.push(oProperty);
-
-			// calculate sortable/filterable
-			MetaModelUtil.addSortInfoForProperty(oProperty, oSortRestrictionsInfo);
-			MetaModelUtil.addFilterInfoForProperty(oProperty, oFilterRestrictionsInfo);
-
-			if (oProperty.inChart) {
-
-				for (var i = 0; i < oProperty.chartItems.length; i++) {
-					var oItem = oProperty.chartItems[i];
-					oItem.propertyPath  = oProperty.name;
-					oItem.type = oProperty.type;
-					oItem.timeUnit = oProperty.timeUnit;
-					oItem.criticality = oProperty.criticality;
-
-					if (oItem.kind == MDCLib.ChartItemType.Measure) {
-
-						var sAggregationMethod = oItem.aggregationMethod instanceof Object ? oItem.aggregationMethod["$Path"] :  oItem.aggregationMethod;
-
-					if (mKnownAggregatableProps[oItem.propertyPath] && mKnownAggregatableProps[oItem.propertyPath][sAggregationMethod]) {
-						oItem.name  = mKnownAggregatableProps[oItem.propertyPath][oItem.aggregationMethod].name;
-						oItem.label = mKnownAggregatableProps[oItem.propertyPath][oItem.aggregationMethod].label;
-					} else {
-						oItem.name = sAggregationMethod + oItem.propertyPath;
-
-						oItem.label = oProperty.label + " (" + sAggregationMethod + ")";
-					}
-
-						oItem.customAggregate = false;
-
-						// in the first wave let us only sort by used items
-						oItem.sortable = true;
-						oItem.sortDirection = "both";
-						oItem.filterable = true;
-					} else {
-						oItem.name = oProperty.name;
-						oItem.textProperty = oProperty.textProperty;
-						oItem.label = oProperty.label;
-
-						// in the first wave let us only sort by used items
-						oItem.sortable = oProperty.sortable;
-						oItem.sortDirection = oProperty.sortDirection;
-
-						// allow filtering on each possible dimension
-						oItem.filterable = oProperty.filterable;
-						oItem.allowedExpressions = oProperty.allowedExpressions;
-					}
-
-					aItems.push(oItem);
-				}
-			}
-		}
-
-		for (sKey in oEntity) {
-
-			if (sKey[0] !== "$") {// no special annotation
-				oProperty = oEntity[sKey];
-
-				if (oProperty && oProperty.$kind && (oProperty.$kind == "Property")) {
-					sPrefix = sPath + sKey + AGGREGATION_ANNO;
-
-					aPropertyPromise.push(
-						Promise.all([
-							oMetaModel.requestObject(sPrefix + ".Groupable"),
-							oMetaModel.requestObject(sPrefix + ".Aggregatable"),
-							oMetaModel.requestObject(sPrefix + ".SupportedAggregationMethods"),
-							oMetaModel.requestObject(sPrefix + ".RecommendedAggregationMethod"),
-							oMetaModel.requestObject(sPrefix + ".ContextDefiningProperties")
-						])
-						.then(handleProperty.bind(oMetaModel.getMetaContext(sPath + sKey)))
-						.then(push)
-					);
-				}
-			}
-		}
-
-		return Promise.all(aPropertyPromise).then(function() {
-			return [bSetSortable, bSetFilterable, aProperties, aItems];
-		});
-	}
-
-	/**
-	 * OData V4 delegate module for the <code>sap.ui.mdc.Chart</code> control.
-	 *
-	 * This module interpret service metadata that represents entity-relationship
-	 * models, service capabilities, and annotations to automatically create
-	 * some chart's inner controls, for example, dimension and measure items.
-	 *
-	 * <b>Note:</b> The module is experimental and is not finalized, hence it should not be used
-	 * productively.
-	 *
-	 * @private
-	 * @experimental
-	 * @alias module:sap/ui/mdc/odata/v4/ChartDelegate
-	 * @since 1.62
-	 * @author SAP SE
-	 */
-	var ChartDelegate = Object.assign({}, BaseChartDelegate);
-
-	/**
-	 * @inheritdoc
-	 */
-	ChartDelegate.MetadataProperty = {
-		kind: "Measure",
-		role: "axis1",
-		contextDefiningProperties: [],
-		className: "sap.ui.mcd.chart.MeasureItem",
-		aggregationMethod: "sum",
-		"default": true,
-		custom: false,
-		name: "sumSalesAmount",
-		propertyPath: "SalesAmount",
-		label: "Total Sales Amount",
-		textProperty: "",
-		sortable: true,
-		sortDirection: "both",
-		filterable: true,
-		allowedExpressions: []
-	};
-
-	/**
-	 * @inheritdoc
-	 */
-	ChartDelegate.fetchProperties = function(oChart) {
-		return this.retrieveAllMetadata(oChart).then(function(oMetadata) {
-			return oMetadata.properties;
-		});
-	};
-
-	/**
-	 * @inheritdoc
-	 */
-	ChartDelegate.retrieveAggregationItem = function(sAggregationName, oMetadata) {
-		var oSettings;
-		var oAggregation = {
-			className: "",
-			settings: {
-				key: oMetadata.name,
-				label: oMetadata.label || oMetadata.name,
-				type: oMetadata.type
-			}
-		};
-
-		switch (oMetadata.kind) {
-
-			case MDCLib.ChartItemType.Dimension:
-				oAggregation.className = "sap.ui.mdc.chart.DimensionItem";
-
-				oSettings = {
-					textProperty: oMetadata.textProperty,
-					timeUnit: oMetadata.timeUnit,
-					displayText: true,
-					criticality: oMetadata.criticality
-				};
-
-				break;
-
-			case MDCLib.ChartItemType.Measure:
-				oAggregation.className = "sap.ui.mdc.chart.MeasureItem";
-
-				oSettings = {
-					propertyPath: oMetadata.propertyPath,
-					aggregationMethod: oMetadata.aggregationMethod
-				};
-
-				break;
-
-			// no default
-		}
-
-		oAggregation.settings = Object.assign(oAggregation.settings, oSettings);
-		return oAggregation;
-	};
-
-	ChartDelegate.getModel = function(oChart) {
-		var vModelName = oChart.getDelegate().model,
-			oModel = oChart.getModel(vModelName);
-
-		if (oModel) {
-			return SyncPromise.resolve(oModel);
-		}
-
-		return new SyncPromise(function(resolve, reject) {
-
-			function onModelContextChange() {
-				var oModel = oChart.getModel(vModelName);
-
-				if (oModel) {
-					oChart.detachModelContextChange(onModelContextChange, oChart);
-					return resolve(oModel);
-				}
-			}
-
-			oChart.attachModelContextChange(onModelContextChange, oChart);
-		});
-	};
-
-	/**
-	 * @inheritdoc
-	 */
-	ChartDelegate.retrieveAllMetadata = function(oChart) {
-		var oModelPromise = this.getModel(oChart);
-
-		function onModelPropagated(oModel) {
-			var oDelegate = oChart.getDelegate(),
-				sPath = "/" + oDelegate.payload.collectionName,
-				oMetaModel = oModel && oModel.getMetaModel();
-
-			if (sPath.endsWith("/")) {
-				throw new Error("The leading path for metadata calculation is the entity set not the path");
-			}
-
-			var sSetPath = sPath,
-				sTypePath = sPath + "/";
-
-			function resolve(aResult) {
-				var oMetadata = {
-					sortable: aResult[0],
-					filterable: aResult[1],
-					attributes: aResult[2],
-					properties: aResult[3]
-				};
-
-				return oMetadata;
-			}
-
-			var aSetAndTypePromise = [
-				oMetaModel.requestObject(sTypePath),
-				oMetaModel.requestObject(sSetPath)
-			];
-
-			return Promise.all(aSetAndTypePromise).then(function(aTypeAndSet) {
-				var oEntity = aTypeAndSet[0];
-				var aAnnotationsPromises = [
-					MetaModelUtil.fetchAllAnnotations(oMetaModel, sTypePath),
-					MetaModelUtil.fetchAllAnnotations(oMetaModel, sSetPath)
-				];
-
-				return Promise.all(aAnnotationsPromises).then(function(aAnnotations) {
-
-					// merge the annotations of set and type and let set overrule
-					var oAnnotations = Object.assign(aAnnotations[0], aAnnotations[1]);
-					return retrieveItems(oEntity, sTypePath, oMetaModel, oAnnotations);
-				});
-
-			}).then(resolve);
-		}
-
-		return oModelPromise.then(onModelPropagated);
-	};
-
-	/**
-	 * Updates the binding info with the relevant filters
-	 *
-	 * @param {Object} oMDCChart The MDC chart instance
-	 * @param {Object} oBindingInfo The binding info of the chart
-	 */
-	ChartDelegate.updateBindingInfo = function(oMDCChart, oBindingInfo) {
-		var oFilter = Core.byId(oMDCChart.getFilter());
-		if (oFilter) {
-			var mConditions = oFilter.getConditions();
-
-			if (mConditions) {
-
-				if (!oBindingInfo) {
-					oBindingInfo = {};
-				}
-
-				var aPropertiesMetadata = oFilter.getPropertyInfoSet ? oFilter.getPropertyInfoSet() : null;
-				var aParameterNames = DelegateUtil.getParameterNames(oFilter);
-				var oFilterInfo = FilterUtil.getFilterInfo(ChartDelegate.getTypeUtil(), mConditions, aPropertiesMetadata, aParameterNames);
-				if (oFilterInfo) {
-					oBindingInfo.filters = oFilterInfo.filters;
-				}
-
-				var sParameterPath = DelegateUtil.getParametersInfo(oFilter);
-				if (sParameterPath) {
-					oBindingInfo.path = sParameterPath;
-				}
-			}
-
-			// get the basic search
-			var sSearchText = oFilter.getSearch instanceof Function ? oFilter.getSearch() :  "";
-			if (sSearchText) {
-
-				if (!oBindingInfo) {
-					oBindingInfo = {};
-				}
-
-				if (!oBindingInfo.parameters) {
-					oBindingInfo.parameters = {};
-				}
-				// add basic search parameter as expected by v4.ODataListBinding
-				oBindingInfo.parameters.$search = sSearchText;
-			}
-		}
-	};
-
-	/**
-	 * Checks the binding of the table and rebinds it if required.
-	 *
-	 * @param {Object} oMDCChart The MDC chart instance
-	 * @param {Object} oBindingInfo The row binding info of the table
-	 */
-	ChartDelegate.rebindChart = function(oMDCChart, oBindingInfo) {
-		BaseChartDelegate.rebindChart(oMDCChart, oBindingInfo);
-	};
-
-	ChartDelegate.getTypeUtil = function (oPayload) {
-		return TypeUtil;
-	};
-
-	return ChartDelegate;
-});
+    "use strict";
+    /**
+     * Delegate class for sap.ui.mdc.Chart and ODataV4.
+     * Enables additional analytical capabilities.
+     * <b>Note:</b> The class is experimental and the API/behavior is not finalized.
+     *
+     * @author SAP SE
+     * @private
+     * @ui5-restricted sap.fe
+     * @MDC_PUBLIC_CANDIDATE
+     * @since 1.88
+     * @alias sap.ui.mdc.odata.v4.ChartDelegate
+     */
+    var Delegate = Object.assign({}, ChartDelegate);
+
+
+    return Delegate;
+});

package/src/sap/ui/mdc/odata/v4/ChartPropertyHelper.js

@@ -0,0 +1,106 @@
+/*
+ * ! OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/mdc/chart/PropertyHelper",
+	"sap/ui/mdc/library"
+], function(
+	PropertyHelperBase,
+	MDCLib
+) {
+	"use strict";
+
+	/**
+	 * Constructor for a new table property helper.
+	 *
+	 * @param {object[]} aProperties The properties to process in this helper
+	 * @param {sap.ui.base.ManagedObject} [oParent] A reference to an instance that will act as the parent of this helper
+	 *
+	 * @class
+	 * Table property helpers give tables of this library a consistent and standardized view on properties and their attributes.
+	 * Validates the given properties, sets defaults, and provides utilities to work with these properties.
+	 * The utilities can only be used for properties that are known to the helper. Known properties are all those that are passed to the constructor.
+	 *
+	 * @extends sap.ui.mdc.chart.PropertyHelper
+	 *
+	 * @author SAP SE
+	 * @version 1.100.0
+	 *
+	 * @private
+	 * @experimental
+	 * @since 1.83
+	 * @alias sap.ui.mdc.table.PropertyHelper
+	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
+	 */
+    var PropertyHelper = PropertyHelperBase.extend("sap.ui.mdc.odata.v4.ChartPropertyHelper");
+
+
+	/**
+	 * Applies defaults and resolves property references.
+	 *
+	 * @param {object} oProperty The property to prepare
+	 * @protected
+	 */
+	PropertyHelper.prototype.prepareProperty = function(oProperty) {
+
+		if (oProperty.groupable) {
+			oProperty.availableRoles = this._getLayoutOptionsForType("groupable");
+			oProperty.kind = "Groupable";
+		} else if (oProperty.aggregatable) {
+			oProperty.availableRoles = this._getLayoutOptionsForType("aggregatable");
+			oProperty.kind = "Aggregatable";
+		}
+
+		if (!oProperty.typeConfig && oProperty.dataType){
+			var oFormatOptions = oProperty.formatOptions ? oProperty.formatOptions : null;
+			var oConstraints = oProperty.constraints ? oProperty.constraints : {};
+
+			oProperty.typeConfig = this.getParent().getControlDelegate().getTypeUtil().getTypeConfig(oProperty.dataType, oFormatOptions, oConstraints);
+		}
+
+		PropertyHelperBase.prototype.prepareProperty.apply(this, arguments);
+
+	};
+
+	/**
+     * This returns the layout options for a specific type of Item (measure/dimension,groupable/aggregatable)
+     * It is used by p13n to determine which layout options to show in the p13n panel
+     * @param {string} sType the type for which the layout options are requested
+     */
+	PropertyHelper.prototype._getLayoutOptionsForType = function(sType){
+	var MDCRb = sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc");
+	var oAvailableRoles = {
+		groupable: [
+			{
+				key: MDCLib.ChartItemRoleType.category,
+				text: MDCRb.getText('chart.PERSONALIZATION_DIALOG_CHARTROLE_CATEGORY')
+			}, {
+				key: MDCLib.ChartItemRoleType.category2,
+				text: MDCRb.getText('chart.PERSONALIZATION_DIALOG_CHARTROLE_CATEGORY2')
+			}, {
+				key: MDCLib.ChartItemRoleType.series,
+				text: MDCRb.getText('chart.PERSONALIZATION_DIALOG_CHARTROLE_SERIES')
+			}
+		],
+		aggregatable: [
+			{
+				key: MDCLib.ChartItemRoleType.axis1,
+				text: MDCRb.getText('chart.PERSONALIZATION_DIALOG_CHARTROLE_AXIS1')
+			}, {
+				key: MDCLib.ChartItemRoleType.axis2,
+				text: MDCRb.getText('chart.PERSONALIZATION_DIALOG_CHARTROLE_AXIS2')
+			}, {
+				key: MDCLib.ChartItemRoleType.axis3,
+				text: MDCRb.getText('chart.PERSONALIZATION_DIALOG_CHARTROLE_AXIS3')
+			}
+		]
+	};
+	return oAvailableRoles[sType];
+};
+
+
+    return PropertyHelper;
+});