Skip to main content
Version: Next

rectangleGrid

Description

Creates a grid of rectangular polygons with width and height consistent in degrees

Parameters

NameTypeDescription
bboxBBoxextent of grid in [minX, minY, maxX, maxY] order. If the grid does not fill the bbox perfectly, it is centered.
cellWidthnumberwidth of each cell, in units
cellHeightnumberheight of each cell, in units
options?ObjectOptional parameters (default {})
options.units?Unitsthe units of the cell width and height value. Supports all valid Turf Units. If you are looking for rectangles with equal width and height in linear units (e.g. kilometers) this is not the module for you. The cellWidth and cellHeight is converted from units provided to degrees internally, so the width and height of resulting polygons will be consistent only in degrees. (default 'kilometers')
options.mask?Feature<Polygon | MultiPolygon>if passed a Polygon or MultiPolygon, the grid Points will be created only inside it
options.properties?Objectpassed to each point of the grid (default {})

Returns

FeatureCollection<Polygon> a grid of polygons

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);

Installation

$ npm install @turf/rectangle-grid

import { rectangleGrid } from "@turf/rectangle-grid";
const result = rectangleGrid(...);
$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.rectangleGrid(...);