Website updates

Author: ahocevar

dist/en/main/apidoc/module-ol_interaction_Modify-Modify.html

@@ -177,7 +177,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L240">line 240</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L249">line 249</a>
         </div>
 
     </div>
@@ -454,6 +454,32 @@ <h4 class="name">
 
 
 
+        <tr class="">
+            
+                <td class="name"><code>filter</code></td>
+            
+
+            
+            <td class="type">
+            
+                
+<span class="param-type"><a href="module-ol_interaction_Modify.html#~FilterFunction">FilterFunction</a></span>
+
+ | undefined
+                
+            
+            </td>
+
+            
+
+            <td  class="description last">
+                
+                <p>A function that takes a <a href="module-ol_Feature-Feature.html"><code>Feature</code></a>
+and returns <code>true</code> if the feature may be modified or <code>false</code> otherwise.</p></td>
+        </tr>
+
+	
+
         <tr class="">
 
                 <td class="name"><code>trace</code></td>
@@ -767,7 +793,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L2032">line 2032</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L2138">line 2138</a>
         </div>
 
     </div>
@@ -858,7 +884,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L1840">line 1840</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L1946">line 1946</a>
         </div>
 
     </div>
@@ -1588,7 +1614,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L640">line 640</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L699">line 699</a>
         </div>
 
     </div>
@@ -1956,7 +1982,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L2065">line 2065</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L2171">line 2171</a>
         </div>
 
     </div>
@@ -2426,7 +2452,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L1871">line 1871</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L1977">line 1977</a>
         </div>
 
     </div>
@@ -2740,7 +2766,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L615">line 615</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L674">line 674</a>
         </div>
 
     </div>

dist/en/main/apidoc/module-ol_interaction_Modify.ModifyEvent.html

@@ -768,7 +768,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L79">line 79</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L80">line 80</a>
         </div>
 
     </div>
@@ -848,7 +848,7 @@ <h4 class="name">
 
         <div class="tag-source">
             <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
-            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L73">line 73</a>
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L74">line 74</a>
         </div>
 
     </div>

dist/en/main/apidoc/module-ol_interaction_Modify.html

@@ -72,6 +72,7 @@
         <span class="subtitle">Typedefs</span>
         <ul>
             <li data-name="dragsegment"><a href="module-ol_interaction_Modify.html#~DragSegment">DragSegment</a>
+            <li data-name="filterfunction"><a href="module-ol_interaction_Modify.html#~FilterFunction">FilterFunction</a>
             <li data-name="options"><a href="module-ol_interaction_Modify.html#~Options">Options</a>
             <li data-name="segmentdata"><a href="module-ol_interaction_Modify.html#~SegmentData">SegmentData</a>
         </ul>
@@ -221,6 +222,87 @@ <h4 class="name">
 
 
 
+</dd>
+
+            
+                
+<dt class="">
+    
+    <div class="nameContainer">
+        <div class="anchor" id="~FilterFunction">
+        </div>
+        <h4 class="name">
+            FilterFunction<span class="signature">()</span>
+            
+            
+
+        </h4>
+        
+        <div class="tag-source">
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js">interaction/Modify.js</a>,
+            <a href="https://github.com/openlayers/openlayers/blob/main/src/ol/interaction/Modify.js#L98">line 98</a>
+        </div>
+        
+    </div>
+    
+    
+</dt>
+<dd class="">
+
+
+
+    
+    <div class="description">
+        <p>A function that takes a <a href="module-ol_Feature-Feature.html"><code>Feature</code></a> and  returns <code>true</code> if
+the feature may be modified or <code>false</code> otherwise.</p>
+    </div>
+    
+
+    
+
+    
+
+    
+    
+    
+
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
 </dd>
 
 
@@ -488,6 +570,30 @@ <h5 class="subsection-title">Properties:</h5>
 
 
 
+        <tr>
+            
+                <td class="name"><code>filter</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a href="module-ol_interaction_Modify.html#~FilterFunction">FilterFunction</a></span>
+
+ | undefined
+                
+            
+            </td>
+
+            <td class="description last">
+                <p>A function that takes a <a href="module-ol_Feature-Feature.html"><code>Feature</code></a>
+and returns <code>true</code> if the feature may be modified or <code>false</code> otherwise.</p>
+                
+            </td>
+        </tr>
+
+	
+
         <tr>
 
                 <td class="name"><code>trace</code></td>

dist/en/main/apidoc/navigation.tmpl.html

@@ -2881,6 +2881,7 @@
         <span class="subtitle">Typedefs</span>
         <ul>
             <li data-name="dragsegment"><a href="module-ol_interaction_Modify.html#~DragSegment">DragSegment</a>
+            <li data-name="filterfunction"><a href="module-ol_interaction_Modify.html#~FilterFunction">FilterFunction</a>
             <li data-name="options"><a href="module-ol_interaction_Modify.html#~Options">Options</a>
             <li data-name="segmentdata"><a href="module-ol_interaction_Modify.html#~SegmentData">SegmentData</a>
         </ul>

dist/en/main/examples/common.js

@@ -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.