@turf/transform-translate

transformTranslate

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.

Parameters

• geojson (GeoJSON | GeometryCollection) object to be translated

• distance number length of the motion; negative values determine motion in opposite direction

• direction number of the motion; angle from North in decimal degrees, positive clockwise

• options Object Optional parameters (optional, default {})

  • options.units Units in which distance will be expressed; Supports all valid Turf Units (optional, default 'kilometers')
  • options.zTranslation number length of the vertical motion, same unit of distance (optional, default 0)
  • options.mutate boolean allows GeoJSON input to be mutated (significant performance increase if true) (optional, default false)

Examples

var poly = turf.polygon([[[0,29],[3.5,29],[2.5,32],[0,29]]]);
var translatedPoly = turf.transformTranslate(poly, 100, 35);

//addToMap
var addToMap = [poly, translatedPoly];
translatedPoly.properties = {stroke: '#F00', 'stroke-width': 4};

Returns (GeoJSON | GeometryCollection) the translated GeoJSON object

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/transform-translate

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

$ npm install @turf/turf