@turf/tag - npm Package Compare versions

Comparing version 3.5.2 to 3.5.3

index.js

@@ -9,27 +9,28 @@ var inside = require('@turf/inside');
  * @param {FeatureCollection<Polygon>} polygons input polygons
- * @param {string} field property in `polygons` to add to joined Point features
- * @param {string} outField property in `points` in which to store joined property from `polygons
+ * @param {string} field property in `polygons` to add to joined {<Point>} features
+ * @param {string} outField property in `points` in which to store joined property from `polygons`
  * @return {FeatureCollection<Point>} points with `containingPolyId` property containing values from `polyId`
  * @example
- * var bbox = [0, 0, 10, 10];
- * // create a triangular grid of polygons
- * var triangleGrid = turf.triangleGrid(bbox, 50, 'miles');
- * triangleGrid.features.forEach(function(f) {
- *   f.properties.fill = '#' +
- *     (~~(Math.random() * 16)).toString(16) +
- *     (~~(Math.random() * 16)).toString(16) +
- *     (~~(Math.random() * 16)).toString(16);
- *   f.properties.stroke = 0;
- *   f.properties['fill-opacity'] = 1;
- * });
- * var randomPoints = turf.random('point', 30, {
- *   bbox: bbox
- * });
- * var both = turf.featurecollection(
- *   triangleGrid.features.concat(randomPoints.features));
+ * var pt1 = point([-77, 44]);
+ * var pt2 = point([-77, 38]);
+ * var poly1 = polygon([[
+ *   [-81, 41],
+ *   [-81, 47],
+ *   [-72, 47],
+ *   [-72, 41],
+ *   [-81, 41]
+ * ]], {pop: 3000});
+ * var poly2 = polygon([[
+ *   [-81, 35],
+ *   [-81, 41],
+ *   [-72, 41],
+ *   [-72, 35],
+ *   [-81, 35]
+ * ]], {pop: 1000});
  *
- * //=both
+ * var points = featureCollection([pt1, pt2]);
+ * var polygons = featureCollection([poly1, poly2]);
  *
- * var tagged = turf.tag(randomPoints, triangleGrid,
- *                       'fill', 'marker-color');
+ * var tagged = turf.tag(points, polygons,
+ *                       'pop', 'population');
  *
@@ -36,0 +37,0 @@ * //=tagged

package.json

 {
   "name": "@turf/tag",
-  "version": "3.5.2",
+  "version": "3.5.3",
   "description": "turf tag module",
@@ -30,3 +30,3 @@ "main": "index.js",
   "dependencies": {
-    "@turf/inside": "^3.5.2"
+    "@turf/inside": "^3.5.3"
   },
@@ -33,0 +33,0 @@ "devDependencies": {

README.md

@@ -11,4 +11,4 @@ # @turf/tag
 -   `polygons` **[FeatureCollection](http://geojson.org/geojson-spec.html#feature-collection-objects)<[Polygon](http://geojson.org/geojson-spec.html#polygon)>** input polygons
--   `field` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** property in `polygons` to add to joined Point features
--   `outField` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** property in `points` in which to store joined property from \`polygons
+-   `field` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** property in `polygons` to add to joined {<Point>} features
+-   `outField` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** property in `points` in which to store joined property from `polygons`
 
@@ -18,23 +18,24 @@ **Examples**
 ```javascript
-var bbox = [0, 0, 10, 10];
-// create a triangular grid of polygons
-var triangleGrid = turf.triangleGrid(bbox, 50, 'miles');
-triangleGrid.features.forEach(function(f) {
-  f.properties.fill = '#' +
-    (~~(Math.random() * 16)).toString(16) +
-    (~~(Math.random() * 16)).toString(16) +
-    (~~(Math.random() * 16)).toString(16);
-  f.properties.stroke = 0;
-  f.properties['fill-opacity'] = 1;
-});
-var randomPoints = turf.random('point', 30, {
-  bbox: bbox
-});
-var both = turf.featurecollection(
-  triangleGrid.features.concat(randomPoints.features));
+var pt1 = point([-77, 44]);
+var pt2 = point([-77, 38]);
+var poly1 = polygon([[
+  [-81, 41],
+  [-81, 47],
+  [-72, 47],
+  [-72, 41],
+  [-81, 41]
+]], {pop: 3000});
+var poly2 = polygon([[
+  [-81, 35],
+  [-81, 41],
+  [-72, 41],
+  [-72, 35],
+  [-81, 35]
+]], {pop: 1000});
 
-//=both
+var points = featureCollection([pt1, pt2]);
+var polygons = featureCollection([poly1, poly2]);
 
-var tagged = turf.tag(randomPoints, triangleGrid,
-                      'fill', 'marker-color');
+var tagged = turf.tag(points, polygons,
+                      'pop', 'population');
 
@@ -41,0 +42,0 @@ //=tagged

No alert changes

Improved metrics

Lines of code

87

increased by1.16%

Number of lines in readme file

69

increased by1.47%

Worsened metrics

Total package byte prevSize

7054

decreased by-5.44%

Dependency changes

• Updated@turf/inside@^3.5.3