This package has been deprecated

Author message:

this package has been deprecated

mbgl-downloadl-ctrl

mbgl-download-ctrl

Control for downloading the background tiles in the map you're currently viewing.

See Example at http://tiles.okdistribute.xyz

It's recommended to use Bing background tiles because Mapbox's terms of service are more restrictive when it comes to downloading and using tiles offline.

By Default, the download control will use StreamSaver.js to download the tiles to a tar file, without hitting the server. This is cool! But it only works on the latest version of Google Chrome (and maybe some others, but you should really check).

If you want to control the download yourself, you can override that default behavior by passing your own onDownload funciton to the control.

Usage

var DownloadControl = require('mpgl-download-control')
var mapboxgl = require('mapbox-gl')
 
const bingSource = {
  type: 'raster',
  tiles: [
    'https://ecn.t0.tiles.virtualearth.net/tiles/a{quadkey}.jpeg?g=1',
    'https://ecn.t1.tiles.virtualearth.net/tiles/a{quadkey}.jpeg?g=1',
    'https://ecn.t2.tiles.virtualearth.net/tiles/a{quadkey}.jpeg?g=1',
    'https://ecn.t3.tiles.virtualearth.net/tiles/a{quadkey}.jpeg?g=1'
  ],
  minzoom: 1,
  maxzoom: 21,
  tileSize: 256
}
 
const bing = {
  id: 'bing',
  type: 'raster',
  source: 'bing',
  layout: {
    visibility: 'visible'
  },
  paint: {
  }
}
 
mapboxgl.accessToken = accessToken
 
var map = new mapboxgl.Map({
  container: 'map',
  style: {
    version: 8,
    sources: {'bing': bingSource},
    layers: [bing]
  }
})
map.on('style.load', function () {
  var underlays = [{
    name: 'Bing Satellite',
    ids: ['bing']
  }]
  var downloadControl = new DownloadControl()
  map.addControl(downloadControl, 'bottom-left')
})

API

new DownloadControl(options)

Options:

• onDownload: optional function that takes parameter data, which is the user-defined area to download: minZoom, maxZoom, minLat, minLng, maxLat, maxLng.

License

MIT