Installation
$ npm install shapefile-stream
Note: you will need node
and npm
installed first.
The easiest way to install node.js
is with nave.sh by executing [sudo] ./nave.sh usemain stable
Usage
You can extract the shapefile data from a file stream:
var shapefile = ; // both the .shp and the .dbf files are required shapefile ;
Roll your own
The easiest way to get started writing your own pipes is to use through2
; just make sure you call next()
.
var shapefile = through = ; shapefile ;
Feature France MARNE Polygon 184Feature France MEURTHE-ET-MOSELLE MultiPolygon 1Feature France NIEVRE Polygon 162Feature France NORD Polygon 167
Schema
Each shapefile is different, but the example file outputs objects which look like this:
"type": "Feature" "properties": "qs_adm0_a3": "FRA" "qs_adm0": "France" "qs_level": "adm2_region" "qs_iso_cc": "FR" "qs_a0": "France" "qs_a0_lc": null "qs_a1r": "ALSACE" "qs_a1r_alt": null "qs_a1r_lc": "42" "qs_a1": "BAS-RHIN" "qs_a1_alt": null "qs_a1_lc": "67" "qs_a2r": "STRASBOURG" "qs_a2r_alt": null "qs_a2r_lc": "6" "qs_type": "Arrondissement" "qs_source": "France IGN" "qs_pop": null "qs_id": null "qs_gn_id": null "qs_woe_id": null "qs_scale": null "geometry": "type": "Polygon" "coordinates": <<truncated>>
NPM Module
The shapefile-stream
npm module can be found here:
https://npmjs.org/package/shapefile-stream
Contributing
Please fork and pull request against upstream master on a feature branch.
Pretty please; provide unit tests and script fixtures in the test
directory.
Running Unit Tests
$ npm test
Continuous Integration
Travis tests every release against node version 0.10