Skip to content

Add web tiled layer

View on GitHubSample viewer app

Display a web tiled layer.

Image of add 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.
  2. Set the attribution property on the web tiled layer. Note: this is a necessary step because web tiled services don't have associated service metadata.
  3. Create a new Basemap from the layer and apply it to the mapView for display.

Relevant API

  • Basemap
  • WebTiledLayer

About the data

The basemap in this sample is provided by ArcGIS Living Atlas of the World. ArcGIS Living Atlas of the World provides tiled services with several unique styles.

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

This sample uses the GeoView-Compose Toolkit module to be able to implement a composable MapView.

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

Tags

arcgis living atlas, geoview-compose, layer, ogc, tiled, tiles, toolkit

Sample Code

AddWebTiledLayerViewModel.ktAddWebTiledLayerViewModel.ktMainActivity.ktAddWebTiledLayerScreen.kt
Use dark colors for code blocksCopy
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
/*
 * Copyright 2024 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.arcgismaps.sample.addwebtiledlayer.components

import android.app.Application
import androidx.core.content.ContextCompat.getString
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.Basemap
import com.arcgismaps.mapping.layers.WebTiledLayer
import com.esri.arcgismaps.sample.addwebtiledlayer.R
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.launch

class AddWebTiledLayerViewModel(application: Application) : AndroidViewModel(application) {
    // build the web tiled layer from ArcGIS Living Atlas of the World tile service url
    private val webTiledLayer = WebTiledLayer.create(
        urlTemplate = "https://server.arcgisonline.com/arcgis/rest/services/Ocean/World_Ocean_Base/MapServer/tile/{level}/{row}/{col}.jpg"
    ).apply {
        // set the attribution on the layer
        attribution = getString(application, R.string.living_atlas_attribution)
    }

    // use web tiled layer as Basemap
    val arcGISMap = ArcGISMap(Basemap(webTiledLayer))

    // create a message dialog view model for handling error messages
    val messageDialogVM = MessageDialogViewModel()

    init {
        viewModelScope.launch {
            arcGISMap.load().onFailure { error ->
                messageDialogVM.showMessageDialog(
                    "Failed to load map",
                    error.message.toString()
                )
            }
        }
    }
}

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