Skip To ContentArcGIS for DevelopersSign In Dashboard

VectorTileLayer

require(["esri/layers/VectorTileLayer"], function(VectorTileLayer) { /* code goes here */ });
Class: esri/layers/VectorTileLayer
Inheritance: VectorTileLayer Layer Accessor
Since: ArcGIS API for JavaScript 4.0

VectorTileLayer accesses cached tiles of data and renders it in vector format. It is similar to a WebTileLayer in the context of caching; however, a WebTileLayer renders as a series of images, not vector data. Unlike raster tiles, they can adapt to the resolution of their display device and can be restyled for multiple uses. VectorTileLayer delivers styled maps while taking advantage of cached raster map tiles with vector map data.

How the VectorTileLayer displays is defined by the Mapbox Style Specification. VectorTileLayer style information is stored separately from its tiles. This means that one set of vector tiles may be styled numerous ways without having to generate a new image cache for each style. This helps saves space and speeds up the process for creating new map styles.

The ArcGIS Vector Tile Style Editor is used to design custom vector basemaps. Please refer to Design custom basemaps with the new ArcGIS Vector Tile Style Editor to learn more about designing custom vector basemaps using the ArcGIS Vector Tile Style Editor.

If the vector tile service is requested from a different domain, a CORS enabled server or a proxy is required.

Known Limitations

  • Vector tile layers have the best performance on machines with newer hardware.
  • In some cases, labels along vector tile boundaries may collide with labels from the neighboring tile.
  • VectorTileLayer printing requires ArcGIS Server 10.5.1 or later.
  • For printing secure VectorTileLayers with ArcGIS Server 10.5.1 or 10.6.0, the PrintTask will create a client-side image for the VectorTileLayer to use in the printout. This has some limitations related to large size printing quality and a dependency on browser window height/width ratio.
See also:

Constructors

