Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warning about shape distortion #217 (transformTranslate) #2831

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/turf-transform-translate/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { rhumbDestination } from "@turf/rhumb-destination";
* Moves any geojson Feature or Geometry of a specified distance along a Rhumb Line
* on the provided direction angle.
*
* Note that this moves the points of your shape individually and can therefore change
* the overall shape. How noticable this is depends on the distance and the used projection.
*
* @function
* @param {GeoJSON|GeometryCollection} geojson object to be translated
* @param {number} distance length of the motion; negative values determine motion in opposite direction
Expand Down