@turf/point-grid

pointGrid

Creates a grid of points

$3

* bbox [BBox][1] extent of grid in \[minX, minY, maxX, maxY] order
* cellSide [number][2] the distance between points
* options [Object][3] Optional parameters (optional, default {})

* options.units Units the units of the cellSide value. Supports all valid Turf [Units][4] (optional, default 'kilometers')
* options.mask [Feature][5]<([Polygon][6] | [MultiPolygon][7])>? if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
* options.properties [Object][3] passed to each point of the grid (optional, default {})

$3

``javascript
var extent = [-70.823364, -33.553984, -70.473175, -33.302986];
var cellSide = 3;
var options = {units: 'miles'};

var grid = turf.pointGrid(extent, cellSide, options);

//addToMap
var addToMap = [grid];
`

Returns [FeatureCollection][8]<[Point][9]> grid of points

[1]: https://tools.ietf.org/html/rfc7946#section-5

[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number

[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[4]: https://github.com/Turfjs/turf/blob/master/packages/turf-helpers/README_UNITS.md

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

[6]: https://tools.ietf.org/html/rfc7946#section-3.1.6

[7]: https://tools.ietf.org/html/rfc7946#section-3.1.7

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

[9]: https://tools.ietf.org/html/rfc7946#section-3.1.2

---

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

$3

Install this single module individually:

`sh
$ npm install @turf/point-grid
`

Or install the all-encompassing @turf/turf module that includes all modules as functions:

`sh
$ npm install @turf/turf
``