Skip to main content
Version: Next

randomPolygon

Description

Returns a random polygon.

Parameters

NameTypeDescription
count?numberhow many geometries will be generated (default 1)
options?ObjectOptional parameters (default {})
options.bbox?BBoxa bounding box inside of which geometries are placed. (default [-180,-90,180,90])
options.num_vertices?numberis how many coordinates each LineString will contain. (default 10)
options.max_radial_length?numberis the maximum number of decimal degrees latitude or longitude that a vertex can reach out of the center of the Polygon. (default 10)

Returns

FeatureCollection<Polygon> GeoJSON FeatureCollection of polygons

Examples

var polygons = turf.randomPolygon(25, { bbox: [-180, -90, 180, 90] });
// => polygons

Installation

$ npm install @turf/random

import { randomPolygon } from "@turf/random";
const result = randomPolygon(...);
$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.randomPolygon(...);