@sapui5/sap.gantt 1.125.0 → 1.126.0

package/src/sap/gantt/simple/ShapeScheme.js

@@ -19,7 +19,7 @@ sap.ui.define(['sap/ui/core/Element'], function (Element) {
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @public

package/src/sap/gantt/simple/StockChart.js

@@ -28,7 +28,7 @@ sap.ui.define([
 	 * @extends sap.gantt.simple.UtilizationChart
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 * @since 1.95
 	 *
 	 * @constructor

package/src/sap/gantt/simple/StockChartDimension.js

@@ -23,7 +23,7 @@ sap.ui.define([
  * @extends sap.ui.core.Element
  *
  * @author SAP SE
- * @version 1.125.0
+ * @version 1.126.0
  * @since 1.95
  *
  * @constructor

package/src/sap/gantt/simple/StockChartPeriod.js

@@ -24,7 +24,7 @@ sap.ui.define(["sap/ui/core/Element"], function(Element){
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @public

package/src/sap/gantt/simple/UtilizationBarChart.js

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @extends sap.gantt.simple.UtilizationChart
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @public

package/src/sap/gantt/simple/UtilizationChart.js

@@ -26,7 +26,7 @@ sap.ui.define([
 	 * @extends sap.gantt.simple.BaseShape
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @abstract
@@ -93,6 +93,9 @@ sap.ui.define([
             iStartTime =  this.getTime().valueOf();
             iEndTime  = this.getEndTime().valueOf();
             iTimeDiff = iEndTime - iStartTime;
+			if (oAxisTime.discontinuityProvider) {	// when skip time pattern is applied, use distance method to calculate time difference
+				iTimeDiff = oAxisTime._discontinuityProviderInstance.distance(this.getTime(), this.getEndTime());
+			}
 			iZoomRate = oAxisTime.getZoomRate();
 			viewOffset = oAxisTime.getViewOffset();
 			viewRange = oAxisTime.getViewRange()[1];

package/src/sap/gantt/simple/UtilizationDimension.js

@@ -20,7 +20,7 @@ sap.ui.define(["sap/ui/core/Element"], function(Element){
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @public

package/src/sap/gantt/simple/UtilizationLineChart.js

@@ -30,7 +30,7 @@ sap.ui.define([
 	 * @extends sap.gantt.simple.UtilizationChart
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @public

package/src/sap/gantt/simple/UtilizationPeriod.js

@@ -24,7 +24,7 @@ sap.ui.define(["sap/ui/core/Element"], function(Element){
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @public

package/src/sap/gantt/simple/shapes/Shape.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @extends sap.gantt.simple.BaseShape
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @abstract
 	 * @constructor

package/src/sap/gantt/simple/shapes/Task.js

@@ -38,7 +38,7 @@ sap.ui.define([
 	 * @extends sap.gantt.simple.shapes.Shape
 	 *
 	 * @author SAP SE
-	 * @version 1.125.0
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @public

package/src/sap/gantt/skipTime/DayInterval.js

@@ -0,0 +1,63 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+
+		(c) Copyright 2009-2015 SAP SE. All rights reserved
+	
+ */
+sap.ui.define([
+	"sap/ui/core/Element"
+], function (Element) {
+	"use strict";
+	/**
+	 * Creates and initializes a new class for day interval.
+	 *
+	 * @param {string} [sId] ID of the new control. The ID is generated automatically if it is not provided.
+	 * @param {object} [mSetting] Initial settings for the new control
+	 *
+	 * @class
+	 * Enables the user to define skip time pattern within a day.
+	 *
+	 * @extends sap.ui.core.Element
+	 *
+	 * @author SAP SE
+	 * @version 1.126.0
+	 * @since 1.126
+	 *
+	 * @constructor
+	 * @public
+	 * @alias sap.gantt.skipTime.DayInterval
+	 */
+	var DayInterval = Element.extend("sap.gantt.skipTime.DayInterval", /** @lends sap.gantt.skipTime.DayInterval.prototype */ {
+		metadata: {
+			library: "sap.gantt",
+			defaultAggregation: "skipIntervals",
+			properties: {
+				/**
+				 * Non-working day, supported values: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"
+				 * @since 1.126
+				 */
+				day: {type: "string"}
+			},
+			aggregations: {
+				/**
+				 * Time intervals to be skipped for the day.
+				 * @since 1.126
+				 */
+				skipIntervals: {type: "sap.gantt.skipTime.SkipInterval", multiple: true, singularName: "skipInterval"}
+			}
+		}
+	});
+
+	/**
+	 * Utility method to format skip intervals
+	 * @returns {Array} returns array of formatted skip intervals
+	 * @private
+	 */
+	DayInterval.prototype._getFormattedSkipIntervals = function () {
+		return this.getSkipIntervals().map(function (oInterval) {
+			return oInterval._getFormattedTime();
+		});
+	};
+
+	return DayInterval;
+});

package/src/sap/gantt/skipTime/DiscontinuousProvider.js

@@ -0,0 +1,48 @@
+sap.ui.define([
+], function () {
+	'use strict';
+	/**
+	 * Creates and initializes a new class for DiscontinuousProvider.
+	 * Enables the user to define custom discontinuous provider.
+	 *
+	 * @author SAP SE
+	 * @version 1.126.0
+	 * @since 1.126
+	 *
+	 * @constructor
+	 * @public
+	 * @alias sap.gantt.skipTime.DiscontinuousProvider
+	 */
+	function DiscontinuousProvider () {}
+
+	// Returns whether the discontinuous provider is to be used or not. This method can be overriden to define custom conditions.
+	DiscontinuousProvider.prototype.useDiscontinuousScale = function(){
+		return true;
+	};
+
+	// If the given date falls within a discontinuity (i.e. an excluded domain range), it must be moved forward to the discontinuity boundary. Otherwise, it should be returned unchanged.
+	DiscontinuousProvider.prototype.clampUp = function (oDate) {
+		return oDate;
+	};
+
+	// If the given date falls within a discontinuity, it must be shifted backwards to the discontinuity boundary. Otherwise, it should be returned unchanged.
+	DiscontinuousProvider.prototype.clampDown = function (oDate) {
+		return oDate;
+	};
+
+	// returns the number of milliseconds between the start and end dates after removing the discontinuities in between.
+	DiscontinuousProvider.prototype.distance = function (start, end) {
+		return end - start;
+	};
+
+	// When given a date and an offset in milliseconds, the date should be advanced by the offset value, skipping any discontinuities, to return the final value.
+	DiscontinuousProvider.prototype.offset = function (oDate, offset) {
+		return new Date(oDate.getTime() + offset);
+	};
+
+	DiscontinuousProvider.prototype.tickFilter = function (aTicks) {
+		return aTicks;
+	};
+
+	return DiscontinuousProvider;
+});

package/src/sap/gantt/skipTime/SkipInterval.js

@@ -0,0 +1,76 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+
+		(c) Copyright 2009-2015 SAP SE. All rights reserved
+	
+ */
+sap.ui.define([
+	"sap/ui/core/Element"
+], function (Element) {
+	"use strict";
+
+	/**
+	 * Creates and initializes a new class for skip interval.
+	 *
+	 * @param {string} [sId] ID of the new control. The ID is generated automatically if it is not provided.
+	 * @param {object} [mSetting] Initial settings for the new control
+	 *
+	 * @class
+	 * Enables the user to define skip time interval.
+	 *
+	 * @extends sap.ui.core.Element
+	 *
+	 * @author SAP SE
+	 * @version 1.126.0
+	 * @since 1.126
+	 *
+	 * @constructor
+	 * @public
+	 * @alias sap.gantt.skipTime.SkipInterval
+	 */
+
+	var SkipInterval = Element.extend("sap.gantt.skipTime.SkipInterval", /** @lends sap.gantt.skipTime.SkipInterval.prototype */ {
+		metadata: {
+			library: "sap.gantt",
+			properties: {
+				/**
+				 * Start time with in a day from which time is to be skipped. Format: HHMMSS.
+				 * @since 1.126
+				 */
+				startTime: { type: "string", group: "Misc", defaultValue: "000000" },
+
+				/**
+				 * End time with in a day till which time is to be skipped. Format: HHMMSS.
+				 * @since 1.126
+				 */
+				endTime: { type: "string", group: "Misc", defaultValue: "235959" }
+			}
+		}
+	});
+
+	/**
+	 * Utility method to format the time slices to d3fc supported value
+	 * @returns {Array} returns the formatted start and end pair
+	 * @private
+	 */
+	SkipInterval.prototype._getFormattedTime = function () {
+		var sStartTime = this.getStartTime();
+		var sEndTime = this.getEndTime();
+
+		if (sStartTime.slice(0, 4) === "0000") {
+			sStartTime = "SOD";
+		} else {
+			sStartTime = sStartTime.slice(0, 2) + ":" + sStartTime.slice(2, 4);
+		}
+
+		if (sEndTime.slice(0, 4) === "2359") {
+			sEndTime = "EOD";
+		} else {
+			sEndTime = sEndTime.slice(0, 2) + ":" + sEndTime.slice(2, 4);
+		}
+
+		return [sStartTime, sEndTime];
+	};
+
+	return SkipInterval;
+});

package/src/sap/gantt/skipTime/SkipPattern.js

@@ -0,0 +1,64 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+
+		(c) Copyright 2009-2015 SAP SE. All rights reserved
+	
+ */
+sap.ui.define([
+	"sap/ui/core/Element",
+	"sap/gantt/thirdparty/d3fc-discontinuous-scale"
+], function (Element) {
+	"use strict";
+
+	/**
+	 * Creates and initializes a new class for skip time pattern.
+	 *
+	 * @param {string} [sId] ID of the new control. The ID is generated automatically if it is not provided.
+	 * @param {object} [mSetting] Initial settings for the new control
+	 *
+	 * @class
+	 * Enables the user to define skip time pattern.
+	 *
+	 * @extends sap.ui.core.Element
+	 *
+	 * @author SAP SE
+	 * @version 1.126.0
+	 * @since 1.126
+	 *
+	 * @constructor
+	 * @public
+	 * @alias sap.gantt.skipTime.SkipPattern
+	 */
+
+	var SkipPattern = Element.extend("sap.gantt.skipTime.SkipPattern", /** @lends sap.gantt.skipTime.SkipPattern.prototype */ {
+		metadata: {
+			library: "sap.gantt",
+			"abstract": true
+		}
+	});
+
+	/**
+	 * Returns the discontinuity provider of the skip pattern. Default value is null
+	 * @return {sap.gantt.skipTime.DiscontinuousProvider} Discontinuity provider of the skip pattern
+	 * @public
+	 */
+	SkipPattern.prototype.getDiscontinuityProvider = function () {
+		return null;
+	};
+
+	/**
+	 * Updates the discontinuity provider for the gantt chart timeline.
+	 * @param {sap.gantt.skipTime.DiscontinuousProvider} oDiscontinuousProvider Discontinuous provider to be set
+	 * @param {Boolean} bSuppressInvalidate Flag to suppress re-rendering of the control.
+	 * @public
+	 */
+	SkipPattern.prototype.updateDiscontinuousProvider = function (oDiscontinuousProvider, bSuppressInvalidate) {
+		var oAxisTimeStrategy = this.getParent();
+		if (oAxisTimeStrategy && oAxisTimeStrategy.isA("sap.gantt.axistime.StepwiseZoomStrategy")) {
+			delete oAxisTimeStrategy._nGanttVisibleWidth;
+			oAxisTimeStrategy.setProperty("_discontinuousProvider", oDiscontinuousProvider, bSuppressInvalidate);
+		}
+	};
+
+	return SkipPattern;
+});

package/src/sap/gantt/skipTime/WeekPattern.js

@@ -0,0 +1,118 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+
+		(c) Copyright 2009-2015 SAP SE. All rights reserved
+	
+ */
+sap.ui.define([
+	"sap/gantt/skipTime/SkipPattern",
+	"./WeeklyDiscontinuousProvider"
+], function (SkipPattern, WeeklyDiscontinuousProvider) {
+	"use strict";
+
+	/**
+	 * Creates and initializes a new class for weekly time pattern.
+	 *
+	 * @param {string} [sId] ID of the new control. The ID is generated automatically if it is not provided.
+	 * @param {object} [mSetting] Initial settings for the new control
+	 *
+	 * @class
+	 * Enables the user to define weekly skip pattern.
+	 * Non working hours are to be removed for timeLineOptions with innerInterval unit as <code>sap.gantt.config.TimeUnit.day<code>, <code>sap.gantt.config.TimeUnit.hour<code> and <code>sap.gantt.config.TimeUnit.minute<code>
+	 *
+	 * @extends sap.gantt.skipTime.SkipPattern
+	 *
+	 * @author SAP SE
+	 * @version 1.126.0
+	 * @since 1.126
+	 *
+	 * @constructor
+	 * @public
+	 * @alias sap.gantt.skipTime.WeekPattern
+	 */
+
+	var WeekPattern = SkipPattern.extend("sap.gantt.skipTime.WeekPattern", /** @lends sap.gantt.skipTime.WeekPattern.prototype */ {
+		metadata: {
+			library: "sap.gantt",
+			defaultAggregation: "dailyIntervals",
+			properties: {
+				/**
+				 * If this property is set to true, week pattern is applied to the gantt chart.
+				 * @since 1.126
+				 */
+				enabled: {type: "boolean", defaultValue: true}
+			},
+			aggregations: {
+				/**
+				 * Day-wise non working time. These intervals are going to be skipped for the specified day.
+				 * @since 1.126
+				 */
+				dailyIntervals: {type: "sap.gantt.skipTime.DayInterval", multiple: true, singularName: "dailyInterval"},
+				/**
+				 * Weekly non working time. This time is going to be skipped for all the days unless dailyIntervals are defined for that day.
+				 * @since 1.126
+				 */
+				weeklyIntervals: {type: "sap.gantt.skipTime.SkipInterval", multiple: true, singularName: "weeklyInterval"}
+			}
+		}
+	});
+
+	/**
+	 * Utility method to format the time slices to d3fc supported value
+	 * @returns {object} returns the formatted start and end pair
+	 * @private
+	 */
+	WeekPattern.prototype._getWeekPattern = function () {
+		var oWeeklyPattern = {};
+		var aDailyInterval = this.getDailyIntervals();
+		var aWeeklyInterval = this.getWeeklyIntervals();
+
+		var aAllDays = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"];
+
+		if (aWeeklyInterval && aWeeklyInterval.length > 0) {
+			var aSkipWeekly = [];
+
+			aWeeklyInterval.forEach(function (oWeeklyInterval) {
+				aSkipWeekly.push(oWeeklyInterval._getFormattedTime());
+			});
+
+			aAllDays.forEach(function (sDay) {
+				oWeeklyPattern[sDay] = aSkipWeekly;
+			});
+		}
+
+		aDailyInterval.forEach(function (oDayInterval) {
+			var oDailyInterval = oDayInterval._getFormattedSkipIntervals();
+			if (oDailyInterval.length) {
+				oWeeklyPattern[oDayInterval.getDay()] = oDayInterval._getFormattedSkipIntervals();
+			}
+		});
+
+		return oWeeklyPattern;
+	};
+
+	/**
+	 * Utility method to calculate the discontinuity provider for the week pattern
+	 * @returns {object} returns the discontinuity provider of the week pattern
+	 * @public
+	 */
+	WeekPattern.prototype.getDiscontinuityProvider = function () {
+		if (this.getEnabled()) {
+			var oWeeklyPattern = this._getWeekPattern();
+			return Object.keys(oWeeklyPattern).length === 0 ? null : WeeklyDiscontinuousProvider.providers.weeklyPattern(oWeeklyPattern);
+		}
+		return null;
+	};
+	/**
+
+	 * Method to enable or disable the week pattern
+	 * @param {boolean} bEnable flag to enable or disable the week pattern
+	 * @public
+	 */
+	WeekPattern.prototype.setEnabled = function (bEnable) {
+		this.setProperty("enabled", bEnable, true);
+		this.updateDiscontinuousProvider(this.getDiscontinuityProvider());
+	};
+
+	return WeekPattern;
+});

package/src/sap/gantt/skipTime/WeeklyDiscontinuousProvider.js

@@ -0,0 +1,78 @@
+sap.ui.define([], function () {
+	'use strict';
+
+	var skipWeeklyPattern = function (oSkipWeeklyPattern) {
+		var oInstance = window.fc.discontinuitySkipWeeklyPattern(oSkipWeeklyPattern);
+
+		oInstance.tradingWeekdays = oInstance.tradingDays.reduce(function (aTradingWeekdays, _, index) {
+			if (oInstance.tradingDays[index].totalTradingTimeInMiliseconds > 0) {
+				aTradingWeekdays.push({
+					index: index,
+					tradingDay: oInstance.tradingDays[index]
+				});
+			}
+
+			return aTradingWeekdays;
+		}, []);
+
+		oInstance.tradingWeekdaysIndex = oInstance.tradingWeekdays.map(function (tradingDay) { return tradingDay.index; });
+
+		oInstance.tickFilter = function (adoptedTicks) {
+			var filteredSet = adoptedTicks.reduce(function (ticks, tick) {
+				var up = this.clampUp(tick).getTime();
+				var down = this.clampDown(tick).getTime();
+
+				if (up !== down) {
+					ticks.add(up);
+				} else {
+					ticks.add(tick.getTime());
+				}
+
+				return ticks;
+			}.bind(this), new Set());
+
+			var aFilteredTicks = Array.from(filteredSet).map(function (value) {
+				return new Date(value);
+			});
+
+			return aFilteredTicks;
+		};
+
+		oInstance.firstTradingDayOfWeek = function (firstDayOfWeek) {
+			var aTradingWeekdays = oInstance.tradingWeekdays;
+
+			if (aTradingWeekdays.length === 0) {
+				return firstDayOfWeek;
+			}
+
+			var firstTradingDay = aTradingWeekdays[0].index;
+
+			if (aTradingWeekdays.length > 1 && firstTradingDay !== firstDayOfWeek) {
+				for (var i = 0; i < aTradingWeekdays.length; i++) {
+					var tradingDayIndex = aTradingWeekdays[i].index;
+
+					if (tradingDayIndex === firstDayOfWeek) {
+						firstTradingDay = firstDayOfWeek;
+						break;
+					} else if (tradingDayIndex > firstDayOfWeek && tradingDayIndex < firstTradingDay) {
+						firstTradingDay = tradingDayIndex;
+					}
+				}
+			}
+
+			return firstTradingDay;
+		};
+
+		oInstance.useDiscontinuousScale = function (unit) {
+			return unit === "d3.time.minute" || unit === "d3.time.hour" || unit === "d3.time.day";
+		};
+
+		return oInstance;
+	};
+
+	return {
+		providers: {
+			weeklyPattern: skipWeeklyPattern
+		}
+	};
+});