@turf/transform-rotate
TypeScript icon, indicating that this package has built-in type declarations

7.0.0 • Public • Published

@turf/transform-rotate

transformRotate

Rotates any geojson Feature or Geometry of a specified angle, around its centroid or a given pivot point.

Parameters

  • geojson GeoJSON object to be rotated

  • angle number of rotation in decimal degrees, positive clockwise

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

    • options.pivot Coord point around which the rotation will be performed (optional, default 'centroid')
    • 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 options = {pivot: [0, 25]};
var rotatedPoly = turf.transformRotate(poly, 10, options);

//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 single module individually:

$ npm install @turf/transform-rotate

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

$ npm install @turf/turf

Package Sidebar

Install

npm i @turf/transform-rotate

Weekly Downloads

395,711

Version

7.0.0

License

MIT

Unpacked Size

16.3 kB

Total Files

9

Last publish

Collaborators

  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly