Warning

This feature is available in the Full MapKit SDK version

MMKSearchLayer

class MMKSearchLayer : NSObject

The search layer handles the map search requests and displays the results on the map automatically. It also handles the map movements and resubmits searches when needed.

Summary

Instance methods

func submitQuery(withQuery query: String, searchOptions: MMKSearchOptions)
Submit search query with search options

func submitQuery(withQuery query: String,
                        geometry: MMKGeometry,
                   searchOptions: MMKSearchOptions)
Submit search query with search options near provided geometry

func searchByUri(withUri uri: String, searchOptions: MMKSearchOptions)
Submit search request for URI resolution

func resubmit()
Manual resubmit

func enableRequestsOnMapMoves(withEnable enable: Bool)
Enable or disable search requests (resubmits and submits) when the map is moved

func enableMapMoveOnSearchResponse(withEnable enable: Bool)
Enable or disable moving the map on primary search response

func hasNextPage() -> Bool
Check if more results could be loaded

func fetchNextPage()
Load the next page of results

func clear()
Clear the displayed search results from the map

func getSearchResultsList() -> [MMKSearchResultItem]
Get the list of search results

func searchMetadata() -> MMKSearchMetadata?
Get the last search response metadata

func setSearchManagerWith( searchManager: MMKSearchManager_)
Set the search manager

func addSearchResultListener(withSearchResultListener searchResultListener: MMKSearchLayerResponseHandler)
Add the search result listener, which will receive notifications from the search layer

func removeSearchResultListener(withSearchResultListener searchResultListener: MMKSearchLayerResponseHandler)
Remove search result listener

func addPlacemarkListener(withPlacemarkListener placemarkListener: MMKSearchLayerTapHandler)
Add a placemark listener, which will receive notifications from the search layer

func removePlacemarkListener(withPlacemarkListener placemarkListener: MMKSearchLayerTapHandler)
Remove placemark listener

func setSortByDistanceWithOrigin( origin: MMKGeometry_)
Set sort order of the results by distance from given geometry

func setPolylinePositionWith( position: MMKPolylinePosition_)
When sorting by distance from polyline sets position on this polyline

func resetSort()
Reset the sort if it was previously set

func setFilterCollectionWithFilters( filters: MMKSearchFilterCollection_?)
Set search filters

func setFiltersWith( filters: [MMKSearchBusinessFilter_])
search

func setAssetsProviderWith( provider: MMKAssetsProvider_)
Set a custom assets provider, which provides images, sizes and icon styles for placemarks

func resetAssetsProvider()
Reset the assets provider to default

func selectPlacemark(withGeoObjectId geoObjectId: String)
Select the placemark by ID

func selectedPlacemarkId() -> String?
Selected placemark ID

func deselectPlacemark()
Deselect all placemarks

func forceUpdateIcon(withGeoObjectId geoObjectId: String,
                                        iconType: MMKPlacemarkIconType,
                                           image: UIImage,
                                           style: MMKIconStyle)
Update the icon image for each suitable placemark

func forceUpdateMapObjects()
Force reloading all visible pins from AssetProvider

func obtainAdIcons(withEnable enable: Bool)
If enabled, the search layer will obtain and set advertising icons without asking AssetsProvider

func setInsetsWithTop(_ top: UInt, left: UInt, bottom: UInt, right: UInt)
Apply insets (in pixels) to the screen

Properties

var isVisible: Bool { get set }
Search layer visibility

var isValid: Bool { get }
Tells if this object is valid or no

Instance methods

submitQuery(withQuery:searchOptions:)

func submitQuery(withQuery query: String, searchOptions: MMKSearchOptions)

Submit search query with search options.

Parameters

query

User query

searchOptions

Search options

submitQuery(withQuery:geometry:searchOptions:)

func submitQuery(withQuery query: String,
                        geometry: MMKGeometry,
                   searchOptions: MMKSearchOptions)

Submit search query with search options near provided geometry.

Parameters

query

User query.

geometry

Geometry to search near. Supported types: point, bounding box, polyline and polygon. Polygon is expected to be a search window: 4 points in outer ring (or 5 if the last point is equal to the first) and no inner rings.

searchOptions

Search options.

searchByUri(withUri:searchOptions:)

func searchByUri(withUri uri: String, searchOptions: MMKSearchOptions)

Submit search request for URI resolution. Allows multiple objects in response.

Parameters

uri

Object URI.

searchOptions

Additional search parameters. See MMKSearchOptions definition for details, and 'searchByURI' method in MMKSearchManager for currently supported options.

resubmit()

func resubmit()

Manual resubmit.


enableRequestsOnMapMoves(withEnable:)

func enableRequestsOnMapMoves(withEnable enable: Bool)

Enable or disable search requests (resubmits and submits) when the map is moved. Requests are enabled by default.

Parameters

enable

Enable requests if true, disable otherwise.

enableMapMoveOnSearchResponse(withEnable:)

func enableMapMoveOnSearchResponse(withEnable enable: Bool)

Enable or disable moving the map on primary search response. Map moving is enabled by default.

Parameters

enable

Enable map moving if true, disable otherwise.

hasNextPage()

func hasNextPage() -> Bool

Check if more results could be loaded.


fetchNextPage()

func fetchNextPage()

Load the next page of results.


clear()

func clear()

Clear the displayed search results from the map.


getSearchResultsList()

