@turf/hex-grid 7.1.0-alpha.7 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -8
- package/package.json +9 -8
package/README.md
CHANGED
|
@@ -17,8 +17,8 @@ described in [Hexagonal Grids][3].
|
|
|
17
17
|
|
|
18
18
|
* `options.units` **[string][7]** used in calculating cell size, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
|
|
19
19
|
* `options.properties` **[Object][6]** passed to each hexagon or triangle of the grid (optional, default `{}`)
|
|
20
|
-
* `options.mask` **[Feature][8]<[Polygon][
|
|
21
|
-
* `options.triangles` **[boolean][
|
|
20
|
+
* `options.mask` **[Feature][8]<[Polygon][2]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
|
|
21
|
+
* `options.triangles` **[boolean][9]** whether to return as triangles instead of hexagons (optional, default `false`)
|
|
22
22
|
|
|
23
23
|
### Examples
|
|
24
24
|
|
|
@@ -33,7 +33,7 @@ var hexgrid = turf.hexGrid(bbox, cellSide, options);
|
|
|
33
33
|
var addToMap = [hexgrid];
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
Returns **[FeatureCollection][
|
|
36
|
+
Returns **[FeatureCollection][1]<[Polygon][2]>** a hexagonal grid
|
|
37
37
|
|
|
38
38
|
[1]: https://tools.ietf.org/html/rfc7946#section-3.3
|
|
39
39
|
|
|
@@ -51,11 +51,7 @@ Returns **[FeatureCollection][11]<[Polygon][9]>** a hexagonal grid
|
|
|
51
51
|
|
|
52
52
|
[8]: https://tools.ietf.org/html/rfc7946#section-3.2
|
|
53
53
|
|
|
54
|
-
[9]: https://
|
|
55
|
-
|
|
56
|
-
[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
|
|
57
|
-
|
|
58
|
-
[11]: https://tools.ietf.org/html/rfc7946#section-3.3
|
|
54
|
+
[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
|
|
59
55
|
|
|
60
56
|
<!-- This file is automatically generated. Please don't edit it directly. If you find an error, edit the source file of the module in question (likely index.js or index.ts), and re-run "yarn docs" from the root of the turf project. -->
|
|
61
57
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@turf/hex-grid",
|
|
3
|
-
"version": "7.1.0
|
|
3
|
+
"version": "7.1.0",
|
|
4
4
|
"description": "turf hex-grid module",
|
|
5
5
|
"author": "Turf Authors",
|
|
6
6
|
"contributors": [
|
|
@@ -62,8 +62,8 @@
|
|
|
62
62
|
"test:types": "tsc --esModuleInterop --module node16 --moduleResolution node16 --noEmit --strict types.ts"
|
|
63
63
|
},
|
|
64
64
|
"devDependencies": {
|
|
65
|
-
"@turf/bbox-polygon": "^7.1.0
|
|
66
|
-
"@turf/truncate": "^7.1.0
|
|
65
|
+
"@turf/bbox-polygon": "^7.1.0",
|
|
66
|
+
"@turf/truncate": "^7.1.0",
|
|
67
67
|
"@types/benchmark": "^2.1.5",
|
|
68
68
|
"@types/tape": "^4.2.32",
|
|
69
69
|
"benchmark": "^2.1.4",
|
|
@@ -76,11 +76,12 @@
|
|
|
76
76
|
"write-json-file": "^5.0.0"
|
|
77
77
|
},
|
|
78
78
|
"dependencies": {
|
|
79
|
-
"@turf/distance": "^7.1.0
|
|
80
|
-
"@turf/helpers": "^7.1.0
|
|
81
|
-
"@turf/intersect": "^7.1.0
|
|
82
|
-
"@turf/invariant": "^7.1.0
|
|
79
|
+
"@turf/distance": "^7.1.0",
|
|
80
|
+
"@turf/helpers": "^7.1.0",
|
|
81
|
+
"@turf/intersect": "^7.1.0",
|
|
82
|
+
"@turf/invariant": "^7.1.0",
|
|
83
|
+
"@types/geojson": "^7946.0.10",
|
|
83
84
|
"tslib": "^2.6.2"
|
|
84
85
|
},
|
|
85
|
-
"gitHead": "
|
|
86
|
+
"gitHead": "68915eeebc9278bb40dec3f1034499698a0561ef"
|
|
86
87
|
}
|