Package Exports

@turf/transform-rotate

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-rotate) 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-rotate

transformRotate

Rotates any geojson Feature or Geometry of a specified angle, around its centroid or a given pivot point; all rotations follow the right-hand rule: https://en.wikipedia.org/wiki/Right-hand_rule

Parameters

geojson GeoJSON object to be rotated
angle number of rotation (along the vertical axis), from North in decimal degrees, negative clockwise
pivot [(Geometry | Feature<Point> | Array<number>)] point around which the rotation will be performed (optional, default `centroid`)
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 rotatedPoly = turf.transformRotate(poly, 10, [0, 25]);

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

Returns GeoJSON the rotated GeoJSON feature

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-rotate

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

$ npm install @turf/turf