RouteEditor | iOS SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
On-Premise
Urbi Pro

RouteEditor

Interface for the route editor. The route editor gets the start and end points of the route, builds routes, and notifies about their updates and realignments through channels.

Extends: Hashable
public static func == (lhs: RouteEditor, rhs: RouteEditor) -> Bool

Returns a Boolean value indicating whether two values are equal.

public convenience init(
    context: Context
)

Function for creating a route editor.

Parameters
context
Methods
public func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Parameters
hasher
Hasher

The hasher to use when combining the components of this instance.

public func setRouteParams(
    routeParams: RouteEditorRouteParams
)

Sets the parameters of the route editor. Starts the search for a new route according to the specified parameters.

Parameters
routeParams
public func setActiveRouteIndex(
    index: RouteIndex
)

Set the active route index.

Parameters
index
Properties
var routesInfoChannel
StatefulChannel<RouteEditorRoutesInfo>

Channel through which you can monitor updates of route information operated by the editor.

var routesInfo

Channel through which you can monitor updates of route information operated by the editor.

var activeRouteIndexChannel
StatefulChannel<RouteIndex?>

The channel through which you can monitor updates of the active route index. If there are no routes, nil is placed in this channel.

var activeRouteIndex

The channel through which you can monitor updates of the active route index. If there are no routes, nil is placed in this channel.