mirror of https://github.com/Turfjs/turf.git synced 2026-01-25 16:07:00 +00:00

Preliminary improvements to documentation, esp internal types e.g. Units (#2727 )

* 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.

2024-10-11 12:56:42 +11:00

1.7 KiB

Raw Permalink Blame History

@turf/sample

sample

Takes a FeatureCollection and returns a FeatureCollection with given number of features at random.

Parameters

fc FeatureCollection<T>
num number number of features to select
featurecollection FeatureCollection set of input features

Examples

var points = turf.randomPoint(100, {bbox: [-80, 30, -60, 60]});

var sample = turf.sample(points, 5);

//addToMap
var addToMap = [points, sample]
turf.featureEach(sample, function (currentFeature) {
  currentFeature.properties['marker-size'] = 'large';
  currentFeature.properties['marker-color'] = '#000';
});

Returns FeatureCollection a FeatureCollection with n 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 single module individually:

$ npm install @turf/sample

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf

1.7 KiB Raw Permalink Blame History