VectorTileLayer - update style layers

Explore in the sandboxView live

This sample shows how to add a VectorTileLayer from a JSON style object by setting the layer's style property. Esri's mid-century vector tile style is simplified and the VectorTileLayer is added from the modified JSON object. Esri also offers a set of vector basemaps with different styles.

It also demonstrates how to change the layout and paint properties for specified style-layers in the VectorTileLayer's currentStyleInfo.style in 2D MapView at runtime without having to reload the entire VectorTileLayer. This can be done by using the setStyleLayer() and setPaintProperties() methods.

The ArcGIS Vector Tile Style Editor is used to design custom vector basemaps and it takes advantage of the methods mentioned above.

                                                                                                                                                                                                                            
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta name="viewport" content="initial-scale=1,maximum-scale=1,user-scalable=no" />
    <title>VectorTileLayer - update style layers | Sample | ArcGIS API for JavaScript 4.20</title>
    <style>
      html,
      body,
      #viewDiv {
        padding: 0;
        margin: 0;
        height: 100%;
        width: 100%;
      #topbar {
        padding: 10px;
      .action-button {
        font-size: 14px;
        height: 32px;
        margin-top: 10px;
        border: 1px solid #0079c1;
        color: #0079c1;
      .action-button:hover {
        background: #0079c1;
        color: #e4e4e4;
    </style>
    <link rel="stylesheet" href="https://js.arcgis.com/4.20/esri/themes/light/main.css" />
    <script src="https://js.arcgis.com/4.20/"></script>

    <script>
      require([
        "esri/Map",
        "esri/views/MapView",
        "esri/layers/VectorTileLayer"
      ], (Map, MapView, VectorTileLayer) => {
        const map = new Map();
        const view = new MapView({
          container: "viewDiv",
          map: map,
          center: [38.5795, 39.8282],
          zoom: 2
        // change the font case for the countries(Admin0 point/large) labels layer
        document.getElementById("layoutButton").addEventListener("click", () => {
          // get the layout properties for the Admin0 point/large layer
          const styleLayer = vtLayer.getStyleLayer("Admin0 point/large");

          // change the text-transform layout property
          styleLayer.layout["text-transform"] = styleLayer.layout["text-transform"] == "uppercase" ? "none" : "uppercase";
          vtLayer.setStyleLayer(styleLayer);
        });

        // change the fill-color for the water(Marine area/1) layer
        document.getElementById("paintButton").addEventListener("click", () => {
          // get the paint properties for the marine area/1 layer
          const paintProperties = vtLayer.getPaintProperties("Marine area/1");

          // change the fill-color paint property for the layer.
          paintProperties["fill-color"] = paintProperties["fill-color"] == "#93CFC7" ? "#0759C1" : "#93CFC7";
          vtLayer.setPaintProperties("Marine area/1", paintProperties);
        });
        // load a new vector tile layer from JSON object
        const vtLayer = new VectorTileLayer({
          style: {
            layers: [
                layout: {},
                paint: {
                  "fill-color": "#F0ECDB"
                source: "esri",
                minzoom: 0,
                "source-layer": "Land",
                type: "fill",
                id: "Land/0"
                layout: {},
                paint: {
                  "fill-pattern": "Landpattern",
                  "fill-opacity": 0.25
                source: "esri",
                minzoom: 0,
                "source-layer": "Land",
                type: "fill",
                id: "Land/1"
                layout: {},
                paint: {
                  "fill-color": "#93CFC7"
                source: "esri",
                minzoom: 0,
                "source-layer": "Marine area",
                type: "fill",
                id: "Marine area/1"
                layout: {},
                paint: {
                  "fill-pattern": "Marine area",
                  "fill-opacity": 0.08
                source: "esri",
                "source-layer": "Marine area",
                type: "fill",
                id: "Marine area/2"
                layout: {
                  "line-cap": "round",
                  "line-join": "round"
                paint: {
                  "line-color": "#cccccc",
                  "line-dasharray": [7, 5.33333],
                  "line-width": 1
                source: "esri",
                minzoom: 1,
                "source-layer": "Boundary line",
                type: "line",
                id: "Boundary line/Admin0/0"
                layout: {
                  "text-font": ["Risque Regular"],
                  "text-anchor": "center",
                  "text-field": "{_name_global}"
                paint: {
                  "text-halo-blur": 1,
                  "text-color": "#AF420A",
                  "text-halo-width": 1,
                  "text-halo-color": "#f0efec"
                source: "esri",
                "source-layer": "Continent",
                type: "symbol",
                id: "Continent"
                layout: {
                  "text-font": ["Atomic Age Regular"],
                  "text-field": "{_name}",
                  "text-transform": "none"
                paint: {
                  "text-halo-blur": 1,
                  "text-color": "#AF420A",
                  "text-halo-width": 1,
                  "text-halo-color": "#f0efec"
                source: "esri",
                minzoom: 2,
                "source-layer": "Admin0 point",
                maxzoom: 10,
                type: "symbol",
                id: "Admin0 point/large"
            glyphs:
              "https://basemaps.arcgis.com/arcgis/rest/services/World_Basemap_v2/VectorTileServer/resources/fonts/{fontstack}/{range}.pbf",
            version: 8,
            sprite:
              "https://www.arcgis.com/sharing/rest/content/items/7675d44bb1e4428aa2c30a9b68f97822/resources/sprites/sprite",
            sources: {
              esri: {
                url:
                  "https://basemaps.arcgis.com/arcgis/rest/services/World_Basemap_v2/VectorTileServer",
                type: "vector"
        view.ui.add("topbar", "top-right");
    </script>
  </head>

  <body>
    <div id="viewDiv">
      <div id="topbar" class="esri-widget">
        <button
          class="action-button"
          id="layoutButton"
          type="button"
          title="Change font case for countries"
        >
          Change font case
        </button>
        <button
          class="action-button"
          id="paintButton"
          type="button"
          title="Change water fill color"
        >
          Change water color
        </button>
      </div>
    </div>
  </body>
</html>

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