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

The TileLayer allows you work with a cached map service exposed by the ArcGIS Server REST API and add it to a Map as a tile layer. A cached service accesses tiles from a cache instead of dynamically rendering images. Because they are cached, tiled layers render faster than MapImageLayers. To create an instance of TileLayer, you must reference the URL of the cached map service.

require(["esri/layers/TileLayer"], function(TileLayer) {
  var layer = new TileLayer({
    url: "https://services.arcgisonline.com/arcgis/rest/services/World_Terrain_Base/MapServer"
  });
  // Add layer to map
});

If the image is requested from a different domain, a CORS enabled server or a proxy is required. If CORS is enabled on the server add the 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.

To display a non-cached map service as a dynamic layer, see MapImageLayer.

Known Limitations

When adding an TileLayer to a map in a SceneView, the following limitations exist:

  • This layer needs to be published from ArcGIS Server 10.3 and later or ArcGIS Server 10.2.2 with this applied fix.
  • If viewingMode is global, then only services with ArcGIS Online/Bing Maps/Google Maps (Web Mercator) or WGS84 Geographic Coordinate System, Version 2 tiling scheme are supported.
  • If viewingMode is local, then only services with projected coordinate systems are supported.

Only Tile layers with the following tiling scheme specifications are supported:

  • 256x256 or 512x512 pixel tiles
  • Scale levels must increase or decrease by a power of two
  • At level 0 there shouldn't be more than 30 root tiles.
  • All tiled layers must have the same tiling scheme and SpatialReference.

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 TileLayer(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 URL that points to the location of the layer's attribution data.

more details
more detailsTileLayer
String

The copyright text as defined by the map service.

more details
more detailsTileLayer
String

The name of the class.

more details
more detailsAccessor
Extent

The full extent of the layer as defined by the map service.

more details
more detailsTileLayer
Boolean

Indicates if the layer has attribution data.

more details
more detailsTileLayer
String

The unique ID assigned to the layer.

more details
more detailsLayer
Boolean

Indicates whether the layer will be included in the legend.

more details
more detailsTileLayer
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 at which the layer is visible in the view.

more details
more detailsTileLayer
Number

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

more details
more detailsTileLayer
Number

The opacity of the layer.

more details
more detailsLayer
PortalItem

The portal item from which the layer is loaded.

more details
more detailsTileLayer
SpatialReference

The spatial reference of the layer as defined by the map service.

more details
more detailsTileLayer
TileInfo

The tiling scheme information for the layer.

more details
more detailsTileLayer
String[]

An array of tile servers used for changing map tiles.

more details
more detailsTileLayer
String

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

more details
more detailsTileLayer
String

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

more details
more detailsTileLayer
String

For TileLayer the type is tile.

more details
more detailsTileLayer
String

The URL of the REST endpoint of the layer.

more details
more detailsTileLayer
Boolean

Indicates if the layer is visible in the View.

more details
more detailsLayer

Property Details

attributionDataUrlStringreadonly

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

The copyright text as defined by the map service.

declaredClassStringreadonly inherited

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

fullExtentExtent

The full extent of the layer as defined by the map service.

Example:
// zooms the view to the full extent of the layer
layer.then(function(){
  view.goTo(layer.fullExtent);
});

hasAttributionDataBooleanreadonly

Indicates if the layer has attribution data.

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

legendEnabledBoolean

Indicates whether the layer will be included in the legend.

Default Value: true

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 inherited

Indicates whether the layer's resources have 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 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;

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

spatialReferenceSpatialReferencereadonly

The spatial reference of the layer as defined by the map service.

The tiling scheme information for the layer.

tileServersString[]

An array of tile servers used for changing map tiles.

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 TileLayer the type is tile.

The URL of the REST endpoint of the layer. The URL may either point to a resource on ArcGIS for Server, Portal for ArcGIS, or ArcGIS Online.

Example:
// URL points to a cached tiled map service hosted on ArcGIS Server
var layer = new TileLayer({
 url: "https://services.arcgisonline.com/arcgis/rest/services/World_Terrain_Base/MapServer"
});

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
Promise

An instance of this class is a Promise.

more details
more detailsLayer

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

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

more details
more detailsLayer
Promise<(HTMLImageElement|HTMLCanvasElement)>

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

more details
more detailsTileLayer
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsTileLayer
String

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

more details
more detailsTileLayer
Boolean

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

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

more details
more detailsLayer
Boolean

An instance of this class is a Promise.

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
Promise

An instance of this class is a Promise.

more details
more detailsLayer
Promise

An instance of this class is a Promise.

more details
more detailsLayer
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsTileLayer

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.

emit(type, event)protectedinherited

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses that inherit from Evented.

Parameters:
type String

The name of the event.

event Object

The event payload.

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.

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

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:
allowImageDataAccess Boolean
optional

Indicates if the access to pixels of the image is allowed.

Returns:
TypeDescription
Promise<( HTMLImageElement| HTMLCanvasElement)>Returns a promise that resolves to an HTMLImageElement or HTMLCanvasElement.
See also:
Example:
// Fetch a tile for the layer for a given level, row and column.
tileLayer.fetchTile(level, row, column, options) {
  // call the layer's getTileUrl() method to generate
  // the URL to a tile.
  var tileUrl = tileLayer.getTileUrl(level, row, column);
  return esriRequest(tileUrl, {
    responseType: "image",
    allowImageDataAccess: options && options.allowImageDataAccess || false
  })
  .then(function (response) {
    return response.data;
  });
}

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
TypeDescription
*Returns a new instance of this class.

getTileUrl(level, row, col){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.

col 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

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.

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

toJSON(){Object}

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

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

There were no match results from your search criteria.