Package Exports

@turf/transform-translate

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@turf/transform-translate) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@turf/transform-translate

transformTranslate

Moves any geojson Feature or Geometry of a specified distance along a Rhumb Line on the provided direction angle.

Parameters

geojson GeoJSON 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
units [string] in which distance will be express; miles, kilometers, degrees, or radians (optional, default kilometers)
zTranslation [number] length of the vertical motion, same unit of distance (optional, default 0)
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 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 module individually:

$ npm install @turf/transform-translate

Or install the Turf module that includes it as a function:

$ npm install @turf/turf