Website updates

Author: ahocevar

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

@@ -63,6 +63,19 @@
           </div>
           <div class="navigation-list-wrapper">
             <ul class="navigation-list search-empty">
+<li class="item item-module toggle-manual toggle-manual-show" data-longname="module:ol/interaction/Modify" data-name="ol/interaction/modify">
+    <span class="title toggle">
+        <span class="fa fa-plus me-2 mt-1"></span>
+        <span><a href="module-ol_interaction_Modify.html">ol​/interaction​/Modify</a></span>
+    </span>
+    <div class="member-list" data-type="typedefs">
+        <span class="subtitle">Typedefs</span>
+        <ul>
+            <li data-name="dragsegment"><a href="module-ol_interaction_Modify.html#~DragSegment">DragSegment</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>
+    </div>
               <li class="loading">Loading …
             </ul>
           </div>
@@ -166,6 +179,52 @@ <h3 class="subsection-title">Type Definitions</h3>
 
         <dl>
 
+<dt class="">
+    <div class="nameContainer">
+        <div class="anchor" id="~DragSegment">
+        </div>
+        <h4 class="name">
+            DragSegment<span class="type-signature type array">{Array}</span> 
+            
+
+        </h4>
+    </div>
+    
+</dt>
+<dd class="">
+    
+
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+
+    
+</dd>
+
+            
+                
 <dt class="">
     <div class="nameContainer">
         <div class="anchor" id="~Options">
@@ -333,7 +392,8 @@ <h5 class="subsection-title">Properties:</h5>
                 <p>Style used for the modification point or vertex. For linestrings and polygons, this will
 be the affected vertex, for circles a point along the circle, and for points the actual
 point. If not configured, the default edit style is used (see <a href="module-ol_style_Style-Style.html"><code>Style</code></a>).
-When using a style function, the point feature passed to the function will have a <code>features</code>
+When using a style function, the point feature passed to the function will have an <code>existing</code> property -
+indicating whether there is an existing vertex underneath or not, a <code>features</code>
 property - an array whose entries are the features that are being modified, and a <code>geometries</code>
 property - an array whose entries are the geometries that are being modified. Both arrays are
 in the same order. The <code>geometries</code> are only useful when modifying geometry collections, where

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

@@ -2836,6 +2836,8 @@
     <div class="member-list" data-type="methods">
         <span class="subtitle">Methods</span>
         <ul>
+            <li data-name="caninsertpoint"><a href="module-ol_interaction_Modify-Modify.html#canInsertPoint">canInsertPoint</a>
+            <li data-name="canremovepoint"><a href="module-ol_interaction_Modify-Modify.html#canRemovePoint">canRemovePoint</a>
             <li data-name="changed"><a href="module-ol_interaction_Modify-Modify.html#changed">changed</a>
             <li data-name="dispatchevent"><a href="module-ol_interaction_Modify-Modify.html#dispatchEvent">dispatchEvent</a>
             <li data-name="get"><a href="module-ol_interaction_Modify-Modify.html#get">get</a>
@@ -2846,6 +2848,7 @@
             <li data-name="getpointercount"><a href="module-ol_interaction_Modify-Modify.html#getPointerCount">getPointerCount</a>
             <li data-name="getproperties"><a href="module-ol_interaction_Modify-Modify.html#getProperties">getProperties</a>
             <li data-name="getrevision"><a href="module-ol_interaction_Modify-Modify.html#getRevision">getRevision</a>
+            <li data-name="insertpoint"><a href="module-ol_interaction_Modify-Modify.html#insertPoint">insertPoint</a>
             <li data-name="on"><a href="module-ol_interaction_Modify-Modify.html#on">on</a>
             <li data-name="once"><a href="module-ol_interaction_Modify-Modify.html#once">once</a>
             <li data-name="removepoint"><a href="module-ol_interaction_Modify-Modify.html#removePoint">removePoint</a>
@@ -2867,6 +2870,19 @@
             <li data-name="propertychange"><a href="module-ol_Object.ObjectEvent.html#event:propertychange">propertychange</a>
         </ul>
     </div>
+<li class="item item-module" data-longname="module:ol/interaction/Modify" data-name="ol/interaction/modify">
+    <span class="title toggle">
+        <span class="fa fa-plus me-2 mt-1"></span>
+        <span><a href="module-ol_interaction_Modify.html">ol​/interaction​/Modify</a></span>
+    </span>
+    <div class="member-list" data-type="typedefs">
+        <span class="subtitle">Typedefs</span>
+        <ul>
+            <li data-name="dragsegment"><a href="module-ol_interaction_Modify.html#~DragSegment">DragSegment</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>
+    </div>
 <li class="item item-class" data-longname="module:ol/interaction/Modify.ModifyEvent" data-name="ol/interaction/modify.modifyevent">
     <span class="title toggle">
         <span class="fa fa-chevron-right me-2 mt-1"></span>

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

@@ -7,6 +7,9 @@
  * @property {Array<Array<number>>} segment Segment.
  * @property {Array<SegmentData>} [featureSegments] FeatureSegments.
  */
+/**
+ * @typedef {[SegmentData, number]} DragSegment
+ */
 /**
  * @typedef {Object} Options
  * @property {import("../events/condition.js").Condition} [condition] A function that
@@ -29,7 +32,8 @@
  * Style used for the modification point or vertex. For linestrings and polygons, this will
  * be the affected vertex, for circles a point along the circle, and for points the actual
  * point. If not configured, the default edit style is used (see {@link module:ol/style/Style~Style}).
- * When using a style function, the point feature passed to the function will have a `features`
+ * When using a style function, the point feature passed to the function will have an `existing` property -
+ * indicating whether there is an existing vertex underneath or not, a `features`
  * property - an array whose entries are the features that are being modified, and a `geometries`
  * property - an array whose entries are the geometries that are being modified. Both arrays are
  * in the same order. The `geometries` are only useful when modifying geometry collections, where
@@ -103,6 +107,7 @@ export type SegmentData = {
      */
     featureSegments?: SegmentData[] | undefined;
 };
+export type DragSegment = [SegmentData, number];
 export type Options = {
     /**
      * A function that
@@ -136,7 +141,8 @@ export type Options = {
      * Style used for the modification point or vertex. For linestrings and polygons, this will
      * be the affected vertex, for circles a point along the circle, and for points the actual
      * point. If not configured, the default edit style is used (see {@link module :ol/style/Style~Style}).
-     * When using a style function, the point feature passed to the function will have a `features`
+     * When using a style function, the point feature passed to the function will have an `existing` property -
+     * indicating whether there is an existing vertex underneath or not, a `features`
      * property - an array whose entries are the features that are being modified, and a `geometries`
      * property - an array whose entries are the geometries that are being modified. Both arrays are
      * in the same order. The `geometries` are only useful when modifying geometry collections, where
@@ -307,7 +313,7 @@ declare class Modify extends PointerInteraction {
      */
     private changingFeature_;
     /**
-     * @type {Array}
+     * @type {Array<DragSegment>}
      * @private
      */
     private dragSegments_;
@@ -360,7 +366,7 @@ declare class Modify extends PointerInteraction {
     private addFeature_;
     /**
      * @param {import("../MapBrowserEvent.js").default} evt Map browser event.
-     * @param {Array<Array<SegmentData>>} segments The segments subject to modification.
+     * @param {Array<SegmentData>} segments The segments subject to modification.
      * @private
      */
     private willModifyFeatures_;
@@ -471,40 +477,71 @@ declare class Modify extends PointerInteraction {
      * @param {import("../coordinate.js").Coordinate} coordinates Coordinates.
      * @param {Array<Feature>} features The features being modified.
      * @param {Array<import("../geom/SimpleGeometry.js").default>} geometries The geometries being modified.
+     * @param {boolean} existing The vertex represents an existing vertex.
      * @return {Feature} Vertex feature.
      * @private
      */
     private createOrUpdateVertexFeature_;
+    findInsertVerticesAndUpdateDragSegments_(pixelCoordinate: any): SegmentData[] | undefined;
     /**
      * @param {import("../MapBrowserEvent.js").default} evt Event.
      * @private
      */
     private handlePointerMove_;
     /**
-     * @param {import("../pixel.js").Pixel} pixel Pixel
-     * @param {import("../Map.js").default} map Map.
-     * @param {import("../coordinate.js").Coordinate} [coordinate] The pixel Coordinate.
+     * @param {import("../coordinate.js").Coordinate} pixelCoordinate The pixel Coordinate.
      * @private
      */
     private handlePointerAtPixel_;
     /**
      * @param {SegmentData} segmentData Segment data.
      * @param {import("../coordinate.js").Coordinate} vertex Vertex.
+     * @return {boolean} A vertex was inserted.
      * @private
      */
     private insertVertex_;
+    updatePointer_(coordinate: any): import("../coordinate.js").Coordinate;
+    /**
+     * Get the current pointer position.
+     * @return {import("../coordinate.js").Coordinate | null} The current pointer coordinate.
+     */
+    getPoint(): import("../coordinate.js").Coordinate | null;
+    /**
+     * Check if a point can be removed from the current linestring or polygon at the current
+     * pointer position.
+     * @return {boolean} A point can be deleted at the current pointer position.
+     * @api
+     */
+    canRemovePoint(): boolean;
     /**
-     * Removes the vertex currently being pointed.
+     * Removes the vertex currently being pointed from the current linestring or polygon.
+     * @param {import('../coordinate.js').Coordinate} [coordinate] If provided, the pointer
+     * will be set to the provided coordinate. If not, the current pointer coordinate will be used.
      * @return {boolean} True when a vertex was removed.
      * @api
      */
-    removePoint(): boolean;
+    removePoint(coordinate?: import("../coordinate.js").Coordinate | undefined): boolean;
     /**
      * Removes a vertex from all matching features.
      * @return {boolean} True when a vertex was removed.
      * @private
      */
     private removeVertex_;
+    /**
+     * Check if a point can be inserted to the current linestring or polygon at the current
+     * pointer position.
+     * @return {boolean} A point can be inserted at the current pointer position.
+     * @api
+     */
+    canInsertPoint(): boolean;
+    /**
+     * Inserts the vertex currently being pointed to the current linestring or polygon.
+     * @param {import('../coordinate.js').Coordinate} [coordinate] If provided, the pointer
+     * will be set to the provided coordinate. If not, the current pointer coordinate will be used.
+     * @return {boolean} A vertex was inserted.
+     * @api
+     */
+    insertPoint(coordinate?: import("../coordinate.js").Coordinate | undefined): boolean;
     /**
      * @param {import("../geom/SimpleGeometry.js").default} geometry Geometry.
      * @param {Array} coordinates Coordinates.