Skip to content
A geographic toolkit for dealing with geometry, geography, formats, and building geo databases
JavaScript Ruby TypeScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
examples bump samples and use https Apr 3, 2019
spec
.gitignore ditch phantom and cruft in npm tarball Jun 9, 2018
.travis.yml ditch phantom and cruft in npm tarball Jun 9, 2018
CHANGELOG.md 📦 1.0.9 Jun 9, 2018
Gemfile
LICENSE Update Copyright date to 2019 Apr 5, 2019
README.md
bower.json
config.rb more tweaks for website Dec 4, 2013
gruntfile.js remove dependency on growl Jun 12, 2018
jasmine.json
package-lock.json bump to @types/geojson: 7946 Jul 31, 2019
package.json
release.sh
terraformer.d.ts bump to @types/geojson: 7946 Jul 31, 2019
terraformer.js pull geometry from feature objects in within (#282) Oct 17, 2016
test.ts
tsconfig.json
tslint.json

README.md

Terraformer

Build Status

A modular toolkit for working with geographic data.

Modules

The Terraformer project is broken up into a series of smaller modules.

  • Terraformer Core - Contains methods and objects for working with GeoJSON. This also contains common methods used by other modules.
  • WKT Parser - Parse Well Known Text into GeoJSON and vice versa.
  • ArcGIS Geometry Parser - Parse the ArcGIS Geometry Format into GeoJSON and vice versa.
  • GeoStore - A framework for persisting and querying GeoJSON features with pluggable indexes and persistent stores.

Features

  • Designed to work in Node and the browser
  • No dependencies on other tools or libraries

Getting Started

Check out the getting started guide which will give you an overview of core concepts and methods in Terraformer.

Node.js

Install the core module with npm and then require it in your Node program.

$ npm install terraformer
var Terraformer = require('terraformer');

If needed, supporting packages can be added too.

require('terraformer-arcgis-parser');
require('terraformer-wkt-parser');
require('terraformer-geostore');

Browser

To see Terraformer in action in the browser, check out our live demos. To use it in the browser yourself, reference it using a <script> tag.

<script src="https://unpkg.com/terraformer@1.0.8"></script>

To utilize supporting packages, you must load their source as well.

<script src="https://unpkg.com/terraformer-arcgis-parser@1.0.5"></script>
<script src="https://unpkg.com/terraformer-wkt-parser@1.1.2"></script>

Documentation

Make sure you check out the full documentation on the Terraformer website and the getting started guide.

var polygon = new Terraformer.Primitive({
  "type": "Polygon",
  "coordinates": [
    [
      [-122.665894, 45.5229015],
      [-122.669263, 45.5229165],
      [-122.671151, 45.5184062],
      [-122.673254, 45.5140008],
      [-122.668426, 45.5127378],
      [-122.667654, 45.5169478],
      [-122.665894, 45.5229015]
    ]
  ]
});

var point = new Terraformer.Primitive({
  "type": "Point",
  "coordinates": [-122.669477, 45.517760]
});

Now that you have a point and a polygon primitive you can use the primitive helper methods.

// add a new vertex to our polygon
polygon.insertVertex([-122.670851, 45.513189], 2);

// figure out if our point is within our polygon
point.within(polygon); // returns true

You can also have Terraformer perform many geometric operations like convex hulls and bounding boxes.

var convexHull = polygon.convexHull();

point.within(convexHull); // returns true

var boundingBox = polygon.bbox(); // returns the geojson bounding box for this object.

Resources

Building the documentation

To build the site locally, first bundle install then bundle exec middleman to run a local server. Maintainers can run bundle exec middleman build, then grunt gh-pages to deploy to github pages.

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

A copy of the license is available in the repository's LICENSE file.

You can’t perform that action at this time.