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

A 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.

Each layer is rendered using styling information separate from the 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 saves space and speeds the process for creating new map styles.

Styles may contain multiple options for rendering the same type of feature. In a street layer, for example, major highways might have three symbology options. The symbology can be changed on the client without having to make a request for a new tile from the server. This enables maps to be dynamic on the client while still taking advantage of map caches.

If the vector tile service is requested from a different domain, a CORS enabled server or a proxy is required. If CORS is enabled on the server add the vector tile service domain to esriConfig.request.corsEnabledServers. Alternatively, if CORS cannot be enabled on ArcGIS Server you can set up a proxy on your web server and then add it to the proxy rules list in esriConfig using addProxyRule().

An instance of this class is also a Promise. This allows you to execute code once the promise resolves, or when the layer finishes loading its resources. See then() for additional details.

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.
  • Mapbox vector tiles are not supported.
  • VectorTileLayer printing requires ArcGIS Server 10.5.1 or later. PrintTask uses a client-side image for the VectorTileLayer 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/bf79e422e9454565ae0cbe9553cf6471/resources/styles/root.json"
});

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

Property Overview

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

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

more details
more details
Object

The current style information of the VectorTileLayer.

more details
more details
String

The name of the class.

more details
more details
Extent

The full extent of the layer.

more details
more details
String

The unique ID assigned to the layer.

more details
more details
String

Indicates how the layer should display in the LayerList widget.

more details
more details
Boolean

Indicates whether the layer's resources have loaded.

more details
more details
Error

The Error object returned if an error occurred while loading.

more details
more details
String

Represents the status of a load operation.

more details
more details
Object[]

A list of warnings which occurred while loading.

more details
more details
Number

The maximum scale at which the layer is visible in the view.

more details
more details
Number

The minimum scale at which the layer is visible in the view.

more details
more details
Number

The opacity of the layer.

more details
more details
PortalItem

The portal item from which the layer is loaded.

more details
more details
SpatialReference

The spatial reference of the layer.

more details
more details
TileInfo

The tiling scheme information for the layer.

more details
more details
String

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

more details
more details
String

Token generated by the token service using the specified userId and password.

more details
more details
String

For VectorTileLayer the type is vector-tile.

more details
more details
String | Object

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

more details
more details
Boolean

Indicates if the layer is visible in the View.

more details
more details

Property Details

attributionDataUrlStringreadonly

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

currentStyleInfoObjectreadonly

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

Properties:
serviceUrl String

The URL of a vector tile service.

styleUrl String

The URL of a style for vector tiles.

spriteUrl String

The sprite URL included in a style.

glyphsUrl String

The template URL of font sets for vector tiles. 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.

layerDefinition Object

Vector tile service information.

declaredClassStringreadonly

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

fullExtentExtent autocast

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.then(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.

listModeString

Indicates how the layer should display in the LayerList widget. The known 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, hide the children layers from the table of contents.
Default Value: show

loadedBooleanreadonly

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

Default Value: false

loadErrorErrorreadonly

The Error object returned if an error occurred while loading.

Default Value: null

loadStatusStringreadonly

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

loadWarningsObject[]readonly

A list of warnings which occurred while loading.

maxScaleNumber

The maximum scale 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.

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

minScaleNumber

The minimum scale 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.

Default Value: 0
Examples:
//The layer will not be visible when the view
//is zoomed 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;

opacityNumber

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;

portalItemPortalItem

The portal item from which the layer is loaded. If the portal item references a Feature Service or Scene Service, then you can specify a single layer to to load with the layerId property.

Examples:
// while this example uses FeatureLayer, this same pattern can be
// used for other layers that may be loaded from portalItem ids
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "caa9bd9da1f4487cb4989824053bb847"
  }  // the first layer in the service is returned
});
// set hostname when using an on-premise portal (default is Arcgis Online)
// esriConfig.portalUrl = "http://myHostName.esri.com/arcgis";

// while this example uses FeatureLayer, this same pattern can be
// used for SceneLayers
var lyr = new FeatureLayer({
  portalItem: {  // autocasts as new PortalItem()
    id: "8d26f04f31f642b6828b7023b84c2188"
  },
  // loads the third item in the given feature service
  layerId: 2
});

spatialReferenceSpatialReference autocast

The spatial reference of the layer.

The tiling scheme information for the layer.

titleString

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.

tokenStringreadonly

Token generated by the token service using the specified userId and password. The recommended approach to pass a token on a layer is to use IdentityManager.registerToken().

typeStringreadonly

For VectorTileLayer the type is vector-tile.

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

Esri provides a World Basemap vector tile service available to the public with default styling: http://basemaps.arcgis.com/arcgis/rest/services/World_Basemap/VectorTileServer

The following styles may be applied to this layer with their corresponding JSON style URLs:

StyleURL
Hybrid Reference
reference-layer
https://www.arcgis.com/sharing/rest/content/items/af6063d6906c4eb589dfe03819610660/resources/styles/root.json
Light Gray Canvas
reference-layer
https://www.arcgis.com/sharing/rest/content/items/5dd75c1a544b46c3af01ba5736bfdfa0/resources/styles/root.json
Dark Gray Canvas
reference-layer
https://www.arcgis.com/sharing/rest/content/items/5ad3948260a147a993ef4865e3fad476/resources/styles/root.json
World Navigation
reference-layer
https://www.arcgis.com/sharing/rest/content/items/e19e9330bf08490ca8353d76b5e2e658/resources/styles/root.json
World Streets
reference-layer
https://www.arcgis.com/sharing/rest/content/items/a60a37a27cc140ddad15f919cd5a69f2/resources/styles/root.json
World Streets (Night)
reference-layer
https://www.arcgis.com/sharing/rest/content/items/92c551c9f07b4147846aae273e822714/resources/styles/root.json
World Streets (with relief)
reference-layer
https://www.arcgis.com/sharing/rest/content/items/78c0a9ab4fbf4198a8b951848aab19d8/resources/styles/root.json
World Terrain (with labels)
reference-layer
https://www.arcgis.com/sharing/rest/content/items/20bdc57ffc484f7d96b3913b180757a9/resources/styles/root.json
World Topographic
reference-layer
https://www.arcgis.com/sharing/rest/content/items/86d5ed4b6dc741de9dad5f0fbe09ae95/resources/styles/root.json

For documentation and examples of using objects to define the style of the layer, see the Mapbox style documentation.

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

visibleBoolean

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 TypeSummary
Promise

An instance of this class is a Promise.

more details
more details

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

more details
more details
Promise

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

more details
more details
Boolean

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

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Boolean

An instance of this class is a Promise.

more details
more details
Promise

Loads the resources referenced by this class.

more details
more details
Promise

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

more details
more details
Object

Registers an event handler on the instance.

more details
more details
Promise

An instance of this class is a Promise.

more details
more details
Promise

An instance of this class is a Promise.

more details
more details

Method Details

always(callbackOrErrback){Promise}inherited

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

cancelLoad()inherited

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

fetchAttributionData(){Promise}inherited

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

Returns:
TypeDescription
PromiseResolves to an object containing custom attribution data for the layer.

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

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}inherited

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been resolved.

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.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.

loadStyle(style){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.

Parameter:
style String | Object

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

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. See the Events summary table for a list of listened events.

Parameters:
type String

The name of event 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.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

otherwise(errback){Promise}inherited

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

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

then(callback, errback, progback){Promise}inherited

An instance of this class is a Promise. Therefore then() 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 promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

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.then(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

NameTypeSummary
{view: View,layerView: LayerView}

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

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

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

more details
more details

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-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

There were no match results from your search criteria.