@turf/planepoint
TypeScript icon, indicating that this package has built-in type declarations

7.1.0 • Public • Published

@turf/planepoint

planepoint

Takes a triangular plane as a polygon and a point within that triangle, and returns the z-value at that point.

The Polygon should have properties a, b, and c that define the values at its three corners. Alternatively, the z-values of each triangle point can be provided by their respective 3rd coordinate if their values are not provided as properties.

Parameters

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

Examples

const point = turf.point([-75.3221, 39.529]);
// "a", "b", and "c" values represent the values of the coordinates in order.
const triangle = turf.polygon([[
  [-75.1221, 39.57],
  [-75.58, 39.18],
  [-75.97, 39.86],
  [-75.1221, 39.57]
]], {
  "a": 11,
  "b": 122,
  "c": 44
});

const zValue = turf.planepoint(point, triangle);
point.properties.zValue = zValue;

//addToMap
const addToMap = [triangle, point];

Returns number the z-value for interpolatedPoint


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 single module individually:

$ npm install @turf/planepoint

Or install the all-encompassing @turf/turf module that includes all modules as functions:

$ npm install @turf/turf

Package Sidebar

Install

npm i @turf/planepoint

Weekly Downloads

852,642

Version

7.1.0

License

MIT

Unpacked Size

17.9 kB

Total Files

9

Last publish

Collaborators

  • smallsaucepan
  • morgan.herlocker
  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly