turf.nearestPointToLine
From @turf/nearest-point-to-line.
| Engine | Turf.js |
|---|---|
| Tool name | turf.nearestPointToLine |
| Interface | js |
| Implements | Not stated |
| Documentation | Not stated |
| Effects | Not stated |
| Notes | From @turf/nearest-point-to-line. |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
points | FeatureCollection<Point> | Feature<GeometryCollection> | GeometryCollection | yes | Not stated | Not stated | Not stated |
line | Feature<LineString> | LineString | yes | Not stated | Not stated | Not stated |
options | { units?: Units; properties?: GeoJsonProperties; } | no | Not stated | Not stated | Not stated |
options.units | Units | no | Not stated | Not stated | field of options |
options.properties | GeoJsonProperties | no | Not stated | Not stated | field of options |
Harvested by the turf harvester from engine version
7.4.0. Names can change when an engine is harvested again.