Class

mapkit.Search

An object that retrieves map-based search results for a user-entered query.

Declaration

interface mapkit.Search

Overview

Search allows developers to populate a map with results from a user-entered query, including information about businesses and other points of interest. This functionality is exposed through a search object that makes network requests to the search service.

Supplying search context creates the most relevant results to a query. Context may include the user's location, or a coordinate or region provided by the developer.

To use search, create an instance of a search object with the desired options. Use the search object to make search requests.

Topics

Creating a Search

mapkit.Search

Creates a search object with optional initial values that you provide.

SearchConstructorOptions

Options that you may provide when creating a search object.

Performing a Search

search

Retrieves the results of a search query.

SearchDelegate

An object or callback function called when performing a search or autocomplete request.

SearchOptions

Options you can provide when performing a search.

SearchResponse

The result of a search, including the original search query, the bounding region, and a list of places that match the query.

Performing a Search Autocomplete

autocomplete

Retrieves a list of autocomplete results for the specified search query.

SearchAutocompleteResponse

An object containing the response from an autocomplete request.

SearchAutocompleteResult

The result of an autocomplete query, including display lines and a coordinate.

Canceling a Search

cancel

Cancels a search request using its request ID.