Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
fonts
images
lib
themes
.gitignore
LICENSE
README.md
VERSION
index.html
refill-style.yaml

README.md

Tangram Refill Style

Refill provides a high contrast, black & white basemap useful for data visualization. Give OpenStreetMap data a refined basemap skin using the Tangram graphics library and Mapzen's versatile Vector Tiles.

Refill is a continuation of the Toner style Geraldine started at Stamen. With the GL capabilities of Tangram, detailed lines, patterns and building extrusions are further explored and elaborated upon from the previous Toner base-style. Toner was a style created at Stamen as part of their great CityTracking project. Please use and adapt the open source scene file in your own projects!

Looking for help? There is a mini tutorial after the preview image below walking thru Vector Tiles API key signup and building a Leaflet map using Tangram and this repo's scene file.

A family of styles with many flavours

Mapzen offers the Refill style in three flavors:

  1. Default (this repo) - Some labels for streets, cities, water bodies, and some big parks with name only (no icons). No business labels. Good for data visualization overlays that need to provide some location context.
  2. More labels - Full set of labels, including high contrast icons highlighting OpenStreetMap business listing data.
  3. No labels - Just the lines and polygons, please.

Looking for a different style? We offer a range of styles including Cinnabar (colorful classic cartography) and Zinc (soft gray cartography).

Live Refill demo: http://tangrams.github.io/refill-style

refill-preview

Developer resources

So how do you actually use this stuff? Tangram styles are called "scenes" and are written in YAML. The scene file (e.g.: refill-style.yaml) requires a vector tile source. To use Mapzen's vector tile service you must first obtain a free developer API key and update your scene file with that key.

Sign up for a Mapzen Vector Tiles API key

Mapzen Vector Tiles are a free, shared tile service. As such, there are generous limitations on requests to prevent individual users from degrading the overall system performance.

  1. Go to https://mapzen.com/developers.
  2. Sign in with your GitHub account. If you have not done this before, you need to agree to the terms first.
  3. Create a new key for Vector Tiles, and optionally, give it a project name so you can remember the purpose of the key.
  4. Keep the web page open so you can copy the key into your source code later.

Building a Leaflet map using Tangram

Using Tangram and Mapzen's Vector tiles inside the popular Leaflet mapping framework is easy. We'll make it even easier soon to do this via a Leaflet provider, but in the meantime...

  1. Update your copy of the scene file on line 428 to reference the API key you created in Step 3 in the Sign up section above. url: //vector.mapzen.com/osm/all/{z}/{x}/{y}.topojson?api_key=vector-tiles-{your-api-key-here}
  2. Reference the index-demo.html file in any of the style repos for how to configure Leaflet with Tangram and the scene file (e.g.: Refill).
  3. Looking for a more sophisticated implementation that includes basic search? The main index.html file has a more real world example.
  4. Need help testing your map locally? See the README in each repo.
  5. Wondering where to host your map? Make a public repo on Github (or fork ours!) and enjoy their GitHub Pages to github.io magic dance.

Tangram resources

  1. Procedural Cartography with Tangram Patricio's presentation notes from JS.Geo.
  2. Walkthrough: Make a map with Tangram by Rhonda on Mapzen's documentation team.

To run locally

Want to modify the style to fit your needs? Clone or downloaded the repo locally. Then...

Start a web server in the repo's directory:

python -m SimpleHTTPServer 8000

If that doesn't work, try:

python -m http.server 8000

Then navigate to: http://localhost:8000, which loads the index.html file.

You should be all set, happy mapping! But please let us know at hello@mapzen.com or via Twitter @mapzen if you encounter any funk and we'll help you get up and running.

See also:

  • Blog post announcing this style...