SYMapPlacesManager Class Reference

Provides map places operations. The purpose is to show huge amount of SYMapPlace objects on the map. More...

#import <SYMapPlacesManager.h>

Inheritance diagram for SYMapPlacesManager:

Collaboration diagram for SYMapPlacesManager:

Instance Methods
((unavailable("Use +[SYMapPlacesManager sharedManager] instead.")	- __attribute__
	SYMapPlacesManager is singleton, use [SYMapPlacesManager sharedManager] to access singleton instance. More...
(void)	- setClusterSettings:completion:
	Provide settings for the clustering calculation. The clustering joins nearby places to cluster objects when a view is zoomed out. The settings will be used in the subsequent fillings of places. This function itself doesn't perform any clusters processing. If settings are invalid, the radius is too small or too large, previous or default settings will be used. More...
(void)	- fillPlaces:categories:completion:
	Fill places and categories data to SDK, in order to show them on the map. All previous map places and their categories will be replaced with the provided data set. Each provided place must belong to one of the provided categories. The data will be shown on all SYMapView instances. See also: SYMapPlace. More...
(void)	- removeAllPlacesWithCompletion:
	Removes all SYMapPlace and SYMapPlaceCategory objects already added to SDK. More...
(NSInteger)	- getPlacesCount
	Get the count of places stored in SDK. More...
(void)	- queryVisiblePlacesOfCategories:withEmptyDescription:completion:
	Query identifiers of visible places. A place is considered visible when: 1) it's located inside of the visible area on at least one map view 2) current zoom level of the map is bigger (closer) than corresponding SYMapPlaceCategory.zoomLimit 3) not currently grouped into a cluster If a place fits criteria but actually hidden due to overlapping with another place, it's considered as visible. More...
(void)	- updatePlace:
	Update the place description. More...

Class Methods
(nonnull SYMapPlacesManager *)	+ sharedManager
	Returns SYMapPlacesManager singleton instance. More...
((unavailable("Use +[SYMapPlacesManager sharedManager] instead.")	+ __attribute__

Detailed Description

Provides map places operations. The purpose is to show huge amount of SYMapPlace objects on the map.

Method Documentation

sharedManager

+ (nonnull SYMapPlacesManager*) sharedManager

Returns SYMapPlacesManager singleton instance.

__attribute__ [1/2]

- ((unavailable("Use +[SYMapPlacesManager sharedManager] instead.") __attribute__

SYMapPlacesManager is singleton, use [SYMapPlacesManager sharedManager] to access singleton instance.

__attribute__ [2/2]

+ ((unavailable("Use +[SYMapPlacesManager sharedManager] instead.") __attribute__

setClusterSettings:completion:

- (void) setClusterSettings:		(nonnull SYMapPlacesClusterSettings *)	settings
completion:		(nonnull SYMapPlacesClusterSettingsCompletionBlock)	completion

Provide settings for the clustering calculation. The clustering joins nearby places to cluster objects when a view is zoomed out. The settings will be used in the subsequent fillings of places. This function itself doesn't perform any clusters processing. If settings are invalid, the radius is too small or too large, previous or default settings will be used.

Parameters

settings	Settings for cluster calculation
completion	A completion block receiving result. See also SYMapPlacesClusterSettings, SYMapPlaceCategory.clusterId.

fillPlaces:categories:completion:

- (void) fillPlaces:		(nonnull NSArray< SYMapPlace * > *)	places
categories:		(nonnull NSArray< SYMapPlaceCategory * > *)	categories
completion:		(fillPlaces(_:categories:completion:))	NS_SWIFT_NAME

Fill places and categories data to SDK, in order to show them on the map. All previous map places and their categories will be replaced with the provided data set. Each provided place must belong to one of the provided categories. The data will be shown on all SYMapView instances. See also: SYMapPlace.

removeAllPlacesWithCompletion:

- (void) removeAllPlacesWithCompletion:

(nonnull SYMapPlacesFillCompletionBlock)

completion

Removes all SYMapPlace and SYMapPlaceCategory objects already added to SDK.

getPlacesCount

- (NSInteger) getPlacesCount

Get the count of places stored in SDK.

queryVisiblePlacesOfCategories:withEmptyDescription:completion:

- (void) queryVisiblePlacesOfCategories:		(nonnull NSArray< NSString * > *)	categories
withEmptyDescription:		(BOOL)	emptyDescription
completion:		(nonnull SYMapPlacesQueryIdsCompletionBlock)	completion

Query identifiers of visible places. A place is considered visible when: 1) it's located inside of the visible area on at least one map view 2) current zoom level of the map is bigger (closer) than corresponding SYMapPlaceCategory.zoomLimit 3) not currently grouped into a cluster If a place fits criteria but actually hidden due to overlapping with another place, it's considered as visible.

Parameters

categories	An array of category identifiers of the wanted places.
emptyDescription	If true, will return only places which have empty description string. If false, will return places with any description.
completion	A completion block is called asynchronously.

updatePlace:

- (void) updatePlace:

(updatePlace(_:))

NS_SWIFT_NAME

Update the place description.

---

The documentation for this class was generated from the following file:

• SYMapPlacesManager.h