common-geohash-parent

Common geohash parent finder v0.1.0

Class with multiple methods to help you find the common parent geohash from points, geohashes, bounding boxes, polygons or other GeoJSON shapes.

Installation

Using npm:

npm i common-geohash-parent

Using yarn:

yarn add common-geohash-parent

Example usage

In node:

const ParentFinder = require('common-geohash-parent');
 
const bbox = [-3.944092, 40.241799, -3.261566, 40.779502];
const precision = 5;
const finder = new ParentFinder(precision);
finder.fromBBox(bbox)
  .then((parents) => {
    // parents is ['ezjp','ezjr','ezjx','ezjn','ezjq','ezjw','ezjj','ezjm','ezjt','ezjh','ezjk','ezjs']
    ...
  });

Classes

ParentFinder

Typedefs

ParentGeohashList : Array.<string>

OptimizationOptions

ParentFinder

Kind: global class

• ParentFinder
  • new ParentFinder()
  • instance
    • .fromPoints(points) ⇒ ParentGeohashList
    • .fromGeohashes(hashes) ⇒ ParentGeohashList
    • .fromBBox(bbox) ⇒ Promise.<ParentGeohashList>
    • .fromPolygon(inputPolygon) ⇒ Promise.<ParentGeohashList>
  • static
    • .ParentFinder
      • new ParentFinder(parentPrecision, [optimization])

new ParentFinder()

ParentFinder class

parentFinder.fromPoints(points) ⇒ ParentGeohashList

Finds common parents from array of points

Kind: instance method of ParentFinder
Returns: ParentGeohashList - Array of geohashes

Param	Type	Description
points	Array.<Array.<number>>	[lon, lat]

parentFinder.fromGeohashes(hashes) ⇒ ParentGeohashList

Finds common parents from array of geohashes

Kind: instance method of ParentFinder
Returns: ParentGeohashList - List of parent geohashes

Param	Type	Description
hashes	Array.<string>	List of geohashes

parentFinder.fromBBox(bbox) ⇒ Promise.<ParentGeohashList>

Finds common parents from bounding box

Kind: instance method of ParentFinder
Returns: Promise.<ParentGeohashList> - Promise of list of parent geohashes

Param	Type	Description
bbox	Array.<number>	[number, number, number, number]

parentFinder.fromPolygon(inputPolygon) ⇒ Promise.<ParentGeohashList>

Finds common parents from polygon feature

Kind: instance method of ParentFinder
Returns: Promise.<ParentGeohashList> - Promise of list of parent geohashes

Param	Type	Description
inputPolygon	object	GeoJSON shape

ParentFinder.ParentFinder

Kind: static class of ParentFinder

new ParentFinder(parentPrecision, [optimization])

Creates an instance of ParentFinder.

Param	Type	Description
parentPrecision	number	Initial parent precision
[optimization]	OptimizationOptions	If desired, specify optimization options

ParentGeohashList : Array.<string>

Kind: global typedef

OptimizationOptions

Kind: global typedef
Properties

Name	Type
enabled	boolean
maxParents	number