3.0.12 • Published 8 years ago

turf-point-on-line v3.0.12

Weekly downloads
11,382
License
MIT
Repository
github
Last release
8 years ago

turf-point-on-line

build status

turf.point-on-line (Line, Point)

Takes a Point and a LineString and calculates the closest Point on the LineString

Parameters

parametertypedescription
LineLineStringto snap to
PointPointto snap from

Example

var line = turf.linestring([
      [
        -77.0316696166992,
        38.878605901789236
      ],
      [
        -77.02960968017578,
        38.88194668656296
      ],
      [
        -77.02033996582031,
        38.88408470638821
      ],
      [
        -77.02566146850586,
        38.885821800123196
      ],
      [
        -77.02188491821289,
        38.88956308852534
      ],
      [
        -77.01982498168944,
        38.89236892551996
      ]
    ]);
var pt = turf.point([-77.02544689178467,38.88689075977245]);

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

Installation

Requires nodejs.

$ npm install turf-point-on-line

Tests

$ npm test