ol 10.7.1-dev.1763988930570 → 10.7.1-dev.1764255874638

package/interaction/Modify.d.ts

@@ -52,6 +52,11 @@ export type SegmentData = {
      */
     featureSegments?: SegmentData[] | undefined;
 };
+/**
+ * A function that takes a {@link module :ol/Feature~Feature} and  returns `true` if
+ * the feature may be modified or `false` otherwise.
+ */
+export type FilterFunction = (arg0: Feature) => boolean;
 export type DragSegment = [SegmentData, number];
 export type Options = {
     /**
@@ -120,6 +125,10 @@ export type Options = {
      * provided, a vector source must be provided with the `source` option.
      */
     features?: Collection<Feature<import("../geom/Geometry.js").default>> | undefined;
+    /**
+     * A function that takes a {@link module :ol/Feature~Feature}and returns `true` if the feature may be modified or `false` otherwise.
+     */
+    filter?: FilterFunction | undefined;
     /**
      * Trace a portion of another geometry.
      * Tracing starts when two neighboring vertices are dragged onto a trace target, without any other modification in between..
@@ -189,6 +198,33 @@ declare class Modify extends PointerInteraction {
      * @param {Options} options Options.
      */
     constructor(options: Options);
+    /**
+     * @param {import("../source/Vector.js").VectorSourceEvent} event Event.
+     * @private
+     */
+    private handleSourceAdd_;
+    /**
+     * @param {import("../source/Vector.js").VectorSourceEvent} event Event.
+     * @private
+     */
+    private handleSourceRemove_;
+    /**
+     * @param {import("../Collection.js").CollectionEvent} event Event.
+     * @private
+     */
+    private handleExternalCollectionAdd_;
+    /**
+     * @param {import("../Collection.js").CollectionEvent} event Event.
+     * @private
+     */
+    private handleExternalCollectionRemove_;
+    /**
+     * Listener for features in external source or features collection.  Ensures the feature filter
+     * is re-run and segment data is updated.
+     * @param {import("../events/Event.js").default | import("../Object").ObjectEvent} evt Event.
+     * @private
+     */
+    private handleFeatureChange_;
     /***
      * @type {ModifyOnSignature<import("../events").EventsKey>}
      */
@@ -201,8 +237,6 @@ declare class Modify extends PointerInteraction {
      * @type {ModifyOnSignature<void>}
      */
     un: ModifyOnSignature<void>;
-    /** @private */
-    private boundHandleFeatureChange_;
     /**
      * @private
      * @type {import("../events/condition.js").Condition}
@@ -324,7 +358,21 @@ declare class Modify extends PointerInteraction {
      */
     private hitDetection_;
     /**
-     * @type {Collection<Feature>}
+     * Useful for performance optimization
+     * @private
+     * @type boolean
+     */
+    private filterFunctionWasSupplied_;
+    /**
+     * @private
+     * @type {FilterFunction}
+     */
+    private filter_;
+    featuresCollection_: Collection<Feature<import("../geom/Geometry.js").default>> | undefined;
+    /**
+     * Internal features array.  When adding or removing features, be sure to use
+     * addFeature_()/removeFeature_() so that the the segment index is adjusted.
+     * @type {Array<Feature>}
      * @private
      */
     private features_;
@@ -351,6 +399,7 @@ declare class Modify extends PointerInteraction {
      */
     setTrace(trace: boolean | import("../events/condition.js").Condition): void;
     /**
+     * Called when a feature is added to the internal features collection
      * @param {Feature} feature Feature.
      * @private
      */
@@ -362,6 +411,8 @@ declare class Modify extends PointerInteraction {
      */
     private willModifyFeatures_;
     /**
+     * Removes a feature from the internal features collection and updates internal state
+     * accordingly.
      * @param {Feature} feature Feature.
      * @private
      */
@@ -386,30 +437,17 @@ declare class Modify extends PointerInteraction {
      */
     getOverlay(): VectorLayer;
     /**
-     * @param {import("../source/Vector.js").VectorSourceEvent} event Event.
-     * @private
-     */
-    private handleSourceAdd_;
-    /**
-     * @param {import("../source/Vector.js").VectorSourceEvent} event Event.
-     * @private
-     */
-    private handleSourceRemove_;
-    /**
-     * @param {import("../Collection.js").CollectionEvent<Feature>} evt Event.
-     * @private
-     */
-    private handleFeatureAdd_;
-    /**
-     * @param {import("../events/Event.js").default} evt Event.
-     * @private
+     * Common handler for event signaling addition of feature to the supplied features source
+     * or collection.
+     * @param {Feature} feature Feature.
      */
-    private handleFeatureChange_;
+    externalAddFeatureHandler_(feature: Feature): void;
     /**
-     * @param {import("../Collection.js").CollectionEvent<Feature>} evt Event.
-     * @private
+     * Common handler for event signaling removal of feature from the supplied features source
+     * or collection.
+     * @param {Feature} feature Feature.
      */
-    private handleFeatureRemove_;
+    externalRemoveFeatureHandler_(feature: Feature): void;
     /**
      * @param {Feature} feature Feature
      * @param {Point} geometry Geometry.

package/interaction/Modify.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Modify.d.ts","sourceRoot":"","sources":["Modify.js"],"names":[],"mappings":"AAgLA;;;;GAIG;AACH;IACE;;;;;;OAMG;IACH,kBANW,eAAe,YACf,UAAU,CAAC,OAAO,CAAC,mBAEnB,OAAO,uBAAuB,EAAE,OAAO,EAmBjD;IAbC;;;;OAIG;IACH,UAHU,UAAU,CAAC,OAAO,CAAC,CAGL;IAExB;;;;OAIG;IACH,iBAHU,OAAO,uBAAuB,EAAE,OAAO,CAGX;CAEzC;;;;;;;;;;aArHa,OAAO;;;;cACP,OAAO,2BAA2B,EAAE,OAAO;;;;;;;;aAE3C,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;;;;;;0BAKrB,CAAC,WAAW,EAAE,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAgHrB,MAAM,IACN,OAAO,eAAe,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,UAAU,EAAE,OAAO,oBAAoB,EAAE,OAAO,EAAE,MAAM,CAAC,GACjI,OAAW,eAAe,EAAE,WAAW,CAAC,OAAO,oBAAoB,EAAE,KAAK,GAC1E,eAAqB,EAAE,OAAO,WAAW,EAAE,WAAW,EAAE,MAAM,CAAC,GAC/D,OAAW,eAAe,EAAE,WAAW,CAAC,WAAW,GAAC,aAAa,EAAE,WAAW,EAAE,MAAM,CAAC,GACvF,OAAW,eAAe,EAAE,mBAAmB,CAAC,OAAO,eAAe,EAAE,UAAU,GAAC,OAAO,oBAAoB,EAAE,KAAK,GACrH,eAAqB,GAAC,WAAW,GAAC,aAAa,EAAE,MAAM,CAAC;kBAxMvC,oBAAoB;uBAZf,kBAAkB;oBAErB,eAAe;uBAgEzB,MAAM;;;;;AA2IhB;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;IACE;;OAEG;IACH,qBAFW,OAAO,EA4PjB;IAvPC;;OAEG;IACH,IAFU,iBAAiB,CAAC,OAAO,WAAW,EAAE,SAAS,CAAC,CAEnD;IAEP;;OAEG;IACH,MAFU,iBAAiB,CAAC,OAAO,WAAW,EAAE,SAAS,CAAC,CAEjD;IAET;;OAEG;IACH,IAFU,iBAAiB,CAAC,IAAI,CAAC,CAE1B;IAEP,eAAe;IACf,kCAAqE;IAErE;;;OAGG;IACH,mBAAuE;IAEvE;;;;OAIG;IACH,gCAEC;IAED;;;OAGG;IACH,yBAEgC;IAEhC;;;OAGG;IACH,+BAEU;IAEV;;;;OAIG;IACH,uBAA0B;IAE1B;;;;OAIG;IACH,wBAA2B;IAE3B;;;OAGG;IACH,wBAA6B;IAE7B;;;;;OAKG;IACH,+BAAmC;IAEnC;;;OAGG;IACH,+BAAkC;IAElC;;;;OAIG;IACH,eAAyB;IAEzB;;;OAGG;IACH,wBACoE;IAEpE;;;OAGG;IACH,yBAA6B;IAE7B;;;;;OAKG;IACH,yBAA6B;IAE7B;;;OAGG;IACH,sBAAuB;IAEvB;;;;OAIG;IACH,iBAQE;IAEF;;;;OAIG;IACH,yBAUC;IAED;;;OAGG;IACH,gBAAmB;IAEnB;;;OAGG;IACH,qBAAiE;IAEjE;;;OAGG;IACH,wBAAoB;IAGpB;;;OAGG;IACH,oBAAkC;IAElC;;;OAGG;IACH,uBAA0B;IAE1B;;;OAGG;IACH,sBAAyB;IA2BzB;;;OAGG;IACH,kBAAyB;IAYzB;;;OAGG;IACH,0BAA6B;IAE7B;;;;OAIG;IACH,eAAoB;IAEpB;;OAEG;IACH,uBAG2B;IAG7B;;;;;OAKG;IACH,gBAHW,OAAO,GAAC,OAAO,wBAAwB,EAAE,SAAS,QAa5D;IAED;;;OAGG;IACH,oBAaC;IAED;;;;OAIG;IACH,4BAsBC;IAED;;;OAGG;IACH,uBAWC;IAED;;;OAGG;IACH,kCAuBC;IAiBD;;;;;;OAMG;IACH,qBAHW,OAAO,WAAW,EAAE,OAAO,QAMrC;IAED;;;;OAIG;IACH,cAHY,WAAW,CAKtB;IAED;;;OAGG;IACH,yBAIC;IAED;;;OAGG;IACH,4BAIC;IAED;;;OAGG;IACH,0BAEC;IAED;;;OAGG;IACH,6BAMC;IAED;;;OAGG;IACH,6BAEC;IAED;;;;OAIG;IACH,4BAWC;IAED;;;;OAIG;IACH,iCAgBC;IAED;;;;OAIG;IACH,iCAeC;IAED;;;;OAIG;IACH,sCAmBC;IAED;;;;OAIG;IACH,8BAmBC;IAED;;;;OAIG;IACH,mCAsBC;IAED;;;;;;;;;;OAUG;IACH,6BAqCC;IAED;;;;OAIG;IACH,yCAOC;IAED;;;;;;;OAOG;IACH,qCAcC;IAwCD;;;;OAIG;IACH,iDA+FC;IAED;;OAEG;IACH,yBAEC;IAED;;;;OAIG;IACH,qBAuEC;IAED,kFAcC;IAED;;;;OAIG;IACH,0BAyBC;IAED;;;;OAIG;IACH,sCA2BC;IAED;;;;OAIG;IACH,iCA4CC;IAED;;;;;OAKG;IACH,8BAmDC;IAED;;;OAGG;IACH,wBAHW,OAAO,kBAAkB,EAAE,UAAU,eACrC,WAAW,QAmFrB;IAiJD;;;OAGG;IACH,2BAGC;IAED;;;OAGG;IACH,8BAuJC;IAED;;;;;OAKG;IACH,sBA8DC;IAED;;;;OAIG;IACH,uBAKC;IAED;;;OAGG;IACH,YAFY,OAAO,kBAAkB,EAAE,UAAU,GAAG,IAAI,CAWvD;IAED;;;;;OAKG;IACH,kBAHY,OAAO,CAyBlB;IAED;;;;;;OAMG;IACH,yBALW,OAAO,kBAAkB,EAAE,UAAU,GAEpC,OAAO,CAoClB;IAED;;;;OAIG;IACH,sBAiHC;IAED;;;;;OAKG;IACH,kBAHY,OAAO,CA2BlB;IAED;;;;;;OAMG;IACH,yBALW,OAAO,kBAAkB,EAAE,UAAU,GAEpC,OAAO,CAiBlB;IAED;;;;OAIG;IACH,gCAIC;IAED;;;;;;OAMG;IACH,8BAeC;CACF;yBA3hEwB,qBAAqB;+BAKf,cAAc;wBAbrB,oBAAoB"}
+{"version":3,"file":"Modify.d.ts","sourceRoot":"","sources":["Modify.js"],"names":[],"mappings":"AAyLA;;;;GAIG;AACH;IACE;;;;;;OAMG;IACH,kBANW,eAAe,YACf,UAAU,CAAC,OAAO,CAAC,mBAEnB,OAAO,uBAAuB,EAAE,OAAO,EAmBjD;IAbC;;;;OAIG;IACH,UAHU,UAAU,CAAC,OAAO,CAAC,CAGL;IAExB;;;;OAIG;IACH,iBAHU,OAAO,uBAAuB,EAAE,OAAO,CAGX;CAEzC;;;;;;;;;;aA7Ha,OAAO;;;;cACP,OAAO,2BAA2B,EAAE,OAAO;;;;;;;;aAE3C,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;;;;;;;;;;6BAOrB,CAAS,IAAO,EAAP,OAAO,KAAE,OAAO;0BAIzB,CAAC,WAAW,EAAE,MAAM,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAkHrB,MAAM,IACN,OAAO,eAAe,EAAE,WAAW,CAAC,OAAO,eAAe,EAAE,UAAU,EAAE,OAAO,oBAAoB,EAAE,OAAO,EAAE,MAAM,CAAC,GACjI,OAAW,eAAe,EAAE,WAAW,CAAC,OAAO,oBAAoB,EAAE,KAAK,GAC1E,eAAqB,EAAE,OAAO,WAAW,EAAE,WAAW,EAAE,MAAM,CAAC,GAC/D,OAAW,eAAe,EAAE,WAAW,CAAC,WAAW,GAAC,aAAa,EAAE,WAAW,EAAE,MAAM,CAAC,GACvF,OAAW,eAAe,EAAE,mBAAmB,CAAC,OAAO,eAAe,EAAE,UAAU,GAAC,OAAO,oBAAoB,EAAE,KAAK,GACrH,eAAqB,GAAC,WAAW,GAAC,aAAa,EAAE,MAAM,CAAC;kBAhNvC,oBAAoB;uBAbf,kBAAkB;oBAErB,eAAe;uBAiEzB,MAAM;;;;;AAmJhB;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;GAoBG;AACH;IACE;;OAEG;IACH,qBAFW,OAAO,EA6SjB;IAuJD;;;OAGG;IACH,yBAKC;IAED;;;OAGG;IACH,4BAKC;IAED;;;OAGG;IACH,qCAKC;IAED;;;OAGG;IACH,wCAKC;IAqCD;;;;;OAKG;IACH,6BAQC;IA1gBC;;OAEG;IACH,IAFU,iBAAiB,CAAC,OAAO,WAAW,EAAE,SAAS,CAAC,CAEnD;IAEP;;OAEG;IACH,MAFU,iBAAiB,CAAC,OAAO,WAAW,EAAE,SAAS,CAAC,CAEjD;IAET;;OAEG;IACH,IAFU,iBAAiB,CAAC,IAAI,CAAC,CAE1B;IAEP;;;OAGG;IACH,mBAAuE;IAEvE;;;;OAIG;IACH,gCAEC;IAED;;;OAGG;IACH,yBAEgC;IAEhC;;;OAGG;IACH,+BAEU;IAEV;;;;OAIG;IACH,uBAA0B;IAE1B;;;;OAIG;IACH,wBAA2B;IAE3B;;;OAGG;IACH,wBAA6B;IAE7B;;;;;OAKG;IACH,+BAAmC;IAEnC;;;OAGG;IACH,+BAAkC;IAElC;;;;OAIG;IACH,eAAyB;IAEzB;;;OAGG;IACH,wBACoE;IAEpE;;;OAGG;IACH,yBAA6B;IAE7B;;;;;OAKG;IACH,yBAA6B;IAE7B;;;OAGG;IACH,sBAAuB;IAEvB;;;;OAIG;IACH,iBAQE;IAEF;;;;OAIG;IACH,yBAUC;IAED;;;OAGG;IACH,gBAAmB;IAEnB;;;OAGG;IACH,qBAAiE;IAEjE;;;OAGG;IACH,wBAAoB;IAGpB;;;OAGG;IACH,oBAAkC;IAElC;;;OAGG;IACH,uBAA0B;IAE1B;;;OAGG;IACH,sBAAyB;IAEzB;;;;OAIG;IACH,mCAC4C;IAE5C;;;OAGG;IACH,gBAA2D;IAqBzD,4FAA2C;IA+B7C;;;;;OAKG;IACH,kBAAmB;IAKnB;;;OAGG;IACH,0BAA6B;IAE7B;;;;OAIG;IACH,eAAoB;IAEpB;;OAEG;IACH,uBAG2B;IAG7B;;;;;OAKG;IACH,gBAHW,OAAO,GAAC,OAAO,wBAAwB,EAAE,SAAS,QAa5D;IAED;;;;OAIG;IACH,oBAaC;IAED;;;;OAIG;IACH,4BAsBC;IAED;;;;;OAKG;IACH,uBASC;IAED;;;OAGG;IACH,kCAuBC;IAiBD;;;;;;OAMG;IACH,qBAHW,OAAO,WAAW,EAAE,OAAO,QAMrC;IAED;;;;OAIG;IACH,cAHY,WAAW,CAKtB;IA8CD;;;;OAIG;IACH,oCAFW,OAAO,QAcjB;IAED;;;;OAIG;IACH,uCAFW,OAAO,QAWjB;IAkBD;;;;OAIG;IACH,4BAWC;IAED;;;;OAIG;IACH,iCAgBC;IAED;;;;OAIG;IACH,iCAeC;IAED;;;;OAIG;IACH,sCAmBC;IAED;;;;OAIG;IACH,8BAmBC;IAED;;;;OAIG;IACH,mCAsBC;IAED;;;;;;;;;;OAUG;IACH,6BAqCC;IAED;;;;OAIG;IACH,yCAOC;IAED;;;;;;;OAOG;IACH,qCAcC;IAwCD;;;;OAIG;IACH,iDA+FC;IAED;;OAEG;IACH,yBAEC;IAED;;;;OAIG;IACH,qBAuEC;IAED,kFAcC;IAED;;;;OAIG;IACH,0BAyBC;IAED;;;;OAIG;IACH,sCA2BC;IAED;;;;OAIG;IACH,iCA4CC;IAED;;;;;OAKG;IACH,8BAmDC;IAED;;;OAGG;IACH,wBAHW,OAAO,kBAAkB,EAAE,UAAU,eACrC,WAAW,QAmFrB;IAiJD;;;OAGG;IACH,2BAGC;IAED;;;OAGG;IACH,8BAuJC;IAED;;;;;OAKG;IACH,sBA8DC;IAED;;;;OAIG;IACH,uBAKC;IAED;;;OAGG;IACH,YAFY,OAAO,kBAAkB,EAAE,UAAU,GAAG,IAAI,CAWvD;IAED;;;;;OAKG;IACH,kBAHY,OAAO,CAyBlB;IAED;;;;;;OAMG;IACH,yBALW,OAAO,kBAAkB,EAAE,UAAU,GAEpC,OAAO,CAoClB;IAED;;;;OAIG;IACH,sBAiHC;IAED;;;;;OAKG;IACH,kBAHY,OAAO,CA2BlB;IAED;;;;;;OAMG;IACH,yBALW,OAAO,kBAAkB,EAAE,UAAU,GAEpC,OAAO,CAiBlB;IAED;;;;OAIG;IACH,gCAIC;IAED;;;;;;OAMG;IACH,8BAeC;CAuDF;yBA1rEwB,qBAAqB;+BAKf,cAAc;wBAbrB,oBAAoB"}

package/interaction/Modify.js

@@ -5,6 +5,7 @@ import Collection from '../Collection.js';
 import CollectionEventType from '../CollectionEventType.js';
 import Feature from '../Feature.js';
 import MapBrowserEventType from '../MapBrowserEventType.js';
+import ObjectEventType from '../ObjectEventType.js';
 import {equals} from '../array.js';
 import {
   closestOnSegment,
@@ -94,6 +95,12 @@ const ModifyEventType = {
  * @property {Array<SegmentData>} [featureSegments] FeatureSegments.
  */
 
+/**
+ * A function that takes a {@link module:ol/Feature~Feature} and  returns `true` if
+ * the feature may be modified or `false` otherwise.
+ * @typedef {function(Feature):boolean} FilterFunction
+ */
+
 /**
  * @typedef {[SegmentData, number]} DragSegment
  */
@@ -144,6 +151,8 @@ const ModifyEventType = {
  * @property {Collection<Feature>} [features]
  * The features the interaction works on.  If a feature collection is not
  * provided, a vector source must be provided with the `source` option.
+ * @property {FilterFunction} [filter] A function that takes a {@link module:ol/Feature~Feature}
+ * and returns `true` if the feature may be modified or `false` otherwise.
  * @property {boolean|import("../events/condition.js").Condition} [trace=false] Trace a portion of another geometry.
  * Tracing starts when two neighboring vertices are dragged onto a trace target, without any other modification in between..
  * @property {VectorSource} [traceSource] Source for features to trace.  If tracing is active and a `traceSource` is
@@ -244,6 +253,24 @@ class Modify extends PointerInteraction {
   constructor(options) {
     super(/** @type {import("./Pointer.js").Options} */ (options));
 
+    //Maintain a ref to event handlers for later unregistering
+    /** @private */
+    this.handleSourceAdd_ = this.handleSourceAdd_.bind(this);
+
+    /** @private */
+    this.handleSourceRemove_ = this.handleSourceRemove_.bind(this);
+
+    /** @private */
+    this.handleExternalCollectionAdd_ =
+      this.handleExternalCollectionAdd_.bind(this);
+
+    /** @private */
+    this.handleExternalCollectionRemove_ =
+      this.handleExternalCollectionRemove_.bind(this);
+
+    /** @private */
+    this.handleFeatureChange_ = this.handleFeatureChange_.bind(this);
+
     /***
      * @type {ModifyOnSignature<import("../events").EventsKey>}
      */
@@ -259,9 +286,6 @@ class Modify extends PointerInteraction {
      */
     this.un;
 
-    /** @private */
-    this.boundHandleFeatureChange_ = this.handleFeatureChange_.bind(this);
-
     /**
      * @private
      * @type {import("../events/condition.js").Condition}
@@ -430,46 +454,80 @@ class Modify extends PointerInteraction {
      */
     this.hitDetection_ = null;
 
-    /** @type {Collection<Feature>} */
+    /**
+     * Useful for performance optimization
+     * @private
+     * @type boolean
+     */
+    this.filterFunctionWasSupplied_ =
+      options.filter != undefined ? true : false;
+
+    /**
+     * @private
+     * @type {FilterFunction}
+     */
+    this.filter_ = options.filter ? options.filter : () => true;
+
+    if (!(options.features || options.source)) {
+      throw new Error(
+        'The modify interaction requires features collection or a source',
+      );
+    }
+    /** @type {Array<Feature>} */
     let features;
     if (options.features) {
-      features = options.features;
+      features = options.features.getArray();
+      //setup listeners on external features collection and features
+      options.features.addEventListener(
+        CollectionEventType.ADD,
+        this.handleExternalCollectionAdd_,
+      );
+      options.features.addEventListener(
+        CollectionEventType.REMOVE,
+        this.handleExternalCollectionRemove_,
+      );
+      //keep ref for unsubscribe on dispose
+      this.featuresCollection_ = options.features;
     } else if (options.source) {
-      this.source_ = options.source;
-      features = new Collection(this.source_.getFeatures());
-      this.source_.addEventListener(
+      features = options.source.getFeatures();
+      //setup listeners on external source and features
+      options.source.addEventListener(
         VectorEventType.ADDFEATURE,
-        this.handleSourceAdd_.bind(this),
+        this.handleSourceAdd_,
       );
-      this.source_.addEventListener(
+      options.source.addEventListener(
         VectorEventType.REMOVEFEATURE,
-        this.handleSourceRemove_.bind(this),
-      );
-    }
-    if (!features) {
-      throw new Error(
-        'The modify interaction requires features, a source or a layer',
+        this.handleSourceRemove_,
       );
+      //keep ref for unsubscribe on dispose
+      this.source_ = options.source;
     }
+    features.forEach((feature) => {
+      //any modification to the feature requires filter to be re-run
+      feature.addEventListener(EventType.CHANGE, this.handleFeatureChange_);
+      //prop change handler is only to re-run the filter
+      if (this.filterFunctionWasSupplied_) {
+        feature.addEventListener(
+          ObjectEventType.PROPERTYCHANGE,
+          this.handleFeatureChange_,
+        );
+      }
+    });
+
     if (options.hitDetection) {
       this.hitDetection_ = options.hitDetection;
     }
 
     /**
-     * @type {Collection<Feature>}
+     * Internal features array.  When adding or removing features, be sure to use
+     * addFeature_()/removeFeature_() so that the the segment index is adjusted.
+     * @type {Array<Feature>}
      * @private
      */
-    this.features_ = features;
-
-    this.features_.forEach(this.addFeature_.bind(this));
-    this.features_.addEventListener(
-      CollectionEventType.ADD,
-      this.handleFeatureAdd_.bind(this),
-    );
-    this.features_.addEventListener(
-      CollectionEventType.REMOVE,
-      this.handleFeatureRemove_.bind(this),
-    );
+    this.features_ = [];
+    features
+      .filter(this.filter_)
+      .forEach((feature) => this.addFeature_(feature));
 
     /**
      * @type {import("../MapBrowserEvent.js").default}
@@ -512,10 +570,12 @@ class Modify extends PointerInteraction {
   }
 
   /**
+   * Called when a feature is added to the internal features collection
    * @param {Feature} feature Feature.
    * @private
    */
   addFeature_(feature) {
+    this.features_.push(feature);
     const geometry = feature.getGeometry();
     if (geometry) {
       const writer = this.SEGMENT_WRITERS_[geometry.getType()];
@@ -527,7 +587,6 @@ class Modify extends PointerInteraction {
     if (map && map.isRendered() && this.getActive()) {
       this.handlePointerAtPixel_(this.lastCoordinate_);
     }
-    feature.addEventListener(EventType.CHANGE, this.boundHandleFeatureChange_);
   }
 
   /**
@@ -560,20 +619,20 @@ class Modify extends PointerInteraction {
   }
 
   /**
+   * Removes a feature from the internal features collection and updates internal state
+   * accordingly.
    * @param {Feature} feature Feature.
    * @private
    */
   removeFeature_(feature) {
+    const itemIndex = this.features_.indexOf(feature);
+    this.features_.splice(itemIndex, 1);
     this.removeFeatureSegmentData_(feature);
     // Remove the vertex feature if the collection of candidate features is empty.
-    if (this.vertexFeature_ && this.features_.getLength() === 0) {
+    if (this.vertexFeature_ && this.features_.length === 0) {
       this.overlay_.getSource().removeFeature(this.vertexFeature_);
       this.vertexFeature_ = null;
     }
-    feature.removeEventListener(
-      EventType.CHANGE,
-      this.boundHandleFeatureChange_,
-    );
   }
 
   /**
@@ -646,8 +705,9 @@ class Modify extends PointerInteraction {
    * @private
    */
   handleSourceAdd_(event) {
-    if (event.feature) {
-      this.features_.push(event.feature);
+    const feature = event.feature;
+    if (feature) {
+      this.externalAddFeatureHandler_(feature);
     }
   }
 
@@ -656,37 +716,83 @@ class Modify extends PointerInteraction {
    * @private
    */
   handleSourceRemove_(event) {
-    if (event.feature) {
-      this.features_.remove(event.feature);
+    const feature = event.feature;
+    if (feature) {
+      this.externalRemoveFeatureHandler_(feature);
     }
   }
 
   /**
-   * @param {import("../Collection.js").CollectionEvent<Feature>} evt Event.
+   * @param {import("../Collection.js").CollectionEvent} event Event.
    * @private
    */
-  handleFeatureAdd_(evt) {
-    this.addFeature_(evt.element);
+  handleExternalCollectionAdd_(event) {
+    const feature = event.element;
+    if (feature) {
+      this.externalAddFeatureHandler_(feature);
+    }
   }
 
   /**
-   * @param {import("../events/Event.js").default} evt Event.
+   * @param {import("../Collection.js").CollectionEvent} event Event.
    * @private
    */
-  handleFeatureChange_(evt) {
-    if (!this.changingFeature_) {
-      const feature = /** @type {Feature} */ (evt.target);
-      this.removeFeature_(feature);
+  handleExternalCollectionRemove_(event) {
+    const feature = event.element;
+    if (feature) {
+      this.externalRemoveFeatureHandler_(feature);
+    }
+  }
+
+  /**
+   * Common handler for event signaling addition of feature to the supplied features source
+   * or collection.
+   * @param {Feature} feature Feature.
+   */
+  externalAddFeatureHandler_(feature) {
+    feature.addEventListener(EventType.CHANGE, this.handleFeatureChange_);
+    //prop change handler is only for reapplying the filter
+    if (this.filterFunctionWasSupplied_) {
+      feature.addEventListener(
+        ObjectEventType.PROPERTYCHANGE,
+        this.handleFeatureChange_,
+      );
+    }
+    if (this.filter_(feature)) {
       this.addFeature_(feature);
     }
   }
 
   /**
-   * @param {import("../Collection.js").CollectionEvent<Feature>} evt Event.
+   * Common handler for event signaling removal of feature from the supplied features source
+   * or collection.
+   * @param {Feature} feature Feature.
+   */
+  externalRemoveFeatureHandler_(feature) {
+    feature.removeEventListener(EventType.CHANGE, this.handleFeatureChange_);
+    if (this.filterFunctionWasSupplied_) {
+      feature.removeEventListener(
+        ObjectEventType.PROPERTYCHANGE,
+        this.handleFeatureChange_,
+      );
+    }
+    this.removeFeature_(feature);
+  }
+
+  /**
+   * Listener for features in external source or features collection.  Ensures the feature filter
+   * is re-run and segment data is updated.
+   * @param {import("../events/Event.js").default | import("../Object").ObjectEvent} evt Event.
    * @private
    */
-  handleFeatureRemove_(evt) {
-    this.removeFeature_(evt.element);
+  handleFeatureChange_(evt) {
+    if (!this.changingFeature_) {
+      const feature = /** @type {Feature} */ (evt.target);
+      this.removeFeature_(feature);
+      //safe to remove handler on a feature if there isn't one, but need to apply the filter
+      // before adding the feature.
+      this.filter_(feature) && this.addFeature_(feature);
+    }
   }
 
   /**
@@ -1615,7 +1721,7 @@ class Modify extends PointerInteraction {
             geom &&
             geom.getType() === 'Point' &&
             feature instanceof Feature &&
-            this.features_.getArray().includes(feature)
+            this.features_.includes(feature)
           ) {
             hitPointGeometry = /** @type {Point} */ (geom);
             const coordinate = /** @type {Point} */ (feature.getGeometry())
@@ -2112,6 +2218,60 @@ class Modify extends PointerInteraction {
       },
     );
   }
+
+  /**
+   * @override
+   */
+  disposeInternal() {
+    super.disposeInternal();
+    if (this.featuresCollection_) {
+      this.featuresCollection_.removeEventListener(
+        CollectionEventType.ADD,
+        this.handleExternalCollectionAdd_,
+      );
+      this.featuresCollection_.removeEventListener(
+        CollectionEventType.REMOVE,
+        this.handleExternalCollectionRemove_,
+      );
+      //change and propertychange event handlers were placed on all features in the external
+      // collection, not just the ones that passed the filter.  Remove these too.
+      for (const feature of this.featuresCollection_.getArray()) {
+        feature.removeEventListener(
+          EventType.CHANGE,
+          this.handleFeatureChange_,
+        );
+        if (this.filterFunctionWasSupplied_) {
+          feature.removeEventListener(
+            ObjectEventType.PROPERTYCHANGE,
+            this.handleFeatureChange_,
+          );
+        }
+      }
+    } else if (this.source_) {
+      this.source_.removeEventListener(
+        VectorEventType.ADDFEATURE,
+        this.handleSourceAdd_,
+      );
+      this.source_.removeEventListener(
+        VectorEventType.REMOVEFEATURE,
+        this.handleSourceRemove_,
+      );
+      //change and propertychange event handlers were placed on all features in the source, not
+      // just the ones that passed the filter.  Remove these too.
+      for (const feature of this.source_.getFeatures()) {
+        feature.removeEventListener(
+          EventType.CHANGE,
+          this.handleFeatureChange_,
+        );
+        if (this.filterFunctionWasSupplied_) {
+          feature.removeEventListener(
+            ObjectEventType.PROPERTYCHANGE,
+            this.handleFeatureChange_,
+          );
+        }
+      }
+    }
+  }
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ol",
-  "version": "10.7.1-dev.1763988930570",
+  "version": "10.7.1-dev.1764255874638",
   "description": "OpenLayers mapping library",
   "keywords": [
     "map",

package/util.js

@@ -33,4 +33,4 @@ export function getUid(obj) {
  * OpenLayers version.
  * @type {string}
  */
-export const VERSION = '10.7.1-dev.1763988930570';
+export const VERSION = '10.7.1-dev.1764255874638';