NMRouteVisualizerRequest Class Reference

Inherits <NSObject>.

Instance Methods
(nonnull instancetype)	- requestDisplayingWaypointMarkersAtCoordinates:consideringFirstOneAsStart:
(nonnull instancetype)	- requestRemovingWaypointMarkers
(nonnull instancetype)	- requestDisplayingPolylineOfRoute:
(nonnull instancetype)	- requestDisplayingPolylineAndWaypointsOfRoute:
(nonnull instancetype)	- requestRemovingRoutePolyline
(nonnull instancetype)	- requestDisplayingPolylinesOfAlternativeRoutes:
(nonnull instancetype)	- requestRemovingAlternativeRoutePolylines
(nonnull instancetype)	- requestRemovingAll
(nonnull instancetype)	- initRemovingAll

Class Methods
(nonnull instancetype)	+ newRequestRemovingAll

Detailed Description

Interface describing route visualizer request. Executing an "empty" request doesn't affect the route visualizer state.

Method Documentation

initRemovingAll()

- (nonnull instancetype) initRemovingAll

Initializes a request configured to remove all the additional data from map.

newRequestRemovingAll()

+ (nonnull instancetype) newRequestRemovingAll

Creates a request configured to remove all the additional data from map.

requestDisplayingPolylineAndWaypointsOfRoute:()

- (nonnull instancetype) requestDisplayingPolylineAndWaypointsOfRoute:

(nullable NMRoute *)

route

Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will display the polyline of the specified route on map along with markers of its route plan.

Parameters

route

Route whose polyline should be displayed on map and whose route plan should be used as coordinates of waypoints where markers should be placed. Passing 'nil' indicates that route polyline and all waypoint markers should be removed from map.

Returns

New request instance.

requestDisplayingPolylineOfRoute:()

- (nonnull instancetype) requestDisplayingPolylineOfRoute:

(nullable NMRoute *)

route

Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will display the polyline of the specified route on map.

Parameters

route

A route whose polyline should be displayed on map. Passing 'nil' indicates that the currently displayed route polyline should be removed from map.

Returns

New request instance.

requestDisplayingPolylinesOfAlternativeRoutes:()

- (nonnull instancetype) requestDisplayingPolylinesOfAlternativeRoutes:

(nullable NSArray< NMRoute * > *)

routes

Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will display alternative routes' polylines on map. By default the polyline of an alternative route has gray color.

Parameters

routes

Alternative routes whose polylines should be displayed on map. Passing 'nil' indicates all the alternative route polylines should be removed from map.

Returns

New request instance.

requestDisplayingWaypointMarkersAtCoordinates:consideringFirstOneAsStart:()

- (nonnull instancetype) requestDisplayingWaypointMarkersAtCoordinates:		(nullable NSArray< NMMapCoordinates * > *)	coordinates
consideringFirstOneAsStart:		(BOOL)	considerFirstOneAsStart

Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will display waypoint markers on map.

Parameters

coordinates

Waypoint marker coordinates. The last waypoint marker is always displayed with special image. Other markers are displayed with regular waypoint images except for the first one. The first marker, depending on the #considerFirstOneAsStart parameter, is either displayed with regular image or with special image for start marker. Passing 'nil' indicates that all the existing markers should be removed from map.

considerFirstOneAsStart

If 'YES' is passed, the first waypoint marker is displayed with the special start image. Otherwise regular waypoint image is used.

Returns

New request instance.

requestRemovingAll()

- (nonnull instancetype) requestRemovingAll

Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will remove all the additional data from map.

Returns

New request instance.

requestRemovingAlternativeRoutePolylines()

- (nonnull instancetype) requestRemovingAlternativeRoutePolylines

Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will remove polylines of all the displayed alternative routes from map.

Returns

New request instance.

requestRemovingRoutePolyline()

- (nonnull instancetype) requestRemovingRoutePolyline

Creates a copy of the instance configured so that the new request, in addition to the previously configured actions, will remove еру displayed route polyline from map.

Returns

New request instance.

requestRemovingWaypointMarkers()

- (nonnull instancetype) requestRemovingWaypointMarkers

Creates a copy of the instance configured to remove all waypoint markers from map.

Returns

New request instance.