@turf/triangle-grid
TypeScript icon, indicating that this package has built-in type declarations

7.1.0 • Public • Published

@turf/triangle-grid

triangleGrid

Creates a grid of triangular polygons.

Parameters

  • bbox BBox extent of grid in [minX, minY, maxX, maxY] order

  • cellSide number dimension of each grid cell. Two triangles are created in each cell.

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

    • options.units Units used in calculating cellSide. Supports all valid Turf Units (optional, default 'kilometers')
    • options.mask Feature<Polygon>? 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 triangleGrid = turf.triangleGrid(bbox, cellSide, options);

//addToMap
var addToMap = [triangleGrid];

Returns FeatureCollection<Polygon> 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/triangle-grid

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

$ npm install @turf/turf

Package Sidebar

Install

npm i @turf/triangle-grid

Weekly Downloads

778,297

Version

7.1.0

License

MIT

Unpacked Size

34.2 kB

Total Files

9

Last publish

Collaborators

  • smallsaucepan
  • morgan.herlocker
  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly