GeoJSON RBush


GeoJSON implementation of RBush — a high-performance JavaScript R-tree-based 2D spatial index for points and rectangles.

Install

npm

``bash
$ npm install --save geojson-rbush
`

API

#### Table of Contents

- rbush
- insert
- load
- remove
- clear
- search
- collides
- all
- toJSON
- fromJSON

$3

GeoJSON implementation of RBush spatial index.

Parameters

- maxEntries number defines the maximum number of entries in a tree node. 9 (used by default) is a
reasonable choice for most applications. Higher value means faster insertion and slower search, and vice versa. (optional, default 9)

Examples

`javascript
var geojsonRbush = require('geojson-rbush').default;
var tree = geojsonRbush();
`

Returns RBush GeoJSON RBush

$3

insert

Parameters

- feature Feature insert single GeoJSON Feature

Examples

`javascript
var poly = turf.polygon([[[-78, 41], [-67, 41], [-67, 48], [-78, 48], [-78, 41]]]);
tree.insert(poly)
`

Returns RBush GeoJSON RBush

$3

load

Parameters

- features (FeatureCollection | Array<Feature>) load entire GeoJSON FeatureCollection

Examples

`javascript
var polys = turf.polygons([
[[[-78, 41], [-67, 41], [-67, 48], [-78, 48], [-78, 41]]],
[[[-93, 32], [-83, 32], [-83, 39], [-93, 39], [-93, 32]]]
]);
tree.load(polys);
`

Returns RBush GeoJSON RBush

$3

remove

Parameters

- feature Feature remove single GeoJSON Feature
- equals Function Pass a custom equals function to compare by value for removal.

Examples

`javascript
var poly = turf.polygon([[[-78, 41], [-67, 41], [-67, 48], [-78, 48], [-78, 41]]]);

tree.remove(poly);
`

Returns RBush GeoJSON RBush

$3

clear

Examples

`javascript
tree.clear()
`

Returns RBush GeoJSON Rbush

$3

search

Parameters

- geojson (BBox | FeatureCollection | Feature) search with GeoJSON

Examples

`javascript
var poly = turf.polygon([[[-78, 41], [-67, 41], [-67, 48], [-78, 48], [-78, 41]]]);

tree.search(poly);
`

Returns FeatureCollection all features that intersects with the given GeoJSON.

$3

collides

Parameters

- geojson (BBox | FeatureCollection | Feature) collides with GeoJSON

Examples

`javascript
var poly = turf.polygon([[[-78, 41], [-67, 41], [-67, 48], [-78, 48], [-78, 41]]]);

tree.collides(poly);
`

Returns boolean true if there are any items intersecting the given GeoJSON, otherwise false.

$3

all

Examples

`javascript
tree.all()
`

Returns FeatureCollection all the features in RBush

$3

toJSON

Examples

`javascript
var exported = tree.toJSON()
`

Returns any export data as JSON object

$3

fromJSON

Parameters

- json any import previously exported data

Examples

`javascript
var exported = {
"children": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [110, 50]
},
"properties": {},
"bbox": [110, 50, 110, 50]
}
],
"height": 1,
"leaf": true,
"minX": 110,
"minY": 50,
"maxX": 110,
"maxY": 50
}
tree.fromJSON(exported)
``

Returns RBush GeoJSON RBush