terraformer

<!doctype html> <html> <head> <meta charset="utf-8"> <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"> <title>Terraformer</title> <link href="/assets/css/terraformer-02847305.css" media="screen" rel="stylesheet" type="text/css" /> </head> <body class="getting-started getting-started_index" id="wrap"> <nav> <ul> <li> <a href="/" class="">Terraformer</a> </li> <li> <a href="https://github.com/search?q=%40Esri+terraformer" class="">GitHub</a> </li> <li> <a href="/install" class="">Install</a> </li> <li> <a href="/" data-direction="active-top" class="toggle" id="close-drawer">Docs</a> </li> </ul> </nav> <div class="drawer" id="drawer"> <div class="doctoc drawer-nav drawer-top"> <div class="container"> <ul> <h3>Terraformer Documentation</h3> <li><a href="/getting-started/">Getting Started</a></li> <li><a href="/core/">Terraformer Core</a></li> <li class="indent"><a href="/core/#terraformerprimitive">Primitives</a></li> <li class="indent"><a href="/core/#terraformertools">Tools</a></li> <li><a href="/geostore/">GeoStores</a></li> <li class="indent"><a href="/geostore/data-stores/">DataStores</a></li> <li class="indent"><a href="/geostore/spatial-indexes/">Spatial Indexes</a></li> <li><a href="/arcgis-parser/">ArcGIS Parser</a></li> <li><a href="/wkt-parser/">WKT Parser</a></li> <li><a href="/glossary/">Glossary</a></li> </ul> </div> </div> </div> <main class="docs main-content" id="main-content"> <h1>Terraformer</h1> <div class='semantic-toc'><ol><li><a href='#getting-started'>Getting Started</a><ol><li><a href='#nodejs'>Node.js</a></li><li><a href='#browser'>Browser</a></li></ol></li><li><a href='#working-with-primitives'>Working with Primitives</a></li><li><a href='#whats-next'>Whats Next?</a></div> Terraformer is an open source (MIT licensed) Javascript geo toolkit, built for the server and the browser. <h2> <a id='getting-started' class='section-link'></a> <a href='#getting-started' class='header-link'>Link</a> Getting Started <a href='#' class='back-to-top-link'>Back to Top</a> </h2> Terraformer is broken into multiple small packages to give you the functionality you need while still remaining extremely lightweight. There are currently several packages in the Terraformer ecosystem. <ul> <li><a href="/core/">Terraformer</a> - The core library for manipilating GeoJSON and performaing calculations. Most other modules rely on <code>terraformer</code>.</li> <li><a href="/arcgis-parser/">ArcGIS Parser</a> - Parses ArcGIS geometry objects to GeoJSON and vice-versa.</li> <li><a href="/wkt-parser/">WKT Parser</a> - Parses basic WKT (Well Known Text) strings to and from GeoJSON.</li> <li><a href="/geostore/">GeoStore</a> - A JavaScript database for storing and querying collections of GeoJSON Features. GeoStores also need an index module and a backing store which are distributed as seperate modules.</li> </ul> <h3> <a id='nodejs' class='section-link'></a> <a href='#nodejs' class='header-link'>Link</a> Node.js <a href='#' class='back-to-top-link'>Back to Top</a> </h3> Install the core module with NPM and then require it in your Node program. <pre class="highlight plaintext"><code>$ npm install terraformer </code></pre> <pre class="highlight javascript"><code>var Terraformer = require('terraformer'); </code></pre> If needed, supporting packages can be added too. <pre class="highlight javascript"><code>require('terraformer-arcgis-parser'); require('terraformer-wkt-parser'); require('terraformer-geostore'); </code></pre> <h3> <a id='browser' class='section-link'></a> <a href='#browser' class='header-link'>Link</a> Browser <a href='#' class='back-to-top-link'>Back to Top</a> </h3> To use the Terraformer library, include a reference to it using a <code><script></code> tag. <pre class="highlight html"><code><script src="http://cdn-geoweb.s3.amazonaws.com/terraformer/1.0.4/terraformer.min.js"></script> </code></pre> To utilize supporting packages, you must load their source as well. <pre class="highlight html"><code><script src="terraformer-arcgis-parser.min.js"></script>  <script src="terraformer-wkt-parser.min.js"></script>  <script src="terraformer-geostore.min.js"></script>  </code></pre> <h2> <a id='working-with-primitives' class='section-link'></a> <a href='#working-with-primitives' class='header-link'>Link</a> Working with Primitives <a href='#' class='back-to-top-link'>Back to Top</a> </h2> Most of the core Terraformer libray centers around using <a href="/core/#terraformerprimitive"><code>Primitives</code></a>, which wrap GeoJSON objects and provide additional functionality. You can create a new <a href="/core/#terraformerprimitive">Terraformer.Primitive</a> with any GeoJSON object. <pre class="highlight javascript"><code> var polygon = new Terraformer.Primitive({ "type": "Polygon", "coordinates": [ [ [-122.66589403152467, 45.52290150862236], [-122.66926288604736, 45.52291654238294], [-122.67115116119385, 45.518406234030586], [-122.67325401306151, 45.514000817199715], [-122.6684260368347, 45.5127377671934], [-122.66765356063841, 45.51694782364431], [-122.66589403152467, 45.52290150862236 ] ] ] }); var point = new Terraformer.Primitive({ "type": "Point", "coordinates": [-122.66947746276854, 45.51775972687403] }); </code></pre> Now that you have a point and a polygon primitive, you can use many of the primitive helper methods. <pre class="highlight javascript"><code>// add a new vertex to our polygon polygon.insertVertex([-122.6708507537842, 45.513188859735436], 2); // figure out if our point is within our polygon point.within(polygon); // returns true </code></pre> You can also have Terraformer perform many geometric operations like convex hulls and bounding boxes. <pre class="highlight javascript"><code>var convexHull = polygon.convexHull(); point.within(convexHull); // returns true var boundingBox = polygon.bbox(); // returns the geojson bounding box for this object. </code></pre> <h2> <a id='whats-next' class='section-link'></a> <a href='#whats-next' class='header-link'>Link</a> Whats Next? <a href='#' class='back-to-top-link'>Back to Top</a> </h2> Start exploring all the options you have working with <a href="/core/#terraformerprimitive">Primitives</a> and the core library. Then start exploring other modules. <a href="/geostore/">Terraformer GeoStore</a> is a JavaScript database for indexing and querying large amounds of GeoJSON. You can use multiple types of spatial indexes and backing stores for your data. You can also convert data between different formats like <a href="/arcgis-parser/">ArcGIS Geometries</a> and <a href="/wkt-parser/">Well Known Text</a>. Since Terraformer is a modular framework, you can pick and choose the pieces to use in your own application. </main> <footer> Terraformer is an open source project from the <a href="http://pdx.esri.com/">Esri Portland R&D Center</a> </footer> <script src="/assets/javascripts/modernizr.custom-cadc78a2.js" type="text/javascript"></script> <script src="/assets/javascripts/classie-b6db1f70.js" type="text/javascript"></script> <script src="/assets/javascripts/drawer-3a1490eb.js" type="text/javascript"></script> </body> </html>