Node.js bindings for GDAL (Geospatial Data Abstraction Library)
C++ JavaScript Other
Clone or download
Permalink
Failed to load latest commit information.
deps Update print syntax Feb 13, 2018
docs Completed documentation. Nov 13, 2014
examples Configured eslint / cleanup Nov 25, 2015
lib Greater tolerance for coordinate transformation test (fixes shared gd… Dec 29, 2016
scripts try build scripts from https://github.com/mapbox/ci-scripts/tree/mast… Jun 2, 2017
src [Node 10] Use Nan::HasOwnProperty and Nan::NewInstance Jun 27, 2018
test Support null / optional getAuthorityCode, getAuthorityName argument (f… Dec 29, 2017
.eslintrc Configured eslint / cleanup Nov 25, 2015
.gitignore Released 0.7.2. [publish binary] Oct 14, 2015
.npmignore Released 0.7.2. [publish binary] Oct 14, 2015
.travis.yml Travis: Restore precise for static builds in Linux Jun 27, 2018
AUTHORS Released 0.9.7. [publish binary] Jun 28, 2018
CHANGELOG Added AUTHORS and CHANGELOG. Aug 21, 2014
CONTRIBUTING.md Misc housecleaning [skip ci] (closes #210) Aug 19, 2017
LICENSE Misc housecleaning [skip ci] (closes #210) Aug 19, 2017
Makefile Updated version in package-lock.json (refs #230 (comment)) [skip ci] Jun 28, 2018
README.md Remove message that async is coming soon Oct 11, 2017
appveyor.yml Add node10 to the build matrix Jun 27, 2018
binding.gyp Binding: Disable win_delay_load_hook to avoid issues with node10 Jun 27, 2018
common.gypi Attempt removal of _HAS_EXCEPTIONS instead of re-define (TODO: re-ena… Apr 6, 2016
package-lock.json Updated version in package-lock.json (refs #230 (comment)) [skip ci] Jun 28, 2018
package.json Released 0.9.7. [publish binary] Jun 28, 2018
yuidoc.json Released 0.9.7. [publish binary] Jun 28, 2018

README.md

node-gdal

NPM version Installs Build Status

Read and write raster and vector geospatial datasets straight from Node.js with this native GDAL binding. GDAL 2.0.1 (GEOS 3.4.2, Proj.4 4.8.0) comes bundled, so node-gdal will work straight out of the box. To get started, browse the API Documentation or examples.

$ npm install gdal --save

To link against shared libgdal, install using:

# requires libgdal-dev (debian: sudo apt-get install libgdal-dev)
$ npm install gdal --build-from-source --shared_gdal

Sample Usage

Raster

var gdal = require("gdal");
var dataset = gdal.open("sample.tif");

console.log("number of bands: " + dataset.bands.count());
console.log("width: " + dataset.rasterSize.x);
console.log("height: " + dataset.rasterSize.y);
console.log("geotransform: " + dataset.geoTransform);
console.log("srs: " + (dataset.srs ? dataset.srs.toWKT() : 'null'));

Vector

var gdal = require("gdal");
var dataset = gdal.open("sample.shp");
var layer = dataset.layers.get(0);

console.log("number of features: " + layer.features.count());
console.log("fields: " + layer.fields.getNames());
console.log("extent: " + JSON.stringify(layer.extent));
console.log("srs: " + (layer.srs ? layer.srs.toWKT() : 'null'));

Notes

  • This binding is not async, so it will block node's event loop. Be very careful (or avoid) using it in server code. We recommended using tools like worker-farm to push expensive operations to a seperate process.

Bundled Drivers

AAIGrid, ACE2, ADRG, AIG, AVCBin, AVCE00, AeronavFAA, AirSAR, BLX, BMP, BNA, BT, CEOS, COASP, COSAR, CPG, CSV, CTG, CTable2, DGN, DIMAP, DIPEx, DOQ1, DOQ2, DTED, DXF, E00GRID, ECRGTOC, EDIGEO, EHdr, EIR, ELAS, ENVI, ERS, ESAT, ESRI Shapefile, MapInfo File, FAST, FIT, FujiBAS, GFF, GML, GPSBabel, GPSTrackMaker, GPX, GRASSASCIIGrid, GS7BG, GSAG, GSBG, GSC, GTX, GTiff, GenBin, GeoJSON, GeoRSS, Geoconcept, HF2, HFA, HTF, IDA, ILWIS, INGR, IRIS, ISIS2, ISIS3, Idrisi, JAXAPALSAR, JDEM, JPEG, KMLSUPEROVERLAY, KML, KRO, L1B, LAN, LCP, LOSLAS, Leveller, MAP, MEM, MFF2, MFF, Memory, NDF, NGSGEOID, NITF, NTv2, NWT_GRC, NWT_GRD, OGR_GMT, OGR_PDS, OGR_SDTS, OGR_VRT, OpenAir, OpenFileGDB, PAux, PCIDSK, PDS, PGDUMP, PNG, PNM, REC, RMF, ROI_PAC, RPFTOC, RS2, RST, R, S57, SAGA, SAR_CEOS, SDTS, SEGUKOOA, SEGY, SGI, SNODAS, SRP, SRTMHGT, SUA, SVG, SXF, TIL, TSX, Terragen, UK .NTF, USGSDEM, VICAR, VRT, WAsP, XPM, XPlane, XYZ, ZMap

Contributors

This binding is a collaboration between Natural Atlas and Mapbox. Its contributors are Brandon Reavis, Brian Reavis, Dane Springmeyer, Zac McCormick, and others.

Before submitting pull requests, please update the tests and make sure they all pass.

$ make test # test against bundled gdal
$ make test-shared # test against shared gdal

License

Copyright © 2015–2017 Natural Atlas, Inc. & Contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.