Slippy Grid
Create slippy tile grid iterators from BBox.
Install
npm
$ npm install --save slippy-grid
web browser ES6
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 PolygonminZoom
number Minimum ZoommaxZoom
number Maximum Zoom
Examples
const grid = slippyGridconst value done = gridnext//=value [x, y, z]//=done true/false
Returns Iterator<Tile> Iterable Grid of Tiles from extent
geojson
Creates an Iterator of Tiles from a given GeoJSON
Parameters
extent
FeatureCollection<(Polygon | MultiPolygon)> GeoJSON Polygon(s)minZoom
number Minimum ZoommaxZoom
number Maximum Zoom
Examples
const grid = slippyGridconst value done = gridnext// value => [x, y, z]// done => true/false
Returns Iterator<Tile> Iterable Grid of Tiles from GeoJSON
getChildren
Creates an Iterator of children Tiles from a given parent tile
Parameters
parentTile
GeoJSON TilemaxZoom
number Maximum Zoom
Examples
const parentTile = 0 572 10const maxZoom = 12const grid = slippyGridconst value done = gridnext// value => [x, y, z]// done => true/false
Returns 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 PolygonminZoom
number Minimum ZoommaxZoom
number Maximum Zoom
Examples
const tiles = slippyGridall-1800 -900 180 90 3 8//=tiles
Returns 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 PolygonminZoom
number Minimum ZoommaxZoom
number Maximum Zoomsize
number Maximum size for bulk Tiles
Examples
const grid = slippyGridconst value done = gridnext//=value Array<[x, y, z]>//=done true/false
Returns 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 PolygonminZoom
number Minimum ZoommaxZoom
number Maximum Zoom
Examples
const levels = slippyGrid//=levels
Returns 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 PolygonminZoom
number Minimum ZoommaxZoom
number Maximum Zoomquick
number Enable quick count if greater than number (optional, default1000
)
Examples
const count = slippyGrid//=count 563136
Returns number Total tiles from BBox