squareGrid
Description
Creates a grid of square polygons with cell length consistent in degrees
Parameters
Name | Type | Description |
---|---|---|
bbox | BBox | extent of grid in [minX, minY, maxX, maxY] order. If the grid does not fill the bbox perfectly, it is centered. |
cellSide | number | length of each cell side. |
options? | Object | Optional parameters (default {}) |
options.units? | Units | the units of the cellSide value. Supports all valid Turf {@link https://github.com/Turfjs/turf/blob/master/packages/turf-helpers/README_UNITS.md Units}. If you are looking for squares with sides of equal lengths in linear units (e.g. kilometers) this is not the module for you. The cellSide is converted from units provided to degrees internally, so the width and height of resulting polygons will be consistent only in degrees. (default 'kilometers') |
options.mask? | Feature<Polygon | MultiPolygon> | if passed a Polygon or MultiPolygon, the grid Points will be created only inside it |
options.properties? | Object | passed to each point of the grid (default {}) |
Returns
FeatureCollection<Polygon> a grid of polygons with equal width and height in degrees.
Examples
var bbox = [-95, 30, -85, 40];
var cellSide = 50;
var options = { units: "miles" };
var squareGrid = turf.squareGrid(bbox, cellSide, options);
Installation
$ npm install @turf/square-grid
import { squareGrid } from "@turf/square-grid";
const result = squareGrid(...);
$ npm install @turf/turf
import * as turf from "@turf/turf";
const result = turf.squareGrid(...);