Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

turf-hexgrid: fix issue #2841 #2856

Merged
merged 2 commits into from
Mar 17, 2025
Merged

turf-hexgrid: fix issue #2841 #2856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7011ead
turf-hexgrid: fix issue #2841
SimonsUnikaNamn Mar 17, 2025
fcb2b1a
feat: update readme of turf-hexgrid to include MultiPolygon
SimonsUnikaNamn Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/turf-hex-grid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ described in [Hexagonal Grids][3].

* `options.units` **[string][7]** used in calculating cell size, can be degrees, radians, miles, or kilometers (optional, default `'kilometers'`)
* `options.properties` **[Object][6]** passed to each hexagon or triangle of the grid (optional, default `{}`)
* `options.mask` **[Feature][8]<[Polygon][2]>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
* `options.triangles` **[boolean][9]** whether to return as triangles instead of hexagons (optional, default `false`)
* `options.mask` **[Feature][8]<([Polygon][2] | [MultiPolygon][9])>?** if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
* `options.triangles` **[boolean][10]** whether to return as triangles instead of hexagons (optional, default `false`)

### Examples

Expand Down Expand Up @@ -51,7 +51,9 @@ Returns **[FeatureCollection][1]<[Polygon][2]>** a hexagonal grid

[8]: https://tools.ietf.org/html/rfc7946#section-3.2

[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
[9]: https://tools.ietf.org/html/rfc7946#section-3.1.7

[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean

<!-- 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. -->

Expand Down
5 changes: 3 additions & 2 deletions packages/turf-hex-grid/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
GeoJsonProperties,
Polygon,
BBox,
MultiPolygon,
} from "geojson";
import { polygon, featureCollection, Units } from "@turf/helpers";

Expand All @@ -21,7 +22,7 @@ import { polygon, featureCollection, Units } from "@turf/helpers";
* @param {Object} [options={}] Optional parameters
* @param {string} [options.units='kilometers'] used in calculating cell size, can be degrees, radians, miles, or kilometers
* @param {Object} [options.properties={}] passed to each hexagon or triangle of the grid
* @param {Feature<Polygon>} [options.mask] if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
* @param {Feature<Polygon | MultiPolygon>} [options.mask] if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
* @param {boolean} [options.triangles=false] whether to return as triangles instead of hexagons
* @returns {FeatureCollection<Polygon>} a hexagonal grid
* @example
Expand All @@ -41,7 +42,7 @@ function hexGrid<P extends GeoJsonProperties = GeoJsonProperties>(
units?: Units;
triangles?: boolean;
properties?: P;
mask?: Feature<Polygon>;
mask?: Feature<Polygon | MultiPolygon>;
} = {}
): FeatureCollection<Polygon, P> {
// Issue => https://github.com/Turfjs/turf/issues/1284
Expand Down
16 changes: 9 additions & 7 deletions packages/turf-hex-grid/test/in/properties.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@
"type": "Feature",
"properties": {},
"geometry": {
"type": "Polygon",
"type": "MultiPolygon",
"coordinates": [
[
[2.223186492919922, 41.416856461155575],
[2.1716880798339844, 41.44182560856202],
[2.1636199951171875, 41.41608406639095],
[2.1334075927734375, 41.407200866420744],
[2.1845626831054683, 41.37977115211044],
[2.223186492919922, 41.416856461155575]
[
[2.223186492919922, 41.416856461155575],
[2.1716880798339844, 41.44182560856202],
[2.1636199951171875, 41.41608406639095],
[2.1334075927734375, 41.407200866420744],
[2.1845626831054683, 41.37977115211044],
[2.223186492919922, 41.416856461155575]
]
]
]
}
Expand Down
16 changes: 9 additions & 7 deletions packages/turf-hex-grid/test/out/properties.geojson
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,15 +292,17 @@
"fill-opacity": 0
},
"geometry": {
"type": "Polygon",
"type": "MultiPolygon",
"coordinates": [
[
[2.223186492919922, 41.416856461155575],
[2.1716880798339844, 41.44182560856202],
[2.1636199951171875, 41.41608406639095],
[2.1334075927734375, 41.407200866420744],
[2.1845626831054683, 41.37977115211044],
[2.223186492919922, 41.416856461155575]
[
[2.223186492919922, 41.416856461155575],
[2.1716880798339844, 41.44182560856202],
[2.1636199951171875, 41.41608406639095],
[2.1334075927734375, 41.407200866420744],
[2.1845626831054683, 41.37977115211044],
[2.223186492919922, 41.416856461155575]
]
]
]
}
Expand Down