Porting Google's S2 Geometry Library to Javascript
Go to file
AJ ONeal 197e07a605 bump 2016-08-03 00:33:32 -06:00
src use correct starting square for face #6 #8 #9 2016-08-03 00:04:26 -06:00
tests fix #8 #6 2016-08-03 00:33:20 -06:00
.gitignore add .gitignore 2016-07-27 20:46:04 -04:00
AUTHORS v1.0.0 2016-07-26 00:42:53 -04:00
LICENSE move to Daplie 2016-07-30 11:06:23 -04:00
README.md add 'used by' section 2016-07-28 05:23:39 -04:00
bower.json v1.0.0 2016-07-26 00:44:38 -04:00
package.json bump 2016-08-03 00:33:32 -06:00

README.md

s2-geometry (JavaScript/ES5.1)

A pure JavaScript/ES5.1 port of Google/Niantic's S2 Geometry library (as used by Ingress, Pokemon GO)

Currently contains basic support for S2Cell

Where is this being used?

Simple Examples

var level = 15;
var latlng = { lat: 40.2574448, lng: -111.7089464 };
var cell = S2.S2Cell.FromLatLng(latlng, level);

cell.getNeighbors();  // [ cellLeft, cellDown, cellRight, cellUp ]

cell.getLatLng();     // { lat: 40.2574448, lng: -111.7089464 }

var key = cell.toHilbertQuadkey();

Previous and Next

You can get the previous and next S2CellId from any given Key:

  1. Convert from Lat/Lng to Key (Face and Hilbert Curve Quadtree)
  2. Get the Previous or Next Key
  3. Convert the Key to an Id (uint64 string)
var key = S2.latLngToKey(40.2574448, -111.7089464);   // '4/032212303102210'
var id = S2.toId(key);                                // '9749618446378729472'

var nextKey = S2.nextKey(key);
var nextId = S2.toId(nextKey);

var prevKey = S2.prevKey(key);
var prevId = S2.toId(prevKey);

// See it
console.log(prevKey);                                 // '4/032212303102203'
console.log(key);                                     // '4/032212303102210'
console.log(nextKey);                                 // '4/032212303102211'
console.log(nextId);

convert Cell Id to Quadkey

Convert from base 10 (decimal) S2 Cell Id to base 4 quadkey (aka hilbert curve quadtree id)

Example '4/032212303102210' becomes '9749618446378729472'

'use strict';

var quadkey = '4/032212303102210'
var parts = quadkey.split('/');
var face = parts[0];                  // 4
var position = parts[1];              // '032212303102210';
var level = '032212303102210'.length; // 15

var cellId = S2.fromFacePosLevel(face, position, level);

console.log(cellId);

Convert from hilbert quadtree id to s2 cell id:

Example '9749618446378729472' becomes '4/032212303102210'

'use strict';

var cellId = '9749618446378729472';

var hilbertQuadkey = S2.toHilbertQuadkey(cellId);

console.log(hilbertQuadkey);