Customize OSM Vector Basemap styles

With ArcGIS Data Appliance: OpenStreetMap Vector Basemaps, you can modify and customize the map style. You can customize the map by changing the hex color codes of map features or labels, removing feature classes, changing fonts (face, size, and color), or making other edits. For more information, see the New ways of customizing Esri Vector Basemaps blog article on the ArcGIS Blog website.

Customization requires changes to the map style's resources\styles\root.json file. There are three main ways to create a map for customization: use the ArcGIS Vector Tile Style Editor, add a style in Map Viewer Classic and save a copy of the layer, or copy a style downloaded from My Esri or from the USB flash drive. Then you can edit the custom style map item to include a new thumbnail and update the item's information for your custom style.

ArcGIS Vector Tile Style Editor

You can customize vector map styles through an app in Map Viewer or Map Viewer Classic.

In Map Viewer, access the Vector Tile Style Editor from the app launcher , or from the Edit in Vector Tile Style Editor button on a tile layer item page.

In Map Viewer Classic, access the Vector Tile Style Editor from the Change Style button under any OSM vector basemap tile layer. Save the new style to your portal from the Editor.

Styling options include the Quick Edit tool, in which layers are customized across groups of features, and the Layer Style Editor list for individual feature style controls. Colors, line weights, font faces, and sprite symbology are examples of the style changes that can be applied to your custom map item.

Information about using the ArcGIS Vector Tile Style Editor to create a custom basemap style is available on the Esri Developer website.

Add a style to the map in Map Viewer Classic and rename the style

To add a style using Map Viewer Classic, complete the following steps:

1. In your Enterprise portal, open the style you want to customize in Map Viewer Classic, for example, OpenStreetMap.
2. Click More Options and select Copy.

   

   A new OpenStreetMap - Copy layer is added to the top of the Contents pane.

3. Click More Options and select Save Layer.

   

4. Rename the style—for example, Custom OpenStreetMap—and select the folder where you want to save the new style.
5. In My Content, go to the item page for the new style and click the Download style button.

   

   The style (root.json file) is saved to your computer.

6. Open the root.json file in a text editor such as Adobe Brackets or Notepad++, and edit and save the file.

   Edits to the root.json file can be color value, line width, font size, and so on.

7. Validate the JSON using JSONLint or a similar JSON validation tool.

   You can also use this website to parse the JSON into a more user-friendly format before editing.

8. On the item page for the new style, click the Update button to update the item and load the modified root.json file from your computer to your portal.

Copy a style downloaded from My Esri or from the USB flash drive and rename the map style directory

To copy a root.json style downloaded from My Esri or from the USB flash drive, complete the following steps:

1. On your local computer, create a directory called CustomStyles at the same directory level as the GCS and WMA directories.

   

2. Copy a style downloaded from My Esri or from the USB flash drive and rename the map style directory; for example, copy the openstreetmap directory into a new directory and change the name to customopenstreetmap.

   

3. In the new customopenstreetmap directory, open the resources\styles\root.json file (for example, CustomStyles\customopenstreetmap\resources\styles\root.json) in a text editor such as Adobe Brackets or Notepad++, edit the map code, and save the file.
   An example of a style edit in the root.json file is changing the country boundary in purple (#AC46AC) to red (#FF0000).

   

4. In the new customopenstreetmap directory, open the metadata\metadata.json file (for example, CustomStyles\customopenstreetmap\metadata\metadata.json) in a text editor such as Adobe Brackets or Notepad++; edit "title":, replacing "OpenStreetMap" with a new map title (for example, "Custom OpenStreetMap"); and save the file.

   

5. Validate the JSON using JSONLint or a similar JSON validation tool.
6. Perform the publish tile layers (map styles) steps, this time pointing to the new directory containing your custom style.

The new style is created in your Enterprise portal under My Content. Following the naming conventions in steps 1 through 4 produces a new item in your portal named Custom OpenStreetMap.

Edit the custom style map item in your portal

On the map item page of your custom map style, you can update the summary, description, tags, and thumbnail to better describe the new map you styled.

It is recommended that you apply Delete Protection to your custom style map item on the item's Settings tab.