Skip to content

rowanwins/arcgis-pbf-parser

Repository files navigation

arcgis-pbf-parser

A library for converting an arcgis-pbf into a geojson FeatureCollection.

By itself it doesn't do much but you can find a more complex example of it's usage is in my mapbox-gl-arcgis-featureserver library.

Test Status minzipped size

Basic Usage

const arcgisPbfDecode = require('arcgis-pbf-parser')
// or in ES6
import arcgisPbfDecode from' arcgis-pbf-parser'

fetch('Some/FeatureServer/0/query?f=pbf&...')
  .then(response => response.arrayBuffer())
  .then(data => {
    const featureCollection = arcgisPbfDecode(new Uint8Array(data)).featureCollection
   })

The decode method returns an object containing the featureCollection object, and a boolean specifying if there were too many features and so you need to paginate for more features with the same request.

{
  featureCollection: {
    ...
  },
  exceededTransferLimit: true/false
}

Status

This was cobbled together fairly quickly based on the minimal documentation available.

Done

  • Polgon
    • Inc MultiPolygon
    • Inc Polygon with holes
  • LineString
    • Inc MultiLineString
  • Point
  • Attributes
  • Features with null geometries

To Do

  • MultiPoint (a sample service would be helpful)
  • Improve tests

Acknowledgements

  • I used the proto spec file supplied by Esri here
  • I used the mapbox pbf library to compile the src/parser/PbfFeatureCollection.js module for parsing rather than the one supplied by Esri
    • This results in a slimmer & faster package and the pbf dependency will be shared/tree-shaken with mapbox-gl.