func getSearchResultsList() -> [MMKSearchResultItem]

Get the list of search results.


searchMetadata()

func searchMetadata() -> MMKSearchMetadata?

Get the last search response metadata.


setSearchManagerWith(_:)

func setSearchManagerWith( searchManager: MMKSearchManager_)

Set the search manager. Do not use this method; it is for internal use only.

Parameters

searchManager

Search manager

addSearchResultListener(withSearchResultListener:)

func addSearchResultListener(withSearchResultListener searchResultListener: MMKSearchLayerResponseHandler)

Add the search result listener, which will receive notifications from the search layer.

The class does not retain the object in the 'searchResultListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.

Parameters

searchResultListener

Search result listener to add.

removeSearchResultListener(withSearchResultListener:)

func removeSearchResultListener(withSearchResultListener searchResultListener: MMKSearchLayerResponseHandler)

Remove search result listener.

Parameters

searchResultListener

Search result listener to remove.

addPlacemarkListener(withPlacemarkListener:)

func addPlacemarkListener(withPlacemarkListener placemarkListener: MMKSearchLayerTapHandler)

Add a placemark listener, which will receive notifications from the search layer.

The class does not retain the object in the 'placemarkListener' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.

Parameters

placemarkListener

Placemark listener to add.

removePlacemarkListener(withPlacemarkListener:)

func removePlacemarkListener(withPlacemarkListener placemarkListener: MMKSearchLayerTapHandler)

Remove placemark listener

Parameters

placemarkListener

Placemark listener to remove.

setSortByDistanceWithOrigin(_:)

func setSortByDistanceWithOrigin( origin: MMKGeometry_)

Set sort order of the results by distance from given geometry.


setPolylinePositionWith(_:)

func setPolylinePositionWith( position: MMKPolylinePosition_)

When sorting by distance from polyline sets position on this polyline. Has the same effect as sorting by distance from the sub-polyline from position to the end of the polyline. Throws if no polyline is set or position is out of range.

Parameters

position

new polyline position value

resetSort()

func resetSort()

Reset the sort if it was previously set.


setFilterCollectionWithFilters(_:)

func setFilterCollectionWithFilters( filters: MMKSearchFilterCollection_?)

Set search filters.

Parameters

filters

Business filters

setFiltersWith(_:)

func setFiltersWith( filters: [MMKSearchBusinessFilter_])

search.FilterCollection)} instead.

Alert

Use {@link SearchLayer#setFilterCollection(const optional


setAssetsProviderWith(_:)

func setAssetsProviderWith( provider: MMKAssetsProvider_)

Set a custom assets provider, which provides images, sizes and icon styles for placemarks.

The class does not retain the object in the 'provider' parameter. It is your responsibility to maintain a strong reference to the target object while it is attached to a class.

Parameters

provider

Assets provider (must not be null)

resetAssetsProvider()

func resetAssetsProvider()

Reset the assets provider to default.


selectPlacemark(withGeoObjectId:)

func selectPlacemark(withGeoObjectId geoObjectId: String)

Select the placemark by ID.

Parameters

geoObjectId

Placemark identifier

selectedPlacemarkId()

func selectedPlacemarkId() -> String?

Selected placemark ID.

Returns

Placemark identifier if any placemark is selected, otherwise
none.

deselectPlacemark()

func deselectPlacemark()

Deselect all placemarks.


forceUpdateIcon(withGeoObjectId:iconType:image:style:)

func forceUpdateIcon(withGeoObjectId geoObjectId: String,
                                        iconType: MMKPlacemarkIconType,
                                           image: UIImage,
                                           style: MMKIconStyle)

Update the icon image for each suitable placemark. If the placemark is not found, the image will be put in a queue and will be applied once when the placemark is created. This is not the normal way to set the image. It is highly advisable to return the right image from AssetsProvider.

Parameters

geoObjectId

Placemark identifier

iconType

Icon type

image

Icon image

style

Icon style

forceUpdateMapObjects()

func forceUpdateMapObjects()

Force reloading all visible pins from AssetProvider. Use when there is a reason to update ALL the icons simultaneously (for example icon theme change, day/night mode, and other). This can be a pretty expensive operation, as it wipes all the map objects off of the layer and creates them from scratch. Use only if absolutely necessary.


obtainAdIcons(withEnable:)

func obtainAdIcons(withEnable enable: Bool)

If enabled, the search layer will obtain and set advertising icons without asking AssetsProvider.

Parameters

enable

Enable mode if true, disable otherwise

setInsetsWithTop(_:left:bottom:right:)

func setInsetsWithTop(_ top: UInt, left: UInt, bottom: UInt, right: UInt)

Apply insets (in pixels) to the screen. If inset is not zero, search in the cut-off area will not be performed.

Parameters

top

Top inset.

left

Left inset.

bottom

Bottom inset.

right

Right inset.

Properties

isVisible

var isVisible: Bool { get set }

Search layer visibility. Visible by default. While the layer is invisible resubmits are not performed on map moves, but all the state changing methods (submitQuery, resubmit, deselectPlacemark, and other) are executed as usual.


isValid

var isValid: Bool { get }

Tells if this object is valid or no. Any method called on an invalid object will throw an exception. The object becomes invalid only on UI thread, and only when its implementation depends on objects already destroyed by now. Please refer to general docs about the interface for details on its invalidation.


Previous
MMKSearchFuelType
Next
MMKSearchLine