tazaf / angular-turf-module

Bridge to use Turf as a service in an Angular Controller

angular-turf-module - Use Turf from an Angular Controller or Service

Note : This repo and this doc are heavily adapted from the angular-underscore-module, developed by andresesfm. Kudos to him.

Introduction

Turf is a JavaScript library developed by people from MapBox that gives you methods to manipulate geodata with JS. The library is composed of several independant module, each of which achieve a particular geotreatment.

Download Turf

As this module is only a wrapper to access turf in an Angular Way, you still need to download the actual library. You have several options to do so:

• Download the complete minified version of the library here
• Use this online turf builder to build your own version of Turf, using only the module you need for your project. This is the recommended option
• Install Browserify by yourself and build your own version of Turf, using only the module you need for your project (see the turf documentation)

Either way, you should finally have a single js file, named whatever you want, that contains all the necessary code. For the rest of this documentation, we will assume that your js file is named turf.min.js

Usage

0. Make sure you have downloaded and included turf.min.js in your project:

   <script src="path/to/turf.min.js">

1. get this module

   bower install tazaf/angular-turf-module
   

2. Add angular-turf-module.js to your main file (index.html)

   <script src="path/to/angular-turf-module/angular-turf-module.js"></script>

3. Add the module as a dependency in your App definition

   angular.module('MyApp', ['TurfModule'])

4. To use, add as an injected dependency to your Controller/Service and it is ready to use

   angular
     .module('MyApp')
     .controller('MyCtrl', function ($scope, turf) {
   ...
   //Use turf
   var pt1 = turf.point([-75.343, 39.984]);
   ...

References:

• Turf: http://turfjs.org/
• Turf Builder Tool: https://turfjs-builder.herokuapp.com/
• Github: https://github.com/tazaf/angular-turf-module