scancode-miro/node_modules/@turf/square-grid

@turf/square-grid

squareGrid

Creates a grid of square polygons with cell length consistent in degrees

Parameters

• bbox BBox extent of grid in [minX, minY, maxX, maxY] order. If the grid does not fill the bbox perfectly, it is centered.
• cellSide number length of each cell side.

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

  • options.units Units the units of the cellSide value. Supports all valid Turf Units. If you are looking for squares with sides of equal lengths in linear units (e.g. kilometers) this is not the module for you. The cellSide is converted from units provided to degrees internally, so the width and height of resulting polygons will be consistent only in degrees. (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 cellSide = 50;
var options = {units: 'miles'};

var squareGrid = turf.squareGrid(bbox, cellSide, options);

//addToMap
var addToMap = [squareGrid]

Returns FeatureCollection<Polygon> a grid of polygons with equal width and height in degrees.

---

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

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

$ npm install @turf/turf