Display a custom basemap style
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.
Prerequisites
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.
Steps
Create a new pen
- To get started, either complete the Display a map tutorial or .
Set the API key
To access ArcGIS services, you need an API key.
Go to your dashboard to get an API key.
In CodePen, set the
api
to your key, so it can be used to access basemap layer and location services.Key Use dark colors for code blocks Change line
Add modules
In the
require
statement, add theBasemap
,Vector
, andTile Layer Tile
modules.Layer Use dark colors for code blocks Add line. Add line. Add line. Change line Change line Change line
Create a vector tile layer
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
Vector
object and set itsTile Layer portal
Item id
property tod2ff12395aeb45998c1b154e25d680e5
and theopacity
property to0.75
.Use dark colors for code blocks Add line. Add line. Add line. Add line. Add line. Add line.
Create an image tile layer
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
Tile
and set itsLayer portal
Item id
property to1b243539f4514b6ba35e7d995890db1d
.Use dark colors for code blocks Add line. Add line. Add line. Add line. Add line.
Add the basemap layers
Basemaps can contain multiple baselayers
. Use the Basemap
class to add the vector
and image
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
Basemap
object and addvector
and theTile Layer image
to theTile Layer baselayers
array.Use dark colors for code blocks Add line. Add line. Add line. Add line. Add line. Add line. Add line. Add line. Update the
basemap
property to use thebasemap
object created earlier.Use dark colors for code blocks Change line
Update the map view
Update the
center
andzoom
properties to zoom the display to North America.Use dark colors for code blocks Change line Change line
Run the app
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.
What's next?
Learn how to use additional API features and ArcGIS services in these tutorials: