Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: WebTiledLayer
[ AMD Module Require | Legacy Module Require ]
require(["esri/layers/WebTiledLayer"], function(WebTiledLayer) { /* code goes here */ });
Description
(Added at v3.2)
The WebTiledLayer class 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 https://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 on the web currently. As of version 3.34, the pattern can also be specified as https://some.domain.com/${z}/${y}/${x}/.
The constructor also takes an options object. 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 options object also accepts a copyright property that can be used to define attribution information that will be displayed in the map's Attribution widget. For additional information on working with attribution please visit the official attribution in your app documentation.Samples
Search for samples that use this class.Class hierarchy
esri/layers/Layer |_esri/layers/TiledMapServiceLayer |_esri/layers/WebTiledLayer
Constructors
| Name | Summary |
|---|---|
| new WebTiledLayer(urlTemplate, options?) | Creates a new WebTiledLayer. |
Properties
| Name | Type | Summary |
|---|---|---|
| attributionDataUrl | String | The URL, when available, where the layer's attribution data is stored. |
| className | String | class attribute of the layer's node. |
| copyright | String | The attribution information for the layer. |
| credential | Credential | Provides credential information for the layer such as userid and token if the layer represents a resource that is secured with token-based authentication. |
| fullExtent | Extent | The full extent of the layer. |
| hasAttributionData | Boolean | When true, the layer has attribution data. |
| id | String | ID assigned to the layer. |
| initialExtent | Extent | The initial extent of the layer. |
| loadError | Error | Set if the layer failed to load. |
| loaded | Boolean | When the layer is loaded, the value becomes "true", and layer properties can be accessed. |
| maxScale | Number | Maximum visible scale for the layer. |
| minScale | Number | Minimum visible scale for the layer. |
| opacity | Number | Opacity or transparency of layer. |
| refreshInterval | Number | Refresh interval of the layer in minutes. |
| showAttribution | Boolean | When true, the layer's attribution is displayed on the map. |
| spatialReference | SpatialReference | The spatial reference of the layer. |
| suspended | Boolean | When true, the layer is suspended. |
| tileInfo | TileInfo | Define the tile info for the layer including lods, rows, cols, origin and spatial reference. |
| tileServers | String[] | The tile server names for the layer. |
| url | String | URL to the ArcGIS Server REST resource that represents a map service. |
| visible | Boolean | Visibility of the layer. |
| visibleAtMapScale | Boolean | When true, the layer is visible at the current map scale. |
Methods
| Name | Return type | Summary |
|---|---|---|
| attr(name, value) | Layer | Adds a new attribute or changes the value of an existing attribute on the layer's node. |
| getAttributionData() | Deferred | Asynchrously returns custom data for the layer when available. |
| getMap() | Map | Returns reference to the map control the layer is added to. |
| getNode() | HTMLElement | Returns the layer's DOM node. |
| getTileUrl(level, row, column) | String | Method to implement when extending TiledMapServiceLayer. |
| hide() | None | Sets the visibility of the layer to "false". |
| isVisibleAtScale(scale) | Boolean | Returns true if the layer is visible at the given scale. |
| refresh() | None | Reloads all the tiles in the current view. |
| resume() | None | Resumes layer drawing. |
| setExclusionAreas() | Array | Specify areas to not show tiles. |
| setMaxScale(scale) | None | Set the maximum scale for the layer. |
| setMinScale(scale) | None | Set the minimum scale for the layer. |
| setOpacity(opacity) | None | Sets the opacity of the layer. |
| setRefreshInterval(interval) | Layer | Changes the layer's refresh interval to the given value (in minutes). |
| setScaleRange(minScale, maxScale) | None | Set the scale range for the layer. |
| setVisibility(isVisible) | None | Sets the visibility of the layer. |
| show() | None | Sets the visibility of the layer to "true". |
| suspend() | None | Suspends layer drawing. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| error | {
error: < | Fires when there is a problem retrieving a layer. |
| load | {
layer: < | Fires after layer properties for the layer are successfully populated. |
| opacity-change | {
opacity: < | Fires when the layer opacity has been changed, and returns an object with the opacity value. |
| refresh-interval-change | This event is fired when the layer's refreshInterval is modified. | |
| resume | Fires when a layer resumes drawing. | |
| scale-range-change | Fires when a layer's minScale and/or maxScale is changed. | |
| scale-visibility-change | Fires when a layer's scale visibility changes. | |
| suspend | Fires when a layer suspends drawing. | |
| update | Fires any time a layer has finished loading or updating itself. | |
| update-end | {
error: < | Fires when a layer has finished updating its content. |
| update-start | Fires when a layer begins to update its content. | |
| visibility-change | {
visible: < | Fires when the layer visibility has been changed, and returns an object with a Boolean visible property containing the new visibility value of the layer. |
Constructor Details
Creates a new WebTiledLayer.
Parameters:
< |
Required | The URL template to retrieve the tiles. The URL template follows a pattern of http://some.domain.com/${Z}/${X}/${Y}/ where Z corresponds to a zoom level, and X and Y represent tile column and row, respectively. You can also use the equivalent https://some.domain.com/${level}/${col}/${row}/ pattern. |
< |
Optional | Optional parameters. See options list. |
options properties: < |
Optional | Define attribution information for the layer to be used by the Attribution widget. |
< |
Optional | Specify the full extent of the layer. If no value is specified the default value, world extent in Web Mercator, is used. |
< |
Optional | Specify the initial extent of the layer. If no value is specified the default value, world extent in Web Mercator, is used. |
< |
Optional | When true, tile resampling is enabled. Default value is false. |
< |
Optional | Number of levels beyond the last level where tiles are available. If not specified, resampling is enabled at all levels where tiles are not available. |
< |
Optional | 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. |
< |
Optional | Define the tile info for the layer including lods, rows, cols, origin and spatial reference. |
< |
Optional | Define additional tile server domains for the layer. |
Sample:
require([
"esri/layers/WebTiledLayer", ...
], function(WebTiledLayer, ... ) {
var cycleMap = new WebTiledLayer("http://${subDomain}.tile.opencyclemap.org/cycle/${level}/${col}/${row}.png", {
"copyright": "Open Cycle Map",
"id": "Open Cycle Map",
"subDomains": ["a", "b", "c"]
});
...
});
Property Details
<String
StringThe URL, when available, where the layer's attribution data is stored. (Added at v3.1)
<String
StringThe attribution information for the layer.
<Credential
CredentialProvides credential information for the layer such as userid and token if the layer represents a resource that is secured with token-based authentication. This value is available after the layer has been loaded i.e.
layer.loaded is true. (Added at v2.5)<Extent
ExtentThe full extent of the layer.
<Boolean
BooleanWhen true, the layer has attribution data. Use the getAttributionData method to retrieve this data as JSON. (Added at v3.1)
Known values:
true | falseDefault value:
false<String
StringID assigned to the layer. If not assigned, esri.Map assigns value. By default, the ID of the layer is "layer" followed by a number. The ID can be user defined only in the layer constructor.
Sample:
- Setting the layer ID in the layer constructor.
require([ "esri/layers/ArcGISDynamicMapServiceLayer", ... ], function(ArcGISDynamicMapServiceLayer, ... ) { var population = new ArcGISDynamicMapServiceLayer("http://myserver/arcgis/rest/population/MapServer/Layers", {id:"population"}); ... }); - Setting the layer ID after a layer is initialized.
population.id = "population";
- Retrieving the layer ID.
function getMapLayers() { for (var j=0, jl=map.layerIds.length; j<jl; j++) { var currentLayer = map.getLayer(map.layerIds[j]); alert("id: " + currentLayer.id); } }
<Extent
ExtentThe initial extent of the layer.
<Error
ErrorSet if the layer failed to load. (Added at v3.9)
<Boolean
BooleanWhen the layer is loaded, the value becomes "true", and layer properties can be accessed. The onLoad event is also fired.
Known values:
true | false<Number
NumberMaximum visible scale for the layer. 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. (Added at v3.1)
Default value:
0<Number
NumberMinimum visible scale for the layer. 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 visible scale. (Added at v3.1)
Default value:
0<Number
NumberOpacity or transparency of layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.
Known values:
0.0 - 1.0Default value:
1.0<Number
NumberRefresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled. (Added at v3.7)
<Boolean
BooleanWhen true, the layer's attribution is displayed on the map. (Added at v3.1)
Known values:
true | falseDefault value:
true<SpatialReference
SpatialReferenceThe spatial reference of the layer.
<Boolean
BooleanWhen true, the layer is suspended. A layer is considered to be suspended when one of the following is true:
- The layer is hidden.
- The layer is not visible at the current map scale.
- The layer is explicitly suspended by calling the
Layer.suspendmethod.
Known values:
true | false<TileInfo
TileInfoDefine the tile info for the layer including lods, rows, cols, origin and spatial reference. If not set it will assume tiles in the Web Mercator tiling scheme.
<String[]
String[]The tile server names for the layer.
<String
StringURL to the ArcGIS Server REST resource that represents a map service. To obtain the URL, use Services Directory. An example URL for the Street Map service on ArcGIS Online is:
https://server.arcgisonline.com/arcgis/rest/services/World_Imagery/MapServer. (Added at v1.2)
https://server.arcgisonline.com/arcgis/rest/services/World_Imagery/MapServer. (Added at v1.2)
<Boolean
BooleanWhen true, the layer is visible at the current map scale. (Added at v3.1)
Known values:
true | falseMethod Details
Adds a new attribute or changes the value of an existing attribute on the layer's node. Removes the attribute if the value is
null or undefined. (Added at v3.7)Return type:
LayerAsynchrously returns custom data for the layer when available. (Added at v3.1)
Return type:
DeferredReturns reference to the map control the layer is added to. Returns
null or undefined if it is not added to a map. (Added at v3.7)Return type:
MapMethod to implement when extending TiledMapServiceLayer. For more details, see Creating custom layer types. (Added at v1.3)
Return type:
StringSets the visibility of the layer to "false". The layer is not removed, but it is hidden from view.
Returns true if the layer is visible at the given scale. (Added at v3.1)
Return type:
BooleanParameters:
< |
Required | The scale at which to check if the layer is visible. |
Specify areas to not show tiles. See the exclusionAreas constructor option description for specifics as to how exclusionAreas work. (Added at v3.10)
Return type:
ArraySample:
var exclusionAreas = [{
minScale: 40000,
maxScale: 9028,
geometry: new Extent(
13871520.850500003,
3910293.086000003,
14574034.873400003,
4686306.161399998,
new SpatialReference(102100)
)
}];Set the maximum scale for the layer. (Added at v3.1)
Parameters:
< |
Required | The maximum scale at which the layer is visible. |
Set the minimum scale for the layer. (Added at v3.1)
Parameters:
< |
Required | The minimum scale at which the layer is visible. |
Sets the opacity of the layer. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency.
Parameters:
< |
Required | Value from 0 to 1, where 0 is 100% transparent and 1 has no transparency. The default value is 1. |
Sample:
layer.setOpacity(0.5);
Changes the layer's refresh interval to the given value (in minutes). Non-zero value sets up automatic layer refresh at the specified interval. Value of 0 stops auto refresh. (Added at v3.7)
Return type:
LayerParameters:
< |
Required | Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled. |
Set the scale range for the layer. If
minScale and maxScale are set to 0 then the layer will be visible at all scales. (Added at v3.1)Sets the visibility of the layer. When true, the layer is visible.
Parameters:
< |
Required | Set the visibility of the layer. |
Event Details
[ On Style Events | Connect Style Event ]
Fires when there is a problem retrieving a layer. Should be used in favor of onError. (Added at v3.5)
Event Object Properties:
< |
ArcGIS Server error message returned in a JavaScript error object. |
Fires after layer properties for the layer are successfully populated. This event must be successful before the layer can be added to the map. Should be used in favor of onLoad. (Added at v3.5)
Event Object Properties:
< |
The loaded layer. |
Fires when the layer opacity has been changed, and returns an object with the opacity value. Should be used in favor of onOpacityChange. (Added at v3.5)
Event Object Properties:
< |
Fires when the layer opacity (transparency) changes. A number property named opacity that indicates the new opacity. Values range from 0.0 to 1.0, where 0.0 is 100% transparent and 1.0 has no transparency. |
This event is fired when the layer's
refreshInterval is modified. (Added at v3.7)Fires when a layer's minScale and/or maxScale is changed. Should be used in favor of onScaleRangeChange. (Added at v3.5)
Fires when a layer's scale visibility changes. The scale visibility changes when a layer is initially visible and becomes invisible because the map scale does not intersect the layer's scale range or vice versa. Should be used in favor of onScaleVisibilityChange. (Added at v3.5)
Fires any time a layer has finished loading or updating itself.
For an ArcGISTiledMapServiceLayer,
the event fires when all required tiles have been retrieved and displayed. For an
ArcGISDynamicMapServiceLayer or
ArcGISImageServiceLayer, the event fires
when the map image has been retrieved and displayed. For a GraphicsLayer,
the event fires when all graphics have been redrawn after a pan or zoom.
Deprecated at v2.0. Use update-start and update-end instead. (Added at v3.6)
Fires when a layer has finished updating its content. It is the responsibility of the subclass to determine when this event is fired. Should be used in favor of onUpdateEnd. (Added at v3.5)
Event Object Properties:
< |
Optional argument. The error object is available when an error occurs during the update. |
Fires when a layer begins to update its content. It is the responsibility of the subclass to determine when this event is fired. Should be used in favor of onUpdateStart. (Added at v3.5)
Fires when the layer visibility has been changed, and returns an object with a Boolean visible property containing the new visibility value of the layer. Should be used in favor of onVisibilityChange. (Added at v3.5)
Event Object Properties:
< |
Fires when the layer visibility changes. A boolean property named visible indicates whether or not the layer is visible after visibility changed. |