Skip to content

Apply raster rendering rule

View on GitHubSample viewer app

Display a raster on a map and apply different rendering rules to that raster.

Image of Apply raster rendering rule sample

Use case

Raster images whose individual pixels represent elevation values can be rendered in a number of different ways, including representation of slope, aspect, hillshade, and shaded relief. Applying these different rendering rules to the same raster allows for a powerful visual analysis of the data. For example, a geologist could interrogate the raster image to map subtle geological features on a landscape, which may become apparent only through comparing the raster when rendered using several different rules.

How to use the sample

Open the sample and use the picker to select a rendering rule.

How it works

  1. Create an ImageServiceRaster using a URL to an online image service.
  2. After loading the raster, get its serviceInfo to get a list of RenderingRuleInfo supported by the service.
  3. Choose a rendering rule info to apply and use it to create a RenderingRule.
  4. Create a new ImageServiceRaster using the same image service URL.
  5. Apply the rendering rule to the new raster.
  6. Create a RasterLayer from the raster for display.

Relevant API

  • ImageServiceRaster
  • RasterLayer
  • RenderingRule

About the data

The CharlotteLAS image service contains 9 LAS files covering Charlotte, North Carolina's downtown area. The LiDAR data was collected in 2007. Four raster rules are available for selection: None, RFTAspectColor, RFTHillshade, and RFTShadedReliefElevationColorRamp.

Additional information

Image service rasters of any type can have rendering rules applied to them; they need not necessarily be elevation rasters. See the list of raster function objects and syntax for rendering rules in the ArcGIS REST API documentation.

Tags

raster, rendering rules, visualization

Sample Code

ApplyRasterRenderingRuleViewModel.ktApplyRasterRenderingRuleViewModel.ktMainActivity.ktApplyRasterRenderingRuleScreen.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
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/* 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.applyrasterrenderingrule.components

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.Viewpoint
import com.arcgismaps.mapping.layers.RasterLayer
import com.arcgismaps.raster.ImageServiceRaster
import com.arcgismaps.raster.RenderingRule
import com.arcgismaps.toolkit.geoviewcompose.MapViewProxy
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.launch

private const val IMAGE_SERVICE_URL = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/CharlotteLAS/ImageServer"

class ApplyRasterRenderingRuleViewModel(app: Application) : AndroidViewModel(app) {

    val mapViewProxy = MapViewProxy()

    var arcGISMap = ArcGISMap(BasemapStyle.ArcGISStreets)

    // List of raster layers, each with a different rendering rule
    private val rasterLayers: MutableList<RasterLayer> = mutableListOf()

    // List of rendering rule names for the dropdown
    private val _renderingRuleNames = MutableStateFlow<List<String>>(emptyList())
    val renderingRuleNames = _renderingRuleNames.asStateFlow()

    // Currently selected rendering rule name
    private val _selectedRenderingRuleName = MutableStateFlow("")
    val selectedRenderingRuleName = _selectedRenderingRuleName.asStateFlow()

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

    init {
        viewModelScope.launch(Dispatchers.IO) {
            createRasterLayers()
        }
    }

    /**
     * Loads the image service raster, gets all rendering rule infos, and creates a raster layer for each rule.
     */
    private suspend fun createRasterLayers() {
        // Create and load the base image service raster
        val imageServiceRaster = ImageServiceRaster(IMAGE_SERVICE_URL)
        imageServiceRaster.load().onFailure {
            messageDialogVM.showMessageDialog(
                title = "Failed to load image service raster",
                description = it.message.toString()
            )
            return
        }
        val serviceInfo = imageServiceRaster.serviceInfo
        // Check availability of rendering rule infos
        val renderingRuleInfos = serviceInfo?.renderingRuleInfos ?: emptyList()
        if (renderingRuleInfos.isEmpty()) {
            messageDialogVM.showMessageDialog("No rendering rules found for this image service.")
            return
        }
        val ruleNames = mutableListOf<String>()
        // 'None' option: no rendering rule
        val baseRaster = ImageServiceRaster(IMAGE_SERVICE_URL)
        val baseLayer = RasterLayer(baseRaster).apply { name = "None" }
        rasterLayers.add(baseLayer)
        // For each rendering rule info, create a new raster layer
        for (ruleInfo in renderingRuleInfos) {
            val raster = ImageServiceRaster(IMAGE_SERVICE_URL)
            raster.renderingRule = RenderingRule(ruleInfo)
            val rasterLayer = RasterLayer(raster).apply { name = ruleInfo.name }
            rasterLayers.add(rasterLayer)
            ruleNames.add(ruleInfo.name)
        }
        // Load all raster layers
        rasterLayers.forEach { layer ->
            layer.load().onFailure {
                messageDialogVM.showMessageDialog(
                    title = "Failed to load raster layer",
                    description = it.message.toString()
                )
            }
        }
        _renderingRuleNames.value = ruleNames
        // Set initial selection to 'None'
        _selectedRenderingRuleName.value = "None"
        // Set the initial layer on the map
        setRasterLayer("None")
    }

    /**
     * Sets the raster layer with the given name as the only operational layer on the map.
     * Zooms to the layer's extent if available.
     */
    fun setRasterLayer(ruleName: String) {
        val rasterLayer = rasterLayers.firstOrNull { it.name == ruleName }
        if (rasterLayer != null) {
            arcGISMap.operationalLayers.clear()
            arcGISMap.operationalLayers.add(rasterLayer)
            _selectedRenderingRuleName.value = ruleName
            // Zoom to the raster layer's extent if available
            viewModelScope.launch {
                rasterLayer.fullExtent?.let { extent ->
                    mapViewProxy.setViewpoint(Viewpoint(extent))
                }
            }
        }
    }
}

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