new VectorTileLayer(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:
// Typical usage
var vtlLayer = new VectorTileLayer({
  // URL to the style of vector tiles
  url: "https://www.arcgis.com/sharing/rest/content/items/4cf7e1fb9f254dcda9c8fbadb15cf0f8/resources/styles/root.json"
});

var vtlLayer = new VectorTileLayer({
  // URL to the vector tile service
  url: "https://basemaps.arcgis.com/arcgis/rest/services/World_Basemap_v2/VectorTileServer"
});

var vtlLayer = new VectorTileLayer({
  // from style object
  style: {
    "version": 8,
    "sources": {
      "esri": {
        "type": "vector",
        "url": "https://VectorTileServiceURL"
      }
    },
    "layers": [
    ...
    ]
  }
});

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The URL that points to the location of the layer's attribution data.

more details
more detailsVectorTileLayer
Object

Indicates the layer's supported capabilities.

more details
more detailsVectorTileLayer
Object

The current style information of the VectorTileLayer.

more details
more detailsVectorTileLayer
String

The name of the class.

more details
more detailsAccessor
Extent

The full extent of the layer.

more details
more detailsLayer
String

The unique ID assigned to the layer.

more details
more detailsLayer
String

Indicates how the layer should display in the LayerList widget.

more details
more detailsLayer
Boolean

Indicates whether the layer's resources have loaded.

more details
more detailsLayer
Error

The Error object returned if an error occurred while loading.

more details
more detailsLayer
String

Represents the status of a load operation.

more details
more detailsLayer
Object[]

A list of warnings which occurred while loading.

more details
more detailsLayer
Number

The maximum scale (most zoomed in) at which the layer is visible in the view.

more details
more detailsVectorTileLayer
Number

The minimum scale (most zoomed out) at which the layer is visible in the view.

more details
more detailsVectorTileLayer
Number

The opacity of the layer.

more details
more detailsLayer
PortalItem

The portal item from which the layer is loaded.

more details
more detailsVectorTileLayer
SpatialReference

The spatial reference of the layer.

more details
more detailsVectorTileLayer
Object

A style JSON object of vector tiles that will be used to render the layer.

more details
more detailsVectorTileLayer
TileInfo

The tiling scheme information for the layer.

more details
more detailsVectorTileLayer
String

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

more details
more detailsVectorTileLayer
String

For VectorTileLayer the type is vector-tile.

more details
more detailsVectorTileLayer
String

The URL to the vector tile service, or the URL to the style resource of vector tiles that will be used to render the layer.

more details
more detailsVectorTileLayer
Boolean

Indicates if the layer is visible in the View.

more details
more detailsLayer

Property Details

attributionDataUrl Stringreadonly

The URL that points to the location of the layer's attribution data.

capabilities Objectreadonly
Since: ArcGIS API for JavaScript 4.8

Indicates the layer's supported capabilities.

Properties:
exportTiles Object

Indicates options supported by the exportTiles operation. Will be null if the supportsExportTiles is false.

exportMap.maxExportTilesCount Number

Specifies the maximum number of tiles that can be exported to a cache dataset or a tile package.

operations Object

Indicates operations that can be performed on the service.

Specification:
supportsExportTiles Boolean

Indicates if the tiles from the service can be exported.

supportsTileMap Boolean

Indicates if the service exposes a tile map that describes the presence of tiles.

currentStyleInfo Objectreadonly

The current style information of the VectorTileLayer. See the object specification below.

Properties:
serviceUrl String

Absolute URL for a vector tile service.

styleUrl String

Absolute URL for vector tile service style.

spriteUrl String

Absolute URL for sprites included in a style.

glyphsUrl String

Absolute template URL for font sets included in a style. The URL includes {fontstack} and {range} tokens.

style Object

Style JSON object for vector tiles. Style object includes version of the style specification, sprite and glyphs properties. It adheres to version 8 of the Mapbox GL style specification.

layerDefinition Object

Vector tile service information.

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the view to match a layer's extent so that its features appear to fill the view. See the sample snippet below.

Example:
// Once the layer loads, set the view's extent to the layer's fullextent
layer.when(function(){
  view.extent = layer.fullExtent;
});

The unique ID assigned to the layer. If not set by the developer, it is automatically generated when the layer is loaded.

listMode String inherited

Indicates how the layer should display in the LayerList widget. The possible values are listed below.

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
hide-childrenIf the layer is a GroupLayer, BuildingSceneLayer, KMLLayer, MapImageLayer, TileLayer or WMSLayer, hide the children layers from the table of contents.
Default Value:show
loaded Booleanreadonly inherited

Indicates whether the layer's resources have loaded. When true, all the properties of the object can be accessed.

Default Value:false
loadError Errorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value:null
loadStatus Stringreadonly inherited

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.
Default Value:not-loaded
loadWarnings Object[]readonly inherited

A list of warnings which occurred while loading.

maxScale Number

The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

Default Value:0
Examples:
// The layer will not be visible when the view is zoomed in beyond a scale of 1:1,000
layer.maxScale = 1000;
// The layer's visibility is not restricted to a maximum scale.
layer.maxScale = 0;
minScale Number

The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

Default Value:0
Examples:
// The layer will not be visible when the view is zoomed out beyond a scale of 1:3,000,000
layer.minScale = 3000000;
// The layer's visibility is not restricted to a minimum scale.
layer.minScale = 0;

The opacity of the layer. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.

Default Value:1
Example:
// Makes the layer 50% transparent
layer.opacity = 0.5;
portalItem PortalItem

The portal item from which the layer is loaded. This will load the layer from the portal item, not the vector tile service.

Example:
var layer = new VectorTileLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "4cf7e1fb9f254dcda9c8fbadb15cf0f8"
  }
});
spatialReference SpatialReferenceautocast

The spatial reference of the layer.

style Object
Since: ArcGIS API for JavaScript 4.6

A style JSON object of vector tiles that will be used to render the layer. If initializing the layer with a style JSON object, the tiles are fetched from the tile servers specified in the style object.

