@turf/boolean-point-on-line

turf boolean-point-on-line module

Usage no npm install needed!

<script type="module">
  import turfBooleanPointOnLine from 'https://cdn.skypack.dev/@turf/boolean-point-on-line';
</script>

README

@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