turf-pointgriddensity
TypeScript icon, indicating that this package has built-in type declarations

1.1.1 • Public • Published

This is a copy of https://github.com/Turfjs/turf/tree/master/packages/turf-point-grid, with additional features. I will attemp to make a PR soon.

@turf/point-grid

pointGrid

Creates a Point grid from a bounding box, FeatureCollection or Feature.

Parameters

  • bbox Array<number> extent in [minX, minY, maxX, maxY] order
  • cellSide number the distance between points, in units
  • options Object Optional parameters (optional, default {})
    • options.units string used in calculating cellSide, can be degrees, radians, miles, or kilometers (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 {})
    • options.spacings Object Object of {latSpacing, lngSpacing} indicating width and height between cells (optional, default {})
    • options.rotation Object The Decimal Degree Value to rotate the resulting features in counter-clockwise. (optional, default 0)

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

 
$ npm install turf-pointgriddensity 
 

Testing:

  npm install --dev jest 
  npm install babel-preset-env
  npm test

What I changed:

Set custom lat-lng spacing between cells. Originally, we passed 1 value for both lat and lng.

latlng

Set rotation, so that we can rotate points.

rotation

note: the example is passing a polygon mask.

Readme

Keywords

Package Sidebar

Install

npm i turf-pointgriddensity

Weekly Downloads

1

Version

1.1.1

License

ISC

Unpacked Size

12.7 kB

Total Files

8

Last publish

Collaborators

  • ikendoit1998