Example:
var vtlLayer = new VectorTileLayer({
  // from style object
  style: {
    "version": 8,
    "sources": {
      "esri": {
        "type": "vector",
        "url": "https://VectorTileServiceURL"
      }
    },
    "layers": [
    ...
    ]
  }
});

The tiling scheme information for the layer.

title String

The title of the layer used to identify it in places such as the Legend and LayerList widgets.

When loading a layer by service url, the title is derived from the service name. If the service has several layers, then the title of each layer will be the concatenation of the service name and the layer name. When the layer is loaded from a portal item, the title of the portal item will be used instead. Finally, if a layer is loaded as part of a webmap or a webscene, then the title of the layer as stored in the webmap/webscene will be used.

type Stringreadonly

For VectorTileLayer the type is vector-tile.

url String

The URL to the vector tile service, or the URL to the style resource of vector tiles that will be used to render the layer. If specifying a URL to a style, the tiles are fetched from the tile servers specified in the style object.

Examples:
// URL to the vector tile service
var layer = new VectorTileLayer({
  url: "https://basemaps.arcgis.com/arcgis/rest/services/World_Basemap_v2/VectorTileServer"
});
// URL to the style of vector tiles
var layer = new VectorTileLayer({
  url: "http://esri.maps.arcgis.com/sharing/rest/content/items/7dc6cea0b1764a1f9af2e679f642f0f5/resources/styles/root.json"
});

Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is referenced in a view, but its features will not be visible in the view.

Default Value:true
Example:
// The layer is no longer visible in the view
layer.visible = false;

Method Overview

NameReturn TypeSummaryClass

Cancels a load() operation if it is already in progress.

more details
more detailsLayer

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

more details
more detailsLayer
Boolean

Emits an event on the instance.

more details
more detailsLayer
Promise<Object>

Fetches custom attribution data for the layer when it becomes available.

more details
more detailsLayer
Object

Returns an instance of layout properties for the specified style-layer.

more details
more detailsVectorTileLayer
Object

Returns an instance of paint properties for the specified style-layer.

more details
more detailsVectorTileLayer
String

Returns the id of the style-layer based on its index.

more details
more detailsVectorTileLayer
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsLayer
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more details
more detailsLayer
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

more details
more detailsLayer
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

more details
more detailsLayer
Promise

Loads the resources referenced by this class.

more details
more detailsLayer
Promise

Loads a style to render a layer from the specified URL to a style resource or style JSON object.

more details
more detailsVectorTileLayer
Object

Registers an event handler on the instance.

more details
more detailsLayer

Assigns new layout properties to the specified style-layer.

more details
more detailsVectorTileLayer

Assigns new paint properties to the specified style-layer.

more details
more detailsVectorTileLayer
Promise

when() may be leveraged once an instance of the class is created.

more details
more detailsLayer

Method Details

cancelLoad()inherited

Cancels a load() operation if it is already in progress.

createLayerView(view, options)inherited

Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it. This method is used internally and there is no use case for invoking it directly.

Parameters:
view *

The parent view.

options Object
optional

An object specifying additional options. See the object specification table below for the required properties of this object.

Specification:
optional

A signal to abort the creation of the layerview.

emit(type, event){Boolean}inherited
Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
TypeDescription
Booleantrue if a listener was notified
fetchAttributionData(){Promise<Object>}inherited

Fetches custom attribution data for the layer when it becomes available.

Returns:
TypeDescription
Promise<Object>Resolves to an object containing custom attribution data for the layer.
getLayoutProperties(layer){Object}
Since: ArcGIS API for JavaScript 4.10

Returns an instance of layout properties for the specified style-layer.

Parameter:
layer String

The style-layer id in the VectorTileLayer's currentStyleInfo.style.

Returns:
TypeDescription
ObjectLayout JSON object for the specified style layer.
getPaintProperties(layer){Object}
Since: ArcGIS API for JavaScript 4.10

