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.

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

Known Limitations

When adding a 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.

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
Collection<Sublayer>

A flat Collection of all the sublayers in the TileLayer including the sublayers of its sublayers.

more details
more detailsTileLayer
String

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

more details
more detailsTileLayer
Object

Indicates the layer's supported capabilities.

more details
more detailsTileLayer
String

The copyright text as defined by the 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
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 (most zoomed in) at which the layer is visible in the view.

more details
more detailsTileLayer
Number

The minimum scale (most zoomed out) 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
Number

Refresh interval of the layer in minutes.

more details
more detailsTileLayer
SpatialReference

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

more details
more detailsTileLayer
Collection<Sublayer>

A Collection of Sublayer objects.

more details
more detailsTileLayer
TileInfo

Contains information about the tiling scheme 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

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

more details
more detailstype
String

The URL of the REST endpoint of the layer.

more details
more detailsTileLayer
Number

The version of ArcGIS Server in which the map service is published.

more details
more detailsTileLayer
Boolean

Indicates if the layer is visible in the View.

more details
more detailsLayer

Property Details

allSublayersCollection<Sublayer>readonly
Since: ArcGIS API for JavaScript 4.9

A flat Collection of all the sublayers in the TileLayer including the sublayers of its sublayers. All sublayers are referenced in the order in which they are drawn in the view (bottom to top).

Example:
// finds the census tracts sublayer from a parent sublayer of the
// TileLayer containing various census sublayers
var tractsId = 5;
var tracksSublayer = layer.allSublayers.find(function(sublayer){
  return sublayer.id === tracksId;
});
attributionDataUrlStringreadonly

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

capabilitiesObjectreadonly
Since: ArcGIS API for JavaScript 4.8

Indicates the layer's supported capabilities.

Properties:
exportMap Object

Indicates options supported by the exportMap operation. Will be null if the supportsExportMap is false.

Specification:
supportsSublayersChanges Boolean

Indicates if sublayers can be added, removed, or reordered.

supportsDynamicLayers Boolean

Indicates if sublayers rendering can be modified or added using dynamic layers.

supportsSublayerVisibility Boolean

Indicates if sublayers visibility can be changed.

supportsSublayerDefinitionExpression Boolean

Indicates if sublayers definition expression can be set.

exportTiles Object

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

Specification:
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:
supportsQuery Boolean

Indicates if features in the sublayers can be queried.

supportsExportMap Boolean

Indicates if the service can generate images.

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.

The copyright text as defined by the service.

declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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.when(function(){
  view.goTo(layer.fullExtent);
});
hasAttributionDataBooleanreadonly

Indicates if the layer has attribution data.

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 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 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 (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;
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
});
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 as defined by the service.

sublayersCollection<Sublayer>readonly
Since: ArcGIS API for JavaScript 4.9

A Collection of Sublayer objects. All sublayers are referenced in the order in which they are drawn in the view (bottom to top). Sublayer properties on TileLayer are read-only, with the following exceptions:

tileInfoTileInfo

Contains information about the tiling scheme 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
Deprecated
  • since version 4.8. Will be removed at version 4.10.

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

The URL of the REST endpoint of the layer. The URL may either point to a resource on ArcGIS Enterprise 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"
});
versionNumberreadonly

The version of ArcGIS Server in which the map service is published.

Example:
// Prints the version number to the console, e.g. 10.2, 10.3, 10.41.
console.log(layer.version);

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

Returns a deep clone of a map service's sublayers as defined by the service.

more details
more detailsTileLayer

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>

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

more details
more detailsTileLayer
Sublayer

Returns the sublayer with the given layerId.

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

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

createServiceSublayers(){Collection<Sublayer>}

Returns a deep clone of a map service's sublayers as defined by the service. This is useful for scenarios when the developer is unfamiliar with the service sublayers and needs to "reset" the layer's sublayers to match those defined by the service.

Returns:
TypeDescription
Collection<Sublayer>A collection of sublayers as defined by the map service.
Example:
Layer.fromPortalItem({
  portalItem: {
    portalId: "dbb9b48477444015912061b182f196b9"
  }
}).then(function(layer){
  var serviceSublayers = layer.createServiceSublayers();
  layer.sublayers = serviceSublayers;
});
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.

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

col 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

Number to append to the tile request to prevent fetching the tile from the browser cache.

Returns:
TypeDescription
Promise<HTMLImageElement>Returns a promise that resolves to an HTMLImageElement.
findSublayerById(id){Sublayer}

Returns the sublayer with the given layerId.

Parameter:

The id of the sublayer.

Returns:
TypeDescription
SublayerReturns the sublayer at the given layer ID.
Example:
// returns the sublayer with a layerId of 0
var sublayer0 = layer.findSublayerById(0);
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

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