Skip to content

Set map image layer sublayer visibility

View on GitHub

Change the visibility of sublayers.

Image of set map image layer sublayer visibility sample

Use case

A map image layer may contain many sublayers such as different types of roads in a road network or city, county, and state borders in a US map. The user may only be interested in a subset of these sublayers. Or, perhaps showing all of the sublayers would show too much detail. In these cases, you can hide certain sublayers by changing their visibility.

How to use the sample

Each sublayer has a check box which can be used to toggle the visibility of the sublayer.

How it works

  1. Create an ArcGISMapImageLayer object with the URL to a map image service.
  2. Get an array of ArcGISMapImageSublayer after loading the map image layer.
  3. For each layer in the sublayer array, set its visible property to true or false.

Relevant API

  • ArcGISMapImageLayer
  • ArcGISMapImageSublayer

Tags

layer, sublayer, visibility

Sample Code

SetMapImageLayerSublayerVisibilityView.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
// 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
//
//   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 SetMapImageLayerSublayerVisibilityView: View {
    /// The error shown in the error alert.
    @State private var error: Error?

    /// A map with no specified style and initial viewpoint.
    @State private var map: Map = {
        let map = Map()
        map.initialViewpoint = Viewpoint(
            center: Point(
                x: -11e6,
                y: 6e6,
                spatialReference: .webMercator
            ),
            scale: 9e7
        )

        return map
    }()

    /// The map image layer.
    @State private var mapImageLayer = ArcGISMapImageLayer(url: .arcGISMapImageLayerSample)

    /// The sublayer options to control the visibility.
    @State private var sublayerOptions: [SublayerOption] = []

    var body: some View {
        MapView(map: map)
            .task {
                do {
                    // Loads the map image layer.
                    try await mapImageLayer.load()
                    // Adds the map image layer to the map.
                    map.addOperationalLayer(mapImageLayer)
                    sublayerOptions = mapImageLayer.mapImageSublayers.map { mapImageSublayer in
                        SublayerOption(
                            name: mapImageSublayer.name,
                            id: mapImageSublayer.id,
                            isVisible: mapImageSublayer.isVisible,
                            sublayer: mapImageSublayer
                        )
                    }
                } catch {
                    self.error = error
                }
            }
            .toolbar {
                ToolbarItem(placement: .bottomBar) {
                    Menu {
                        ForEach($sublayerOptions, id: \.id) { $sublayerOption in
                            Toggle(isOn: $sublayerOption.isVisible) {
                                Text(sublayerOption.name)
                            }
                            .onChange(of: sublayerOption.isVisible) {
                                sublayerOption.sublayer.isVisible = sublayerOption.isVisible
                            }
                        }
                    } label: {
                        Text("Sublayers")
                    }
                }
            }
            .errorAlert(presentingError: $error)
    }
}

private struct SublayerOption: Equatable, Identifiable {
    let name: String
    let id: Int
    var isVisible = true
    let sublayer: ArcGISMapImageSublayer
}

extension SublayerOption: Hashable {
    func hash(into hasher: inout Hasher) {
        hasher.combine(id)
    }
}

extension URL {
    static var arcGISMapImageLayerSample: URL {
        URL(
            string: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SampleWorldCities/MapServer"
        )!
    }
}

#Preview {
    SetMapImageLayerSublayerVisibilityView()
}

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