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

7.1.0 • Public • Published

@turf/transform-scale

transformScale

Scale GeoJSON objects from a given point by a scaling factor e.g. factor=2 would make each object 200% larger. If a FeatureCollection is provided, the origin point will be calculated based on each individual feature unless an exact

Parameters

  • geojson (GeoJSON | GeometryCollection) objects to be scaled

  • factor number of scaling, positive values greater than 0. Numbers between 0 and 1 will shrink the geojson, numbers greater than 1 will expand it, a factor of 1 will not change the geojson.

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

    • options.origin (Corners | Coord) Point from which the scaling will occur (string options: sw/se/nw/ne/center/centroid) (optional, default 'centroid')
    • options.mutate boolean allows GeoJSON input to be mutated (significant performance improvement if true) (optional, default false)

Examples

const poly = turf.polygon([[[0,29],[3.5,29],[2.5,32],[0,29]]]);
const scaledPoly = turf.transformScale(poly, 3);

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

Returns (GeoJSON | GeometryCollection) scaled GeoJSON


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

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

Weekly Downloads

597,773

Version

7.1.0

License

MIT

Unpacked Size

34.7 kB

Total Files

9

Last publish

Collaborators

  • smallsaucepan
  • morgan.herlocker
  • twelch
  • jamesmilneruk
  • rowanwins
  • tmcw
  • morganherlocker
  • tcql
  • mdfedderly