ol 10.4.1-dev.1738789133545 → 10.4.1-dev.1739165709127

package/interaction/Snap.d.ts

@@ -1,41 +1,75 @@
 export default Snap;
-export type Result = {
+/**
+ * An array of two coordinates representing a line segment, or an array of one
+ * coordinate representing a point.
+ */
+export type Segment = Array<import("../coordinate.js").Coordinate>;
+export type SegmentData = {
     /**
-     * Vertex.
+     * Feature.
      */
-    vertex: import("../coordinate.js").Coordinate | null;
+    feature: import("../Feature.js").default;
     /**
-     * VertexPixel.
+     * Segment.
      */
-    vertexPixel: import("../pixel.js").Pixel | null;
+    segment: Segment;
     /**
-     * Feature.
+     * Is intersection.
      */
-    feature: import("../Feature.js").default | null;
+    isIntersection?: boolean | undefined;
+};
+/**
+ * A function taking a {@link module :ol/geom/Geometry~Geometry} as argument and returning an array of {@link Segment}s.
+ */
+export type Segmenter<GeometryType extends import("../geom/Geometry.js").default = import("../geom/Geometry.js").default> = (geometry: GeometryType, projection?: import("../proj/Projection.js").default) => Array<Segment>;
+/**
+ * Each segmenter specified here will override the default segmenter for the
+ * corresponding geometry type. To exclude all geometries of a specific geometry type from being snapped to,
+ * set the segmenter to `null`.
+ */
+export type Segmenters = {
     /**
-     * Segment, or `null` if snapped to a vertex.
+     * Point segmenter.
      */
-    segment: Array<import("../coordinate.js").Coordinate> | null;
-};
-export type SegmentData = {
+    Point?: Segmenter<import("../geom/Point.js").default> | null | undefined;
     /**
-     * Feature.
+     * LineString segmenter.
      */
-    feature: import("../Feature.js").default;
+    LineString?: Segmenter<import("../geom/LineString.js").default> | null | undefined;
     /**
-     * Segment.
+     * Polygon segmenter.
      */
-    segment: Array<import("../coordinate.js").Coordinate>;
+    Polygon?: Segmenter<import("../geom/Polygon.js").default> | null | undefined;
     /**
-     * Is intersection.
+     * Circle segmenter.
      */
-    isIntersection?: boolean | undefined;
+    Circle?: Segmenter<import("../geom/Circle.js").default> | null | undefined;
+    /**
+     * GeometryCollection segmenter.
+     */
+    GeometryCollection?: Segmenter<import("../geom/GeometryCollection.js").default> | null | undefined;
+    /**
+     * MultiPoint segmenter.
+     */
+    MultiPoint?: Segmenter<import("../geom/MultiPoint.js").default> | null | undefined;
+    /**
+     * MultiLineString segmenter.
+     */
+    MultiLineString?: Segmenter<import("../geom/MultiLineString.js").default> | null | undefined;
+    /**
+     * MultiPolygon segmenter.
+     */
+    MultiPolygon?: Segmenter<import("../geom/MultiPolygon.js").default> | null | undefined;
 };
 export type Options = {
     /**
      * Snap to these features. Either this option or source should be provided.
      */
     features?: import("../Collection.js").default<import("../Feature.js").default<import("../geom/Geometry.js").default>> | undefined;
+    /**
+     * Snap to features from this source. Either this option or features should be provided
+     */
+    source?: import("../source/Vector.js").default<import("../Feature.js").default<import("../geom/Geometry.js").default>> | undefined;
     /**
      * Snap to edges.
      */
@@ -54,9 +88,18 @@ export type Options = {
      */
     pixelTolerance?: number | undefined;
     /**
-     * Snap to features from this source. Either this option or features should be provided
-     */
-    source?: import("../source/Vector.js").default<import("../Feature.js").default<import("../geom/Geometry.js").default>> | undefined;
+     * Custom segmenters by {@link module :ol/geom/Geometry~Type}. By default, the
+     * following segmenters are used:
+     * - `Point`: A one-dimensional segment (e.g. `[[10, 20]]`) representing the point.
+     * - `LineString`: One two-dimensional segment (e.g. `[[10, 20], [30, 40]]`) for each segment of the linestring.
+     * - `Polygon`: One two-dimensional segment for each segment of the exterior ring and the interior rings.
+     * - `Circle`: One two-dimensional segment for each segment of a regular polygon with 32 points representing the circle circumference.
+     * - `GeometryCollection`: All segments of the contained geometries.
+     * - `MultiPoint`: One one-dimensional segment for each point.
+     * - `MultiLineString`: One two-dimensional segment for each segment of the linestrings.
+     * - `MultiPolygon`: One two-dimensional segment for each segment of the polygons.
+     */
+    segmenters?: Segmenters | undefined;
 };
 /**
  * Information about the last snapped state.
@@ -69,7 +112,7 @@ export type SnappedInfo = {
     /**
      * - The pixel of the snapped vertex.
      */
-    vertexPixel: import("../coordinate.js").Coordinate | null;
+    vertexPixel: import("../pixel.js").Pixel | null;
     /**
      * - The feature being snapped.
      */
@@ -77,7 +120,7 @@ export type SnappedInfo = {
     /**
      * - Segment, or `null` if snapped to a vertex.
      */
-    segment: Array<import("../coordinate.js").Coordinate> | null;
+    segment: Segment | null;
 };
 /**
  * *
@@ -201,11 +244,10 @@ declare class Snap extends PointerInteraction {
      */
     private snapped_;
     /**
-     * @const
+     * @type {Object<string, Segmenter>}
      * @private
-     * @type {Object<string, function(Array<Array<import('../coordinate.js').Coordinate>>, import("../geom/Geometry.js").default): void>}
      */
-    private GEOMETRY_SEGMENTERS_;
+    private segmenters_;
     /**
      * Add a feature to the collection of features that we may snap to.
      * @param {import("../Feature.js").default} feature Feature.
@@ -264,62 +306,14 @@ declare class Snap extends PointerInteraction {
      * @param {import("../pixel.js").Pixel} pixel Pixel
      * @param {import("../coordinate.js").Coordinate} pixelCoordinate Coordinate
      * @param {import("../Map.js").default} map Map.
-     * @return {Result|null} Snap result
+     * @return {SnappedInfo|null} Snap result
      */
-    snapTo(pixel: import("../pixel.js").Pixel, pixelCoordinate: import("../coordinate.js").Coordinate, map: import("../Map.js").default): Result | null;
+    snapTo(pixel: import("../pixel.js").Pixel, pixelCoordinate: import("../coordinate.js").Coordinate, map: import("../Map.js").default): SnappedInfo | null;
     /**
      * @param {import("../Feature.js").default} feature Feature
      * @private
      */
     private updateFeature_;
-    /**
-     * @param {Array<Array<import('../coordinate.js').Coordinate>>} segments Segments
-     * @param {import("../geom/Circle.js").default} geometry Geometry.
-     * @private
-     */
-    private segmentCircleGeometry_;
-    /**
-     * @param {Array<Array<import('../coordinate.js').Coordinate>>} segments Segments
-     * @param {import("../geom/GeometryCollection.js").default} geometry Geometry.
-     * @private
-     */
-    private segmentGeometryCollectionGeometry_;
-    /**
-     * @param {Array<Array<import('../coordinate.js').Coordinate>>} segments Segments
-     * @param {import("../geom/LineString.js").default} geometry Geometry.
-     * @private
-     */
-    private segmentLineStringGeometry_;
-    /**
-     * @param {Array<Array<import('../coordinate.js').Coordinate>>} segments Segments
-     * @param {import("../geom/MultiLineString.js").default} geometry Geometry.
-     * @private
-     */
-    private segmentMultiLineStringGeometry_;
-    /**
-     * @param {Array<Array<import('../coordinate.js').Coordinate>>} segments Segments
-     * @param {import("../geom/MultiPoint.js").default} geometry Geometry.
-     * @private
-     */
-    private segmentMultiPointGeometry_;
-    /**
-     * @param {Array<Array<import('../coordinate.js').Coordinate>>} segments Segments
-     * @param {import("../geom/MultiPolygon.js").default} geometry Geometry.
-     * @private
-     */
-    private segmentMultiPolygonGeometry_;
-    /**
-     * @param {Array<Array<import('../coordinate.js').Coordinate>>} segments Segments
-     * @param {import("../geom/Point.js").default} geometry Geometry.
-     * @private
-     */
-    private segmentPointGeometry_;
-    /**
-     * @param {Array<Array<import('../coordinate.js').Coordinate>>} segments Segments
-     * @param {import("../geom/Polygon.js").default} geometry Geometry.
-     * @private
-     */
-    private segmentPolygonGeometry_;
 }
 import { SnapEvent } from '../events/SnapEvent.js';
 import PointerInteraction from './Pointer.js';

package/interaction/Snap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Snap.d.ts","sourceRoot":"","sources":["Snap.js"],"names":[],"mappings":";;;;;YAkCc,OAAO,kBAAkB,EAAE,UAAU,GAAC,IAAI;;;;iBAC1C,OAAO,aAAa,EAAE,KAAK,GAAC,IAAI;;;;aAChC,OAAO,eAAe,EAAE,OAAO,GAAC,IAAI;;;;aACpC,KAAK,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC,GAAC,IAAI;;;;;;aAKjD,OAAO,eAAe,EAAE,OAAO;;;;aAC/B,KAAK,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAkB5C,OAAO,kBAAkB,EAAE,UAAU,GAAC,IAAI;;;;iBAC1C,OAAO,kBAAkB,EAAE,UAAU,GAAC,IAAI;;;;aAC1C,OAAO,eAAe,EAAE,OAAO,GAAC,IAAI;;;;aACpC,KAAK,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC,GAAC,IAAI;;;;;4BAiClD,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,MAAM,GAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,GAC3E,OAAW,eAAe,EAAE,mBAAmB,CAAC,OAAO,eAAe,EAAE,UAAU,GAAC,OAAO,oBAAoB,EAAE,KAAK,GACrH,eAAqB,GAAC,MAAM,GAAC,QAAQ,EAAE,MAAM,CAAC;AAP/C;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH;IACE;;OAEG;IACH,sBAFW,OAAO,EAmIjB;IAhHC;;OAEG;IACH,IAFU,eAAe,CAAC,OAAO,WAAW,EAAE,SAAS,CAAC,CAEjD;IAEP;;OAEG;IACH,MAFU,eAAe,CAAC,OAAO,WAAW,EAAE,SAAS,CAAC,CAE/C;IAET;;OAEG;IACH,IAFU,eAAe,CAAC,IAAI,CAAC,CAExB;IAEP;;;OAGG;IACH,gBAAqD;IAErD;;;OAGG;IACH,gBAAmE;IAEnE;;;OAGG;IACH,cAA6D;IAE7D;;;OAGG;IACH,sBACmE;IAEnE;;;OAGG;IACH,kBAA2D;IAE3D;;;OAGG;IACH,8BAA+B;IAE/B;;;OAGG;IACH,mCAAoC;IAEpC;;;;;OAKG;IACH,gCAAiC;IAEjC;;;;;;OAMG;IACH,yBAA0B;IAE1B;;;OAGG;IACH,wBACoE;IAEpE;;;;OAIG;IACH,eAAyB;IAEzB;;;;OAIG;IACH,iBAAoB;IAEpB;;;;OAIG;IACH,6BAUC;IAGH;;;;;;OAMG;IACH,oBALW,OAAO,eAAe,EAAE,OAAO,aAC/B,OAAO,QA8FjB;IAED;;;OAGG;IACH,qBASC;IAED;;;;;;;;OAQG;IACH,0BAEC;IAoCD;;;OAGG;IACH,0BAKC;IAED;;;OAGG;IACH,6BAKC;IAED;;;OAGG;IACH,6BAUC;IAiBD;;;;;;OAMG;IACH,uBALW,OAAO,eAAe,EAAE,OAAO,aAC/B,OAAO,QAyBjB;IAED;;;;;;OAMG;IACH,qBAHW,OAAO,WAAW,EAAE,OAAO,QAqDrC;IAED;;;;;OAKG;IACH,cALW,OAAO,aAAa,EAAE,KAAK,mBAC3B,OAAO,kBAAkB,EAAE,UAAU,OACrC,OAAO,WAAW,EAAE,OAAO,GAC1B,MAAM,GAAC,IAAI,CAsHtB;IAED;;;OAGG;IACH,uBAGC;IAED;;;;OAIG;IACH,+BAiBC;IAED;;;;OAIG;IACH,2CAQC;IAED;;;;OAIG;IACH,mCAKC;IAED;;;;OAIG;IACH,wCAQC;IAED;;;;OAIG;IACH,mCAIC;IAED;;;;OAIG;IACH,qCAWC;IAED;;;;OAIG;IACH,8BAEC;IAED;;;;OAIG;IACH,gCAQC;CACF;0BAzyBsC,wBAAwB;+BAoBhC,cAAc"}
+{"version":3,"file":"Snap.d.ts","sourceRoot":"","sources":["Snap.js"],"names":[],"mappings":";;;;;sBAiCa,KAAK,CAAC,OAAO,kBAAkB,EAAE,UAAU,CAAC;;;;;aAO3C,OAAO,eAAe,EAAE,OAAO;;;;aAC/B,OAAO;;;;;;;;;sBAKiC,YAAY,SAArD,OAAQ,qBAAqB,EAAE,OAAQ,4CACvC,CAAC,QAAQ,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,OAAO,uBAAuB,EAAE,OAAO,KAAK,KAAK,CAAC,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA2C/F,OAAO,kBAAkB,EAAE,UAAU,GAAC,IAAI;;;;iBAC1C,OAAO,aAAa,EAAE,KAAK,GAAC,IAAI;;;;aAChC,OAAO,eAAe,EAAE,OAAO,GAAC,IAAI;;;;aACpC,OAAO,GAAC,IAAI;;;;;4BAgMb,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,MAAM,GAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,CAAC,GAC3E,OAAW,eAAe,EAAE,mBAAmB,CAAC,OAAO,eAAe,EAAE,UAAU,GAAC,OAAO,oBAAoB,EAAE,KAAK,GACrH,eAAqB,GAAC,MAAM,GAAC,QAAQ,EAAE,MAAM,CAAC;AAP/C;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH;IACE;;OAEG;IACH,sBAFW,OAAO,EA4HjB;IAzGC;;OAEG;IACH,IAFU,eAAe,CAAC,OAAO,WAAW,EAAE,SAAS,CAAC,CAEjD;IAEP;;OAEG;IACH,MAFU,eAAe,CAAC,OAAO,WAAW,EAAE,SAAS,CAAC,CAE/C;IAET;;OAEG;IACH,IAFU,eAAe,CAAC,IAAI,CAAC,CAExB;IAEP;;;OAGG;IACH,gBAAqD;IAErD;;;OAGG;IACH,gBAAmE;IAEnE;;;OAGG;IACH,cAA6D;IAE7D;;;OAGG;IACH,sBACmE;IAEnE;;;OAGG;IACH,kBAA2D;IAE3D;;;OAGG;IACH,8BAA+B;IAE/B;;;OAGG;IACH,mCAAoC;IAEpC;;;;;OAKG;IACH,gCAAiC;IAEjC;;;;;;OAMG;IACH,yBAA0B;IAE1B;;;OAGG;IACH,wBACoE;IAEpE;;;;OAIG;IACH,eAAyB;IAEzB;;;;OAIG;IACH,iBAAoB;IAEpB;;;OAGG;IACH,oBAIC;IAGH;;;;;;OAMG;IACH,oBALW,OAAO,eAAe,EAAE,OAAO,aAC/B,OAAO,QA+FjB;IAED;;;OAGG;IACH,qBASC;IAED;;;;;;;;OAQG;IACH,0BAEC;IAoCD;;;OAGG;IACH,0BAKC;IAED;;;OAGG;IACH,6BAKC;IAED;;;OAGG;IACH,6BAUC;IAkBD;;;;;;OAMG;IACH,uBALW,OAAO,eAAe,EAAE,OAAO,aAC/B,OAAO,QAyBjB;IAED;;;;;;OAMG;IACH,qBAHW,OAAO,WAAW,EAAE,OAAO,QAwDrC;IAED;;;;;OAKG;IACH,cALW,OAAO,aAAa,EAAE,KAAK,mBAC3B,OAAO,kBAAkB,EAAE,UAAU,OACrC,OAAO,WAAW,EAAE,OAAO,GAC1B,WAAW,GAAC,IAAI,CAsH3B;IAED;;;OAGG;IACH,uBAGC;CACF;0BA52BsC,wBAAwB;+BAoBhC,cAAc"}