@turf/isobands 6.5.0 → 7.0.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/README.md +9 -8
  2. package/dist/es/index.js +145 -3709
  3. package/dist/es/lib/grid-to-matrix.js +101 -0
  4. package/dist/es/lib/marchingsquares-isobands.js +3453 -0
  5. package/dist/js/index.d.ts +20 -0
  6. package/dist/js/index.js +149 -3721
  7. package/dist/js/lib/grid-to-matrix.d.ts +37 -0
  8. package/dist/js/lib/grid-to-matrix.js +104 -0
  9. package/dist/js/lib/marchingsquares-isobands.d.ts +1 -0
  10. package/dist/js/lib/marchingsquares-isobands.js +3456 -0
  11. package/package.json +27 -22
  12. package/index.d.ts +0 -19
package/README.md CHANGED
@@ -7,16 +7,17 @@
7
7
  Takes a square or rectangular grid [FeatureCollection][1] of [Point][2] features with z-values and an array of
8
8
  value breaks and generates filled contour isobands.
9
9
 
10
- **Parameters**
10
+ ### Parameters
11
11
 
12
- - `pointGrid` **[FeatureCollection][3]<[Point][4]>** input points - must be square or rectangular
13
- - `breaks` **[Array][5]<[number][6]>** where to draw contours
14
- - `options` **[Object][7]** options on output (optional, default `{}`)
15
- - `options.zProperty` **[string][8]** the property name in `points` from which z-values will be pulled (optional, default `'elevation'`)
16
- - `options.commonProperties` **[Object][7]** GeoJSON properties passed to ALL isobands (optional, default `{}`)
17
- - `options.breaksProperties` **[Array][5]<[Object][7]>** GeoJSON properties passed, in order, to the correspondent isoband (order defined by breaks) (optional, default `[]`)
12
+ * `pointGrid` **[FeatureCollection][3]<[Point][4]>** input points - must be square or rectangular
13
+ * `breaks` **[Array][5]<[number][6]>** where to draw contours
14
+ * `options` **[Object][7]** options on output (optional, default `{}`)
18
15
 
19
- Returns **[FeatureCollection][3]&lt;[MultiPolygon][9]>** a FeatureCollection of [MultiPolygon][10] features representing isobands
16
+ * `options.zProperty` **[string][8]** the property name in `points` from which z-values will be pulled (optional, default `'elevation'`)
17
+ * `options.commonProperties` **[Object][7]** GeoJSON properties passed to ALL isobands (optional, default `{}`)
18
+ * `options.breaksProperties` **[Array][5]<[Object][7]>** GeoJSON properties passed, in order, to the correspondent isoband (order defined by breaks) (optional, default `[]`)
19
+
20
+ Returns **[FeatureCollection][3]<[MultiPolygon][9]>** a FeatureCollection of [MultiPolygon][10] features representing isobands
20
21
 
21
22
  [1]: https://tools.ietf.org/html/rfc7946#section-3.3
22
23