mapbox_static_helper

2.0.0 • Public • Published

mapbox_static_helper

Provides urls and pixel positions for loading MapBox's static (square) tiles and create a bigger image

Installation

Using npm:

$ npm install mapbox_static_helper

Usage

//Load module
let map = require('mapbox_static_helper');
 
//set values
 
//for example satellite-v9
 
map.setup({
  mapBoxToken, // Provided by MapBox
  screen_width,
  screen_height,
  zoom,
  map_style, //Available styles can be found here: https://www.mapbox.com/api-documentation/#styles
  location_data, //location_data must be an instance of this other module: https://github.com/JuanIrache/latlon_to_xy
  tile_size,
  attribution, // Whether to attribute MapBox on the image itself. Attribution is mandatory https://docs.mapbox.com/help/how-mapbox-works/attribution/#static--print
  double // Retrieve double resolution images
});
let image_urls = mp.getUrlsAndXY();
//getUrlsAndXY() returns an array of objects, with 3 values each: url (string), x and y (center position of image on screen)
 
//Other methods
map.setStyle(style); //sets the style string
console.log(map.getStyle()); //returns the style string
map.setLocation(location_data); //sets the location instance of latlon_to_xy
let location_data = map.getLocation(); //returns the location instance of latlon_to_xy

TODO

  • Not sure it's working well in conjunction with the laton_to_xy conversions module when changing tile size. What works for me is setting the tile size to 512 in the laton_to_xy module ant to 1024 here
  • Maybe we should make this module completely independent of laton_to_xy

Package Sidebar

Install

npm i mapbox_static_helper

Weekly Downloads

6

Version

2.0.0

License

ISC

Unpacked Size

6.28 kB

Total Files

4

Last publish

Collaborators

  • juanirache