Add a vector tile layer

Add a published vector tile layer to an existing map.

A vector tile layer is a hosted data layer. The data is vector tile data. You can create a vector tile layer by publishing your data with data management tools.

In this tutorial, you display a parcels layer from a public vector tile service, using the default styling.

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

  1. To get started, either complete the Display a map tutorial or .

Set the API key

To access ArcGIS services, you need an API key.

  1. Go to your dashboard to get an API key.

  2. 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
    });
    

Add modules

  1. In the require statement, add the VectorTileLayer module.

    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.

    Add 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
    <html>
      <head>
        <meta charset="utf-8" />
        <meta
          name="viewport"
          content="initial-scale=1,maximum-scale=1,user-scalable=no"
        />
    <title>ArcGIS API for JavaScript: Add a vector tile layer</title>
    
        <style>
          html,
          body,
          #viewDiv {
            padding: 0;
            margin: 0;
            height: 100%;
            width: 100%;
        </style>
    
    <link rel="stylesheet" href="https://js.arcgis.com/4.19/esri/themes/light/main.css">
    <script src="https://js.arcgis.com/4.19/"></script>
    <script>
      require([
        "esri/config",
        "esri/Map",
    
        "esri/layers/VectorTileLayer",
    
        "esri/views/MapView"
    
      ], function (esriConfig,Map, VectorTileLayer, MapView) {
        const vtlLayer = new VectorTileLayer({
          url: "https://vectortileservices3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Santa_Monica_Mountains_Parcels_VTL/VectorTileServer/"
        esriConfig.apiKey = "YOUR_API_KEY";
        const map = new Map({
          basemap: "arcgis-light-gray",
          layers: [vtlLayer]
        const view = new MapView({
          container: "viewDiv",
          center: [-118.80543,34.02700],
          zoom: 13,
          map: map
    </script>
    </head>
    
    <body>
    <div id="viewDiv"></div>
    </body>
    </html>

Add the vector tile layer

  1. Create a VectorTileLayer. Set the the url property to reference the vector tile layer.

    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
    <html>
      <head>
        <meta charset="utf-8" />
        <meta
          name="viewport"
          content="initial-scale=1,maximum-scale=1,user-scalable=no"
        />
    <title>ArcGIS API for JavaScript: Add a vector tile layer</title>
    
        <style>
          html,
          body,
          #viewDiv {
            padding: 0;
            margin: 0;
            height: 100%;
            width: 100%;
        </style>
    
    <link rel="stylesheet" href="https://js.arcgis.com/4.19/esri/themes/light/main.css">
    <script src="https://js.arcgis.com/4.19/"></script>
    <script>
      require([
        "esri/config",
        "esri/Map",
        "esri/layers/VectorTileLayer",
        "esri/views/MapView"
      ], function (esriConfig,Map, VectorTileLayer, MapView) {
    
        const vtlLayer = new VectorTileLayer({
          url: "https://vectortileservices3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Santa_Monica_Mountains_Parcels_VTL/VectorTileServer/"
        });
        esriConfig.apiKey = "YOUR_API_KEY";
        const map = new Map({
          basemap: "arcgis-light-gray",
          layers: [vtlLayer]
        const view = new MapView({
          container: "viewDiv",
          center: [-118.80543,34.02700],
          zoom: 13,
          map: map
    </script>
    </head>
    
    <body>
    <div id="viewDiv"></div>
    </body>
    </html>

Update the map

  1. Update the basemap property to display a gray basemap. Set the layers to the vtlLayer element.

    Change lineAdd 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
    <html>
      <head>
        <meta charset="utf-8" />
        <meta
          name="viewport"
          content="initial-scale=1,maximum-scale=1,user-scalable=no"
        />
    <title>ArcGIS API for JavaScript: Add a vector tile layer</title>
    
        <style>
          html,
          body,
          #viewDiv {
            padding: 0;
            margin: 0;
            height: 100%;
            width: 100%;
        </style>
    
    <link rel="stylesheet" href="https://js.arcgis.com/4.19/esri/themes/light/main.css">
    <script src="https://js.arcgis.com/4.19/"></script>
    <script>
      require([
        "esri/config",
        "esri/Map",
        "esri/layers/VectorTileLayer",
        "esri/views/MapView"
      ], function (esriConfig,Map, VectorTileLayer, MapView) {
        const vtlLayer = new VectorTileLayer({
          url: "https://vectortileservices3.arcgis.com/GVgbJbqm8hXASVYi/arcgis/rest/services/Santa_Monica_Mountains_Parcels_VTL/VectorTileServer/"
        esriConfig.apiKey = "YOUR_API_KEY";
    
        const map = new Map({
    
          basemap: "arcgis-light-gray",
    
          layers: [vtlLayer]
    
        });
        const view = new MapView({
          container: "viewDiv",
          center: [-118.80543,34.02700],
          zoom: 13,
          map: map
    </script>
    </head>
    
    <body>
    <div id="viewDiv"></div>
    </body>
    </html>

Run the App

In CodePen, run your code to display the map.

You should see the vector tile layer with parcels displayed on the basemap layer.

Learn how to use additional API features and ArcGIS services in these tutorials:

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.