# turf-point-on-line

> # pointOnLine

Latest version **3.0.12** (published 2016-07-05) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install turf-point-on-line
pnpm add turf-point-on-line
yarn add turf-point-on-line
bun add turf-point-on-line
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.12 |
| Published | 2016-07-05 |
| First published | 2015-01-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | morganherlocker |
| Maintainers | morganherlocker, tmcw |

## Links

- npm: https://www.npmjs.com/package/turf-point-on-line
- Repository: https://github.com/Turfjs/turf-point-on-line
- Issues: https://github.com/Turfjs/turf-point-on-line/issues
- npm.io page: https://npm.io/package/turf-point-on-line

## Dependencies (4)

- [turf-bearing](https://npm.io/package/turf-bearing.md) ^3.0.12
- [turf-helpers](https://npm.io/package/turf-helpers.md) ^3.0.12
- [turf-distance](https://npm.io/package/turf-distance.md) ^3.0.12
- [turf-destination](https://npm.io/package/turf-destination.md) ^3.0.12

## Recent versions

- 3.0.12 (latest) — 2016-07-05
- 3.0.7-canary.ae89c8b3 (canary) — 2016-06-14
- 3.0.11 — 2016-06-17
- 3.0.10 — 2016-06-15
- 3.0.9 — 2016-06-14
- 3.0.5 — 2016-05-17
- 3.0.1 — 2016-05-16
- 3.0.0-canary.7879bf6c — 2016-05-16
- 3.0.0-canary.2f5f7167 — 2016-05-16
- 1.0.2 — 2015-02-06
- 1.0.1 — 2015-01-26

## README

# turf-point-on-line

# pointOnLine

Takes a [Point](Point) and a [LineString](LineString) and calculates the closest Point on the LineString.

**Parameters**

-   `line` **Feature<LineString>** line to snap to
-   `point` **Feature<Point>** point to snap from

**Examples**

```javascript
var line = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "LineString",
    "coordinates": [
      [-77.031669, 38.878605],
      [-77.029609, 38.881946],
      [-77.020339, 38.884084],
      [-77.025661, 38.885821],
      [-77.021884, 38.889563],
      [-77.019824, 38.892368]
    ]
  }
};
var pt = {
  "type": "Feature",
  "properties": {},
  "geometry": {
    "type": "Point",
    "coordinates": [-77.037076, 38.884017]
  }
};

var snapped = turf.pointOnLine(line, pt);
snapped.properties['marker-color'] = '#00f'

var result = {
  "type": "FeatureCollection",
  "features": [line, pt, snapped]
};

//=result
```

Returns **Feature<Point>** closest point on the `line` to `point`

---

This module is part of the [Turfjs project](http://turfjs.org/), an open source
module collection dedicated to geographic algorithms. It is maintained in the
[Turfjs/turf](https://github.com/Turfjs/turf) repository, where you can create
PRs and issues.

### Installation

Install this module individually:

```sh
$ npm install turf-point-on-line
```

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

```sh
$ npm install turf
```

---
_Source: https://npm.io/package/turf-point-on-line · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._