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

  1. Create a WebTiledLayer from a URL and a list of subdomains.
  2. Create a new Basemap from the layer.
  3. 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

  • Basemap
  • 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 ArcGIS 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:

Tags

layer, OGC, Open Street Map, OpenStreetMap, stamen.com, tiled, tiles

Sample Code

WebTiledLayerSample.java
                                                                                                             
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
/*
 * Copyright 2018 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.samples.web_tiled_layer;

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

import javafx.application.Application;
import javafx.scene.Scene;
import javafx.scene.control.Alert;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;

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 WebTiledLayerSample extends Application {

  private MapView mapView;
  private WebTiledLayer webTiledLayer;

  @Override
  public void start(Stage stage) {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);

      // set title, size, and add scene to stage
      stage.setTitle("Web Tiled Layer Sample");
      stage.setWidth(800);
      stage.setHeight(700);
      stage.setScene(scene);
      stage.show();

      // create a map view and set a map to it without a basemap
      mapView = new MapView();
      final ArcGISMap map = new ArcGISMap();
      mapView.setMap(map);

      // create a list of subdomains and template URI
      List<String> subDomains = Arrays.asList("a", "b", "c", "d");
      String templateURI = "http://{subDomain}.tile.stamen.com/terrain/{level}/{col}/{row}.png";

      // create a web tiled layer
      webTiledLayer = new WebTiledLayer(templateURI, subDomains);
      webTiledLayer.loadAsync();
      webTiledLayer.addDoneLoadingListener(() -> {
        if(webTiledLayer.getLoadStatus() == LoadStatus.LOADED){
          // set the web tiled layer as the map's basemap
          map.setBasemap(new Basemap(webTiledLayer));
          // set custom attribution on the layer
          webTiledLayer.setAttribution("Map tiles by <a href=\"http://stamen.com/\">Stamen Design</a>, " +
              "under <a href=\"http://creativecommons.org/licenses/by/3.0\">CC BY 3.0</a>. " +
              "Data by <a href=\"http://openstreetmap.org/\">OpenStreetMap</a>, " +
              "under <a href=\"http://creativecommons.org/licenses/by-sa/3.0\">CC BY SA</a>.");
        } else {
          new Alert(Alert.AlertType.ERROR, webTiledLayer.getLoadError().getMessage()).show();
        }
      });

      // add the map view and control panel to stack pane
      stackPane.getChildren().addAll(mapView);
    } catch (Exception e) {
      // on any error, display stack trace
      e.printStackTrace();
    }
  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() {

    if (mapView != null) {
      mapView.dispose();
    }
  }

  /**
   * Opens and runs application.
   *
   * @param args arguments passed to this application
   */
  public static void main(String[] args) {

    Application.launch(args);
  }

}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.