DenisCarriere
Slippy Grid
Create slippy tile grid iterators from BBox.
Install
npm
$ npm install --save slippy-gridweb browser ES6
<script src="https://unpkg.com/slippy-grid/docs/slippy-grid.min.js"></script>API
Table of Contents
single
Creates an Iterator of Tiles from a given BBox
Parameters
extent(BBox | Array<BBox> | GeoJSON) BBox [west, south, east, north] order or GeoJSON PolygonminZoomnumber Minimum ZoommaxZoomnumber Maximum Zoom
Examples
const grid = slippyGrid.single([-180.0, -90.0, 180, 90], 3, 8)
const {value, done} = grid.next()
//=value [x, y, z]
//=done true/falseReturns Iterator<Tile> Iterable Grid of Tiles from extent
geojson
Creates an Iterator of Tiles from a given GeoJSON
Parameters
extentFeatureCollection<(Polygon | MultiPolygon)> GeoJSON Polygon(s)minZoomnumber Minimum ZoommaxZoomnumber Maximum Zoom
Examples
const grid = slippyGrid.geojson(poly, 3, 8)
const {value, done} = grid.next()
// value => [x, y, z]
// done => true/falseReturns Iterator<Tile> Iterable Grid of Tiles from GeoJSON
getChildren
Creates an Iterator of children Tiles from a given parent tile
Parameters
parentTileGeoJSON TilemaxZoomnumber Maximum Zoom
Examples
const parentTile = [0, 572, 10]
const maxZoom = 12
const grid = slippyGrid.getChildren(parentTile, maxZoom)
const {value, done} = grid.next()
// value => [x, y, z]
// done => true/falseReturns Iterator<Tile> Iterable of Tiles
all
All Tiles from a given BBox
Parameters
extent(BBox | Array<BBox> | GeoJSON) BBox [west, south, east, north] order or GeoJSON PolygonminZoomnumber Minimum ZoommaxZoomnumber Maximum Zoom
Examples
const tiles = slippyGrid.all([-180.0, -90.0, 180, 90], 3, 8)
//=tilesReturns Array<Tile> Tiles from extent
bulk
Creates a bulk Iterator of Tiles from a given BBox
Parameters
extent(BBox | Array<BBox> | GeoJSON) BBox [west, south, east, north] order or GeoJSON PolygonminZoomnumber Minimum ZoommaxZoomnumber Maximum Zoomsizenumber Maximum size for bulk Tiles
Examples
const grid = slippyGrid.bulk([-180.0, -90.0, 180, 90], 3, 8, 5000)
const {value, done} = grid.next()
//=value Array<[x, y, z]>
//=done true/falseReturns Iterator<Array<Tile>> Bulk Iterable Grid of Tiles from extent
levels
Creates a grid level pattern of arrays
Parameters
extent(BBox | Array<BBox> | GeoJSON) BBox [west, south, east, north] order or GeoJSON PolygonminZoomnumber Minimum ZoommaxZoomnumber Maximum Zoom
Examples
const levels = slippyGrid.levels([-180.0, -90.0, 180, 90], 3, 8)
//=levelsReturns Array<GridLevel> Grid Level
count
Counts the total amount of tiles from a given BBox
Parameters
extent(BBox | Array<BBox> | GeoJSON) BBox [west, south, east, north] order or GeoJSON PolygonminZoomnumber Minimum ZoommaxZoomnumber Maximum Zoomquicknumber Enable quick count if greater than number (optional, default1000)
Examples
const count = slippyGrid.count([-180.0, -90.0, 180, 90], 3, 8)
//=count 563136Returns number Total tiles from BBox