@turf/dissolve 6.4.0 → 7.0.0-alpha.0

package/README.md

@@ -7,13 +7,14 @@
 Dissolves a FeatureCollection of [polygon][1] features, filtered by an optional property name:value.
 Note that [mulitpolygon][2] features within the collection are not supported
 
-**Parameters**
+### Parameters
 
--   `featureCollection` **[FeatureCollection][3]<[Polygon][4]>** input feature collection to be dissolved
--   `options` **[Object][5]** Optional parameters (optional, default `{}`)
-    -   `options.propertyName` **[string][6]?** features with equals 'propertyName' in `properties` will be merged
+*   `featureCollection` **[FeatureCollection][3]<[Polygon][4]>** input feature collection to be dissolved
+*   `options` **[Object][5]** Optional parameters (optional, default `{}`)
 
-**Examples**
+    *   `options.propertyName` **[string][6]?** features with the same `propertyName` value will be dissolved.
+
+### Examples
 
 ```javascript
 var features = turf.featureCollection([
@@ -28,7 +29,7 @@ var dissolved = turf.dissolve(features, {propertyName: 'combine'});
 var addToMap = [features, dissolved]
 ```
 
-Returns **[FeatureCollection][3]&lt;[Polygon][4]>** a FeatureCollection containing the dissolved polygons
+Returns **[FeatureCollection][3]<[Polygon][4]>** a FeatureCollection containing the dissolved polygons
 
 [1]: polygon
 

package/dist/es/index.js

@@ -1,113 +1,8 @@
-import rbush from 'geojson-rbush';
-import clone from '@turf/clone';
-import overlap from '@turf/boolean-overlap';
-import turfUnion from '@turf/union';
-import lineIntersect from '@turf/line-intersect';
-import { coordAll } from '@turf/meta';
+import { isObject, multiPolygon, featureCollection } from '@turf/helpers';
 import { collectionOf } from '@turf/invariant';
-import { lineString, isObject } from '@turf/helpers';
-
-/**
- * @license get-closest https://github.com/cosmosio/get-closest
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2014-2017 Olivier Scherrer <pode.fr@gmail.com>
- */
-
-/**
- * Get the closest number in an array
- *
- * @private
- * @param {number} item the base number
- * @param {Array} array the array to search into
- * @param {Function} getDiff returns the difference between the base number and
- *   and the currently read item in the array. The item which returned the smallest difference wins.
- * @returns {Object} Get Closest
- */
-function _getClosest(item, array, getDiff) {
-  var closest, diff;
-
-  if (!Array.isArray(array)) {
-    throw new Error("Get closest expects an array as second argument");
-  }
-
-  array.forEach(function (comparedItem, comparedItemIndex) {
-    var thisDiff = getDiff(comparedItem, item);
-
-    if (thisDiff >= 0 && (typeof diff == "undefined" || thisDiff < diff)) {
-      diff = thisDiff;
-      closest = comparedItemIndex;
-    }
-  });
-
-  return closest;
-}
-
-/**
- * Get the closest number in an array given a base number
- *
- * @private
- * @param {number} item the base number
- * @param {Array<number>} array the array of numbers to search into
- * @returns {number} the index of the closest item in the array
- * @example
- * closestNumber(30, [20, 0, 50, 29])
- * //= will return 3 as 29 is the closest item
- */
-
-
-/**
- * Get the closest greater number in an array given a base number
- *
- * @private
- * @param {number} item the base number
- * @param {Array<number>} array the array of numbers to search into
- * @returns {number} the index of the closest item in the array
- * @example
- * closestGreaterNumber(30, [20, 0, 50, 29])
- * //= will return 2 as 50 is the closest greater item
- */
-function closestGreaterNumber(item, array) {
-  return _getClosest(item, array, function (comparedItem, item) {
-    return comparedItem - item;
-  });
-}
-
-/**
- * Get the closest lower number in an array given a base number
- *
- * @private
- * @param {number} item the base number
- * @param {Array<number>} array the array of numbers to search into
- * @returns {number} the index of the closest item in the array
- * @example
- * closestLowerNumber(30, [20, 0, 50, 29])
- * //= will return 0 as 20 is the closest lower item
- */
-
-
-/**
- * Get the closest item in an array given a base item and a comparator function
- *
- * @private
- * @param {*} item the base item
- * @param {Array} array an array of items
- * @param {Function} comparator a comparatof function to compare the items
- * @returns {Object} Closest Custom
- * @example
- * closestCustom("lundi", ["mundi", "mardi"], getLevenshteinDistance)
- * //= will return 0 for "lundi"
- *
- * // The function looks like:
- *
- * // comparedItem comes from the array
- * // baseItem is the item to compare the others to
- * // It returns a number
- * function comparator(comparedItem, baseItem) {
- *     return comparedItem - baseItem;
- * }
- */
+import { featureEach } from '@turf/meta';
+import flatten from '@turf/flatten';
+import polygonClipping from 'polygon-clipping';
 
 /**
  * Dissolves a FeatureCollection of {@link polygon} features, filtered by an optional property name:value.
@@ -116,7 +11,7 @@ function closestGreaterNumber(item, array) {
  * @name dissolve
  * @param {FeatureCollection<Polygon>} featureCollection input feature collection to be dissolved
  * @param {Object} [options={}] Optional parameters
- * @param {string} [options.propertyName] features with equals 'propertyName' in `properties` will be merged
+ * @param {string} [options.propertyName] features with the same `propertyName` value will be dissolved.
  * @returns {FeatureCollection<Polygon>} a FeatureCollection containing the dissolved polygons
  * @example
  * var features = turf.featureCollection([
@@ -130,118 +25,57 @@ function closestGreaterNumber(item, array) {
  * //addToMap
  * var addToMap = [features, dissolved]
  */
