Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add new icons, shields #41

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+36,789 −1,497
Open

add new icons, shields #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
75774ba
add new icons, shields
nvkelso Dec 6, 2018
be60b74
update version; nextzen the things
nvkelso Dec 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
58 changes: 29 additions & 29 deletions api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,38 @@ Mapzen basemaps offer several global properties to customize and extend the map.

Not every basemap supports the full set of resources and the default styling of these assets is customized per Mapzen map style. See [Styles](styles.md) for what's supported.

As the basemaps are still in active development, Mapzen recommends pegging an import to a specific major version, such as `6`. See the [versioning](versioning.md) doc for more details.
As the basemaps are still in active development, Mapzen recommends pegging an import to a specific major version, such as `12`. See the [versioning](versioning.md) doc for more details.

## Mapzen API keys
## Nextzen API keys

Mapzen basemaps require setting a Mapzen API key to access related Mapzen vector tile and terrain tile services.
Mapzen basemaps require setting a Nextzen API key to access related Nextzen vector tile and terrain tile services.

[Sign up](https://mapzen.com/documentation/overview/#developer-accounts-and-api-keys) for a Mapzen API key here.

### sdk_mapzen_api_key
### sdk_api_key

* `sdk_mapzen_api_key`: defaults to `''` (an empty string)
* `sdk_api_key`: defaults to `''` (an empty string)

Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/12/refill-style.yaml

global:
sdk_mapzen_api_key: your-mapzen-api-key
sdk_api_key: your-api-key
```

Example **Tangram JS** usage:

```
var layer = Tangram.leafletLayer({
scene: {
import: 'https://mapzen.com/carto/refill-style/6/refill-style.yaml',
global: { sdk_mapzen_api_key: 'your-mapzen-api-key' }
import: 'https://www.nextzen.org/carto/refill-style/12/refill-style.yaml',
global: { sdk_api_key: 'your-api-key' }
});
```

Example [mapzen.js](https://mapzen.com/documentation/mapzen-js/get-started/) usage (all services):
Example [mapzen.js](https://www.nextzen.org/documentation/mapzen-js/get-started/) usage (all services):


```
Expand All @@ -53,7 +53,7 @@ var map = L.Mapzen.map('map', {
});
```

Example [mapzen.js](https://mapzen.com/documentation/mapzen-js/get-started/) usage (just Tangram):
Example [mapzen.js](https://www.nextzen.org/documentation/mapzen-js/get-started/) usage (just Tangram):

```
var map = L.Mapzen.map('map', {
Expand All @@ -77,9 +77,9 @@ _SceneUpdate allows globals to be chained together._

```
map->loadScene(
"https://mapzen.com/carto/refill-style/6/refill-style.yaml",
"https://www.nextzen.org/carto/refill-style/12/refill-style.yaml",
false,
{ SceneUpdate("global.sdk_mapzen_api_key", "mapzen-xxxxxx"),
{ SceneUpdate("global.sdk_api_key", "mapzen-xxxxxx"),
SceneUpdate("global.sdk_building_extrude:", "false") }
);
```
Expand All @@ -97,13 +97,13 @@ If you ask for a language that isn't present in the data, it will automatically
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/6/refill-style.yaml

global:
ux_language: fr
```

Example [mapzen.js](https://mapzen.com/documentation/mapzen-js/get-started/) usage:
Example [mapzen.js](https://www.nextzen.org/documentation/mapzen-js/get-started/) usage:

```
var map = L.Mapzen.map('map', {
Expand Down Expand Up @@ -132,7 +132,7 @@ For instance, if someone reads French but not Japanese they would prefer to see
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/6/refill-style.yaml

global:
ux_language: fr
Expand All @@ -151,7 +151,7 @@ Common language codes values include:
- `es` Spanish
- `bn` Bengali
- `de` German
- `gr` Greek
- `el` Greek
- `hi` Hindi
- `id` Indonesian
- `it` Italian
Expand All @@ -174,7 +174,7 @@ Road shield artwork can be disabled. This can be useful when showing transit ove
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/6/refill-style.yaml

global:
sdk_road_shields: false
Expand All @@ -197,20 +197,20 @@ Are the 3d buildings distracting? Turn them off.
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/6/refill-style.yaml

global:
sdk_building_extrude: false
```

## Data visualization

To facilitate map customization and data visualizations several recommended sort orders are provided. The order properties abstract the values which work with specific versions of Mapzen vector tiles (see [feature ordering](https://mapzen.com/documentation/vector-tiles/layers/#feature-ordering) docs).
To facilitate map customization and data visualizations several recommended sort orders are provided. The order properties abstract the values which work with specific versions of Mapzen vector tiles (see [feature ordering](https://www.nextzen.org/documentation/vector-tiles/layers/#feature-ordering) docs).

Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/6/refill-style.yaml

_layername:
draw:
Expand Down Expand Up @@ -289,7 +289,7 @@ All basemap styles support a transit overlay.
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/6/refill-style.yaml

global:
sdk_transit_overlay: true
Expand All @@ -304,7 +304,7 @@ Some basemap styles support a bike overlay showing cycling routes and special ic
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/walkabout-style/5/walkabout-style.yaml
import: https://www.nextzen.org/carto/walkabout-style/5/walkabout-style.yaml

global:
sdk_bike_overlay: true
Expand All @@ -325,7 +325,7 @@ Some basemap styles support a path overlay (only Walkabout).
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/walkabout-style/5/walkabout-style.yaml
import: https://www.nextzen.org/carto/walkabout-style/5/walkabout-style.yaml

global:
sdk_path_overlay: false
Expand All @@ -340,13 +340,13 @@ Some basemap styles support [bathymetry](https://en.wikipedia.org/wiki/Bathymetr
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/walkabout-style/5/walkabout-style.yaml
import: https://www.nextzen.org/carto/walkabout-style/5/walkabout-style.yaml

global:
sdk_bathymetry: true
```

Example [mapzen.js](https://mapzen.com/documentation/mapzen-js/get-started/) usage:
Example [mapzen.js](https://www.nextzen.org/documentation/mapzen-js/get-started/) usage:

```
var map = L.Mapzen.map('map', {
Expand All @@ -355,7 +355,7 @@ var map = L.Mapzen.map('map', {
tangramOptions: {
scene: {
import: L.Mapzen.BasemapStyles.WalkaboutMoreLabels,
global: {
global: {
sdk_bathymetry: true
}
}
Expand All @@ -372,7 +372,7 @@ Special `mz_*` **data sources** are available to automatically render content us
Example **Tangram YAML** examples for `mz_*` source names:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/6/refill-style.yaml

sources:
mz_default_polygon:
Expand All @@ -388,7 +388,7 @@ sources:
Example **Tangram YAML** usage:

```
import: https://mapzen.com/carto/refill-style/6/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/6/refill-style.yaml

sources:
_my_source:
Expand Down
62 changes: 31 additions & 31 deletions get-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,55 @@
# Get started with Mapzen basemaps

_You will need a free Mapzen API key to use the basemaps. Visit https://mapzen.com/developers to get yours now._
_You will need a free Mapzen API key to use the basemaps. Visit https://www.nextzen.org/developers to get yours now._

_Mapzen basemaps are written in Tangram's scene file syntax. They can be displayed in web maps using [Tangram JS](
https://mapzen.com/documentation/tangram/Javascript-API/) or [mapzen.js](https://mapzen.com/documentation/mapzen-js/) and on [iOS](https://mapzen.com/documentation/ios/) and [Android](https://mapzen.com/documentation/tangram/android-walkthrough/) using [Tangram ES](https://github.com/tangrams/tangram-es)._
https://www.nextzen.org/documentation/tangram/Javascript-API/) or [mapzen.js](https://www.nextzen.org/documentation/mapzen-js/) and on [iOS](https://www.nextzen.org/documentation/ios/) and [Android](https://www.nextzen.org/documentation/tangram/android-walkthrough/) using [Tangram ES](https://github.com/tangrams/tangram-es)._

## Add a basemap to a project

There are two convenient methods to incorporate Mapzen basemaps into your project:

### mapzen.js
### nextzen.js

[mapzen.js](https://mapzen.com/documentation/mapzen-js/) is an easy way to embed Mapzen basemaps into web pages. mapzen.js wraps Leaflet, Tangram, and Mapzen basemaps into an general toolkit.
[nextzen.js](https://www.nextzen.org/documentation/nextzen-js/) is an easy way to embed Mapzen basemaps into web pages. mapzen.js wraps Leaflet, Tangram, and Mapzen basemaps into an general toolkit.

For example:

```
L.Mapzen.apiKey = 'your-mapzen-api-key';
L.Mapzen.apiKey = 'your-api-key';

var map = L.Mapzen.map('map', {
var map = L.Nextzen.map('map', {
tangramOptions: {
scene: {
import: L.Mapzen.BasemapStyles.Refill
import: L.Nextzen.BasemapStyles.Refill
}
}
})
```

See the mapzen.js [Get Started](https://mapzen.com/documentation/mapzen-js/get-started/) guide for full examples.
See the nextzen.js [Get Started](https://www.mapzen.org/documentation/mapzen-js/get-started/) guide for full examples.

**mapzen.js basemap styles**
**nextzen.js basemap styles**

The [API reference](https://mapzen.com/documentation/mapzen-js/api-reference/#basemap-styles) lists out all named Mapzen basemap styles and is currently:
The [API reference](https://www.mapzen.com/documentation/mapzen-js/api-reference/#basemap-styles) lists out all named Mapzen basemap styles and is currently:

* **[Bubble Wrap](https://mapzen.com/products/maps/bubble-wrap)**
* **[Bubble Wrap](https://www.nextzen.org/products/maps/bubble-wrap)**
* `L.Mapzen.BasemapStyles.BubbleWrap`
* `L.Mapzen.BasemapStyles.BubbleWrapMoreLabels`
* `L.Mapzen.BasemapStyles.BubbleWrapNoLabels`
* **[Refill](https://mapzen.com/products/maps/refill/more-labels)**
* **[Refill](https://www.nextzen.org/products/maps/refill/more-labels)**
* `L.Mapzen.BasemapStyles.Refill`
* `L.Mapzen.BasemapStyles.RefillMoreLabels`
* `L.Mapzen.BasemapStyles.RefillNoLabels`
* **[Walkabout](https://mapzen.com/products/maps/walkabout/more-labels)**
* **[Walkabout](https://www.nextzen.org/products/maps/walkabout/more-labels)**
* `L.Mapzen.BasemapStyles.Walkabout`
* `L.Mapzen.BasemapStyles.WalkaboutMoreLabels`
* `L.Mapzen.BasemapStyles.WalkaboutNoLabels`
* **[Tron](https://mapzen.com/products/maps/tron/more-labels)**
* **[Tron](https://www.nextzen.org/products/maps/tron/more-labels)**
* `L.Mapzen.BasemapStyles.Tron`
* `L.Mapzen.BasemapStyles.TronMoreLabels`
* `L.Mapzen.BasemapStyles.TronNoLabels`
* **[Cinnabar](https://mapzen.com/products/maps/cinnabar/more-labels)**
* **[Cinnabar](https://www.nextzen.org/products/maps/cinnabar/more-labels)**
* `L.Mapzen.BasemapStyles.Cinnabar`
* `L.Mapzen.BasemapStyles.CinnabarMoreLabels`
* `L.Mapzen.BasemapStyles.CinnabarNoLabels`
Expand All @@ -58,53 +58,53 @@ _Note: Zinc has been retired as a standalone basemap style but is now available

### Tangram

You can also use Mapzen's GL map renderer, [Tangram](https://mapzen.com/documentation/tangram/) to add basemaps to your project.
You can also use Mapzen's GL map renderer, [Tangram](https://www.nextzen.org/documentation/tangram/) to add basemaps to your project.

Tangram's scene import syntax ([documentation](https://mapzen.com/documentation/tangram/import/)) allows one scene file to import another:
Tangram's scene import syntax ([documentation](https://www.nextzen.org/documentation/tangram/import/)) allows one scene file to import another:

```
import: https://mapzen.com/carto/refill-style/9/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/10/refill-style.yaml

global:
sdk_mapzen_api_key: your-mapzen-api-key
sdk_api_key: your-api-key
```

Scene files and related assets are available for use in Tangram and Leaflet directly via the Mapzen CDN.

**Template**

* `https://mapzen.com/carto/{stylename}/{stylefile}.{format}`
* `https://www.nextzen.org/carto/{stylename}/{stylefile}.{format}`

Where `{stylename}` and `{stylefile}` are generally the same and will likely converge in future versions.

And where `{format}` is mostly `yaml` but Tangram scene file bundles can also be specified as `zip`.

Looking to peg to a specific **version** of a style? We have you covered!

* `https://mapzen.com/carto/{stylename}/{version}/{stylefile}.{format}`
* `https://www.nextzen.org/carto/{stylename}/{version}/{stylefile}.{format}`

Where {version} is optional and can be major (eg: `1`), major + minor (`1.0`), or major + minor + patch (`1.0.0`).

**Partial listing of Refill versions:**

In this case, these all resolve to the same asset.

* `https://mapzen.com/carto/refill-style/1/refill-style.zip`
* `https://mapzen.com/carto/refill-style/1.0/refill-style.zip`
* `https://mapzen.com/carto/refill-style/1.0.0/refill-style.zip`
* `https://www.nextzen.org/carto/refill-style/1/refill-style.zip`
* `https://www.nextzen.org/carto/refill-style/1.0/refill-style.zip`
* `https://www.nextzen.org/carto/refill-style/1.0.0/refill-style.zip`

**Mapzen CDN basemap styles**

* **Bubble Wrap**
* `https://mapzen.com/carto/bubble-wrap-style/bubble-wrap.zip`
* `https://www.nextzen.org/carto/bubble-wrap-style/bubble-wrap.zip`
* **Refill**
* `https://mapzen.com/carto/refill-style/refill-style.zip`
* `https://www.nextzen.org/carto/refill-style/refill-style.zip`
* **Walkabout**
* `https://mapzen.com/carto/walkabout-style/walkabout-style.zip`
* `https://www.nextzen.org/carto/walkabout-style/walkabout-style.zip`
* **Tron**
* `https://mapzen.com/carto/tron-style/tron-style.zip`
* `https://www.nextzen.org/carto/tron-style/tron-style.zip`
* **Cinnabar**
* `https://mapzen.com/carto/cinnabar-style/cinnabar-style.zip`
* `https://www.nextzen.org/carto/cinnabar-style/cinnabar-style.zip`

## Customize basemap

Expand All @@ -113,7 +113,7 @@ Modify Mapzen basemap styles using the scene file's global properties. See [API
For example, modify the default labels in Bubble Wrap to show Kannada, an Indian language:

```
import: https://mapzen.com/carto/bubble-wrap-style/bubble-wrap.yaml
import: https://www.nextzen.org/carto/bubble-wrap-style/bubble-wrap.yaml

global:
ux_language: kn
Expand All @@ -126,7 +126,7 @@ Import Mapzen basemaps into your own Tangram project and overlay your own data.
For example:

```
import: https://mapzen.com/carto/refill-style/9/refill-style.yaml
import: https://www.nextzen.org/carto/refill-style/10/refill-style.yaml

sources:
polygons_in_polls:
Expand Down
Loading