Apply raster rendering rule

View on GitHub

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

ApplyRasterRenderingRuleView.swift
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
// 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
//
//   https://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.

import ArcGIS
import SwiftUI

struct ApplyRasterRenderingRuleView: View {
    /// A map with a streets basemap.
    @State private var map = Map(basemapStyle: .arcGISStreets)

    /// An array of raster layers, each with a different rendering rule.
    @State private var rasterLayers: [RasterLayer] = []

    /// The name of rendering rule selected by the picker.
    @State private var selectedRenderingRule = "None"

    /// The viewpoint for zooming the map view to a layer's extent.
    @State private var viewpoint: Viewpoint?

    /// The error shown in the error alert.
    @State private var error: Error?

    var body: some View {
        MapView(map: map, viewpoint: viewpoint)
            .toolbar {
                ToolbarItem(placement: .bottomBar) {
                    Picker("Rendering Rule", selection: $selectedRenderingRule) {
                        ForEach(rasterLayers, id: \.name) { rasterLayer in
                            Text(rasterLayer.name)
                        }
                    }
                    .onChange(of: selectedRenderingRule) { newRule in
                        if let rasterLayer = rasterLayers.first(where: { $0.name == newRule }) {
                            setLayer(rasterLayer)
                        }
                    }
                }
            }
            .task {
                // Sets up the raster layers when the sample opens.
                do {
                    rasterLayers = try await makeRasterLayers()
                    await rasterLayers.load()

                    if let rasterLayer = rasterLayers.first {
                        setLayer(rasterLayer)
                    }
                } catch {
                    self.error = error
                }
            }
            .errorAlert(presentingError: $error)
    }

    /// Sets a given layer on the map and zooms the viewpoint the layer's extent.
    /// - Parameter layer: The layer to set.
    private func setLayer(_ layer: Layer) {
        map.removeAllOperationalLayers()
        map.addOperationalLayer(layer)

        if let layerExtent = layer.fullExtent {
            viewpoint = Viewpoint(boundingGeometry: layerExtent)
        }
    }

    /// Creates raster layers for all the rendering rules from an image service raster.
    /// - Returns: An array of new `RasterLayer` objects.
    private func makeRasterLayers() async throws -> [RasterLayer] {
        // Creates and loads an image service raster using an image service URL.
        let imageServiceRaster = ImageServiceRaster(url: .charlotteLASImageService)
        try await imageServiceRaster.load()

        // Gets the rendering rule infos from the raster's service info.
        guard let renderingRuleInfos = imageServiceRaster.serviceInfo?.renderingRuleInfos else {
            return []
        }

        return renderingRuleInfos.map { renderingRuleInfo in
            // Creates another image service raster and sets its rendering rule using the info.
            // This is required since the raster can't be loaded when setting its rendering rule.
            let imageServiceRaster = ImageServiceRaster(url: .charlotteLASImageService)
            imageServiceRaster.renderingRule = RenderingRule(info: renderingRuleInfo)

            // Creates a layer using the raster.
            let rasterLayer = RasterLayer(raster: imageServiceRaster)
            rasterLayer.name = renderingRuleInfo.name

            return rasterLayer
        }
    }
}

private extension URL {
    /// The web URL to the "CharlotteLAS" image service containing LAS files for Charlotte, NC downtown area.
    static var charlotteLASImageService: URL {
        URL(string: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/CharlotteLAS/ImageServer")!
    }
}

#Preview {
    ApplyRasterRenderingRuleView()
}

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