Work with location search

Add location search functionality on a map

First, make sure you've provisioned a search index resource and configured your app using the instructions in either Configure Location Search or Use existing Amazon Location Service resources and you have already setup displaying a map in your application.

To add a location search UI component to your AMLMapView, you will add an AMLSearchBar to your View in your desired layout. Upon searching, Geo.Places are converted to MGLPointFeatures using AmplifyMapLibre.createFeatures(places). Lastly assign those converted MGLPointFeatures to mapState.features. Alternatively, you can leverage the AMLMapCompositeView directly, which includes an AMLSearchBar among other pre-configured UI components.

1import SwiftUI
2import AmplifyMapLibreUI
3import AmplifyMapLibreAdapter
4import Amplify
5
6struct MyMapView: View {
7
8    @StateObject private var mapState = AMLMapViewState()
9    @State private var searchText = ""
10    @State private var displayState: AMLSearchBar.DisplayState = .map
11
12    var body: some View {
13        ZStack(alignment: .top) {
14            AMLMapView(mapState: mapState)
15                .edgesIgnoringSafeArea(.all)
16
17            AMLSearchBar(
18                text: $searchText,
19                displayState: $displayState,
20                onEditing: { },
21                onCommit: search,
22                onCancel: { mapState.features = [] }
23            )
24            .padding()
25        }
26    }
27
28    private func search() {
29        let searchArea = Geo.SearchArea.near(mapState.center)
30        let searchOptions = Geo.SearchForTextOptions(area: searchArea)
31        Task {
32            do {
33                let places = try await Amplify.Geo.search(for: searchText, options: searchOptions)
34                await MainActor.run {
35                    self.mapState.features = AmplifyMapLibre.createFeatures(places)
36                }
37            } catch let error as Geo.Error {
38                print("Failed to search: \(error)")
39            } catch {
40                print("Unexpected error: \(error)")
41            }
42        }
43    }
44}

Customize Feature Icons

You can customize the feature images displayed on the AMLMapView or AMLMapCompositeView, you can leverage the featureImage() view modifier.

1var body: some View {
2        AMLMapView(mapState: mapState)
3            .featureImage {
4                let image = UIImage(
5                    systemName: "paperplane.circle.fill",
6                    withConfiguration: UIImage.SymbolConfiguration(
7                        font: .systemFont(ofSize: 22, weight: .medium)
8                    )
9                )!
10                return image
11             }
12            .edgesIgnoringSafeArea(.all)
13    }

AMLMapView featureImage view modifier

Location-based search capabilities

Amplify Geo enables you to search for locations by text, addresses, or geo-coordinates.

Search for text

The Amplify.Geo.search(for text:) API enables you to search for places or points of interest by free-form text, such as an address, name, city, or region.

1do {
2    let places = try await Amplify.Geo.search(for: "coffee shops")
3    dump(places)
4} catch {
5    print(error)
6}

You can refine your search by specifying following parameters inside Geo.SearchForTextOptions

area
- .near - to act as the search origination location.
- .within - to limit the area to search within.
countries - to limit the search results to given countries.
maxResults - to limit the maximum result set (defaults to 50).

1let coordinates = Geo.Coordinates(latitude: 47.62246, longitude: -122.336775)
2let options = Geo.SearchForTextOptions(area: .near(coordinates), countries: [.usa, .can], maxResults: 25)
3
4do {
5    let places = try await Amplify.Geo.search(for: "coffee shops", options: options)
6    dump(places)
7} catch let error as Geo.Error {
8    print("Failed to search: \(error)"
9} catch {
10    print("Unexpected error: \(error)")
11}

Search for coordinates

The Amplify.Geo.search(for coordinates:) API is a reverse Geocoder that takes a coordinate point and returns information about what it finds at that point on the map.

1do {
2    let places = try await Amplify.Geo.search(for: coordinates)
3    dump(places)
4} catch let error as Geo.Error {
5    print("Failed to search: \(error)")
6} catch {
7    print("Unexpected error: \(error)")
8}

You can refine your search by specifying following parameters inside Geo.SearchForCoordinatesOptions

maxResults - to limit the maximum result set (defaults to 50)

1let options = Geo.SearchForCoordinatesOptions(maxResults: 25)

Configure location search

Configure a geofence collection