Set basemap

View on GitHub

Set a map's basemap. A basemap is beneath all layers on a map and is used to provide visual reference for the operational layers.

Image of set basemap

Use case

Basemaps should be selected contextually. For example, in maritime applications, it would be more appropriate to use a basemap of the world's oceans as opposed to a basemap of the world's streets.

How to use the sample

Tap the map button in the toolbar to view a list of the available basemaps. Tap an item to set it as the map's basemap.

How it works

Create a Map object with the arcGISImagery basemap style.
Create a MapView instance with the map.
Create a BasemapGallery using the toolkit.

Relevant API

BasemapGallery
BasemapStyle
Map
MapView

Additional information

This samples uses the basemap gallery toolkit component, which requires the ArcGIS Maps SDK for Swift Toolkit.

Sample Code

SetBasemapView.swift
Use dark colors for code blocksCopy
// Copyright 2022 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 ArcGISToolkit
import SwiftUI

struct SetBasemapView: View {
    /// A Boolean value that indicates whether to show the basemap gallery.
    @State private var isShowingBasemapGallery = false

    /// A map with imagery basemap.
    @State private var map: Map = {
        let map = Map(basemapStyle: .arcGISImagery)
        // The initial viewpoint of the map.
        map.initialViewpoint = Viewpoint(
            center: Point(x: -118.4, y: 33.7, spatialReference: .wgs84),
            scale: 1e6
        )
        return map
    }()

    var body: some View {
        GeometryReader { geometryProxy in
            MapView(map: map)
                .overlay(alignment: .topTrailing) {
                    if isShowingBasemapGallery {
                        BasemapGallery(geoModel: map)
                            .style(.automatic())
                            .frame(maxWidth: geometryProxy.size.width / 3)
                            .esriBorder()
                            .padding()
                    }
                }
                .toolbar {
                    ToolbarItem(placement: .primaryAction) {
                        Toggle(isOn: $isShowingBasemapGallery) {
                            Label("Basemap Gallery", systemImage: "map")
                        }
                    }
                }
        }
    }
}

#Preview {
    NavigationStack {
        SetBasemapView()
    }
}