Improved performance when clearing timeouts, closes #7901.

highcharts · Feb 27, 2018 · fa4d43e · fa4d43e
1 parent f10d01e
commit fa4d43e
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 14 deletions.
diff --git a/js/.eslintrc b/js/.eslintrc
@@ -1,7 +1,7 @@
 {
     "globals": {
         "clearInterval": true,
-        "clearTimeout": true,
+        "clearTimeout": false,
         "console": true,
         "module": true,
         "setInterval": true,

diff --git a/js/modules/boost-canvas.src.js b/js/modules/boost-canvas.src.js
@@ -411,7 +411,7 @@ H.initCanvasBoost = function () {
 						opacity: 1
 					}
 				});
-				clearTimeout(destroyLoadingDiv);
+				H.clearTimeout(destroyLoadingDiv);
 				chart.showLoading('Drawing...');
 				chart.options.loading = loadingOptions; // reset
 			}

diff --git a/js/modules/exporting.src.js b/js/modules/exporting.src.js
@@ -1278,7 +1278,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
 					menu.hideTimer = setTimeout(hide, 500);
 				}),
 				addEvent(menu, 'mouseenter', function () {
-					clearTimeout(menu.hideTimer);
+					H.clearTimeout(menu.hideTimer);
 				}),
 
 				// Hide it on clicking or touching outside the menu (#2258, #2335,
@@ -1513,7 +1513,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
 			each(exportDivElements, function (elem, i) {
 
 				// Remove the event handler
-				clearTimeout(elem.hideTimer); // #5427
+				H.clearTimeout(elem.hideTimer); // #5427
 				removeEvent(elem, 'mouseleave');
 
 				// Remove inline events

diff --git a/js/modules/series-label.src.js b/js/modules/series-label.src.js
@@ -761,7 +761,7 @@ function drawLabels(proceed) {
 	chart.labelSeries = [];
 	chart.labelSeriesMaxSum = 0;
 
-	clearTimeout(chart.seriesLabelTimer);
+	H.clearTimeout(chart.seriesLabelTimer);
 
 	// Which series should have labels
 	each(chart.series, function (series) {

diff --git a/js/parts-map/MapSeries.js b/js/parts-map/MapSeries.js
@@ -965,7 +965,7 @@ seriesType('map', 'scatter', {
 	 * Stop the fade-out
 	 */
 	onMouseOver: function (e) {
-		clearTimeout(this.colorInterval);
+		H.clearTimeout(this.colorInterval);
 		if (this.value !== null || this.series.options.nullInteraction) {
 			Point.prototype.onMouseOver.call(this, e);
 		} else { // #3401 Tooltip doesn't hide when hovering over null points

diff --git a/js/parts/Chart.js b/js/parts/Chart.js
@@ -1157,7 +1157,7 @@ extend(Chart.prototype, /** @lends Highcharts.Chart.prototype */ {
 				width !== chart.containerWidth ||
 				height !== chart.containerHeight
 			) {
-				clearTimeout(chart.reflowTimeout);
+				H.clearTimeout(chart.reflowTimeout);
 				// When called from window.resize, e is set, else it's called
 				// directly (#2224)
 				chart.reflowTimeout = syncTimeout(function () {

diff --git a/js/parts/Series.js b/js/parts/Series.js
@@ -4019,7 +4019,7 @@ H.Series = H.seriesType('line', null, { // base series options
 
 		// Clear the animation timeout if we are destroying the series during
 		// initial animation
-		clearTimeout(series.animationTimeout);
+		H.clearTimeout(series.animationTimeout);
 
 		// Destroy all SVGElements associated to the series
 		objectEach(series, function (val, prop) {

diff --git a/js/parts/Tooltip.js b/js/parts/Tooltip.js
@@ -194,8 +194,8 @@ H.Tooltip.prototype = {
 			this.cleanSplit(this.chart, true);
 			this.tt = this.tt.destroy();
 		}
-		clearTimeout(this.hideTimer);
-		clearTimeout(this.tooltipTimeout);
+		H.clearTimeout(this.hideTimer);
+		H.clearTimeout(this.tooltipTimeout);
 	},
 
 	/**
@@ -235,7 +235,7 @@ H.Tooltip.prototype = {
 		if (animate) {
 
 			// Never allow two timeouts
-			clearTimeout(this.tooltipTimeout);
+			H.clearTimeout(this.tooltipTimeout);
 
 			// Set the fixed interval ticking for the smooth tooltip
 			this.tooltipTimeout = setTimeout(function () {
@@ -255,7 +255,7 @@ H.Tooltip.prototype = {
 	hide: function (delay) {
 		var tooltip = this;
 		// disallow duplicate timers (#1728, #1766)
-		clearTimeout(this.hideTimer);
+		H.clearTimeout(this.hideTimer);
 		delay = pick(delay, this.options.hideDelay, 500);
 		if (!this.isHidden) {
 			this.hideTimer = syncTimeout(function () {
@@ -493,7 +493,7 @@ H.Tooltip.prototype = {
 			return;
 		}
 
-		clearTimeout(this.hideTimer);
+		H.clearTimeout(this.hideTimer);
 
 		// get the reference point coordinates (pie charts use tooltipPos)
 		tooltip.followPointer = splat(point)[0].series.tooltipOptions

diff --git a/js/parts/Utilities.js b/js/parts/Utilities.js
@@ -677,7 +677,7 @@ H.splat = function (obj) {
  * @param   {Number}   delay - Delay in milliseconds.
  * @param   {Object}   [context] - The context.
  * @returns {Number} An identifier for the timeout that can later be cleared
- * with clearTimeout.
+ * with H.clearTimeout.
  */
 H.syncTimeout = function (fn, delay, context) {
 	if (delay) {
@@ -686,6 +686,20 @@ H.syncTimeout = function (fn, delay, context) {
 	fn.call(0, context);
 };
 
+/**
+ * Internal clear timeout.
+ * Function checks if the `id` was not removed (e.g. by `chart.destroy()`).
+ * For the details see issue #7901.
+ *
+ * @function #clearTimeout
+ * @memberOf Highcharts
+ * @param   {Number}   id - id of a timeout.
+ */
+H.clearTimeout = function (id) {
+	if (H.defined(id)) {
+		clearTimeout(id);
+	}
+};
 
 /**
  * Utility function to extend an object with the members of another.