slippy-tile

Slippy Tile

Slippy Tile helps parse a Tile scheme URL from a given Tile [x, y, zoom].

Install

$ npm install --save slippy-tile

Quickstart

import * as slippyTile from 'slippy-tile'

const tile = [10, 15, 8] // x, y, zoom
const url = slippyTile.url(tile, 'osm')
//= https://b.tile.openstreetmap.org/8/10/15.png

Providers

Name	Unique Key
OSM (Default)	osm, osm-standard
OSM Cycle Map	osm-cycle
OSM Humanitarian	osm-hot
OSM Transport	osm-transport
OSM Wikimedia	osm-wikimedia
OSM Lyrk	osm-lyrk
Bing Imagery	bing, imagery, bing-imagery
Strava Cycling & Running	strava
National Geographic World Map	natgeo
ESRI Imagery	esri, esri-imagery
ESRI Ocean Basemap	esri-ocean
ESRI USA Topo Maps	esri-usa-topo
ESRI World Street Map	esri-street
ESRI World Topographic Map	esri-topo

Scheme

You can provide your own scheme by following the same syntax as JOSM.

const scheme = 'https://{switch:a,b,c}.tile.openstreetmap.org/{zoom}/{x}/{y}.png'
const url = slippyTile.url([10, 15, 8], scheme)
//= https://b.tile.openstreetmap.org/8/10/15.png

Options

• {x}: Tile Column
• {y}: Tile Row
• {-y}: Tile Row using TMS tile scheme
• {zoom}: Zoom Level
• {bbox}: GeoJSON Bounding Box
• {quadkey}: Microsoft's Quadkey
• {switch:1,2,3}: Selects a random sample
• {height} default = 256
• {width}: default = 256
• {proj}: default = EPSG:3857

url

Substitutes the given tile information [x,y,zoom] to the URL tile scheme.

Parameters

• tile Tile Tile [x, y, zoom]
• scheme string Tile scheme URL or provider unique key

Examples

const url = slippyTile.url([10, 15, 8], 'osm')
//='https://c.tile.openstreetmap.org/8/10/15.png'

Returns string

download

Downloads Tile

Parameters

• tile Tile Tile [x, y, zoom]
• scheme string Tile scheme URL or provider unique key

Examples

const url = slippyTile.url([10, 15, 8], 'osm')
//='https://c.tile.openstreetmap.org/8/10/15.png'

Returns Promise<Buffer> tile buffer

parseSwitch

Replaces {switch:a,b,c} with a random sample.

Parameters

• url string URL Scheme

Examples

const scheme = 'http://tile-{switch:a,b,c}.openstreetmap.fr/hot/{zoom}/{x}/{y}.png'
const url = slippyTile.parseSwitch(scheme)
//='http://tile-b.openstreetmap.fr/hot/{zoom}/{x}/{y}.png'

Returns string Parsed URL with switch replaced

providerLookup

Provider Lookup

Parameters

• provider string Provider's unique key

Examples

const scheme = slippyTile.providerLookup('bing')
//='http://ecn.t{switch:0,1,2,3}.tiles.virtualearth.net/tiles/a{quadkey}.jpeg?g=5250'

Returns string scheme Tile scheme URL

sample

Sample an item from a given list

Parameters

• collection Array<any> List of items

Examples

const item = sample(['a', 'b', 'c'])
//='a'

Returns (string | number) Single item from the list