Web tiled layer

View on GitHub

Sample viewer app

Display a tiled web layer.

Image of web tiled layer

Use case

Tiled map services are a set of pre-generated images (e.g. "tiles") arranged in folders for each row, column, and zoom level. As you navigate the map, map tiles are requested for the current extent. ArcGISTiledLayer and WmtsLayer are types of tiled map services used for specific data types. WebTiledLayer is useful for displaying other data sources that contain tiles arranged in a row/column/level directory structure, such as OpenStreetMap.

How to use the sample

Run the sample and a map will appear. As you navigate the map, map tiles will be fetched automatically and displayed on the map.

How it works

Create a WebTiledLayer from a URL and a list of subdomains.
Create a new Basemap from the layer.
Update the attribution on the layer with webTiledLayer.setAttribution(attributionString). Note: this is a necessary step because web tiled services don't have associated service metadata.

Relevant API

BasemapStyle
WebTiledLayer

About the data

The basemap in this sample is provided by Stamen Design. Stamen publishes tiled services based on OpenStreetMap data with several unique styles applied.

Additional information

Web tiled services use a uniform addressing scheme with pre-rendered tiles. Image tiles are accessed via a URL template string, with parameters for subdomain, level, column, and row.

Subdomain is optional and allows Runtime to balance requests among multiple servers for enhanced performance.
Level, row, and column select the tiles to load based on the visible extent of the map.

For more information about web tiled layers, see the following resources:

Sample Code

MainActivity.java
Use dark colors for code blocksCopy
/* Copyright 2017 Esri
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package com.esri.arcgisruntime.sample.webtiledlayer;

import java.util.Arrays;
import java.util.List;

import android.os.Bundle;
import androidx.appcompat.app.AppCompatActivity;

import com.esri.arcgisruntime.layers.WebTiledLayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.view.MapView;

public class MainActivity extends AppCompatActivity {

  private MapView mMapView;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    // get reference to map view
    mMapView = findViewById(R.id.mapView);

    // list of sub-domains
    List<String> subDomains = Arrays.asList("a", "b", "c", "d");

    // build the web tiled layer from stamen
    WebTiledLayer webTiledLayer = new WebTiledLayer(getString(R.string.template_uri_stamen), subDomains);
    // use web tiled layer as Basemap
    ArcGISMap map = new ArcGISMap(new Basemap(webTiledLayer));
    mMapView.setMap(map);
    // custom attributes
    webTiledLayer.setAttribution(getString(R.string.stamen_attribution));
  }

  @Override
  protected void onPause() {
    mMapView.pause();
    super.onPause();
  }

  @Override
  protected void onResume() {
    super.onResume();
    mMapView.resume();
  }

  @Override
  protected void onDestroy() {
    mMapView.dispose();
    super.onDestroy();
  }
}