Skip to content
View on GitHubSample viewer app

Apply a colormap renderer to a raster.

Image of apply colormap renderer to raster sample

Use case

A colormap renderer transforms pixel values in a raster to display raster data based on specific colors, aiding in visual analysis of the data. For example, a forestry commission may want to quickly visualize areas above and below the tree-line line occurring at a known elevation on a raster containing elevation values. They could overlay a transparent colormap set to color those areas below the tree-line elevation green, and those above white.

How to use the sample

Pan and zoom to explore the effect of the colormap applied to the raster.

How it works

  1. Create a raster from a raster file using Raster.createWithPath(path: String).
  2. Create a raster layer with the raster using RasterLayer(raster: Raster).
  3. Create an array of colors. Colors at the beginning of the array replace the darkest values in the raster and colors at the end of the array replace the brightest values of the raster.
  4. Create a colormap renderer with the color array using ColormapRenderer(colors: Iterable<Color>), and assign it to the raster layer using RasterLayer.renderer.

Relevant API

  • ColormapRenderer
  • Raster
  • RasterLayer

Offline data

This sample uses the ShastaBW raster. It is downloaded from ArcGIS Online automatically.

About the data

The raster used in this sample shows an area in the south of the Shasta-Trinity National Forest, California.

Tags

colormap, data, raster, renderer, visualization

Sample Code

ApplyColormapRendererToRasterViewModel.ktApplyColormapRendererToRasterViewModel.ktMainActivity.ktDownloadActivity.ktApplyColormapRendererToRasterScreen.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
/* 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.applycolormaprenderertoraster.components

import android.app.Application
import androidx.lifecycle.AndroidViewModel
import androidx.lifecycle.viewModelScope
import com.arcgismaps.Color
import com.arcgismaps.mapping.ArcGISMap
import com.arcgismaps.mapping.BasemapStyle
import com.arcgismaps.mapping.Viewpoint
import com.arcgismaps.mapping.layers.RasterLayer
import com.arcgismaps.mapping.symbology.raster.ColormapRenderer
import com.arcgismaps.raster.Raster
import com.esri.arcgismaps.sample.sampleslib.components.MessageDialogViewModel
import kotlinx.coroutines.launch
import java.io.File

/**
 * ViewModel that creates a map with a raster layer and applies a colormap renderer to the raster.
 *
 * The sample expects the raster file to be placed in the application's external files directory
 * under a folder matching the sample name and a subfolder "raster-file" containing "Shasta.tif".
 */
class ApplyColormapRendererToRasterViewModel(private val app: Application) : AndroidViewModel(app) {

    // Provision path where sample data is expected if provided by the downloader activity
    private val provisionPath: String by lazy {
        app.getExternalFilesDir(null)?.path.toString() + File.separator +
            app.getString(com.esri.arcgismaps.sample.applycolormaprenderertoraster.R.string.apply_colormap_renderer_to_raster_app_name)
    }

    // Raster created from a local file.
    private val raster: Raster by lazy {
        Raster.createWithPath(provisionPath + File.separator + "ShastaBW.tif")
    }

    // Raster layer that will display the raster.
    private val rasterLayer: RasterLayer by lazy {
        // Create a simple colormap: 150 red entries followed by 151 yellow entries
        val colors = mutableListOf<Color>().apply {
            repeat(150) { add(Color.red) }
            repeat(151) { add(Color.yellow) }
        }

        // Create and assign the ColormapRenderer
        val colormapRenderer = ColormapRenderer(colors = colors)
        RasterLayer(raster).apply {
            renderer = colormapRenderer
        }
    }

    // The ArcGISMap used by the sample.
    val arcGISMap = ArcGISMap(BasemapStyle.ArcGISImageryStandard).apply {
        operationalLayers += rasterLayer
    }

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

    init {
        viewModelScope.launch {
            rasterLayer.load().onSuccess {
                // When the raster layer is loaded, center the map on the raster's full extent
                rasterLayer.fullExtent?.center?.let { centerPoint ->
                    arcGISMap.initialViewpoint = Viewpoint(center = centerPoint, scale = 80_000.0)
                }
            }.onFailure { messageDialogVM.showMessageDialog(it) }
        }
    }
}

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