cutting-room-floor / tilemill-reference-layer Goto Github PK

View Code? Open in Web Editor NEW

14.0 57.0 7.0 294 KB

TileMill Plugin that allows adding a tiled layer from tiles.mapbox.com

JavaScript 100.00%

tilemill-reference-layer's Introduction

Reference Layer for TileMill

This TileMill plugin adds a custom map as a reference layer to your TileMill projects.

This reference layer will be visible while designing & previewing a map, but will not be included in any exports.

Installation

The plugin should be available from the Plugins panel in TileMill.

You can also install it manually by cloning this repository into your TileMill plugins directory.The plugins directory for TileMill is located at ~/.tilemill/node_modules. It will not exist if you have not already installed a plugin. So you may need to create it yourself. You can create the plugins directory and install this plugin manually like:

mkdir -p ~/.tilemill/node_modules
cd ~/.tilemill/node_modules
git clone https://github.com/mapbox/tilemill-reference-layer.git

Note: This plugin is not tested to work with other plugins.

Use

Enable the plugin

Go to a projects settings, and enter a map ID from your Mapbox.com map, or a URL for a TileJSON Service, in the Reference Layer field.

You can get the map ID from the Project settings on Mapbox.com.

If you have a custom tileset available elsewhere, you'll need a TileJSON service to describe this map. You can use the URL of this service for the Reference Layer field.
Design a map with a transparent Map background
Upload your map to Mapbox
Add your map to a composite with your map
Share your map!

tilemill-reference-layer's People

Contributors

Stargazers

Watchers

Forkers

jeffschuler trulia mapconcierge xkwangy benjaki2

tilemill-reference-layer's Issues

Update NPM

@springmeyer I just pushed an update to this project. Can you update it on npm? I think you're the only maintainer currently.

Expose UI to set map id for baselayer

In master, the baselayer is a setting in project.mml. So we need a UI to allow this to be set. Something like a form field on the project settings for base layer where people can paste in a tilejson url copied from MapBox.com would work well.

cc @tmcw

add images to readme for installation and enabling layer in settings

Clear cache in Tilemill

Thanks for this great plugin! It’s immensely helpful in combination with satellite and terrain maps.

Is it possible to clear the cache of the plugin somehow? I have made changes to my reference layer (and underlying terrain map) and the cached tiles won’t update, so I am still seeing the old version.

Thanks for your help!

Update to v0.9.1

see https://github.com/mapbox/tilemill/issues/1458

New name?

Now that this is going to be more generic, we should have a less specific name. @aibram, what do you think?

Incompatible with TileMill 0.10.2

I can't use the plugin with the latest TileMill :(
Steps to reproduce:
Install tilemill via apt-get.
clone git repo of TRL
start TileMill.

Add License.md

I would like to use this plugin as it appears to have the foundation for solving a problem of mine but I noticed there is no LICENSE.MD in this repo. Was leaving this unlicensed done by choice or would it be possible to add a License to this repo that would allow for its use?

I would be willing to make the PR for this if it is just a matter of effort.

Thank you!

Move to MapBox organization

This needs to be maintained by other MapBox folks. See #1.

Can't get plugin to work w/ non-MapBox TileJSON file

Been trying to get this plugin to work w/ my own TileJSON reference but am getting the following error:

[tilemill] Client Error: Script error.
[tilemill]     at :0
[tilemill] Client Error: TypeError: 'undefined' is not an object (evaluating 'a.tiles')
[tilemill]     at http://127.0.0.1:20009/assets/tilemill/js/vendor.js:5164

My TileJSON definition is hosted here, which is CORS supported.

I did have luck using the TileJSON url w/ mapbox.js, so I don't think it's an error w/ the definition. And the plugin did work with a MapBox TileJSON url (tried with this). Any thoughts?

Really useful plugin--allows me to style transparent data overlay layers on top of my base layer w/o having to define the whole baselayer w/i the data overlay project. Thanks.