@openui5/sap.ui.mdc 1.97.1 → 1.100.0

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

@@ -1,91 +0,0 @@
-/*!
- * 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(['./library'],
-    function(library) {
-        "use strict";
-
-        /**
-         * Chart renderer.
-         * @namespace
-         */
-        var ChartRenderer = {
-            apiVersion: 2
-        };
-
-        /**
-         * CSS class to be applied to the HTML root element of the control.
-         *
-         * @readonly
-         * @const {string}
-         */
-        ChartRenderer.CSS_CLASS = "sapUiMDCChart";
-
-        /**
-         * Renders the HTML for the given control, using the provided {@link sap.ui.core.RenderManager}.
-         *
-         * @param {sap.ui.core.RenderManager} oRm The RenderManager that can be used for writing to the render output buffer
-         * @param {sap.ui.core.Control} oInnerChart An object representation of the control that should be rendered
-         */
-        ChartRenderer.render = function(oRm, oMDCChart) {
-                oRm.openStart("div", oMDCChart);
-                //TODO: Clarify why writeControlData doesn't work on rerender
-                oRm.attr("id", oMDCChart.getId());
-                oRm.class(ChartRenderer.CSS_CLASS);
-                //oRm.class("sapUiFixFlex");
-                //oRm.style("overflow", "hidden");
-                oRm.style("height", oMDCChart.getHeight());
-                oRm.style("width", oMDCChart.getWidth());
-                oRm.style("min-height", oMDCChart.getMinHeight());
-                oRm.style("min-width", oMDCChart.getMinWidth());
-                oRm.openEnd();
-                this.renderToolbar(oRm, oMDCChart.getAggregation("_toolbar"));
-                this.renderBreadcrumbs(oRm, oMDCChart.getAggregation("_breadcrumbs"));
-                //this.renderInnerChart(oRm, oMDCChart._getInnerChart());
-                this.renderInnerStructure(oRm, oMDCChart.getAggregation("_innerChart"));
-                oRm.close("div");
-        };
-
-        ChartRenderer.renderNoDataStruct = function(oRm, oNoDataStruct) {
-            if (oNoDataStruct) {
-               /*oRm.openStart("div");
-                oRm.class("sapUiFixFlexFlexibleContainer");
-                oRm.openEnd();
-                oRm.renderControl(oNoDataStruct);
-                oRm.close("div");*/
-            }
-        };
-
-        ChartRenderer.renderToolbar = function(oRm, oToolbar) {
-
-            if (oToolbar) {
-                oRm.openStart("div");
-                oRm.class("sapUiFixFlexFixed");
-                oRm.openEnd();
-                oRm.renderControl(oToolbar);
-                oRm.close("div");
-            }
-        };
-
-        ChartRenderer.renderBreadcrumbs = function(oRm, oDrillBreadcrumbs) {
-
-            if (oDrillBreadcrumbs) {
-                oRm.renderControl(oDrillBreadcrumbs);
-            }
-        };
-
-        ChartRenderer.renderInnerChart = function(oRm, oInnerChart) {
-
-            if (oInnerChart) {
-                oRm.renderControl(oInnerChart);
-            }
-        };
-        ChartRenderer.renderInnerStructure = function (oRm, oInnerStructure){
-            oRm.renderControl(oInnerStructure);
-        };
-
-        return ChartRenderer;
-    }, true);

package/src/sap/ui/mdc/chart/DimensionItem.js

