Learn how to access and display a styled vector basemap layer in a map.
A styled basemap layer is a set of styles that you define to override one of the default Basemap layer service vector tile layer styles. These are used to create and display a map or scene with your own custom styles, labels, and colors. To create a styled basemap layer, you use the ArcGIS Vector Tile Style Editor . The editor stores your styles in ArcGIS as a layer item with an item ID .
In this tutorial, you use an item ID to access and display a styled vector tile layer (Forest and Parks Canvas ) in a map . You also add an image tile layer (World Hillshade ) to enhance the visualization. Both layers are hosted in ArcGIS Online .
You need a free ArcGIS developer account to access your dashboard and API keys . The API key must be scoped to access the services used in this tutorial.
To get started, either complete the Display a map tutorial or use this pen . To access ArcGIS services , you need an API key .
Go to your dashboard to get an API key .
In CodePen , set the apiKey to your key, so it can be used to access basemap layer and location services.
Change line
1
2
3
4
esriConfig.apiKey = "YOUR_API_KEY" ;
const map = new Map ({
basemap : "arcgis-topographic" // Basemap layer service
});
In the require statement, add the BasemapVectorTileLayerTileLayer
More info The ArcGIS API for JavaScript uses AMD modules . The require function is used to load modules so they can be used in the main function. It's important to keep the module references and function parameters in the same order.
Show more lines
Add line. Add line. Add line. Change line Change line 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
< html >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1, user-scalable=no" >
< title > ArcGIS API for JavaScript Tutorials: Add a styled basemap layer </ title >
< style >
html , body , #viewDiv {
padding : 0 ;
margin : 0 ;
height : 100% ;
width : 100% ;
}
</ style > < link rel = "stylesheet" href = "https://js.arcgis.com/4.21/esri/themes/light/main.css" >
< script src = "https://js.arcgis.com/4.21/" > </ script >
< script >
require ([
"esri/config" ,
"esri/Map" ,
"esri/views/MapView" ,
"esri/Basemap" ,
"esri/layers/VectorTileLayer" ,
"esri/layers/TileLayer" ,
], function ( esriConfig, Map , MapView, Basemap, VectorTileLayer, TileLayer ) {
esriConfig.apiKey = "YOUR_API_KEY" ;
const vectorTileLayer = new VectorTileLayer({
portalItem : {
id : "6976148c11bd497d8624206f9ee03e30" // Forest and Parks Canvas
},
opacity : .75
});
const imageTileLayer = new TileLayer({
portalItem : {
id : "1b243539f4514b6ba35e7d995890db1d" // World Hillshade
}
});
const basemap = new Basemap({
baseLayers : [
imageTileLayer,
vectorTileLayer
]
});
// const apikey = YOUR_API_KEY ;
const map = new Map ({
basemap : basemap,
});
const view = new MapView({
container : "viewDiv" ,
map : map,
center : [- 100 , 40 ],
zoom : 3
});
});
</ script >
</ head >
< body >
< div id = "viewDiv" > </ div >
</ body >
</ html >
Show more lines
You can access a basemap layer by referencing its item ID . You can find a layer's item ID by accessing it with ArcGIS 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.
In CodePen , create a new VectorTileLayerportalItemid property to d2ff12395aeb45998c1b154e25d680e5 and the opacity property to 0.75.
More info Learn more about loading a layer by its item ID in the API reference .
Show more lines
Add line. Add line. Add line. Add line. Add line. Add 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
< html >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1, user-scalable=no" >
< title > ArcGIS API for JavaScript Tutorials: Add a styled basemap layer </ title >
< style >
html , body , #viewDiv {
padding : 0 ;
margin : 0 ;
height : 100% ;
width : 100% ;
}
</ style > < link rel = "stylesheet" href = "https://js.arcgis.com/4.21/esri/themes/light/main.css" >
< script src = "https://js.arcgis.com/4.21/" > </ script >
< script >
require ([
"esri/config" ,
"esri/Map" ,
"esri/views/MapView" ,
"esri/Basemap" ,
"esri/layers/VectorTileLayer" ,
"esri/layers/TileLayer" ,
], function ( esriConfig, Map , MapView, Basemap, VectorTileLayer, TileLayer ) {
esriConfig.apiKey = "YOUR_API_KEY" ;
const vectorTileLayer = new VectorTileLayer({
portalItem : {
id : "6976148c11bd497d8624206f9ee03e30" // Forest and Parks Canvas
},
opacity : .75
});
const imageTileLayer = new TileLayer({
portalItem : {
id : "1b243539f4514b6ba35e7d995890db1d" // World Hillshade
}
});
const basemap = new Basemap({
baseLayers : [
imageTileLayer,
vectorTileLayer
]
});
// const apikey = YOUR_API_KEY ;
const map = new Map ({
basemap : basemap,
});
const view = new MapView({
container : "viewDiv" ,
map : map,
center : [- 100 , 40 ],
zoom : 3
});
});
</ script >
</ head >
< body >
< div id = "viewDiv" > </ div >
</ body >
</ html >
Show more lines
Use ArcGIS Online to find the item ID for the World Hillshade image tile layer and then use it to access the layer . The image tile layer will be used to visually enhance the styles with terrain.
Go to the World Hillshade image tile layer in ArcGIS and find its item ID. The ID is at the end of the URL.
In CodePen , create a new TileLayerportalItemid property to 1b243539f4514b6ba35e7d995890db1d.
More info Learn more about loading a layer by its item ID in the API reference .
Show more lines
Add line. Add line. Add line. Add line. Add 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
< html >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1, user-scalable=no" >
< title > ArcGIS API for JavaScript Tutorials: Add a styled basemap layer </ title >
< style >
html , body , #viewDiv {
padding : 0 ;
margin : 0 ;
height : 100% ;
width : 100% ;
}
</ style > < link rel = "stylesheet" href = "https://js.arcgis.com/4.21/esri/themes/light/main.css" >
< script src = "https://js.arcgis.com/4.21/" > </ script >
< script >
require ([
"esri/config" ,
"esri/Map" ,
"esri/views/MapView" ,
"esri/Basemap" ,
"esri/layers/VectorTileLayer" ,
"esri/layers/TileLayer" ,
], function ( esriConfig, Map , MapView, Basemap, VectorTileLayer, TileLayer ) {
esriConfig.apiKey = "YOUR_API_KEY" ;
const vectorTileLayer = new VectorTileLayer({
portalItem : {
id : "6976148c11bd497d8624206f9ee03e30" // Forest and Parks Canvas
},
opacity : .75
});
const imageTileLayer = new TileLayer({
portalItem : {
id : "1b243539f4514b6ba35e7d995890db1d" // World Hillshade
}
});
const basemap = new Basemap({
baseLayers : [
imageTileLayer,
vectorTileLayer
]
});
// const apikey = YOUR_API_KEY ;
const map = new Map ({
basemap : basemap,
});
const view = new MapView({
container : "viewDiv" ,
map : map,
center : [- 100 , 40 ],
zoom : 3
});
});
</ script >
</ head >
< body >
< div id = "viewDiv" > </ div >
</ body >
</ html >
Show more lines
Basemaps can contain multiple baselayersBasemapvectorTileLayerand imageTileLayer created above. These layers will be blended together to create the underlying style for the map. The vector tile layer provides the base colors and the image tile layer provides the hillshade or topographic effect.
In the main function, create a BasemapvectorTileLayer and the imageTileLayer to the baselayers
Show more lines
Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
< html >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1, user-scalable=no" >
< title > ArcGIS API for JavaScript Tutorials: Add a styled basemap layer </ title >
< style >
html , body , #viewDiv {
padding : 0 ;
margin : 0 ;
height : 100% ;
width : 100% ;
}
</ style > < link rel = "stylesheet" href = "https://js.arcgis.com/4.21/esri/themes/light/main.css" >
< script src = "https://js.arcgis.com/4.21/" > </ script >
< script >
require ([
"esri/config" ,
"esri/Map" ,
"esri/views/MapView" ,
"esri/Basemap" ,
"esri/layers/VectorTileLayer" ,
"esri/layers/TileLayer" ,
], function ( esriConfig, Map , MapView, Basemap, VectorTileLayer, TileLayer ) {
esriConfig.apiKey = "YOUR_API_KEY" ;
const vectorTileLayer = new VectorTileLayer({
portalItem : {
id : "6976148c11bd497d8624206f9ee03e30" // Forest and Parks Canvas
},
opacity : .75
});
const imageTileLayer = new TileLayer({
portalItem : {
id : "1b243539f4514b6ba35e7d995890db1d" // World Hillshade
}
});
const basemap = new Basemap({
baseLayers : [
imageTileLayer,
vectorTileLayer
]
});
// const apikey = YOUR_API_KEY ;
const map = new Map ({
basemap : basemap,
});
const view = new MapView({
container : "viewDiv" ,
map : map,
center : [- 100 , 40 ],
zoom : 3
});
});
</ script >
</ head >
< body >
< div id = "viewDiv" > </ div >
</ body >
</ html >
Show more lines
Update the basemapbasemap object created earlier.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
< html >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1, user-scalable=no" >
< title > ArcGIS API for JavaScript Tutorials: Add a styled basemap layer </ title >
< style >
html , body , #viewDiv {
padding : 0 ;
margin : 0 ;
height : 100% ;
width : 100% ;
}
</ style > < link rel = "stylesheet" href = "https://js.arcgis.com/4.21/esri/themes/light/main.css" >
< script src = "https://js.arcgis.com/4.21/" > </ script >
< script >
require ([
"esri/config" ,
"esri/Map" ,
"esri/views/MapView" ,
"esri/Basemap" ,
"esri/layers/VectorTileLayer" ,
"esri/layers/TileLayer" ,
], function ( esriConfig, Map , MapView, Basemap, VectorTileLayer, TileLayer ) {
esriConfig.apiKey = "YOUR_API_KEY" ;
const vectorTileLayer = new VectorTileLayer({
portalItem : {
id : "6976148c11bd497d8624206f9ee03e30" // Forest and Parks Canvas
},
opacity : .75
});
const imageTileLayer = new TileLayer({
portalItem : {
id : "1b243539f4514b6ba35e7d995890db1d" // World Hillshade
}
});
const basemap = new Basemap({
baseLayers : [
imageTileLayer,
vectorTileLayer
]
});
// const apikey = YOUR_API_KEY ;
const map = new Map ({
basemap : basemap,
});
const view = new MapView({
container : "viewDiv" ,
map : map,
center : [- 100 , 40 ],
zoom : 3
});
});
</ script >
</ head >
< body >
< div id = "viewDiv" > </ div >
</ body >
</ html >
Show more lines
Update the centerzoom
Show more lines
Change line 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
< html >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "initial-scale=1, maximum-scale=1, user-scalable=no" >
< title > ArcGIS API for JavaScript Tutorials: Add a styled basemap layer </ title >
< style >
html , body , #viewDiv {
padding : 0 ;
margin : 0 ;
height : 100% ;
width : 100% ;
}
</ style > < link rel = "stylesheet" href = "https://js.arcgis.com/4.21/esri/themes/light/main.css" >
< script src = "https://js.arcgis.com/4.21/" > </ script >
< script >
require ([
"esri/config" ,
"esri/Map" ,
"esri/views/MapView" ,
"esri/Basemap" ,
"esri/layers/VectorTileLayer" ,
"esri/layers/TileLayer" ,
], function ( esriConfig, Map , MapView, Basemap, VectorTileLayer, TileLayer ) {
esriConfig.apiKey = "YOUR_API_KEY" ;
const vectorTileLayer = new VectorTileLayer({
portalItem : {
id : "6976148c11bd497d8624206f9ee03e30" // Forest and Parks Canvas
},
opacity : .75
});
const imageTileLayer = new TileLayer({
portalItem : {
id : "1b243539f4514b6ba35e7d995890db1d" // World Hillshade
}
});
const basemap = new Basemap({
baseLayers : [
imageTileLayer,
vectorTileLayer
]
});
// const apikey = YOUR_API_KEY ;
const map = new Map ({
basemap : basemap,
});
const view = new MapView({
container : "viewDiv" ,
map : map,
center : [- 100 , 40 ],
zoom : 3
});
});
</ script >
</ head >
< body >
< div id = "viewDiv" > </ div >
</ body >
</ html >
Show more lines
In CodePen , run your code to display the map.
The map view should display the Forest and Parks Canvas vector tile layer on top of the World Hillshade image tile layer. The styled vector tile layer is displayed on top of the hillshade terrain.
Learn how to use additional API features and
ArcGIS services in these tutorials: