Skip to content

Commit b53f6d1

Browse files
jtheisentwelch
andauthored
Add warning about shape distortion #217 (#2831)
Co-authored-by: Tim Welch <[email protected]>
1 parent a5c5ed8 commit b53f6d1

File tree

1 file changed

+3
-0
lines changed
  • packages/turf-transform-translate

1 file changed

+3
-0
lines changed

packages/turf-transform-translate/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ import { rhumbDestination } from "@turf/rhumb-destination";
99
* Moves any geojson Feature or Geometry of a specified distance along a Rhumb Line
1010
* on the provided direction angle.
1111
*
12+
* Note that this moves the points of your shape individually and can therefore change
13+
* the overall shape. How noticable this is depends on the distance and the used projection.
14+
*
1215
* @function
1316
* @param {GeoJSON|GeometryCollection} geojson object to be translated
1417
* @param {number} distance length of the motion; negative values determine motion in opposite direction

0 commit comments

Comments
 (0)