MMKNavigationLayer

Warning

This feature is available in the NaviKit SDK version.

class MMKNavigationLayer : NSObject

Summary

Instance methods

func getViewWith(_ route: MMKDrivingRoute) -> MMKRouteView?
Find appearance of route

func selectRoute(withRoute route: MMKRouteView?)
NavigationLayer will try to show as much info as possible about selected route

func selectedRoute() -> MMKRouteView?

func addRouteViewListener(with routeViewListener: any MMKRouteViewListener)
Add this listener if you wish to handle taps on routes

func removeRouteViewListener(with routeViewListener: any MMKRouteViewListener)

func selectRoadEvent(withEventId eventId: String)

func deselectRoadEvent()

func selectRequestPoint(withRequestPointIndex requestPointIndex: UInt)
Selects a request point with specified index

func deselectRequestPoint()
Deselects selected request point if any

func addRequestPointListener(with requestPointListener: any MMKRequestPointListener)
Add this listener if you wish to handle taps on request points

func removeRequestPointListener(with requestPointListener: any MMKRequestPointListener)

func addBalloonViewListener(withBalloonListener balloonListener: any MMKBalloonViewListener)
The class does not retain the object in the 'balloonListener' parameter

func removeBalloonViewListener(withBalloonListener balloonListener: any MMKBalloonViewListener)

func addListener(with navigationLayerListener: any MMKNavigationLayerListener)
The class does not retain the object in the 'navigationLayerListener' parameter

func removeListener(with navigationLayerListener: any MMKNavigationLayerListener)

func addPlacemarkTapListener(withRoadEventsListener roadEventsListener: any MMKNavigationLayerPlacemarkTapListener)
The class does not retain the object in the 'roadEventsListener' parameter

func removePlacemarkTapListener(withRoaadEventsListener roaadEventsListener: any MMKNavigationLayerPlacemarkTapListener)
The class does not retain the object in the 'roaadEventsListener' parameter

func setRoadEventVisibleOnRouteWith(_ tag: MMKRoadEventsEventTag, on: Bool)
Sets road events on route tag visibility

func removeFromMap()
Removes layer from map

func setShowBalloonsGeometryWithEnabled(_ enabled: Bool)
for debug usage only

func refreshStyle()
Force refresh style for all navigation layer objects

func is2DMode() -> Bool
When in 2D mode: - map is switched to 2D mode - 'Free' and 'Following' camera modes have zero tilt - tilt changing gestures are disabled

Disabled by default

func set2DMode(withEnabled enabled: Bool)

Properties

var navigation: MMKNavigation { get }

var camera: MMKCamera { get }

var mode: MMKNavigationLayerMode { get }
Current view mode

var routes: [MMKRouteView] { get }
Routes representation on the map

var isShowRequestPoints: Bool { get set }
Enabled by default

var isIsVisible: Bool { get set }

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

Instance methods

getViewWith(_:)

func getViewWith(_ route: MMKDrivingRoute) -> MMKRouteView?

Find appearance of route.


selectRoute(withRoute:)

func selectRoute(withRoute route: MMKRouteView?)

NavigationLayer will try to show as much info as possible about selected route. For example if road event placemarks from different routes overlap, road event from selected route will be displayed, conflict will be hidden. None or one route can be selected at the same time. Pass nil/null to unselect route. Can be used only if mode() == NavigationLayerMode.RouteSelection


selectedRoute()

func selectedRoute() -> MMKRouteView?

addRouteViewListener(with:)

func addRouteViewListener(with routeViewListener: any MMKRouteViewListener)

Add this listener if you wish to handle taps on routes.

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


removeRouteViewListener(with:)

func removeRouteViewListener(with routeViewListener: any MMKRouteViewListener)

selectRoadEvent(withEventId:)

func selectRoadEvent(withEventId eventId: String)

deselectRoadEvent()

func deselectRoadEvent()

selectRequestPoint(withRequestPointIndex:)

func selectRequestPoint(withRequestPointIndex requestPointIndex: UInt)

Selects a request point with specified index. Only one point can be selected at a time. If some other point is selected already, it will be deselected.


deselectRequestPoint()

func deselectRequestPoint()

Deselects selected request point if any.


addRequestPointListener(with:)

func addRequestPointListener(with requestPointListener: any MMKRequestPointListener)

Add this listener if you wish to handle taps on request points.

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


removeRequestPointListener(with:)

func removeRequestPointListener(with requestPointListener: any MMKRequestPointListener)

addBalloonViewListener(withBalloonListener:)

func addBalloonViewListener(withBalloonListener balloonListener: any MMKBalloonViewListener)

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


removeBalloonViewListener(withBalloonListener:)

func removeBalloonViewListener(withBalloonListener balloonListener: any MMKBalloonViewListener)

addListener(with:)

func addListener(with navigationLayerListener: any MMKNavigationLayerListener)

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


removeListener(with:)

func removeListener(with navigationLayerListener: any MMKNavigationLayerListener)

addPlacemarkTapListener(withRoadEventsListener:)

func addPlacemarkTapListener(withRoadEventsListener roadEventsListener: any MMKNavigationLayerPlacemarkTapListener)

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


removePlacemarkTapListener(withRoaadEventsListener:)

func removePlacemarkTapListener(withRoaadEventsListener roaadEventsListener: any MMKNavigationLayerPlacemarkTapListener)

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


setRoadEventVisibleOnRouteWith(_:on:)

func setRoadEventVisibleOnRouteWith(_ tag: MMKRoadEventsEventTag, on: Bool)

Sets road events on route tag visibility. Setting local chats visibility will also set visibility for ordinary chats and vice versa. None are visible by default.


removeFromMap()

func removeFromMap()

Removes layer from map. No further operations with layer should be performed.


setShowBalloonsGeometryWithEnabled(_:)

func setShowBalloonsGeometryWithEnabled(_ enabled: Bool)

for debug usage only


refreshStyle()

func refreshStyle()

Force refresh style for all navigation layer objects.


is2DMode()

func is2DMode() -> Bool

When in 2D mode: - map is switched to 2D mode - 'Free' and 'Following' camera modes have zero tilt - tilt changing gestures are disabled

Disabled by default


set2DMode(withEnabled:)

func set2DMode(withEnabled enabled: Bool)

Properties

var navigation: MMKNavigation { get }

camera

var camera: MMKCamera { get }

mode

var mode: MMKNavigationLayerMode { get }

Current view mode


routes

var routes: [MMKRouteView] { get }

Routes representation on the map.


isShowRequestPoints

var isShowRequestPoints: Bool { get set }

Enabled by default.


isIsVisible

var isIsVisible: Bool { get set }

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
MMKNavigationJamStyle
Next
MMKNavigationLayerFactory