YMKNavigationLayer

@interface YMKNavigationLayer : NSObject

Undocumented

Summary

Instance methods

- (nullable YMKRouteView *)getViewWithRoute:(nonnull YMKDrivingRoute *)route;
Find appearance of route

- (void)selectRouteWithRoute:(nullable YMKRouteView *)route;
NavigationLayer will try to show as much info as possible about selected route

- (nullable YMKRouteView *)selectedRoute;
Undocumented

- (void)addRouteViewListenerWithRouteViewListener:
    (nonnull id<YMKRouteViewListener>)routeViewListener;
Add this listener if you wish to handle taps on routes

- (void)removeRouteViewListenerWithRouteViewListener:
    (nonnull id<YMKRouteViewListener>)routeViewListener;
Undocumented

- (void)selectRequestPointWithRequestPointIndex:(NSUInteger)requestPointIndex;
Selects a request point with specified index

- (void)deselectRequestPoint;
Deselects selected request point if any

- (void)addRequestPointListenerWithRequestPointListener:
    (nonnull id<YMKRequestPointListener>)requestPointListener;
Add this listener if you wish to handle taps on request points

- (void)removeRequestPointListenerWithRequestPointListener:
    (nonnull id<YMKRequestPointListener>)requestPointListener;
Undocumented

- (void)addBalloonViewListenerWithBalloonListener:
    (nonnull id<YMKBalloonViewListener>)balloonListener;
The class does not retain the object in the 'balloonListener' parameter

- (void)removeBalloonViewListenerWithBalloonListener:
    (nonnull id<YMKBalloonViewListener>)balloonListener;
Undocumented

- (void)addListenerWithNavigationLayerListener:
    (nonnull id<YMKNavigationLayerListener>)navigationLayerListener;
The class does not retain the object in the 'navigationLayerListener' parameter

- (void)removeListenerWithNavigationLayerListener:
    (nonnull id<YMKNavigationLayerListener>)navigationLayerListener;
Undocumented

- (void)removeFromMap;
Removes layer from map

- (void)setShowBalloonsGeometryWithEnabled:(BOOL)enabled;
for debug usage only

- (void)refreshStyle;
Force refresh style for all navigation layer objects

- (BOOL)is2DMode;
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

- (void)set2DModeWithEnabled:(BOOL)enabled;
Undocumented

Properties

@property (nonatomic, readonly, nonnull) YMKNavigation *navigation;
Undocumented

@property (nonatomic, readonly, nonnull) YMKCamera *camera;
Undocumented

@property (nonatomic, readonly) YMKRoutesSource routesSource;
Current view mode

@property (nonatomic, readonly, nonnull) NSArray<YMKRouteView *> *routes;
Routes representation on the map

@property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isShowRequestPoints) BOOL showRequestPoints;
Enabled by default

@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isIsVisible)
    BOOL isVisible;
Undocumented

@property (nonatomic, readonly, getter=isValid) BOOL valid;
Tells if this object is valid or no

Instance methods

getViewWithRoute:

- (nullable YMKRouteView *)getViewWithRoute:(nonnull YMKDrivingRoute *)route;

Find appearance of route.


selectRouteWithRoute:

- (void)selectRouteWithRoute:(nullable YMKRouteView *)route;

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.


selectedRoute

- (nullable YMKRouteView *)selectedRoute;

Undocumented


addRouteViewListenerWithRouteViewListener:

- (void)addRouteViewListenerWithRouteViewListener:
    (nonnull id<YMKRouteViewListener>)routeViewListener;

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.


removeRouteViewListenerWithRouteViewListener:

- (void)removeRouteViewListenerWithRouteViewListener:
    (nonnull id<YMKRouteViewListener>)routeViewListener;

Undocumented


selectRequestPointWithRequestPointIndex:

- (void)selectRequestPointWithRequestPointIndex:(NSUInteger)requestPointIndex;

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

- (void)deselectRequestPoint;

Deselects selected request point if any.


addRequestPointListenerWithRequestPointListener:

- (void)addRequestPointListenerWithRequestPointListener:
    (nonnull id<YMKRequestPointListener>)requestPointListener;

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.


removeRequestPointListenerWithRequestPointListener:

- (void)removeRequestPointListenerWithRequestPointListener:
    (nonnull id<YMKRequestPointListener>)requestPointListener;

Undocumented


addBalloonViewListenerWithBalloonListener:

- (void)addBalloonViewListenerWithBalloonListener:
    (nonnull id<YMKBalloonViewListener>)balloonListener;

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.


removeBalloonViewListenerWithBalloonListener:

- (void)removeBalloonViewListenerWithBalloonListener:
    (nonnull id<YMKBalloonViewListener>)balloonListener;

Undocumented


addListenerWithNavigationLayerListener:

- (void)addListenerWithNavigationLayerListener:
    (nonnull id<YMKNavigationLayerListener>)navigationLayerListener;

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.


removeListenerWithNavigationLayerListener:

- (void)removeListenerWithNavigationLayerListener:
    (nonnull id<YMKNavigationLayerListener>)navigationLayerListener;

Undocumented


removeFromMap

- (void)removeFromMap;

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


setShowBalloonsGeometryWithEnabled:

- (void)setShowBalloonsGeometryWithEnabled:(BOOL)enabled;

for debug usage only


refreshStyle

- (void)refreshStyle;

Force refresh style for all navigation layer objects.


is2DMode

- (BOOL)is2DMode;

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


set2DModeWithEnabled:

- (void)set2DModeWithEnabled:(BOOL)enabled;

Undocumented


Properties

@property (nonatomic, readonly, nonnull) YMKNavigation *navigation;

Undocumented


camera

@property (nonatomic, readonly, nonnull) YMKCamera *camera;

Undocumented


routesSource

@property (nonatomic, readonly) YMKRoutesSource routesSource;

Current view mode


routes

@property (nonatomic, readonly, nonnull) NSArray<YMKRouteView *> *routes;

Routes representation on the map.


showRequestPoints

@property (nonatomic, assign, unsafe_unretained, readwrite,
          getter=isShowRequestPoints) BOOL showRequestPoints;

Enabled by default.


isVisible

@property (nonatomic, assign, unsafe_unretained, readwrite, getter=isIsVisible)
    BOOL isVisible;

Undocumented


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.


Previous
YMKNavigationJamStyle
Next
YMKNavigationLayerFactory
In this article: