Skip to main content
Version: Next

transformScale

Description

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

NameTypeDescription
geojsonGeoJSON | GeometryCollectionobjects to be scaled
factornumberof 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?ObjectOptional parameters (default {})
options.origin?Corners | CoordPoint from which the scaling will occur (string options: sw/se/nw/ne/center/centroid) (default 'centroid')
options.mutate?booleanallows GeoJSON input to be mutated (significant performance improvement if true) (default false)

Returns

GeoJSON | GeometryCollection scaled GeoJSON

Examples

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

Installation

$ npm install @turf/transform-scale

import { transformScale } from "@turf/transform-scale";
const result = transformScale(...);
$ npm install @turf/turf

import * as turf from "@turf/turf";
const result = turf.transformScale(...);