Merge pull request #10736 from M393/clustersource-setsource

Allow cluster source to unlisten from its source

src/ol/source/Cluster.js

@@ -29,7 +29,7 @@ import VectorSource from './Vector.js';
  * ```
  * See {@link module:ol/geom/Polygon~Polygon#getInteriorPoint} for a way to get a cluster
  * calculation point for polygons.
- * @property {VectorSource} source Source.
+ * @property {VectorSource} [source] Source.
  * @property {boolean} [wrapX=true] Whether to wrap the world horizontally.
  */
 
@@ -39,6 +39,10 @@ import VectorSource from './Vector.js';
  * Layer source to cluster vector data. Works out of the box with point
  * geometries. For other geometry types, or if not all geometries should be
  * considered for clustering, a custom `geometryFunction` can be defined.
+ *
+ * If the instance is disposed without also disposing the underlying
+ * source `setSource(null)` has to be called to remove the listener reference
+ * from the wrapped source.
  * @api
  */
 class Cluster extends VectorSource {
@@ -81,13 +85,17 @@ class Cluster extends VectorSource {
       return geometry;
     };
 
-    /**
-     * @type {VectorSource}
-     * @protected
-     */
-    this.source = options.source;
+    this.boundRefresh_ = this.refresh.bind(this);
 
-    this.source.addEventListener(EventType.CHANGE, this.refresh.bind(this));
+    this.setSource(options.source || null);
+  }
+
+  /**
+   * @override
+   */
+  clear(opt_fast) {
+    this.features.length = 0;
+    super.clear(opt_fast);
   }
 
   /**
@@ -132,7 +140,23 @@ class Cluster extends VectorSource {
   }
 
   /**
-   * handle the source changing
+   * Replace the wrapped source.
+   * @param {VectorSource} source The new source for this instance.
+   * @api
+   */
+  setSource(source) {
+    if (this.source) {
+      this.source.removeEventListener(EventType.CHANGE, this.boundRefresh_);
+    }
+    this.source = source;
+    if (source) {
+      source.addEventListener(EventType.CHANGE, this.boundRefresh_);
+    }
+    this.refresh();
+  }
+
+  /**
+   * Handle the source changing.
    * @override
    */
   refresh() {
@@ -145,10 +169,9 @@ class Cluster extends VectorSource {
    * @protected
    */
   cluster() {
-    if (this.resolution === undefined) {
+    if (this.resolution === undefined || !this.source) {
       return;
     }
-    this.features.length = 0;
     const extent = createEmpty();
     const mapDistance = this.distance * this.resolution;
     const features = this.source.getFeatures();

test/spec/ol/source/cluster.test.js

@@ -6,6 +6,7 @@ import {get as getProjection} from '../../../../src/ol/proj.js';
 import Cluster from '../../../../src/ol/source/Cluster.js';
 import Source from '../../../../src/ol/source/Source.js';
 import VectorSource from '../../../../src/ol/source/Vector.js';
+import EventType from '../../../../src/ol/events/EventType.js';
 
 describe('ol.source.Cluster', function() {
 
@@ -76,3 +77,33 @@ describe('ol.source.Cluster', function() {
   });
 
 });
+
+describe('#setSource', function() {
+  it('removes the change listener from the old source', function() {
+    const source = new VectorSource();
+    const clusterSource = new Cluster({
+      source: source
+    });
+    expect(source.hasListener(EventType.CHANGE)).to.be(true);
+    clusterSource.setSource(null);
+    expect(source.hasListener(EventType.CHANGE)).to.be(false);
+  });
+
+  it('properly removes the previous features', function() {
+    const source = new Cluster({
+      source: new VectorSource({
+        features: [new Feature(new Point([0, 0]))]
+      })
+    });
+
+    const projection = getProjection('EPSG:3857');
+    const extent = [-1, -1, 1, 1];
+    source.loadFeatures(extent, 1, projection);
+
+    expect(source.features.length).to.be(1);
+    source.setSource(null);
+    expect(source.features.length).to.be(0);
+  });
+
+});
+