Skip to content

dpmcmlxxvi/olturf

Repository files navigation

OpenLayers Turf

build coverage codacy npm

OpenLayers Turf (olturf) is a Turf toolbar for OpenLayers. The toolbar provides the following features:

  • Customizable commands to display
  • Forms to collect command inputs
  • Popups to display numerical outputs
  • Input features are selected in the map
  • Output features are displayed in the map

Instead of displaying all the Turf commands available, individual commands can be selected or a subset of pre-defined groups can be displayed. The following groups are available aggregation, classification, data, grids, interpolation, measurement, misc, joins, transformation.

GETTING STARTED

A toolbar can be added to an OpenLayers map by adding its dependencies

<link href="https://cdn.rawgit.com/openlayers/openlayers.github.io/master/en/v5.3.0/css/ol.css"
  rel="stylesheet" type="text/css" />
<link href="https://unpkg.com/olturf/dist/olturf.min.css" rel="stylesheet" type="text/css" />

<script src="https://cdn.rawgit.com/openlayers/openlayers.github.io/master/en/v5.3.0/build/ol.js"></script>
<script src="https://unpkg.com/@turf/turf@5.1.6/turf.min.js"></script>
<script src="https://unpkg.com/olturf/dist/olturf.min.js"></script>

then creating an instance and adding it to the map

const toolbar = new olturf.Toolbar();
const map = new ol.Map({...});
map.addControl(toolbar);

DOCUMENTATION

The following help is available at the olturf website:

BUILD

To build and test the library locally:

npm install
npm test

The bundled library and stylesheet are at dist/olturf.min.js and dist/olturf.min.css.

LICENSE

Copyright (c) 2016 Daniel Pulido mailto:dpmcmlxxvi@gmail.com

Source code is released under the MIT License. Documentation is released under the CC BY 4.0. Icons are from OSGeo and released under the CC BY 3.0.