turf.squareGrid
How Turf.js runs Create Grid: turf.squareGrid.
| Engine | Turf.js |
|---|---|
| Tool name | turf.squareGrid |
| Interface | js |
| Implements | Create Grid |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | From @turf/square-grid. |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
bbox | BBox | yes | Not stated | Not stated | Not stated |
cellSide | number | yes | Not stated | Not stated | Not stated |
options | { units?: Units; properties?: P; mask?: Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon; } | no | Not stated | Not stated | Not stated |
options.units | Units | no | Not stated | Not stated | field of options |
options.properties | P | no | Not stated | Not stated | field of options |
options.mask | Feature<Polygon | MultiPolygon> | Polygon | MultiPolygon | no | Not stated | Not stated | field of options |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
layer | Not stated | bbox: [west, south, east, north] in longitude/latitude. |
cell_size | cellSide | In options.units (default kilometers). |
shape | Not stated | always square. turf.hexGrid for hexagons. |
Differences from the operation
- Turf works on GeoJSON in longitude/latitude (WGS 84); data in another CRS must be reprojected first.
Harvested by the turf harvester from engine version
7.4.0. Names can change when an engine is harvested again.