-function dissolve(featureCollection, options) {
+function dissolve(fc, options) {
   // Optional parameters
   options = options || {};
   if (!isObject(options)) throw new Error("options is invalid");
   var propertyName = options.propertyName;
 
   // Input validation
-  collectionOf(featureCollection, "Polygon", "dissolve");
+  collectionOf(fc, "Polygon", "dissolve");
 
   // Main
-  var fc = clone(featureCollection);
-  var features = fc.features;
-
-  var originalIndexOfItemsRemoved = [];
-
-  features.forEach(function (f, i) {
-    f.properties.origIndexPosition = i;
-  });
-  var tree = rbush();
-  tree.load(fc);
-
-  for (var i in features) {
-    var polygon = features[i];
-
-    var featureChanged = false;
-
-    tree.search(polygon).features.forEach(function (potentialMatchingFeature) {
-      polygon = features[i];
-
-      var matchFeaturePosition =
-        potentialMatchingFeature.properties.origIndexPosition;
-
+  var outFeatures = [];
+  if (!options.propertyName) {
+    return flatten(
+      multiPolygon(
+        polygonClipping.union.apply(
+          null,
+          fc.features.map(function (f) {
+            return f.geometry.coordinates;
+          })
+        )
+      )
+    );
+  } else {
+    var uniquePropertyVals = {};
+    featureEach(fc, function (feature) {
       if (
-        originalIndexOfItemsRemoved.length > 0 &&
-        matchFeaturePosition !== 0
+        !Object.prototype.hasOwnProperty.call(
+          uniquePropertyVals,
+          feature.properties[propertyName]
+        )
       ) {
-        if (
-          matchFeaturePosition >
-          originalIndexOfItemsRemoved[originalIndexOfItemsRemoved.length - 1]
-        ) {
-          matchFeaturePosition =
-            matchFeaturePosition - originalIndexOfItemsRemoved.length;
-        } else {
-          var closestNumber$$1 = closestGreaterNumber(
-            matchFeaturePosition,
-            originalIndexOfItemsRemoved
-          );
-          if (closestNumber$$1 !== 0) {
-            matchFeaturePosition = matchFeaturePosition - closestNumber$$1;
-          }
-        }
+        uniquePropertyVals[feature.properties[propertyName]] = [];
       }
-
-      if (matchFeaturePosition === +i) return;
-
-      var matchFeature = features[matchFeaturePosition];
-      if (!matchFeature || !polygon) return;
-
-      if (
-        propertyName !== undefined &&
-        matchFeature.properties[propertyName] !==
-          polygon.properties[propertyName]
-      )
-        return;
-
-      if (
-        !overlap(polygon, matchFeature) ||
-        !ringsIntersect(polygon, matchFeature)
-      )
-        return;
-
-      features[i] = turfUnion(polygon, matchFeature);
-
-      originalIndexOfItemsRemoved.push(
-        potentialMatchingFeature.properties.origIndexPosition
-      );
-      originalIndexOfItemsRemoved.sort(function (a, b) {
-        return a - b;
-      });
-
-      tree.remove(potentialMatchingFeature);
-      features.splice(matchFeaturePosition, 1);
-      polygon.properties.origIndexPosition = i;
-      tree.remove(polygon, function (a, b) {
-        return (
-          a.properties.origIndexPosition === b.properties.origIndexPosition
-        );
-      });
-      featureChanged = true;
+      uniquePropertyVals[feature.properties[propertyName]].push(feature);
     });
-
-    if (featureChanged) {
-      if (!polygon) continue;
-      polygon.properties.origIndexPosition = i;
-      tree.insert(polygon);
-      i--;
+    var vals = Object.keys(uniquePropertyVals);
+    for (var i = 0; i < vals.length; i++) {
+      var mp = multiPolygon(
+        polygonClipping.union.apply(
+          null,
+          uniquePropertyVals[vals[i]].map(function (f) {
+            return f.geometry.coordinates;
+          })
+        )
+      );
+      mp.properties[propertyName] = vals[i];
+      outFeatures.push(mp);
     }
   }
 
-  features.forEach(function (f) {
-    delete f.properties.origIndexPosition;
-    delete f.bbox;
-  });
-
-  return fc;
-}
-
-function ringsIntersect(poly1, poly2) {
-  var line1 = lineString(coordAll(poly1));
-  var line2 = lineString(coordAll(poly2));
-  var points = lineIntersect(line1, line2).features;
-  return points.length > 0;
+  return flatten(featureCollection(outFeatures));
 }
 
 export default dissolve;

package/dist/js/index.js

@@ -1,117 +1,15 @@
 'use strict';
 
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var rbush = _interopDefault(require('geojson-rbush'));
-var clone = _interopDefault(require('@turf/clone'));
-var overlap = _interopDefault(require('@turf/boolean-overlap'));
-var turfUnion = _interopDefault(require('@turf/union'));
-var lineIntersect = _interopDefault(require('@turf/line-intersect'));
-var meta = require('@turf/meta');
-var invariant = require('@turf/invariant');
 var helpers = require('@turf/helpers');
+var invariant = require('@turf/invariant');
+var meta = require('@turf/meta');
+var flatten = require('@turf/flatten');
+var polygonClipping = require('polygon-clipping');
 
-/**
- * @license get-closest https://github.com/cosmosio/get-closest
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2014-2017 Olivier Scherrer <pode.fr@gmail.com>
- */
-
-/**
- * Get the closest number in an array
- *
- * @private
- * @param {number} item the base number
- * @param {Array} array the array to search into
- * @param {Function} getDiff returns the difference between the base number and
- *   and the currently read item in the array. The item which returned the smallest difference wins.
- * @returns {Object} Get Closest
- */
-function _getClosest(item, array, getDiff) {
-  var closest, diff;
-
-  if (!Array.isArray(array)) {
-    throw new Error("Get closest expects an array as second argument");
-  }
-
-  array.forEach(function (comparedItem, comparedItemIndex) {
-    var thisDiff = getDiff(comparedItem, item);
-
-    if (thisDiff >= 0 && (typeof diff == "undefined" || thisDiff < diff)) {
-      diff = thisDiff;
-      closest = comparedItemIndex;
-    }
-  });
-
-  return closest;
-}
-
-/**
- * Get the closest number in an array given a base number
- *
- * @private
- * @param {number} item the base number
- * @param {Array<number>} array the array of numbers to search into
- * @returns {number} the index of the closest item in the array
- * @example
- * closestNumber(30, [20, 0, 50, 29])
- * //= will return 3 as 29 is the closest item
- */
-
-
-/**
- * Get the closest greater number in an array given a base number
- *
- * @private
- * @param {number} item the base number
- * @param {Array<number>} array the array of numbers to search into
- * @returns {number} the index of the closest item in the array
- * @example
- * closestGreaterNumber(30, [20, 0, 50, 29])
- * //= will return 2 as 50 is the closest greater item
- */
-function closestGreaterNumber(item, array) {
-  return _getClosest(item, array, function (comparedItem, item) {
-    return comparedItem - item;
-  });
-}
-
-/**
- * Get the closest lower number in an array given a base number
- *
- * @private
- * @param {number} item the base number
- * @param {Array<number>} array the array of numbers to search into
- * @returns {number} the index of the closest item in the array
- * @example
- * closestLowerNumber(30, [20, 0, 50, 29])
- * //= will return 0 as 20 is the closest lower item
- */
-
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
-/**
- * Get the closest item in an array given a base item and a comparator function
- *
- * @private
- * @param {*} item the base item
- * @param {Array} array an array of items
- * @param {Function} comparator a comparatof function to compare the items
- * @returns {Object} Closest Custom
- * @example
- * closestCustom("lundi", ["mundi", "mardi"], getLevenshteinDistance)
- * //= will return 0 for "lundi"
- *
- * // The function looks like:
- *
- * // comparedItem comes from the array
- * // baseItem is the item to compare the others to
- * // It returns a number
- * function comparator(comparedItem, baseItem) {
- *     return comparedItem - baseItem;
- * }
- */
+var flatten__default = /*#__PURE__*/_interopDefaultLegacy(flatten);
+var polygonClipping__default = /*#__PURE__*/_interopDefaultLegacy(polygonClipping);
 
 /**
  * Dissolves a FeatureCollection of {@link polygon} features, filtered by an optional property name:value.
@@ -120,7 +18,7 @@ function closestGreaterNumber(item, array) {
  * @name dissolve
  * @param {FeatureCollection<Polygon>} featureCollection input feature collection to be dissolved
  * @param {Object} [options={}] Optional parameters
- * @param {string} [options.propertyName] features with equals 'propertyName' in `properties` will be merged
+ * @param {string} [options.propertyName] features with the same `propertyName` value will be dissolved.
  * @returns {FeatureCollection<Polygon>} a FeatureCollection containing the dissolved polygons
  * @example
  * var features = turf.featureCollection([
@@ -134,118 +32,58 @@ function closestGreaterNumber(item, array) {
  * //addToMap
  * var addToMap = [features, dissolved]
  */
-function dissolve(featureCollection, options) {
+function dissolve(fc, options) {
   // Optional parameters
   options = options || {};
   if (!helpers.isObject(options)) throw new Error("options is invalid");
   var propertyName = options.propertyName;
 
   // Input validation
-  invariant.collectionOf(featureCollection, "Polygon", "dissolve");
+  invariant.collectionOf(fc, "Polygon", "dissolve");
 
   // Main
-  var fc = clone(featureCollection);
-  var features = fc.features;
-
-  var originalIndexOfItemsRemoved = [];
-
-  features.forEach(function (f, i) {
-    f.properties.origIndexPosition = i;
-  });
-  var tree = rbush();
-  tree.load(fc);
-
-  for (var i in features) {
-    var polygon = features[i];
-
-    var featureChanged = false;
-
-    tree.search(polygon).features.forEach(function (potentialMatchingFeature) {
-      polygon = features[i];
-
-      var matchFeaturePosition =
-        potentialMatchingFeature.properties.origIndexPosition;
-
+  var outFeatures = [];
+  if (!options.propertyName) {
+    return flatten__default['default'](
+      helpers.multiPolygon(
+        polygonClipping__default['default'].union.apply(
+          null,
+          fc.features.map(function (f) {
+            return f.geometry.coordinates;
+          })
+        )
+      )
+    );
+  } else {
+    var uniquePropertyVals = {};
+    meta.featureEach(fc, function (feature) {
       if (
-        originalIndexOfItemsRemoved.length > 0 &&
-        matchFeaturePosition !== 0
+        !Object.prototype.hasOwnProperty.call(
+          uniquePropertyVals,
+          feature.properties[propertyName]
+        )
       ) {
-        if (
-          matchFeaturePosition >
-          originalIndexOfItemsRemoved[originalIndexOfItemsRemoved.length - 1]
-        ) {
-          matchFeaturePosition =
-            matchFeaturePosition - originalIndexOfItemsRemoved.length;
-        } else {
-          var closestNumber$$1 = closestGreaterNumber(
-            matchFeaturePosition,
-            originalIndexOfItemsRemoved
-          );
-          if (closestNumber$$1 !== 0) {
-            matchFeaturePosition = matchFeaturePosition - closestNumber$$1;
-          }
-        }
+        uniquePropertyVals[feature.properties[propertyName]] = [];
       }
-
-      if (matchFeaturePosition === +i) return;
-
-      var matchFeature = features[matchFeaturePosition];
-      if (!matchFeature || !polygon) return;
-
-      if (
-        propertyName !== undefined &&
-        matchFeature.properties[propertyName] !==
-          polygon.properties[propertyName]
-      )
-        return;
-
-      if (
-        !overlap(polygon, matchFeature) ||
-        !ringsIntersect(polygon, matchFeature)
-      )
-        return;
-
-      features[i] = turfUnion(polygon, matchFeature);
-
-      originalIndexOfItemsRemoved.push(
-        potentialMatchingFeature.properties.origIndexPosition
-      );
-      originalIndexOfItemsRemoved.sort(function (a, b) {
-        return a - b;
-      });
-
-      tree.remove(potentialMatchingFeature);
-      features.splice(matchFeaturePosition, 1);
-      polygon.properties.origIndexPosition = i;
-      tree.remove(polygon, function (a, b) {
-        return (
-          a.properties.origIndexPosition === b.properties.origIndexPosition
-        );
-      });
-      featureChanged = true;
+      uniquePropertyVals[feature.properties[propertyName]].push(feature);
     });
-
-    if (featureChanged) {
-      if (!polygon) continue;
-      polygon.properties.origIndexPosition = i;
-      tree.insert(polygon);
-      i--;
+    var vals = Object.keys(uniquePropertyVals);
+    for (var i = 0; i < vals.length; i++) {
+      var mp = helpers.multiPolygon(
+        polygonClipping__default['default'].union.apply(
+          null,
+          uniquePropertyVals[vals[i]].map(function (f) {
+            return f.geometry.coordinates;
+          })
+        )
+      );
+      mp.properties[propertyName] = vals[i];
+      outFeatures.push(mp);
     }
   }
 
-  features.forEach(function (f) {
-    delete f.properties.origIndexPosition;
-    delete f.bbox;
-  });
-
-  return fc;
-}
-
-function ringsIntersect(poly1, poly2) {
-  var line1 = helpers.lineString(meta.coordAll(poly1));
-  var line2 = helpers.lineString(meta.coordAll(poly2));
-  var points = lineIntersect(line1, line2).features;
-  return points.length > 0;
+  return flatten__default['default'](helpers.featureCollection(outFeatures));
 }
 
 module.exports = dissolve;
+module.exports.default = dissolve;

package/index.d.ts

@@ -1,4 +1,4 @@
-import { FeatureCollection, Polygon } from "@turf/helpers";
+import { FeatureCollection, Polygon } from "geojson";
 
 /**
  * http://turfjs.org/docs.html#dissolve

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turf/dissolve",
-  "version": "6.4.0",
+  "version": "7.0.0-alpha.0",
   "description": "turf dissolve module",
   "author": "Turf Authors",
   "license": "MIT",
@@ -12,6 +12,7 @@
     "type": "git",
     "url": "git://github.com/Turfjs/turf.git"
   },
+  "funding": "https://opencollective.com/turf",
   "publishConfig": {
     "access": "public"
   },
@@ -53,15 +54,11 @@
     "write-json-file": "*"
   },
   "dependencies": {
-    "@turf/boolean-overlap": "^6.4.0",
-    "@turf/clone": "^6.4.0",
-    "@turf/helpers": "^6.4.0",
-    "@turf/invariant": "^6.4.0",
-    "@turf/line-intersect": "^6.4.0",
-    "@turf/meta": "^6.4.0",
-    "@turf/union": "^6.4.0",
-    "geojson-rbush": "3.x",
-    "get-closest": "*"
+    "@turf/flatten": "^7.0.0-alpha.0",
+    "@turf/helpers": "^7.0.0-alpha.0",
+    "@turf/invariant": "^7.0.0-alpha.0",
+    "@turf/meta": "^7.0.0-alpha.0",
+    "polygon-clipping": "^0.15.3"
   },
-  "gitHead": "1e62773cfc88c627cca8effcb5c14cfb65a905ac"
+  "gitHead": "0edc4c491b999e5ace770a61e1cf549f7c004189"
 }