turf-point-on-surface
pointOnSurface
Takes a feature and returns a Point guaranteed to be on the surface of the feature.
- Given a Polygon, the point will be in the area of the polygon
- Given a LineString, the point will be along the string
- Given a Point, the point will the same as the input
Parameters
fc
(Feature | FeatureCollection) any feature or set of features
Examples
// create a random polygonvar polygon = turf; //=polygon var pointOnPolygon = turf; var resultFeatures = polygonfeatures;var result = "type": "FeatureCollection" "features": resultFeatures; //=result
Returns Feature a point on the surface of input
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-point-on-surface
Or install the Turf module that includes it as a function:
$ npm install turf