Set initial viewpoint

View on GitHub

Display the map at an initial viewpoint representing a bounding geometry.

Image of Set initial viewpoint

Use case

Setting the initial viewpoint is useful when a user wishes to first load the map at a particular area of interest.

How to use the sample

When the sample loads, note the map is opened at the initial viewpoint that is set to it.

How it works

  1. Instantiate a Map object.
  2. Instantiate a Viewpoint object using an Envelope object.
  3. Set the starting location of the map with map.initialViewpoint = Viewpoint(boundingGeometry:).
  4. Set the map to a MapView object.

Relevant API

  • Envelope
  • Map
  • MapView
  • Point
  • Viewpoint

Tags

envelope, extent, initial viewpoint, zoom

Sample Code

SetInitialViewpointView.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
// 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 SetInitialViewpointView: View {
    /// A map with a basemap and an initial viewpoint.
    @State private var map: Map = {
        let map = Map(basemapStyle: .arcGISImageryStandard)
        map.initialViewpoint = Viewpoint(boundingGeometry: .potashPonds)
        return map
    }()

    var body: some View {
        MapView(map: map)
    }
}

private extension Geometry {
    /// The area around Potash Ponds, Moab, Utah.
    static var potashPonds: Envelope {
        Envelope(
            xRange: -12211308.778729 ... -12208257.879667,
            yRange: 4645116.003309 ... 4650542.535773,
            spatialReference: .webMercator
        )
    }
}
#Preview {
    SetInitialViewpointView()
}

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