@turf/point-grid

pointGrid

Creates a grid of points

Parameters

• bbox BBox extent of grid in [minX, minY, maxX, maxY] order

• cellSide number the distance between points

• options Object Optional parameters (optional, default {})

  • options.units Units the units of the cellSide value. Supports all valid Turf Units (optional, 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 (optional, default {})

Examples

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<Point> grid of points

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.

Installation

Install this single module individually:

$ npm install @turf/point-grid

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

$ npm install @turf/turf