squareGrid
Description
Creates a square grid from a bounding box.
Parameters
Name | Type | Description |
---|---|---|
bbox | Array<number> | extent in [minX, minY, maxX, maxY] order |
cellSide | number | of each cell, in units |
options? | Object | Optional parameters (default {}) |
options.units? | string | used in calculating cellSide, can be degrees, radians, miles, or kilometers (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> grid a grid of polygons
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(...);