Add map image layer

View on GitHub

Sample viewer app

Display a layer from an ArcGIS map image layer service.

Add map image Layer

Use case

Map image layers are also referred to as dynamic map services. These services generate images dynamically on the server and send the resulting image to the requesting client. This is useful when rendering complex cartography or large amounts of data in a connected environment, as the client simply displays the image that the server returns. This can result in more accurate and faster-performing layers.

How to use the sample

Open the sample and view the map image layer. As you navigate the map, the layer issues image requests for the new map extent. The resulting images are rendered on the screen.

How it works

Create an ArcGISMap.
Create an ArcGISMapImageLayer with the URL to a map image service.
Add the map image layer to the map's operationalLayers.
Display the map in a MapView composable.

Relevant API

ArcGISMap
ArcGISMapImageLayer

Sample Code

AddMapImageLayerViewModel.kt

MainActivity.kt

AddMapImageLayerScreen.kt

Use dark colors for code blocksCopy
/* Copyright 2025 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.addmapimagelayer.components

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.layers.ArcGISMapImageLayer
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.launch

class AddMapImageLayerViewModel(app: Application) : AndroidViewModel(app) {
    // Create a map image layer using the World Elevation map server
    private val mapImageLayer = ArcGISMapImageLayer(
        url = "https://sampleserver5.arcgisonline.com/arcgis/rest/services/Elevation/WorldElevations/MapServer"
    )

    // The ArcGISMap containing the map image layer
    val arcGISMap = ArcGISMap().apply {
        // Add the map image layer to the operational layers
        operationalLayers.add(mapImageLayer)
    }

    // Message dialog view model for error handling
    val messageDialogVM = MessageDialogViewModel()

    init {
        viewModelScope.launch {
            arcGISMap.load().onFailure { messageDialogVM.showMessageDialog(it) }
        }
    }
}