Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

distance-to-polygon

vhf6.2kMIT2.0.2

Compute distance from a point to an arbitrary shaped polygon, line, or point

distance, point, polygon

readme

distance-to-polygon

Build Status Coverage Status

  • a point p# is represented as a list like this : const p1 = [x = 0, y = 0];
  • f(x) is a transformation function applied to the result :

      const roundToTwoDecimal = (x) => Math.round(x * 100) / 100;
      distanceBetweenPoints(p1, p2, roundToTwoDecimal);

  • distanceBetweenPoints(p1, p2, f = (x) => x)

  • distanceToLine(point, line, f = (x) => x)
    • const line = [p1, p2];

For polygons, make sure the vertices are listed clockwise or counter-clockwise.

  • distanceToPolygon(point, vertices, f = (x) => x)
    • const vertices = [p1, p2, p3, …];

License

(C) 2016 Victor Felder - MIT License