@turf/point-on-line

@turf/point-on-line

pointOnLine

Takes a Point and a LineString and calculates the closest Point on the (Multi)LineString.

Parameters

• lines (Geometry | Feature<(LineString | MultiLineString)>) lines to snap to
• pt (Geometry | Feature<Point> | Array<number>) point to snap from
• units [string] can be degrees, radians, miles, or kilometers (optional, default kilometers)

Examples

var line = turf.lineString([
    [-77.031669, 38.878605],
    [-77.029609, 38.881946],
    [-77.020339, 38.884084],
    [-77.025661, 38.885821],
    [-77.021884, 38.889563],
    [-77.019824, 38.892368]
]);
var pt = turf.point([-77.037076, 38.884017]);

var snapped = turf.pointOnLine(line, pt, 'miles');

//addToMap
var addToMap = [line, pt, snapped];
snapped.properties['marker-color'] = '#00f';

Returns Feature<Point> closest point on the line to point. The properties object will contain three values: index: closest point was found on nth line part, dist: distance between pt and the closest point, location: distance along the line between start and the closest point.

---

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-line

Or install the Turf module that includes it as a function:

$ npm install @turf/turf

Changelog

4.6.0

🚀 New Modules

• @turf/clean-coords Removes redundant coordinates from any GeoJSON Geometry. (PR https://github.com/Turfjs/turf/pull/875 - Author @stebogit)
• @turf/interpolate Takes a set of points and estimates their 'property' values on a grid using the Inverse Distance Weighting (IDW) method.. (PR https://github.com/Turfjs/turf/pull/832 - Author @stebogit)
• @turf/clusters-dbscan Takes a set of Points and partition them into clusters according to DBSCAN's data clustering algorithm. (PR https://github.com/Turfjs/turf/pull/812 and https://github.com/Turfjs/turf/pull/851 - Author @DenisCarriere)

  special mention to this incredibly instructive and fun interactive map by @DenisCarriere 😎👏

• @turf/clusters Provides getCluster, clusterEach, and clusterReduce functions. (PR https://github.com/Turfjs/turf/pull/847 - Author @DenisCarriere)
• @turf/boolean-point-on-line Returns true if a point is on a line. Accepts a optional parameter to ignore the start and end vertices of the linestring. (PR https://github.com/Turfjs/turf/pull/858 - Author @rowanwins)
• @turf/boolean-overlap Takes two features and returns true or false whether or not they overlap, i.e. whether any pair of edges on the two polygons intersect. If there are any edge intersections, the polygons overlap. (PR https://github.com/Turfjs/turf/pull/856 and https://github.com/Turfjs/turf/pull/868 - Author @stebogit @tcql)
• @turf/boolean-equal Determine whether two geometries of the same type have identical X,Y coordinate values. (PR https://github.com/Turfjs/turf/pull/869 - Author @stebogit @tcql)

🏅 New Features/Enhancements

• Sets centered param default to true in @turf/point-grid (PR https://github.com/Turfjs/turf/pull/836 - Contributor @stebogit)
• Adds MultiLineString support for @turf/point-on-line (PR https://github.com/Turfjs/turf/pull/838 - Contributor @stebogit)
• Renames @turf/clusters => @turf/clusters-kmeans, plus adds deprecated warning message to @turf/clusters@4.5.2 (See Issue https://github.com/Turfjs/turf/issues/845)
• Changes output type of @turf/clusters-kmeans (See Issue https://github.com/Turfjs/turf/issues/850 - Contributor @DenisCarriere)
• Adds segmentEach and segmentReduce functions to @turf/meta (See Issue https://github.com/Turfjs/turf/issues/850 - Contributor @DenisCarriere)
• Adds tests and linting on JSDoc in TurfJS core from turf-www; see Issue https://github.com/Turfjs/turf/issues/859 (PR https://github.com/Turfjs/turf/issues/857 + https://github.com/Turfjs/turf/issues/864 + https://github.com/Turfjs/turf/issues/870 - Contributor @DenisCarriere @stebogit)
• Introduces null Geometry support across TurfJS modules (See Issue https://github.com/Turfjs/turf/issues/853) (PR https://github.com/Turfjs/turf/issues/866 - Contributor @DenisCarriere)
• Includes feature(Sub)Index in coordEach/coordReduce (@turf/meta) 🎉 (PR https://github.com/Turfjs/turf/issues/872 - Contributor @DenisCarriere)
• Adds bbox and id params plus geometry method to @turf/helpers (PR https://github.com/Turfjs/turf/issues/877 - Contributor @DenisCarriere)

🐛 Bug Fixes

• Applies @turf/truncate to @turf/line-split splitter input to avoid approximation errors. Fixed #852 (PR https://github.com/Turfjs/turf/pull/855)
• Fixes @turf-mask error (See Issue https://github.com/Turfjs/turf/issues/837) (PR https://github.com/Turfjs/turf/pull/865 - Contributor @thiagoxvo)
• Fixes create-new-module script error on LICENSE file creation (See Issue https://github.com/Turfjs/turf/issues/861) (commit df6986e)
• Fixes @turf/isobands error on commonProperties (See Issue https://github.com/Turfjs/turf/issues/831) (commit 1663f07)