Display a custom basemap style

Learn how to add a custom 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 styles 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.

Prerequisites

Steps

Create a custom basemap

You can create your own custom basemap with the ArcGIS Vector Tile Style Editor.

1. Go to the Vector Tile Style Editor.

2. Sign in with your ArcGIS account.

3. Click + New style.

4. In the Select a style to continue panel, click Popular > Light Gray Canvas.

5. In left-panel, click Quick Edit. Style the basemap using Colors, Font, Label Size, and Road Width. For example:

   • Colors
     • Land: #cbe8b0
     • Water: #b9dbf7
     • Roads: #f0f1f0
     • Boundaries: #ffffff
     • Buildings: #ebe7dc
     • Nature: #f0fae6

6. In the search tool of the map, enter Yosemite National Park.

7. Click on any green area to open the Admin0 forest or park layer.

8. In the map, zoom out to level 6 so that the layer disappears.

9. In the Layer Editor > Visibility panel, set the first number of the Visible Zoom Range to 3 to make the layer visible.

10. In the Layer Editor > Appearance panel, set the fill and outline color properties to change at different zoom levels using either hex codes or the color selector. For example:

    • Color > Settings icon > Set Value by Zoom level:
      • 3 #ddf0ca
      • 6 #cbe5b1
      • Click Add Stop and enter: 10 #bae291.
    • Outline Color: #bbd4a2
    • Opacity: 60%

11. In the toolbar, click Save As to save your customized basemap. Enter a Title and Tags.

Get the starter app

Select a type of authentication below and follow the steps to create a new application.

Set up authentication

Create developer credentials in your portal for the type of authentication you selected.

Set developer credentials

Use the API key or OAuth developer credentials so your application can access location services.

Display the custom basemap

You can access a basemap layer by referencing its item ID. You can find a layer's item ID by accessing it in your portal or the ArcGIS Vector Tile Style Editor.

1. Go to the item page of the custom basemap style that you previously created and find its item ID. The ID is at the end of the URL, for example 9d94a890b76a417cad8a748df4f97336

2. Change the basemapId from arcgis/outdoor to your own item ID and the basemapURL to enable your custom item.

   Expand

   Use dark colors for code blocks

   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
   73
   74
       olms.apply(map, basemapURL).then(() => {
   
         // Add Esri attribution
         // Learn more in https://esriurl.com/attribution
         const source = map.getLayers().item(0).getSource();
         source.setAttributions(["Powered by <a href='https://www.esri.com/en-us/home' target='_blank'>Esri</a> | ", source.getAttributions()]);
   
       });
   

   Expand

Run the app

Run the app.

It should display the Forest and Parks Canvas vector basemap layer.

What's next?

Learn how to use additional ArcGIS location services in these tutorials: