Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Esri/terraformer-geostore
GeoStore module for Terraformer
https://github.com/Esri/terraformer-geostore
Last synced: about 1 month ago
JSON representation
GeoStore module for Terraformer
- Host: GitHub
- URL: https://github.com/Esri/terraformer-geostore
- Owner: Esri
- License: mit
- Archived: true
- Created: 2013-08-23T21:41:07.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2021-03-08T18:16:15.000Z (over 3 years ago)
- Last Synced: 2024-07-23T09:11:14.993Z (about 2 months ago)
- Language: JavaScript
- Size: 85.9 KB
- Stars: 34
- Watchers: 9
- Forks: 19
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Important!
This repo is part of the Terraformer project which has been archived. See https://github.com/Esri/terraformer#important for more details.
[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]
[npm-image]: https://img.shields.io/npm/v/terraformer-geostore.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/terraformer-geostore
[travis-image]: https://img.shields.io/travis/Esri/terraformer-geostore/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/Esri/terraformer-geostore
# terraformer-geostore
`Terraformer.GeoStore` is a class built for handing lightweight storage and querying large numbers of [GeoJSON Features](http://www.geojson.org/geojson-spec.html#feature-objects). It is very fast and can index the [rough US counties data](https://github.com/Esri/Terraformer/blob/master/examples/geostore/counties_rough.json) (~950k features) in about 120ms and do a point in polygon search contains a point in ~6.5ms.
## Installing
### Node.js
```bash
$ npm install terraformer
$ npm install terraformer-geostore
$ npm install terraformer-rtree
$ npm install terraformer-geostore-memory
```
### Browser
In the browser, [Terraformer](http://github.com/esri/terraformer) is required.
You can use [Bower](http://bower.io/) to install the components if you like or download them and host them yourself.
```html
```
## Documentation
For a full guide to GeoStore check out the [Terraformer website](https://github.com/Esri/terraformer/blob/master/docs/geostore.md).
```js
var store = new Terraformer.GeoStore({
store: new Terraformer.GeoStore.Memory(),
index: new Terraformer.RTree()
});
// Add a GeoJSON feature
store.add({
"type": "Feature",
"properties": {
"name": "Ladds Addition"
},
"id": "ladds-addition",
"geometry": {
"type": "Polygon",
"coordinates": [
[ [ -122.65355587005614, 45.50499344809821 ], [ -122.65355587005614, 45.512061121601 ], [ -122.64535903930664, 45.512061121601 ], [ -122.64535903930664, 45.50499344809821 ], [ -122.65355587005614, 45.50499344809821 ] ]
]
}
}, function (err, success) {
// callback when the geojson is added
});
// You can also add a FeatureCollection
store.add({
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"name": "Esri PDX"
},
"id": "esri-pdx",
"geometry": {
"type": "Point",
"coordinates": [ -122.67629563808441, 45.51646293140592 ]
}
},
{
"type": "Feature",
"properties": {
"name": "Barista"
},
"id": "barista",
"geometry": {
"type": "Point",
"coordinates": [ -122.67520129680635, 45.51926322043975 ]
}
}
]
}, function (err, success) {
// callback when all features are added
});
// ask the store which features are within a given polygon.
store.within({
"type": "Polygon",
"coordinates": [
[ [-122.69290924072266, 45.54038305764738], [-122.72054672241211, 45.535453299886896], [-122.69479751586914, 45.51464736754301], [-122.67848968505858, 45.495398037299395], [-122.66836166381836, 45.495398037299395], [-122.66681671142577, 45.50321887154943], [-122.67127990722655, 45.51067773196122], [-122.67127990722655, 45.522585798722176], [-122.67110824584961, 45.53028260179986], [-122.69290924072266, 45.54038305764738] ]
]
}, function (err, results) {
for (var i = results.length - 1; i >= 0; i--) {
console.log(results[i].id);
};
});
```
## Issues
Find a bug or want to request a new feature? Please let us know by submitting an issue.
## Contributing
Esri welcomes contributions from anyone and everyone. Please see our [guidelines for contributing](https://github.com/Esri/contributing).
## Licensing
A copy of the license is available in the repository's [LICENSE](./LICENSE) file.