@turf/random

What is @turf/random?

@turf/random is a module within the Turf.js library that provides functions to generate random geometries such as points, polygons, and lines. It is useful for creating test data, simulations, and other applications where random spatial data is needed.

What are @turf/random's main functionalities?

Random Points

Generates a specified number of random points. In this example, it generates 5 random points.

const turf = require('@turf/random');
const points = turf.randomPoint(5);
console.log(points);

Random Polygons

Generates a specified number of random polygons. In this example, it generates 3 random polygons.

const turf = require('@turf/random');
const polygons = turf.randomPolygon(3);
console.log(polygons);

Random Lines

Generates a specified number of random line strings. In this example, it generates 2 random line strings.

const turf = require('@turf/random');
const lines = turf.randomLineString(2);
console.log(lines);

Other packages similar to @turf/random

faker

Faker is a library for generating fake data, including names, addresses, and other types of data. While it is not specifically focused on spatial data, it can be used to generate random data for various applications. Compared to @turf/random, Faker is more general-purpose and not specialized in geospatial data.

chance

Chance is a random generator helper for JavaScript. It can generate random numbers, strings, and other types of data. Like Faker, it is not specialized in geospatial data but can be used for a wide range of random data generation needs. Compared to @turf/random, Chance is more versatile but less focused on spatial data.

geojson-random

GeoJSON-Random is a library specifically designed to generate random GeoJSON data, including points, polygons, and lines. It is very similar to @turf/random in terms of functionality but is a standalone package rather than part of a larger geospatial library like Turf.js.

README

@turf/random

random

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

Parameters

• type [string] type of features desired: 'points' or 'polygons' (optional, default 'point')
• count [number] how many geometries should be generated. (optional, default 1)
• options Object options relevant to the feature desired. Can include:
  • options.bbox Array<number> a bounding box inside of which geometries are placed. In the case of Point features, they are guaranteed to be within this bounds, while Polygon features have their centroid within the bounds.
  • options.num_vertices [number] options.vertices the number of vertices added to polygon features. (optional, default 10)
  • options.max_radial_length [Number] the total number of decimal degrees longitude or latitude that a polygon can extent outwards to from its center. (optional, default 10)

Examples

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

//=points

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

//=polygons

Returns FeatureCollection generated random features

---

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/random

Or install the Turf module that includes it as a function:

$ npm install @turf/turf