VenueMap
public class VenueMapextension VenueMap: NativeBaseextension VenueMap: HashableConnects a map with venues. When the VenueMap is started,
venues can be seen on the map as interactive models. The user can switch drawings and levels,
change a visual style of geometries and related labels inside the venue etc.
After constructing the VenueMap, delegates
for relevant events should be added to the object. VenueMap is an add-on to
the base map functionality with its own content loading and cache. For this reason, in certain
situations there may be a small delay before the venue is visible.
-
Undocumented
Declaration
Swift
public typealias VenueInfoList = [VenueInfo] -
The
VenueServiceobject. It can be used to search and get theVenueModelobjects.Declaration
Swift
public var venueService: VenueService { get } -
The selected venue or
nilif no venue is selected. Usenilto deselect the venue.Declaration
Swift
public var selectedVenue: Venue? { get set } -
Downloads and adds a
Venueto theVenueMap. Method will do nothing if the venue already exists on the venue map.Declaration
Swift
public func addVenueAsync(venueId: Int32)Parameters
venueIdThe ID of the venue to download and add.
-
Downloads and adds a
Venueto theVenueMap. Method will do nothing if the venue already exists on the venue map.Declaration
Swift
public func addVenueAsync(venueIdentifier: String)Parameters
venueIdentifierThe ID of the venue to download and add.
-
Downloads and adds a
Venueto theVenueMap. Method will do nothing if the venue already exists on the venue map.Declaration
Swift
public func addVenueAsync(venueId: Int32, completion: @escaping VenueLoadErrorHandler)Parameters
venueIdThe ID of the venue to download and add.
completionCallback to receives the error while venue load on the main thread.
-
Downloads and adds a
Venueto theVenueMap. Method will do nothing if the venue already exists on the venue map.Declaration
Swift
public func addVenueAsync(venueIdentifier: String, completion: @escaping VenueLoadErrorHandler)Parameters
venueIdentifierThe ID of the venue to download and add.
completionCallback to receives the error while venue load on the main thread.
-
Downloads a
VenueModelif needed and selects aVenue.Declaration
Swift
public func selectVenueAsync(venueId: Int32)Parameters
venueIdThe ID of the venue to download and select.
-
Downloads a
VenueModelif needed and selects aVenue.Declaration
Swift
public func selectVenueAsync(venueIdentifier: String)Parameters
venueIdentifierThe ID of the venue to download and select.
-
Downloads a
VenueModelif needed and selects aVenue.Declaration
Swift
public func selectVenueAsync(venueId: Int32, completion: @escaping VenueLoadErrorHandler)Parameters
venueIdThe ID of the venue to download and select.
completionCallback to receives the error while venue load on the main thread.
-
Downloads a
VenueModelif needed and selects aVenue.Declaration
Swift
public func selectVenueAsync(venueIdentifier: String, completion: @escaping VenueLoadErrorHandler)Parameters
venueIdentifierThe ID of the venue to download and select.
completionCallback to receives the error while venue load on the main thread.
-
Attempts to cancel venue loading and selection that may currently be in progress.
Declaration
Swift
public func cancelVenueSelection() -> BoolReturn Value
Trueif a venue was about to load andfalseotherwise. -
Tries to find a
Venueat the specified geographic coordinates.Declaration
Swift
public func getVenue(position: GeoCoordinates) -> Venue?Parameters
positionGeographic coordinates where a venue is located.
Return Value
Venue or
nilif there is no venue at the specified geographic coordinates. -
Tries to find a
VenueGeometryat the specified geographic coordinates in the selectedVenuein the currently selectedVenueLevel.Declaration
Swift
public func getGeometry(position: GeoCoordinates) -> VenueGeometry?Parameters
positionGeographic coordinates where the geometry is located.
Return Value
Geometry or
nilif there is no geometry at the specified geographic coordinates. -
Adds a venue lifecycle delegate.
Declaration
Swift
public func addVenueLifecycleDelegate(_ delegate: VenueLifecycleDelegate)Parameters
delegateThe delegate to add.
-
Removes a venue lifecycle delegate.
Declaration
Swift
public func removeVenueLifecycleDelegate(_ delegate: VenueLifecycleDelegate)Parameters
delegateThe delegate to remove.
-
Adds a venue map lifecycle delegate.
Declaration
Swift
public func addVenueMapLifecycleDelegate(_ delegate: VenueMapLifecycleDelegate)Parameters
delegateThe delegate to add.
-
Removes a venue map lifecycle delegate.
Declaration
Swift
public func removeVenueMapLifecycleDelegate(_ delegate: VenueMapLifecycleDelegate)Parameters
delegateThe delegate to remove.
-
Adds a venue selection delegate.
Declaration
Swift
public func addVenueSelectionDelegate(_ delegate: VenueSelectionDelegate)Parameters
delegateThe delegate to add.
-
Removes a venue selection delegate.
Declaration
Swift
public func removeVenueSelectionDelegate(_ delegate: VenueSelectionDelegate)Parameters
delegateThe delegate to remove.
-
Adds a drawing selection delegate.
Declaration
Swift
public func addDrawingSelectionDelegate(_ delegate: VenueDrawingSelectionDelegate)Parameters
delegateThe delegate to add.
-
Removes a drawing selection delegate.
Declaration
Swift
public func removeDrawingSelectionDelegate(_ delegate: VenueDrawingSelectionDelegate)Parameters
delegateThe delegate to remove.
-
Adds a level selection delegate.
Declaration
Swift
public func addLevelSelectionDelegate(_ delegate: VenueLevelSelectionDelegate)Parameters
delegateThe delegate to add.
-
Removes a level selection delegate.
Declaration
Swift
public func removeLevelSelectionDelegate(_ delegate: VenueLevelSelectionDelegate)Parameters
delegateThe delegate to remove.
-
Adds a listener to handle the completion of the asynchronous venue info list retrieval.
Declaration
Swift
public func addVenueInfoListDelegate(_ delegate: VenueInfoListListenerDelegate)Parameters
delegateThe listener to add.
-
Removes a listener for the asynchronous venue info list retrieval.
Declaration
Swift
public func removeVenueInfoListDelegate(_ delegate: VenueInfoListListenerDelegate)Parameters
delegateThe listener to remove.
-
The list of
VenueInfocontains venue id and name.Declaration
Swift
public func getVenueInfoList() -> VenueMap.VenueInfoListReturn Value
returns the list of object of
VenueInfo. -
The list of
VenueInfocontains venue id and name.Declaration
Swift
public func getVenueInfoList(completion: @escaping VenueLoadErrorHandler) -> VenueMap.VenueInfoListParameters
completionCallback to receives the error while venue load on the main thread.
Return Value
returns the list of object of
VenueInfo. -
Declaration
Swift
public func getVenueInfoListAsync(completion: @escaping VenueLoadErrorHandler)Parameters
completionCallback to receive the list of venue info if successful.
-
Tries to find a
VenueTopologyat the specified geographic coordinates in the selectedVenuein the currently selectedVenueLevel.Declaration
Swift
public func getTopology(position: GeoCoordinates) -> VenueTopology?Parameters
positionGeographic coordinates where the topology is located.
Return Value
Topology or
nilif there is no topology at the specified geographic coordinates. -
Tries to find a
Crosswalkat the specified geographic coordinates in the selectedVenuein the currently selectedVenueLevel.Declaration
Swift
public func getCrosswalk(position: GeoCoordinates) -> Crosswalk?Parameters
positionGeographic coordinates where the crosswalk is located.
Return Value
Crosswalk or
nilif there is no crosswalk at the specified geographic coordinates.