Helper for turning a geocode into information about its graticule.
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
src
test
.babelrc
.gitignore
.travis.yml
LICENSE
README.md
package.json

README.md

geo-graticule

Helper for turning a geocode into information about its graticule.

I use this for xkcd Geohashing.

NPM Build Status js-standard-style

Install

npm install geo-graticule

Usage

import Geo from 'geo-graticule'

const geo = new Geo(34.189, -110.8567)

geo.toString()      // '34.189,-110.8567'
get.toArray()       // [ 34.189, -110.8567 ]
get.toJSON()        // { latitude: 34.189, longitude: -110.8567 }

geo.quadrant()           // 'NW'
geo.graticule()          // [ 34, -110 ]
geo.graticuleCenter()    // [ 34.5, -110.5 ]
geo.graticuleBox()       // [ [ 34, -110 ], [ 34, -111 ], [ 35, -111 ], [ 35, -110 ] ]

geo.pointWithinGraticule(0.456, 0.2345) // [ 34.456, -110.2345 ]

API

new Geo(latitude, longitude)

The constructor accepts numbers or strings for any of the values. It will also accept an object with keys latitude|lat and longitude|long|lon or an array of [latitude, longitude].

Return values

All values returned (whether inside objects or arrays) from methods will be a Number (except for toString).

Contributing

This is written in ES6 and compiled to ES5 using babel. The code you require will come from the lib/ directory which gets compiled from src/ before each npm publish.

Tests

npm test

License

MIT