- Summary
- Instance methods
- submitQueryWithQuery:searchOptions:
- submitQueryWithQuery:geometry:searchOptions:
- searchByUriWithUri:searchOptions:
- resubmit
- enableRequestsOnMapMovesWithEnable:
- enableMapMoveOnSearchResponseWithEnable:
- hasNextPage
- fetchNextPage
- clear
- getSearchResultsList
- searchMetadata
- setSearchManagerWithSearchManager:
- addSearchResultListenerWithSearchResultListener:
- removeSearchResultListenerWithSearchResultListener:
- addPlacemarkListenerWithPlacemarkListener:
- removePlacemarkListenerWithPlacemarkListener:
- setSortByDistanceWithOrigin:
- setPolylinePositionWithPosition:
- resetSort
- setFilterCollectionWithFilters:
- setFiltersWithFilters:
- setAssetsProviderWithProvider:
- resetAssetsProvider
- selectPlacemarkWithGeoObjectId:
- selectedPlacemarkId
- deselectPlacemark
- forceUpdateIconWithGeoObjectId:iconType:image:style:
- forceUpdateMapObjects
- obtainAdIconsWithEnable:
- setInsetsWithTop:left:bottom:right:
- Properties
Warning
This feature is available in the Full MapKit SDK version
MMKSearchLayer
@interface 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
- (void)submitQueryWithQuery:(nonnull NSString *)query |
- (void)submitQueryWithQuery:(nonnull NSString *)query |
- (void)searchByUriWithUri:(nonnull NSString *)uri |
- (void)resubmit; |
- (void)enableRequestsOnMapMovesWithEnable:(BOOL)enable; |
- (void)enableMapMoveOnSearchResponseWithEnable:(BOOL)enable; |
- (BOOL)hasNextPage; |
- (void)fetchNextPage; |
- (void)clear; |
- (nonnull NSArray<MMKSearchResultItem *> *)getSearchResultsList; |
- (nullable MMKSearchMetadata *)searchMetadata; |
- (void)setSearchManagerWithSearchManager: |
- (void)addSearchResultListenerWithSearchResultListener: |
- (void)removeSearchResultListenerWithSearchResultListener: |
- (void)addPlacemarkListenerWithPlacemarkListener: |
- (void)removePlacemarkListenerWithPlacemarkListener: |
- (void)setSortByDistanceWithOrigin:(nonnull MMKGeometry *)origin; |
- (void)setPolylinePositionWithPosition:(nonnull MMKPolylinePosition *)position; |
- (void)resetSort; |
- (void)setFilterCollectionWithFilters: |
- (void)setFiltersWithFilters: |
- (void)setAssetsProviderWithProvider:(nonnull id<MMKAssetsProvider>)provider; |
- (void)resetAssetsProvider; |
- (void)selectPlacemarkWithGeoObjectId:(nonnull NSString *)geoObjectId; |
- (nullable NSString *)selectedPlacemarkId; |
- (void)deselectPlacemark; |
- (void)forceUpdateIconWithGeoObjectId:(nonnull NSString *)geoObjectId |
- (void)forceUpdateMapObjects; |
- (void)obtainAdIconsWithEnable:(BOOL)enable; |
- (void)setInsetsWithTop:(NSUInteger)top |
Properties
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isVisible) |
@property (nonatomic, readonly, getter=isValid) BOOL valid; |
Instance methods
submitQueryWithQuery:searchOptions:
- (void)submitQueryWithQuery:(nonnull NSString *)query |
Submit search query with search options.
Parameters |
|
query |
User query |
searchOptions |
Search options |
submitQueryWithQuery:geometry:searchOptions:
- (void)submitQueryWithQuery:(nonnull NSString *)query |
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. |
searchByUriWithUri:searchOptions:
- (void)searchByUriWithUri:(nonnull NSString *)uri |
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
- (void)resubmit; |
Manual resubmit.
enableRequestsOnMapMovesWithEnable:
- (void)enableRequestsOnMapMovesWithEnable:(BOOL)enable; |
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. |
enableMapMoveOnSearchResponseWithEnable:
- (void)enableMapMoveOnSearchResponseWithEnable:(BOOL)enable; |
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
- (BOOL)hasNextPage; |
Check if more results could be loaded.
fetchNextPage
- (void)fetchNextPage; |
Load the next page of results.
clear
- (void)clear; |
Clear the displayed search results from the map.
getSearchResultsList
- (nonnull NSArray<MMKSearchResultItem *> *)getSearchResultsList; |
Get the list of search results.
searchMetadata
- (nullable MMKSearchMetadata *)searchMetadata; |
Get the last search response metadata.
setSearchManagerWithSearchManager:
- (void)setSearchManagerWithSearchManager: |
Set the search manager. Do not use this method; it is for internal use only.
Parameters |
|
searchManager |
Search manager |
addSearchResultListenerWithSearchResultListener:
- (void)addSearchResultListenerWithSearchResultListener: |
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. |
removeSearchResultListenerWithSearchResultListener:
- (void)removeSearchResultListenerWithSearchResultListener: |
Remove search result listener.
Parameters |
|
searchResultListener |
Search result listener to remove. |
addPlacemarkListenerWithPlacemarkListener:
- (void)addPlacemarkListenerWithPlacemarkListener: |
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. |
removePlacemarkListenerWithPlacemarkListener:
- (void)removePlacemarkListenerWithPlacemarkListener: |
Remove placemark listener
Parameters |
|
placemarkListener |
Placemark listener to remove. |
setSortByDistanceWithOrigin:
- (void)setSortByDistanceWithOrigin:(nonnull MMKGeometry *)origin; |
Set sort order of the results by distance from given geometry.
setPolylinePositionWithPosition:
- (void)setPolylinePositionWithPosition:(nonnull MMKPolylinePosition *)position; |
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
- (void)resetSort; |
Reset the sort if it was previously set.
setFilterCollectionWithFilters:
- (void)setFilterCollectionWithFilters: |
Set search filters.
Parameters |
|
filters |
Business filters |
setFiltersWithFilters:
- (void)setFiltersWithFilters: |
search.FilterCollection)} instead.
Alert
Use {@link SearchLayer#setFilterCollection(const optional
setAssetsProviderWithProvider:
- (void)setAssetsProviderWithProvider:(nonnull id<MMKAssetsProvider>)provider; |
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
- (void)resetAssetsProvider; |
Reset the assets provider to default.
selectPlacemarkWithGeoObjectId:
- (void)selectPlacemarkWithGeoObjectId:(nonnull NSString *)geoObjectId; |
Select the placemark by ID.
Parameters |
|
geoObjectId |
Placemark identifier |
selectedPlacemarkId
- (nullable NSString *)selectedPlacemarkId; |
Selected placemark ID.
Returns |
Placemark identifier if any placemark is selected, otherwise |
deselectPlacemark
- (void)deselectPlacemark; |
Deselect all placemarks.
forceUpdateIconWithGeoObjectId:iconType:image:style:
- (void)forceUpdateIconWithGeoObjectId:(nonnull NSString *)geoObjectId |
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
- (void)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.
obtainAdIconsWithEnable:
- (void)obtainAdIconsWithEnable:(BOOL)enable; |
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:
- (void)setInsetsWithTop:(NSUInteger)top |
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
visible
@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isVisible) |
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.
valid
@property (nonatomic, readonly, getter=isValid) BOOL valid; |
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.