https://github.com/tsamaya/random-points-generator
Generates random points
https://github.com/tsamaya/random-points-generator
browser geojson javascript node random
Last synced: 5 months ago
JSON representation
Generates random points
- Host: GitHub
- URL: https://github.com/tsamaya/random-points-generator
- Owner: tsamaya
- License: mit
- Created: 2016-02-19T17:36:55.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T06:40:37.000Z (12 months ago)
- Last Synced: 2024-05-02T04:34:36.515Z (12 months ago)
- Topics: browser, geojson, javascript, node, random
- Language: JavaScript
- Homepage:
- Size: 3.73 MB
- Stars: 13
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# random-points-generator
[](https://www.npmjs.com/package/random-points-generator)
[](https://www.npmjs.com/package/random-points-generator)
[](https://github.com/tsamaya/random-points-generator/blob/master/LICENSE)
[](https://github.com/prettier/prettier)
Generates _n_ random points based on @turf/random.
The value added regarding @turf/random is the filter. Indeed, here points can be generated inside a GeoJSON polygon.
And it comes with :
- a command line tool,
- a node library,
- a browser library
[](https://circleci.com/gh/tsamaya/random-points-generator)
[](https://codecov.io/gh/tsamaya/random-points-generator)
[](https://codeclimate.com/github/tsamaya/random-points-generator/maintainability)
[](https://houndci.com)
[](https://www.meterian.io/report/gh/tsamaya/random-points-generator)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Ftsamaya%2Frandom-points-generator?ref=badge_shield)
## Prerequisites
- node
## Usage
### node
```sh
$ npm i random-points-generator
```
or
```sh
yarn add random-points-generator
```
### browser
```html
const fc = geotools.random(5);
```
## API
#### function random (number, options)
| Name | Description | Type | Default |
| --------- | ---------------------------- | ------- | --------- |
| `number` | number of points to generate | Integer | 10 |
| `options` | random options | Object | undefined |
returns a [FeatureCollection](https://tools.ietf.org/html/rfc7946#section-3.3)
> `options`
| `Options` | Description |
| ---------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `bbox` | Array extent in [ minX, minY, maxX, maxY ] order which means (southwest lng, lat northeast lng,lat) |
| `features` | GeoJSON polygons as features or a FeatureCollection |
| `unkink` | `true\|false` [Default is true] Unkink Polygon ([see](https://turfjs.org/docs/#unkinkPolygon)) before processing the features |
### Example
```javascript
const RandomGenerator = require('random-points-generator');
const points = RandomGenerator.random(3);
console.log(JSON.stringify(points));
```
will output something like :
```javascript
{"type":"FeatureCollection","features":[{"type":"Feature","geometry":{"type":"Point","coordinates":[126.41316810428155,-47.548372609587574]},"properties":{}},{"type":"Feature","geometry":{"type":"Point","coordinates":[97.69989737806617,-47.200575920302434]},"properties":{}},{"type":"Feature","geometry":{"type":"Point","coordinates":[24.264802630637277,72.69680002654108]},"properties":{}}]}
```
### From the command line
- clone or fork the repo
- `cd random-points-generator`
- run `npm install`
- run `./bin/random-points-generator --help` to get options
```bash
Usage: bin/random-points-generator [options]
Options:
--help, -h Show help [boolean]
--number, -n [default: 10]
--verbose, -v [default: false]
Examples:
bin/random-points-generator Generates 10 random coordinates,
output to console in GeoJSON format
bin/random-points-generator -n 1000 Generates 1000 random coordinates
--xmin=-2 --xmax=4 --ymin=-45 --ymax=50 with these bounding box
bin/random-points-generator -i Generates 10 random coordinates
world_countries.geojson within polygons from file
world_countries.geojson
```
## Converting to csv
CSV files are not dead. So if needed here is a simple example to generate csv files.
```sh
$ npm install random-points-generator
$ npm install geojson2csv
$ ./node_modules/.bin/random-points-generator > points.geojson
$ node
```
```javascript
const geojson2csv = require('geojson2csv');
geojson2csv('points.geojson', 'points.csv', (err) => {
if (err) throw err;
});
```
:warning: geojson2csv inverts latitude and longitude regarding the column headers [check issue](https://github.com/morganherlocker/geojson2csv/issues/4).
## Revision History
| Version | Date | Description |
| -------- | ---------- | --------------------------------------- |
| `v1.9.1` | 03/11/2024 | deps: Esint 9 and pnpm |
| `v1.9.0` | 29/07/2024 | Upgrade deps packages |
| `v1.8.0` | 26/01/2023 | Adds optional unkink polygons parameter |
| `v1.7.6` | 31/03/2021 | Upgrade deps packages |
| `v1.7.5` | 22/11/2020 | Upgrade deps packages |
| `v1.7.4` | 09/12/2019 | Upgrade deps packages |
| `v1.7.3` | 09/12/2019 | Upgrade deps packages |
| `v1.7.2` | 16/08/2019 | Upgrade deps packages |
| `v1.7.1` | 16/08/2019 | Build removes node 6 |
| `v1.7.0` | 14/08/2019 | Build / test on node 10 |
| `v1.6.1` | 10/12/2018 | Missing Built Files |
| `v1.6.0` | 10/12/2018 | Upgrade deps packages |
| `v1.5.2` | 01/05/2018 | fixes unnecessary verbose message |
| `v1.5.0` | 25/03/2018 | add a browser package |
| `v1.4.0` | 20/02/2018 | Use single turf modules |
| `v1.3.0` | 07/11/2017 | Unkink input polygons |
| `v1.2.0` | 21/05/2017 | Rewrite with es6 notation |
| `v1.1.0` | 25/04/2017 | Split command line and lib |
| `v1.0.0` | 03/10/2016 | Creation : a tool command line |
## Resources
_resources_ folder contains Large Scale Data from [Natural Earth](http://www.naturalearthdata.com/)
## Licensing
Licensed under the MIT License
A copy of the license is available in the repository's [LICENSE](LICENSE) file.
[](https://app.fossa.com/projects/git%2Bgithub.com%2Ftsamaya%2Frandom-points-generator?ref=badge_large)