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

6.5.0 • Public • Published

@turf/truncate

truncate

Takes a GeoJSON Feature or FeatureCollection and truncates the precision of the geometry.

Parameters

  • geojson GeoJSON any GeoJSON Feature, FeatureCollection, Geometry or GeometryCollection.
  • options Object Optional parameters (optional, default {})
    • options.precision number coordinate decimal precision (optional, default 6)
    • options.coordinates number maximum number of coordinates (primarly used to remove z coordinates) (optional, default 3)
    • options.mutate boolean allows GeoJSON input to be mutated (significant performance increase if true) (optional, default false)

Examples

var point = turf.point([
    70.46923055566859,
    58.11088890802906,
    1508
]);
var options = {precision: 3, coordinates: 2};
var truncated = turf.truncate(point, options);
//=truncated.geometry.coordinates => [70.469, 58.111]

//addToMap
var addToMap = [truncated];

Returns GeoJSON layer with truncated geometry


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/truncate

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

$ npm install @turf/turf

Package Sidebar

Install

npm i @turf/truncate

Weekly Downloads

419,105

Version

6.5.0

License

MIT

Unpacked Size

11.9 kB

Total Files

7

Last publish

Collaborators

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