Find web map portal items by using a search term.
Use case
Portals can contain many portal items and, at times, you may wish to query the portal to find what you're looking for. In this example, we search for web map portal items using a text search.
How to use the sample
Enter search terms into the search bar. Once the search is complete, a list is populated with the resultant web maps. Tap on a web map to set it to the map view. Scrolling to the bottom of the web map list view will get more results.
How it works
- Create a new
Portal
and load it. - Create new
PortalItemQueryParameters
. Set the type to web map by addingtype:"Web Map"
and add the text you want to search for. Note that web maps authored prior to July 2nd, 2014, are not supported. You can also limit the query to only return maps published after that date. - Use
findItems(queryParameters:)
to get the first set of matching items (10 by default). - Get more results using the
nextQueryParameters
from thePortalQueryResultSet
.
Relevant API
- Portal
- PortalItem
- PortalQueryParameters
- PortalQueryResultSet
Tags
keyword, query, search, web map
Sample Code
// 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 SearchForWebMapView: View {
/// The view model for the sample.
@StateObject private var model = Model()
/// The text query in the search bar.
@State private var query = ""
/// A Boolean value indicating whether new results are being loaded.
@State private var resultsAreLoading = false
/// The error shown in the error alert.
@State private var error: Error?
var body: some View {
ScrollView {
LazyVStack {
ForEach(model.portalItems, id: \.id) { item in
NavigationLink {
SafeMapView(map: Map(item: item))
.navigationTitle(item.title)
} label: {
PortalItemRowView(item: item)
}
.buttonStyle(.plain)
.task {
// Load the next results when the last item is reached.
guard item.id == model.portalItems.last?.id else { return }
resultsAreLoading = true
defer { resultsAreLoading = false }
do {
try await model.findNextItems()
} catch {
self.error = error
}
}
}
if resultsAreLoading {
ProgressView()
.padding()
} else if !query.isEmpty && model.portalItems.isEmpty {
VStack {
Text("No Results")
.font(.headline)
Text("Check spelling or try a new search.")
.font(.footnote)
}
.padding()
}
}
}
.background(Color(.secondarySystemBackground))
.searchable(
text: $query,
placement: .navigationBarDrawer(displayMode: .always),
prompt: "Web Maps"
)
.task(id: query) {
// Load new results when the query changes.
resultsAreLoading = true
defer { resultsAreLoading = false }
do {
try await model.findItems(for: query)
} catch {
self.error = error
}
}
.errorAlert(presentingError: $error)
}
}
#Preview {
NavigationStack {
SearchForWebMapView()
}
}