Package Exports

@turf/rectangle-grid
@turf/rectangle-grid/package.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/rectangle-grid) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/rectangle-grid

rectangleGrid

Creates a grid of rectangles from a bounding box, Feature or FeatureCollection.

Parameters

bbox Array<number> extent in [minX, minY, maxX, maxY] order
cellWidth number of each cell, in units
cellHeight number of each cell, in units
options Object Optional parameters (optional, default {})
- options.units string units ("degrees", "radians", "miles", "kilometers") that the given cellWidth and cellHeight are expressed in. Converted at the southern border. (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 bbox = [-95, 30 ,-85, 40];
var cellWidth = 50;
var cellHeight = 20;
var options = {units: 'miles'};

var rectangleGrid = turf.rectangleGrid(bbox, cellWidth, cellHeight, options);

//addToMap
var addToMap = [rectangleGrid]

Returns FeatureCollection<Polygon> a grid of polygons

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/rectangle-grid

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

$ npm install @turf/turf