Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

turf-square-grid

Turfjs73.8kMITdeprecated3.0.12

Turf packages are now namespaced: please use @turf/square-grid instead

squareGrid

turf, grid, regular, cartesian, grid

readme

turf-square-grid

build status

turf.square-grid(extent, cellWidth, units)

Takes a bounding box and a cell depth and returns a FeatureCollection of Polygon features in a grid.

Parameters

parameter type description
extent Array.<number> extent in [minX, minY, maxX, maxY] order
cellWidth Number width of each cell
units String units to use for cellWidth

Example

var extent = [-77.3876953125,38.71980474264239,-76.9482421875,39.027718840211605];
var cellWidth = 10;
var units = 'miles';

var squareGrid = turf.squareGrid(extent, cellWidth, units);

//=squareGrid

Installation

Requires nodejs.

$ npm install turf-square-grid

Tests

$ npm test