@turf/isobands

turf isobands module

Usage no npm install needed!

<script type="module">
  import turfIsobands from 'https://cdn.skypack.dev/@turf/isobands';
</script>

README

@turf/isobands

isobands

Takes a square or rectangular grid FeatureCollection of Point features with z-values and an array of value breaks and generates filled contour isobands.

Parameters

  • pointGrid FeatureCollection<Point> input points - must be square or rectangular
  • breaks Array<number> where to draw contours
  • options Object options on output (optional, default {})
    • options.zProperty string the property name in points from which z-values will be pulled (optional, default 'elevation')
    • options.commonProperties Object GeoJSON properties passed to ALL isobands (optional, default {})
    • options.breaksProperties Array<Object> GeoJSON properties passed, in order, to the correspondent isoband (order defined by breaks) (optional, default [])

Returns FeatureCollection<MultiPolygon> a FeatureCollection of MultiPolygon features representing isobands

This module is part of the Turfjs project, an open source module collection dedicated to geographic algorithms. It is maintained in the Turfjs/turf repository, where you can create PRs and issues.

Installation

Install this module individually:

$ npm install @turf/isobands

Or install the Turf module that includes it as a function:

$ npm install @turf/turf