Learn how to add a styled vector basemap layer to a map .
A basemap layer provides the visual context for a map . You can use the default basemap layer styles provided by the basemap layer service or you can create your own custom styles with the ArcGIS Vector Tile Style Editor for specific mapping applications.
In this tutorial you use OpenLayers to display a styled vector basemap layer in a map .
You need an ArcGIS account to access the developer dashboard and create an API key .
To get started, either complete the Display a map tutorial or use this pen . To access location services , you need an API key or OAuth 2.0 access token .
Go to your dashboard to get an API key. The API key must be scoped to access the services used in this tutorial.
In CodePen , update apiKey to use your key.
Change line
1
2
3
4
const apiKey = "YOUR_API_KEY" ;
const basemapId = "ArcGIS:Streets" ;
const basemapURL = "https://basemaps-api.arcgis.com/arcgis/rest/services/styles/" + basemapId + "?type=style&token=" + apiKey;
olms(map, basemapURL);
You can access a basemap layer by referencing its item ID . You can find a layer's item ID by accessing it inArcGIS Online or the ArcGIS Vector Tile Style Editor .
Go to the Forest and Parks Canvas vector tile layer in ArcGIS Online and find its item ID . The ID is at the end of the URL.
Change the basemapId from ArcGIS:Streets to your own item ID.
Show more lines
Change line
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<!DOCTYPE html >
< html >
< head >
< meta charset = "utf-8" />
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1, user-scalable=no" />
< title > OpenLayers Tutorials: Add a styled basemap layer </ title >
< style >
html ,
body ,
#map {
padding : 0 ;
margin : 0 ;
height : 100% ;
width : 100% ;
font-family : Arial, Helvetica, sans-serif;
font-size : 14px ;
color : #323232 ;
}
</ style >
< link rel = "stylesheet" href = "https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.4.3/css/ol.css" type = "text/css" />
< script src = "https://cdn.jsdelivr.net/gh/openlayers/openlayers.github.io@master/en/v6.4.3/build/ol.js" > </ script >
< script src = "https://cdn.jsdelivr.net/npm/ol-mapbox-style@6.1.4/dist/olms.js" > </ script >
</ head >
< body >
< div id = "map" > </ div >
< script >
const map = new ol.Map({ target : "map" });
map.setView(
new ol.View({
center : ol.proj.fromLonLat([- 118.805 , 34.027 ]),
zoom : 8
})
);
const apiKey = "YOUR_API_KEY" ;
const basemapId = "6976148c11bd497d8624206f9ee03e30" ; // Custom vector tile style
const basemapURL = "https://basemaps-api.arcgis.com/arcgis/rest/services/styles/" + basemapId + "?type=style&token=" + apiKey;
olms(map, basemapURL);
</ script >
</ body >
</ html >
Show more lines
If you would like to use your own vector tile layer or basemap layer style in your app, and if you have an ArcGIS account , you can use an API key or Oauth 2.0 access token to access them. Use the developer dashboard to configure your API key to support accessing Basemap layers and Private content and items . Learn more in Security and authentication .
In CodePen , run your code to display the map.
It should display the Forest and Parks Canvas vector basemap layer.
Learn how to use additional ArcGIS location services in these tutorials:
