letmaik / covutils

JavaScript utilities for creating, transforming, and handling Coverage Data objects

covutils

JavaScript utilities for creating, transforming, and handling Coverage Data objects.

API docs

Usage

A minified bundle of this library is available on unpkg.

Usage is simple:

<script src="https://unpkg.com/[email protected]/covutils.min.js"></script>
<script>
var coverage = ... ;

// let's mask the Coverage with a GeoJSON polygon
// any data values outside the polygon become null
var polygon = {
  "type": "Polygon",
  "coordinates": [
    [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0], [100.0, 1.0], [100.0, 0.0] ]
    ]
}
CovUtils.maskByPolygon(coverage, polygon, ['x','y'])
  .then(function (maskedCov) {
    // work with masked Coverage
  })
</script>

If polygon-related functionality is not needed, then a lite bundle can be used instead:

<script src="https://unpkg.com/[email protected]/covutils-lite.min.js"></script>

NPM

You may also use this library within common package managers as it is published on npm.

An ES2015 import may look like that:

import {maskByPolygon} from 'covutils'

Acknowledgments

This library has been developed within the MELODIES project and is maintained as open source software.