Northern Pileated Marmoset

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

    6.5.0 • Public • Published

    @turf/point-to-line-distance

    pointToLineDistance

    Returns the minimum distance between a Point and a LineString, being the distance from a line the minimum distance between the point and any segment of the LineString.

    Parameters

    • pt (Feature<Point> | Array<number>) Feature or Geometry
    • line Feature<LineString> GeoJSON Feature or Geometry
    • options Object Optional parameters (optional, default {})
      • options.units string can be anything supported by turf/convertLength, eg degrees, radians, miles, or kilometers (optional, default 'kilometers')
      • options.method string wehther to calculate the distance based on geodesic (spheroid) or planar (flat) method. Valid options are 'geodesic' or 'planar'. (optional, default 'geodesic')

    Examples

    var pt = turf.point([0, 0]);
    var line = turf.lineString([[1, 1],[-1, 1]]);
    
    var distance = turf.pointToLineDistance(pt, line, {units: 'miles'});
    //=69.11854715938406

    Returns number distance between point and line


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

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

    $ npm install @turf/turf

    Install

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

    DownloadsWeekly Downloads

    287,294

    Version

    6.5.0

    License

    MIT

    Unpacked Size

    14.3 kB

    Total Files

    7

    Last publish

    Collaborators

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