Returns an instance of paint properties for the specified style-layer.

Parameter:
layer String

The style-layer id in the VectorTileLayer's currentStyleInfo.style.

Returns:
TypeDescription
ObjectPaint JSON object of the style-layer.
getStyleLayerId(index){String}
Since: ArcGIS API for JavaScript 4.10

Returns the id of the style-layer based on its index.

Parameter:
index Number

Index of the style-layer in the VectorTileLayer's currentStyleInfo.style.

Returns:
TypeDescription
StringThe style-layer id.
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
TypeDescription
BooleanReturns true if the class supports the input event.
isFulfilled(){Boolean}inherited

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
TypeDescription
BooleanIndicates whether creating an instance of the class has been resolved.
load(signal){Promise}inherited

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameter:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.
loadStyle(style, options){Promise}

Loads a style to render a layer from the specified URL to a style resource or style JSON object. It is equivalent of changing the entire CSS style sheet for web page. When loading a style, it is the developer's responsibility to make sure that any relative urls in the style resolve correctly.

Parameters:

The URL to a style of vector tiles or style JSON object.

options Object
optional

An object with the following properties.

Specification:
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
TypeDescription
PromiseReturns a promise that resolves when the style is loaded and applied to the layer.
on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event(s).
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
setLayoutProperties(layer, layout)
Since: ArcGIS API for JavaScript 4.10

Assigns new layout properties to the specified style-layer.

Known Limitations

This method is only supported in 2D MapView.

Parameters:
layer String

The style-layer id in the VectorTileLayer's currentStyleInfo.style.

layout Object

An instance of layout properties to assign to the style-layer.

Example:
// get the layout properties for the "Admin0 point/large" layer
const layoutProperties = vtLayer.getLayoutProperties("Admin0 point/large");

// change the text-transform layout property for the layer
layoutProperties["text-transform"] = "uppercase";
vtLayer.setLayoutProperties("Admin0 point/large", layoutProperties);
setPaintProperties(layer, painter)
Since: ArcGIS API for JavaScript 4.10

Assigns new paint properties to the specified style-layer.

Known Limitations

This method is only supported in 2D MapView.

Parameters:
layer String

The style-layer id in the VectorTileLayer's currentStyleInfo.style.

painter Object

An instance of paint properties to assign to the specified style-layer.

Example:
// 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"] = "#93CFC7";
vtLayer.setPaintProperties("Marine area/1", paintProperties);
when(callback, errback){Promise}inherited
Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Event Overview

NameTypeSummaryClass
{view: View,layerView: LayerView}

Fires after the layer's LayerView is created and rendered in a view.

more details
more detailsLayer
{view: View,error: Error}

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

more details
more detailsLayer
{view: View,layerView: LayerView}

Fires after the layer's LayerView is destroyed and no longer renders in a view.

more details
more detailsLayer

Event Details

layerview-createinherited

Fires after the layer's LayerView is created and rendered in a view.

Properties:
view View

The view in which the layerView was created.

layerView LayerView

The LayerView rendered in the view representing the layer in layer.

See also:
Example:
// This function will fire each time a layer view is created for this
// particular view.
layer.on("layerview-create", function(event){
  // The LayerView for the layer that emitted this event
  event.layerView;
});
layerview-create-errorinherited

Fires when an error emits during the creation of a LayerView after a layer has been added to the map.

Properties:
view View

The view that failed to create a layerview for the layer emitting this event.

error Error

An error object describing why the layer view failed to create.

See also:
Example:
// This function fires when an error occurs during the creation of the layer's layerview
layer.on("layerview-create-error", function(event) {
  console.error("LayerView failed to create for layer with the id: ", layer.id, " in this view: ", event.view);
});
layerview-destroyinherited

Fires after the layer's LayerView is destroyed and no longer renders in a view.

Properties:
view View

The view in which the layerView was destroyed.

layerView LayerView

The destroyed LayerView representing the layer.

API Reference search results

NameTypeModule
Loading...