Create a raster layer from a raster image service.

Use case
Accessing a raster image from an online service can be useful for analysing the most up-to-date data available for an area. For example, retrieving recent results of bathymetry surveys within a shipping channel monitored for its sediment build-up would allow planners to assess dredging needs.
How to use the sample
Simply launch the sample to see a raster from an image service being used on a map.
How it works
- Create an
ImageServiceRasterusing the service’s URL. - Create a
RasterLayerfrom the image service raster. - Add the raster layer to the map.
Relevant API
- ImageServiceRaster
- RasterLayer
About the data
This sample uses a NOAA raster image service. The service computes a hillshade image from the depth (in meters) of U.S. coastal waters.
Tags
image service, raster
Sample Code
/* 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.addrasterfromservice
import android.os.Bundleimport androidx.activity.ComponentActivityimport androidx.activity.compose.setContentimport androidx.compose.material3.MaterialThemeimport androidx.compose.material3.Surfaceimport androidx.compose.runtime.Composableimport com.arcgismaps.ApiKeyimport com.arcgismaps.ArcGISEnvironmentimport com.esri.arcgismaps.sample.sampleslib.theme.SampleAppThemeimport com.esri.arcgismaps.sample.addrasterfromservice.screens.AddRasterFromServiceScreen
class MainActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // authentication with an API key or named user is // required to access basemaps and other location services ArcGISEnvironment.apiKey = ApiKey.create(BuildConfig.ACCESS_TOKEN)
setContent { SampleAppTheme { AddRasterFromServiceApp() } } }
@Composable private fun AddRasterFromServiceApp() { Surface(color = MaterialTheme.colorScheme.background) { AddRasterFromServiceScreen( sampleName = getString(R.string.add_raster_from_service_app_name) ) } }}/* 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.addrasterfromservice.components
import android.app.Applicationimport androidx.lifecycle.AndroidViewModelimport androidx.lifecycle.viewModelScopeimport com.arcgismaps.LoadStatusimport com.arcgismaps.geometry.Pointimport com.arcgismaps.geometry.SpatialReferenceimport com.arcgismaps.mapping.ArcGISMapimport com.arcgismaps.mapping.BasemapStyleimport com.arcgismaps.mapping.Viewpointimport com.arcgismaps.mapping.layers.RasterLayerimport com.arcgismaps.raster.ImageServiceRasterimport com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModelimport kotlinx.coroutines.flow.MutableStateFlowimport kotlinx.coroutines.flow.asStateFlowimport kotlinx.coroutines.launch
/** * ViewModel for the Add raster from service sample. */class AddRasterFromServiceViewModel(application: Application) : AndroidViewModel(application) {
// Map used by the Compose MapView var arcGISMap = ArcGISMap(BasemapStyle.ArcGISDarkGray).apply { initialViewpoint = Viewpoint( center = Point(-13637000.0, 4550000.0, SpatialReference.webMercator()), scale = 100000.0 ) }
// The image service raster (NOAA bathymetry service) private val imageServiceRaster = ImageServiceRaster( url = "https://gis.ngdc.noaa.gov/arcgis/rest/services/bag_bathymetry/ImageServer" )
// Raster layer that will display the image service raster private val rasterLayer = RasterLayer(imageServiceRaster)
// Flow exposing the current load status of the raster layer for the UI to observe private val _rasterLoadStatus = MutableStateFlow<LoadStatus>(LoadStatus.NotLoaded) val rasterLoadStatus = _rasterLoadStatus.asStateFlow()
// Message dialog view model for error reporting val messageDialogVM = MessageDialogViewModel()
init { // Add the raster layer to the map's operational layers arcGISMap.operationalLayers.add(rasterLayer)
// Start loading the raster layer and observe its load status viewModelScope.launch { // Attempt to load the raster layer and report any immediate failures rasterLayer.load().onFailure { throwable -> messageDialogVM.showMessageDialog(throwable) }.onSuccess { _rasterLoadStatus.value = LoadStatus.Loaded } } }}/* 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.addrasterfromservice.screens
import androidx.compose.foundation.layout.Columnimport androidx.compose.foundation.layout.fillMaxSizeimport androidx.compose.foundation.layout.paddingimport androidx.compose.material3.Scaffoldimport androidx.compose.runtime.Composableimport androidx.compose.runtime.getValueimport androidx.compose.ui.Modifierimport androidx.lifecycle.compose.collectAsStateWithLifecycleimport androidx.lifecycle.viewmodel.compose.viewModelimport com.arcgismaps.LoadStatusimport com.arcgismaps.toolkit.geoviewcompose.MapViewimport com.esri.arcgismaps.sample.addrasterfromservice.components.AddRasterFromServiceViewModelimport com.esri.arcgismaps.sample.sampleslib.components.LoadingDialogimport com.esri.arcgismaps.sample.sampleslib.components.MessageDialogimport com.esri.arcgismaps.sample.sampleslib.components.SampleTopAppBar
/** * Main screen layout for the sample app. * Displays a MapView showing a raster retrieved from an image service. */@Composablefun AddRasterFromServiceScreen(sampleName: String) { val mapViewModel: AddRasterFromServiceViewModel = viewModel()
// Observe raster load status to show a simple loading overlay while the raster is being fetched/drawn val rasterLoadStatus by mapViewModel.rasterLoadStatus.collectAsStateWithLifecycle()
Scaffold( topBar = { SampleTopAppBar(title = sampleName) }, content = { padding -> Column( modifier = Modifier .fillMaxSize() .padding(padding) ) { MapView( modifier = Modifier .fillMaxSize() .weight(1f), arcGISMap = mapViewModel.arcGISMap, ) }
// Display a loading dialog while the raster layer is not yet fully loaded if (rasterLoadStatus != LoadStatus.Loaded) { LoadingDialog(loadingMessage = "Loading raster…") }
// Display any error messages raised by the ViewModel mapViewModel.messageDialogVM.apply { if (dialogStatus) { MessageDialog( title = messageTitle, description = messageDescription, onDismissRequest = ::dismissDialog ) } } } )}