Neolithic Psychedelic Mushrooms

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

    6.4.0 • Public • Published

    @turf/boolean-point-on-line

    booleanPointOnLine

    Returns true if a point is on a line. Accepts a optional parameter to ignore the start and end vertices of the linestring.

    Parameters

    • pt Coord GeoJSON Point
    • line Feature<LineString> GeoJSON LineString
    • options Object Optional parameters (optional, default {})
      • options.ignoreEndVertices boolean whether to ignore the start and end vertices. (optional, default false)

    Examples

    var pt = turf.point([0, 0]);
    var line = turf.lineString([[-1, -1],[1, 1],[1.5, 2.2]]);
    var isPointOnLine = turf.booleanPointOnLine(pt, line);
    //=true

    Returns boolean true/false


    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/boolean-point-on-line

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

    $ npm install @turf/turf

    Install

    npm i @turf/[email protected]

    Version

    6.4.0

    License

    MIT

    Unpacked Size

    13.4 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar
    • avatar