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

WebTileLayer provides a simple way to add non-ArcGIS Server map tiles as a layer to a map. The constructor takes a URL template that usually follows a pattern of http://some.domain.com/{level}/{col}/{row}/ where level corresponds to a zoom level, and column and row represent tile column and row, respectively. This pattern is not required, but is the most common one currently on the web.

The subDomains property can be used to specify subDomains where tiles are served to speed up tile retrieval (using subDomains gets around the browser limit of the max number of concurrent requests to a domain). If subDomains are specified, the urlTemplate should include a {subDomain} place holder. The copyright property can be used to define attribution information that will be displayed in the map's Attribution widget.

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

Esri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content. For detailed guidelines on working with attribution, please visit the official attribution in your app documentation. For information on terms of use, see the Terms of Use FAQ.

See also:

Constructors

new WebTileLayer(properties)
Parameter:
properties Object
optional

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

Property Overview

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

The attribution information for the layer.

more details
more detailsWebTileLayer
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 instance has loaded.

more details
more detailsWebTileLayer
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 detailsWebTileLayer
Number

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

more details
more detailsWebTileLayer
Number

The opacity of the layer.

more details
more detailsLayer
Number

Refresh interval of the layer in minutes.

more details
more detailsWebTileLayer
SpatialReference

The spatial reference of the layer.

more details
more detailsWebTileLayer
String[]

A string of subDomain names where tiles are served to speed up tile retrieval.

more details
more detailsWebTileLayer
TileInfo

The tiling scheme information for the layer.

more details
more detailsWebTileLayer
String[]

The list of tile server urls for the layer.

more details
more detailsWebTileLayer
String

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

more details
more detailsLayer
String

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

more details
more detailsLayer
String

For WebTileLayer the type is web-tile.

more details
more detailstype
String

URL template for the hosted tiles.

more details
more detailsWebTileLayer
Boolean

Indicates if the layer is visible in the View.

more details
more detailsLayer

Property Details

The attribution information for the layer.

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

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, hide the children layers from the table of contents.
Default Value:show
loadedBooleanreadonly

Indicates whether the layer instance has loaded. When true, all the properties of the object can be accessed.

Default Value:false
loadErrorErrorreadonly inherited

The Error object returned if an error occurred while loading.

Default Value:null
loadStatusStringreadonly 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
loadWarningsObject[]readonly inherited

A list of warnings which occurred while loading.

maxScaleNumber

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

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;
refreshIntervalNumber
Since: ArcGIS API for JavaScript 4.6

Refresh interval of the layer in minutes. Minimum refresh interval is 0.1 minute (6 seconds). Value of 0 indicates no refresh.

Default Value:0
Example:
// the layer will be refreshed every 6 seconds.
layer.refreshInterval = 0.1;
spatialReferenceSpatialReferencereadonly

The spatial reference of the layer.

Default Value:Web Mercator Auxiliary Sphere (wkid: 3857)
subDomainsString[]

A string of subDomain names where tiles are served to speed up tile retrieval. If subDomains are specified, the urlTemplate should include a {subDomain} place holder.

See also:
Example:
new WebTileLayer({
  urlTemplate: 'https://stamen-tiles-{subDomain}.a.ssl.fastly.net/terrain/{level}/{col}/{row}.png',
  subDomains: ['a', 'b', 'c', 'd']
});

The tiling scheme information for the layer.

tileServersString[]readonly

The list of tile server urls for the layer. It's computed from the urlTemplate and the list of subDomains

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

typeStringreadonly inherited

The layer type provides a convenient way to check the type of the layer without the need to import specific layer modules.

Possible values: base-dynamic | base-elevation | base-tile | bing-maps | elevation | feature | graphics | group | imagery | integrated-mesh | map-image | open-street-map | point-cloud | scene | stream | tile | unknown | unsupported | vector-tile | web-tile

typeStringinner,readonly

For WebTileLayer the type is web-tile.

urlTemplateString

URL template for the hosted tiles. The urlTemplate should contain a {subDomain} place holder if subDomains are specified.

See also:
Example:
new WebTileLayer({
  urlTemplate: 'https://stamen-tiles-{subDomain}.a.ssl.fastly.net/terrain/{level}/{col}/{row}.png',
  subDomains: ['a', 'b', 'c', 'd']
});

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

Emits an event on the instance.

more details
more detailsLayer
Promise<HTMLImageElement>

This method fetches a tile for the given level, row and column present in the view.

more details
more detailsWebTileLayer
String

This method returns a URL to a tile for a given level, row and column.

more details
more detailsWebTileLayer
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
Object

Registers an event handler on the instance.

more details
more detailsLayer

Fetches all the data for the layer.

more details
more detailsWebTileLayer
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.

emit(type, event)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

The event payload.

fetchTile(level, row, column, options){Promise<HTMLImageElement>}

This method fetches a tile for the given level, row and column present in the view.

Parameters:
level Number

Level of detail of the tile to fetch. This value is provided by LayerView.

row Number

The row(y) position of the tile fetch. This value is provided by LayerView.

column Number

The column(x) position of the tile to fetch. This value is provided by LayerView.

options Object
optional

Optional settings for the tile request. The options have the following properties.

Specification:
timestamp Boolean
optional

A timestamp to append to the tile url to avoid loading a cached version of the tile.

Returns:
TypeDescription
Promise<HTMLImageElement>Returns a promise that resolves to an HTMLImageElement.
getTileUrl(level, row, column){String}

This method returns a URL to a tile for a given level, row and column.

Parameters:
level Number

The requested tile's level.

row Number

The requested tile's row.

column Number

The requested tile's column.

Returns:
TypeDescription
StringReturns the tile URL.
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.

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.
on(type, listener){Object}inherited

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

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);
});
refresh()
Since: ArcGIS API for JavaScript 4.6

Fetches all the data for the layer.

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