Neil Patrick's Mansion

    @turf/nearest-point-to-line
    TypeScript icon, indicating that this package has built-in type declarations

    6.5.0 • Public • Published

    @turf/nearest-point-to-line

    nearestPointToLine

    Returns the closest point, of a collection of points, to a line. The returned point has a dist property indicating its distance to the line.

    Parameters

    Examples

    var pt1 = turf.point([0, 0]);
    var pt2 = turf.point([0.5, 0.5]);
    var points = turf.featureCollection([pt1, pt2]);
    var line = turf.lineString([[1,1], [-1,1]]);
    
    var nearest = turf.nearestPointToLine(points, line);
    
    //addToMap
    var addToMap = [nearest, line];

    Returns Feature<Point> the closest point

    pt

    Translate Properties to final Point, priorities: 1. options.properties 2. inherent Point properties 3. dist custom properties created by NearestPointToLine


    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/nearest-point-to-line

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

    $ npm install @turf/turf

    Install

    npm i @turf/nearest-point-to-line

    DownloadsWeekly Downloads

    155,207

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    14 kB

    Total Files

    7

    Last publish

    Collaborators

    • twelch
    • jamesmilneruk
    • rowanwins
    • tmcw
    • morganherlocker
    • tcql
    • mdfedderly