@@ -1,281 +0,0 @@
-/*
- * !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([
-	"./Item", 'sap/ui/base/SyncPromise', "sap/ui/mdc/library"
-], function(Item, SyncPromise, MDCLib) {
-	"use strict";
-
-	var DimensionClass, TimeDimensionClass, HierachyDimensionClass;
-	var _SUPPORTED_ROLE = {
-		category: true,
-		category2: true,
-		series: true
-	};
-
-	// Provides the Item class.
-	/**
-	 * Constructor for a new Item.
-	 *
-	 * @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 Item for the field/property metadata used within MDC controls, an instance can be created to override the default/metadata
-	 *        behavior.
-	 *        <h3><b>Note:</b></h3>
-	 *        The control is experimental and the API/behaviour is not finalised and hence this should not be used for productive usage.
-	 * @extends sap.ui.mdc.chart.Item
-	 * @author SAP SE
-	 * @private
-	 * @experimental As of version 1.61
-	 * @ui5-restricted sap.ui.mdc
-	 * @since 1.61
-	 * @alias sap.ui.mdc.chart.DimensionItem
-	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
-	 */
-	var DimensionItem = Item.extend("sap.ui.mdc.chart.DimensionItem", /** @lends sap.ui.mdc.chart.DimensionItem.prototype */
-	{
-		metadata: {
-			"abstract": true,
-			library: "sap.ui.mdc",
-			properties: {
-				/**
-				 * Function returning a formatted text for a item key value that will be used for axis labelling. If specified, this property takes precedence over the "textProperty" property of the item.
-				 * item key value and the corresponding text will be passed to the supplied function as parameters.
-				 */
-				textFormatter: {
-					type: "function"
-				},
-				/**
-				 * Text for a item key value, typically by a pointer using the binding syntax to some property containing the text.
-				 *
-				 * <b>NOTE:</b> This property was bound internally if automatically created via metadata of oData service and please call "unbindProperty" before setting.
-				 */
-				textProperty: {
-					type: "string"
-				},
-				/**
-				 * Whether a text is displayed. If the "textProperty" property has not been specified, it will be derived from the metadata.
-				 */
-				displayText: {
-					type: "boolean",
-					defaultValue: true
-				},
-				role: {
-					type: "string",
-					defaultValue: "category"
-				},
-				/**
-				 * Specifies whether item as a dimension is part of the inResult of inner chart
-				 */
-				inResult: {
-					type: "boolean",
-					defaultValue: false
-				},
-				/**
-				 * The level for hierachy dimension
-				 */
-				level: {
-					type: "int",
-					defaultValue: undefined
-				},
-				/**
-				 * The time unit @link sap.chart.TimeUnitType
-				 */
-				timeUnit: {
-					type: "string",
-					defaultValue: undefined
-				},
-				/**
-				 * The criticality for coloring
-				 *
-				 * @since 1.64
-				 */
-				criticality: {
-					type: "object",
-					multiple: "false"
-				}
-			}
-		}
-	});
-
-	/**
-	 * Translate mdc dimension item settings to viz chart dimension settings
-	 *
-	 * @param mMetadata
-	 * @return {{role: *, name: *, label: *}}
-	 *
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	DimensionItem.prototype.getSettings = function(mMetadata) {
-		var mSettings = {
-			label: this.getLabel() || mMetadata.label,
-			role: this.getRole(),
-			name: this.getKey(),
-			textProperty: this.getTextProperty(),
-			displayText: this.getDisplayText()
-		};
-
-		if (this._isHierarchyDimension()) {
-			mSettings.level = this.getLevel();
-		}
-
-		return mSettings;
-	};
-
-	/**
-	 * Pushes updates on the item to the inner chart
-	 *
-	 * @param {object} oChart chart to push the update to
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	DimensionItem.prototype.toChart = function(oChart) {
-		return new SyncPromise(function(resolve) {
-			this._oVizItem = oChart.getDimensionByName(this.getKey());
-			if (this._oVizItem) {
-				var sOldRole = this._oVizItem.getRole();
-				this._oVizItem.setRole(this.getRole());
-				if (this._observer) {
-					this._observer.propertyChange(this, "role", sOldRole, this.getRole());
-				}
-				resolve(this);
-			} else {
-				this.toVizChartItem().then(function(oItem) {
-					this._oVizItem = oItem;
-					oChart.addDimension(this._oVizItem, true);
-					if (this._observer) {
-						this._observer.propertyChange(this, "role", null, this.getRole());
-					}
-					resolve(this);
-				}.bind(this));
-			}
-		}.bind(this));
-	};
-
-	/**
-	 * Returns a promise that resolves to a Vizchart Item with given metadata
-	 *
-	 * @param mMetadata given metadata for the item
-	 * @returns {sap.ui.base.SyncPromise} resolves to Vizchart Item
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	DimensionItem.prototype.toVizChartItem = function(mMetadata) {
-		if (!this._pToVizItem) {
-			this._pToVizItem = new SyncPromise(function(resolve) {
-				mMetadata = mMetadata || {};
-				var DimInstanceClass, sDimInstanceClass, oVizItem;
-				if (this._isHierarchyDimension()) {
-					DimInstanceClass = HierachyDimensionClass;
-					sDimInstanceClass = "sap/chart/data/HierarchyDimension";
-				} else if (this._isTimeDimension()) {
-					DimInstanceClass = TimeDimensionClass;
-					sDimInstanceClass = "sap/chart/data/TimeDimension";
-				} else {
-					DimInstanceClass = DimensionClass;
-					sDimInstanceClass = "sap/chart/data/Dimension";
-				}
-
-				if (DimInstanceClass) {
-					oVizItem = new DimInstanceClass(this.getSettings(mMetadata));
-					resolve(oVizItem);
-				} else {
-					sap.ui.require([
-						sDimInstanceClass
-					], function(DimensionClassLoaded) {
-						DimInstanceClass = DimensionClassLoaded;
-						oVizItem = new DimInstanceClass(this.getSettings(mMetadata));
-						resolve(oVizItem);
-					}.bind(this));
-				}
-			}.bind(this));
-		}
-
-		return this._pToVizItem;
-	};
-
-	/**
-	 * Role of the inner chart item, see @sap.ui.mdc.ChartItemRoleType
-	 * @param vRole The role of the inner chart item
-	 * @returns {this} reference to <code>this</code> for method chaining
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	DimensionItem.prototype.setRole = function(vRole) {
-		if (!_SUPPORTED_ROLE[vRole]) {
-			throw new TypeError("Invalide Measure role: " + vRole);
-		}
-
-		this.setProperty("role", vRole, true);
-
-		var oChart = this.getParent();
-		//now changing the role may affect a change of the type
-
-		if (oChart) {
-			oChart.oChartPromise.then(function(oVizChart) {
-				this.toChart(oVizChart);
-			}.bind(this));
-		}
-
-		return this;
-	};
-
-	/**
-	 *
-	 * @return {string} The type of the inner charts item which can be 'Dimension' or 'Measure'
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	DimensionItem.prototype.getVizItemType = function() {
-		return MDCLib.ChartItemType.Dimension;
-	};
-
-	/**
-	 *
-	 * @return {boolean} <code>true</code> if the item is a hierarchy dimension
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	DimensionItem.prototype._isHierarchyDimension = function() {
-		return false;
-	};
-
-	/**
-	 *
-	 * @return {boolean} <code>true</code> if the item is a time dimension
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	DimensionItem.prototype._isTimeDimension = function() {
-		if (this.getVizItemType() == "Measure") {
-			return false;
-		}
-
-		switch (this.getType()) {
-			case "date":
-			case "time":
-			case "datetime":
-				return true;
-			default:
-				return false;
-		}
-	};
-
-	return DimensionItem;
-
-}, true);

package/src/sap/ui/mdc/chart/MeasureItem.js

@@ -1,318 +0,0 @@
-/*
- * !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([
-	"./Item", 'sap/ui/base/SyncPromise', "sap/ui/mdc/library"
-], function(Item, SyncPromise, MDCLib) {
-	"use strict";
-
-	var MeasureClass;
-	var _SUPPORTED_ROLE = {axis1:true,axis2:true,axis3:true};
-
-	// Provides the Item class.
-	/**
-	 * Constructor for a new measure Item.
-	 *
-	 * @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 Item for the field/property metadata used within MDC controls, an instance can be created to override the default/metadata
-	 *        behavior.
-	 *        <h3><b>Note:</b></h3>
-	 *        The control is experimental and the API/behaviour is not finalised and hence this should not be used for productive usage.
-	 * @extends sap.ui.mdc.chart.Item
-	 * @author SAP SE
-	 * @private
-	 * @experimental As of version 1.61
-	 * @ui5-restricted sap.ui.mdc
-	 * @since 1.61
-	 * @alias sap.ui.mdc.chart.MeasureItem
-	 * @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
-	 */
-	var MeasureItem = Item.extend("sap.ui.mdc.chart.MeasureItem", /** @lends sap.ui.mdc.chart.MeasureItem.prototype */
-		{
-			metadata: {
-				"abstract": true,
-				library: "sap.ui.mdc",
-				properties: {
-					/**
-					 * The property path of the chart item which may differ from the corresponsing property
-					 */
-					propertyPath: {
-						type: "string"
-					},
-					/**
-					 * How values of Measure will be rendered in the chart. Possible role values are {@link sap.chart.data.MeasureRoleType axis1}, {@link sap.chart.data.MeasureRoleType axis2}, {@link sap.chart.data.MeasureRoleType axis3}, and {@link sap.chart.data.MeasureRoleType axis4}.
-					 * The default is {@link sap.chart.data.MeasureRoleType axis1}.
-					 * They correspond to the well-known concepts of axis identifiers in the Cartesian coordinate system, e.g. a Y-axis in a bar/column/line chart, an X- and a Y-axis in a scatter chart, or two Y-axes in bar charts, and an optional third axis for the weight/size/intensity/temperature of a data point.
-					 *
-					 * You can create a new measure as follow:
-					 * <pre>
-					 * ...
-					 * new sap.chart.data.Measure({name: "MEASURE1", role: sap.chart.data.MeasureRoleType.axis1})
-					 * ...
-					 * </pre>
-					 *
-					 * Detailed usage of measure role. Please refer to {@link sap.chart.data.MeasureRoleType MeasureRoleType}
-					 *
-					 * <b>NOTE:</b> Role definition would not work for Bullet Chart and users need to set semantics instead.
-					 */
-					role: {
-						type: "string",
-						defaultValue: "axis1"
-					},
-					/**
-					 * The measures data point for coloring
-					 *
-					 * A data point is an object that defines relation between measures and criticality
-					 * it is inspired by a @com.sap.vocabularies.UI.v1.DataPoint used in the odata protocol
-					 *
-					 * Its structure is:
-					 * <ul>
-					 *     <li> targetValue: the target value (path to reference measure)</li>
-					 *     <li> foreCastValue: the forcast value (path to a projected measure) </li>
-					 *     <li> criticality: the criticality object</li>
-					 * </ul>
-					 * @since 1.64
-					 */
-					dataPoint: {
-						type: "object"
-					},
-					/**
-					 * The aggregation method which depends on the data service.
-					 *
-					 * For OData based services this can be <code>min,max,sum,average</code>
-					 */
-					aggregationMethod: {
-						type: "string",
-						defaultValue: undefined
-					}
-				}
-			}
-		});
-
-	MeasureItem.prototype.getCriticality = function() {
-		var oDataPoint = this.getDataPoint();
-
-		return oDataPoint ? oDataPoint.criticality : null;
-	};
-
-	/**
-	 * Set the data point for coloring.
-	 *
-	 * Note the 'dataPoint' property is final
-	 * @param oValue
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.prototype.setDataPoint = function(oValue) {
-		if (!this.isPropertyInitial("dataPoint")) {
-			throw new Error("Data point is readonly");
-		}
-
-		return this.setProperty("dataPoint", oValue);
-	};
-
-	/**
-	 * Creates a vizChart Item with given settings
-	 *
-	 * @param {*} mSettings settings for the item
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.createVizChartItem = function(mSettings) {
-		return new SyncPromise(function(resolve) {
-			var oVizItem;
-			if (MeasureClass) {
-				oVizItem = new MeasureClass(mSettings);
-				resolve(oVizItem);
-			} else {
-				sap.ui.require(["sap/chart/data/Measure"],
-					function (MeasureClassLoaded) {
-						MeasureClass = MeasureClassLoaded;
-						oVizItem = new MeasureClass(mSettings);
-						resolve(oVizItem);
-					});
-			}
-		});
-	};
-
-	/**
-	 * Translate mdc measure item settings to viz chart measure settings
-	 *
-	 * @param mMetadataSettings
-	 * @return {{role: *, name: *, label: *}}
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.getVizItemSettings = function(mMetadataSettings) {
-		var mSettings = {
-			label: mMetadataSettings.label,
-			role: mMetadataSettings.role || "axis1",
-			name: mMetadataSettings.key
-		};
-
-		var sAggregationMethod = mMetadataSettings.aggregationMethod;
-		if (sAggregationMethod) {
-			mSettings.analyticalInfo = {
-				"with": sAggregationMethod,
-				propertyPath: mMetadataSettings.propertyPath
-			};
-		}
-
-		return mSettings;
-	};
-
-	/**
-	 * Retrieve the setting for translating the measure item to a viz chart measure
-	 *
-	 * @param mMetadataSettings
-	 * @return {*}
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.prototype.getSettings = function(mMetadataSettings) {
-		if (mMetadataSettings && mMetadataSettings.key == this.getKey()) {
-			mMetadataSettings.label = this.getLabel() || mMetadataSettings.label;
-			mMetadataSettings.role = this.getRole();
-		} else {
-			mMetadataSettings = {
-				key: this.getKey(),
-				label: this.getLabel(),
-				role: this.getRole(),
-				propertyPath: this.getPropertyPath(),
-				aggregationMethod: this.getAggregationMethod(),
-				dataPoint: this.getDataPoint()
-			};
-		}
-
-		return MeasureItem.getVizItemSettings(mMetadataSettings);
-	};
-
-	/**
-	 * Pushes updates on the item to the inner chart
-	 *
-	 * @param {object} oChart chart to push the update to
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.prototype.toChart = function(oChart) {
-		return new SyncPromise(function(resolve) {
-			var oVizItem = oChart.getMeasureByName(this.getKey());
-			if (oVizItem) {
-				var sOldRole = oVizItem.getRole();
-				oVizItem.setRole(this.getRole());
-				if (this._observer) {
-					this._observer.propertyChange(this, "role", sOldRole, this.getRole());
-				}
-			} else {
-				this.toVizChartItem().then(function (oItem) {
-					oChart.addMeasure(oItem, true);
-					if (this._observer) {
-						this._observer.propertyChange(this, "role", null, this.getRole());
-					}
-				}.bind(this));
-			}
-		}.bind(this));
-	};
-
-	/**
-	 * Returns a promise that resolves to a Vizchart Item with given metadata
-	 *
-	 * @param mMetadata given metadata for the item
-	 * @returns {sap.ui.base.SyncPromise} resolves to Vizchart Item
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.prototype.toVizChartItem = function(mMetadata) {
-		if (!this._pToVizItem) {
-			this._pToVizItem = new SyncPromise(function (resolve) {
-				mMetadata = mMetadata || {};
-				MeasureItem.createVizChartItem(this.getSettings(mMetadata)).then(function(oVizItem) {
-					resolve(oVizItem);
-				});
-			}.bind(this));
-		}
-
-		return this._pToVizItem;
-	};
-
-
-	/**
-	 * Role of the inner chart item, see @sap.ui.mdc.ChartItemRoleType
-	 * @param vRole The role of the inner chart item
-	 * @return {this} reference to the <code>MeasureItem</code> for method chaining
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.prototype.setRole = function(vRole) {
-		if (!_SUPPORTED_ROLE[vRole]) {
-			throw new TypeError("Invalide Measure role: " + vRole);
-		}
-
-		this.setProperty("role", vRole, true);
-
-		var oChart = this.getParent();
-		//now changing the role may affect a change of the type
-
-		if (oChart) {
-			oChart.oChartPromise.then(function(oVizChart) {
-				this.toChart(oVizChart);
-			}.bind(this));
-		}
-
-		return this;
-	};
-
-	/**
-	 * Gets the type of the item (dimension or measure)
-	 *
-	 * @return {string} The type of the inner charts item which can be 'Dimension' or 'Measure'
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.prototype.getVizItemType = function() {
-		return MDCLib.ChartItemType.Measure;
-	};
-
-	/**
-	 * Retrieve the additional measures from coloring for initially equiping the chart
-	 * @param mItems
-	 * @return {Array}
-	 *
-	 * @experimental
-	 * @private
-	 * @ui5-restricted sap.ui.mdc
-	 */
-	MeasureItem.prototype.getAdditionalColoringMeasures = function() {
-		var aAdditional = [];
-
-		var oCriticality = this.getCriticality();
-
-		if (oCriticality && oCriticality.DynamicThresholds) {
-			aAdditional = oCriticality.DynamicThresholds.usedMeasures;
-		}
-
-		return aAdditional;
-	};
-
-	return MeasureItem;
-
-}, true);