turf-planepoint - npm Package Compare versions

Comparing version 3.0.10 to 3.0.12

index.js

		@@ -8,3 +8,3 @@ /**
		* @name planepoint
		* @param {Feature<Point>} interpolatedPoint the Point for which a z-value will be calculated
		* @param {Feature<Point>} point the Point for which a z-value will be calculated
		* @param {Feature<Polygon>} triangle a Polygon feature with three vertices
		@@ -11,0 +11,0 @@ * @return {Number} the z-value for `interpolatedPoint`

package.json

		{
		"name": "turf-planepoint",
		"version": "3.0.10",
		"version": "3.0.12",
		"description": "turf planepoint module",
		@@ -5,0 +5,0 @@ "main": "index.js",

README.md

		# turf-planepoint

		[![build status](https://secure.travis-ci.org/Turfjs/turf-planepoint.png)](http://travis-ci.org/Turfjs/turf-planepoint)
		# planepoint

		turf planepoint module


		### `turf.planepoint(interpolatedPoint, triangle)`

		Takes a triangular plane as a Polygon
		and a Point within that triangle and returns the z-value
		Takes a triangular plane as a [Polygon](Polygon)
		and a [Point](Point) within that triangle and returns the z-value
		at that point. The Polygon needs to have properties `a`, `b`, and `c`
		that define the values at its three corners.

		Parameters

		### Parameters
		- `point` Feature<Point> the Point for which a z-value will be calculated
		- `triangle` Feature<Polygon> a Polygon feature with three vertices

		\| parameter \| type \| description \|
		\| ------------------- \| -------------------- \| ------------------------------------------------ \|
		\| `interpolatedPoint` \| Feature\.\<Point\> \| the Point for which a z-value will be calculated \|
		\| `triangle` \| Feature\.\<Polygon\> \| a Polygon feature with three vertices \|
		Examples


		### Example

		```js
		```javascript
		var point = {
		@@ -69,9 +60,15 @@ "type": "Feature",

		Returns [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number) the z-value for `interpolatedPoint`

		Returns `Number`, the z-value for `interpolatedPoint`
		---

		## Installation
		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.

		Requires [nodejs](http://nodejs.org/).
		### Installation

		Install this module individually:

		```sh
		@@ -81,8 +78,6 @@ $ npm install turf-planepoint

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

		```sh
		$ npm test
		$ npm install turf
		```

turf-planepoint - npm Package Compare versions

New alerts

Fixed alerts

Worsened metrics