Merge pull request #169 from yuhongda/gh-pages

API.md

@@ -13,6 +13,23 @@ wordcloud2.js works around it by scaling the canvas, but you may be interested t
 
 	WordCloud.minFontSize
 
+## Stop the renderring
+
+Sometimes we need to stop wordcloud2.js renderring, to optimize the component renderring performance, especially in some FE libraries like 'React'.
+In this scenario, you can just call the function below
+
+	WordCloud.stop
+
+```js
+useEffect(() => {
+  ...
+  return () => {
+    // stop the renderring
+    WordCloud.stop();
+  };
+}, [deps]);
+```
+
 ## Usage
 
     WordCloud(elements, options);

src/wordcloud2.js

@@ -157,6 +157,7 @@ if (!window.clearImmediate) {
     return arr
   }
 
+  var timer;
   var WordCloud = function WordCloud (elements, options) {
     if (!isSupported) {
       return
@@ -1168,8 +1169,7 @@ if (!window.clearImmediate) {
       }
 
       addEventListener('wordcloudstart', anotherWordCloudStart)
-
-      var timer = loopingFunction(function loop () {
+      timer = loopingFunction(function loop () {
         if (i >= settings.list.length) {
           stoppingFunction(timer)
           sendEvent('wordcloudstop', false)
@@ -1202,6 +1202,11 @@ if (!window.clearImmediate) {
 
   WordCloud.isSupported = isSupported
   WordCloud.minFontSize = minFontSize
+  WordCloud.stop = function stop () {
+    if (timer) {
+      window.clearImmediate(timer)
+    }
+  }
 
   // Expose the library as an AMD module
   if (typeof define === 'function' && define.amd) { // eslint-disable-line no-undef