e7227f51b7
* Added JSDoc for internal types and constants e.g. Unts and earthRadius. Minimal other changes to bring JSDoc types into line with code types. Added GeoJsonProperties to documentation.yml for type linking. * Generated README.md files based on updated source that now includes JSDoc for internal types and constants e.g. Units. Also synced up some out of data JSDoc types with what is in the code. * Switched the structure of documentation.yml to be more traditionally nested. We'll use this new structure from the turf-www repo to generate the website documentation in a more robust manner. * For some reason leaving this function documented as the default (geojsonRbush) causes @turf/turf last-checks to fail. Specifically defining it as rbush like it used to be, except with the @function tag rather than @name.
4.4 KiB
@turf/random
randomPosition
Returns a random position within a bounding box.
Parameters
bboxBBox a bounding box inside of which positions are placed. (optional, default[-180,-90,180,90])
Examples
var position = turf.randomPosition([-180, -90, 180, 90])
// => position
- Throws Error if bbox is invalid
Returns Position Position [longitude, latitude]
randomPoint
Returns a random point.
Parameters
-
countnumber how many geometries will be generated (optional, default1) -
optionsObject Optional parameters (optional, default{})options.bboxBBox a bounding box inside of which geometries are placed. (optional, default[-180,-90,180,90])
Examples
var points = turf.randomPoint(25, {bbox: [-180, -90, 180, 90]})
// => points
- Throws Error if bbox is invalid
Returns FeatureCollection<Point> GeoJSON FeatureCollection of points
randomPolygon
Returns a random polygon.
Parameters
-
countnumber how many geometries will be generated (optional, default1) -
optionsObject Optional parameters (optional, default{})options.bboxBBox a bounding box inside of which geometries are placed. (optional, default[-180,-90,180,90])options.num_verticesnumber is how many coordinates each LineString will contain. (optional, default10)options.max_radial_lengthnumber is the maximum number of decimal degrees latitude or longitude that a vertex can reach out of the center of the Polygon. (optional, default10)
Examples
var polygons = turf.randomPolygon(25, {bbox: [-180, -90, 180, 90]})
// => polygons
- Throws Error if bbox is invalid
Returns FeatureCollection<Polygon> GeoJSON FeatureCollection of polygons
randomLineString
Returns a random LineString.
Parameters
-
countnumber how many geometries will be generated (optional, default1) -
optionsObject Optional parameters (optional, default{})options.bboxBBox a bounding box inside of which geometries are placed. (optional, default[-180,-90,180,90])options.num_verticesnumber is how many coordinates each LineString will contain. (optional, default10)options.max_lengthnumber is the maximum number of decimal degrees that a vertex can be from its predecessor (optional, default0.0001)options.max_rotationnumber is the maximum number of radians that a line segment can turn from the previous segment. (optional, defaultMath.PI/8)
Examples
var lineStrings = turf.randomLineString(25, {bbox: [-180, -90, 180, 90]})
// => lineStrings
- Throws Error if bbox is invalid
Returns FeatureCollection<LineString> GeoJSON FeatureCollection of linestrings
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/random
Or install the all-encompassing @turf/turf module that includes all modules as functions:
$ npm install @turf/turf