3.0.12 • Published 8 years ago

turf-random v3.0.12

Weekly downloads
11,919
License
ISC
Repository
github
Last release
8 years ago

turf-random

build status

generate random features

turf.random([type='point'], [count=1], options, options.bbox, [options.num_vertices=10], [options.max_radial_length=10])

Generates random GeoJSON data, including Points and Polygons, for testing and experimentation.

Parameters

parametertypedescription
[type='point']Stringoptional: type of features desired. Valid values are 'points' or 'polygons'
[count=1]Numberoptional: how many geometries should be generated.
optionsObjectrelevant to the feature desired. Can include:
options.bboxArray.a bounding box inside of which geometries are placed. In the case of points, they are guaranteed to be within this bounds,
while polygons have their centroid within it.
[options.num_vertices=10]Numberoptional: the number of vertices added to polygon features.
[options.max_radial_length=10]Numberoptional: the total number of decimal degrees longitude or latitude that a polygon can extent outwards to
from its center.

Example

var points = turf.random('points', 100, {
  bbox: [-70, 40, -60, 60]
});
//=points
var polygons = turf.random('polygons', 4, {
  bbox: [-70, 40, -60, 60]
});
//=polygons

Installation

Requires nodejs.

$ npm install turf-random

Tests

$ npm test