@spatial/clean-coords
v2.0.0
Published
turf clean-coords module
Downloads
81
Readme
@spatial/clean-coords
cleanCoords
Removes redundant coordinates from any GeoJSON Geometry.
Parameters
geojson
(Geometry | Feature) Feature or Geometryoptions
Object Optional parameters (optional, default{}
)options.mutate
boolean allows GeoJSON input to be mutated (optional, defaultfalse
)
Examples
var line = turf.lineString([[0, 0], [0, 2], [0, 5], [0, 8], [0, 8], [0, 10]]);
var multiPoint = turf.multiPoint([[0, 0], [0, 0], [2, 2]]);
turf.cleanCoords(line).geometry.coordinates;
//= [[0, 0], [0, 10]]
turf.cleanCoords(multiPoint).geometry.coordinates;
//= [[0, 0], [2, 2]]
Returns (Geometry | Feature) the cleaned input Feature/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 @spatial/clean-coords
Or install the Turf module that includes it as a function:
$ npm install @turf/turf