@turf/rectangle-grid

@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 module individually:

$ npm install @turf/rectangle-grid

Or install the Turf module that includes it as a function:

$ npm install @turf/turf

Changelog

6.4.0

🏅 New Features/Enhancements

• @turf/boolean-point-on-line Added an epislon option to help in floating point comparison. (PR https://github.com/Turfjs/turf/pull/2051 - Author @okcoker)

🐛 Bug Fixes

• @turf/line-slice-along Fixed a bug where the offset distance equal to the length of the line (PR https://github.com/Turfjs/turf/pull/2030 - Author @EricPKerr)

• @turf/helpers Fixed the conversion ratio for converting meters to yards and vice-versa (PR https://github.com/Turfjs/turf/pull/2046 - Author @anotherhale)

• @turf/center-median Fixed a missing TS type import (PR https://github.com/Turfjs/turf/pull/2044 - Author @Seairth)

• `@turf/bezier-spline Fix a bug ensuring the spline result reaches the end of the input (PR https://github.com/Turfjs/turf/pull/2090 - Author @the-nemz)

📖 Documentation

• @turf/transform-rotate and @turf/ellipse) Improve documentation for angle parameter (PR https://github.com/Turfjs/turf/pull/2016 - Author @pasieronen)

• @turf/line-chunk Fix an invalid anchor (PR https://github.com/Turfjs/turf/pull/2071 - Author @GraxMonzo)

• @turf/distance Enhance distance doco so supported inputs are clearer (PR https://github.com/Turfjs/turf/pull/2032 - Author @rowanwins)

🔔 Misc

• @turf/concave Replace deprecated topojson dependency (PR https://github.com/Turfjs/turf/pull/2037 - Author @elliots)

• Work towards enabling TS Strict Mode (PR https://github.com/Turfjs/turf/pull/2053 - Author @mfedderly)