RouteMapObject | iOS SDK | 2GIS Documentation
iOS SDK
Maps
Search
Navigation
On-Premise
Urbi Pro
CityLens
Account

RouteMapObject

Route object on the map.

Extends: MapObject
public convenience init(
    trafficRoute: TrafficRoute,
    isActive: Bool,
    index: RouteIndex,
    displayFlags: RouteMapObjectDisplayFlagOptionSet? = nil,
    calloutLabelFlags: RouteMapObjectCalloutLabelFlagOptionSet? = nil,
    calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.absoluteValues,
    permanentDisplayFlags: RouteMapObjectPermanentDisplayFlagOptionSet? = nil
)
Parameters
trafficRoute
isActive
index
displayFlags
calloutLabelFlags
calloutLabelDisplayMode
permanentDisplayFlags
Properties
var displayFlagsChannel
StatefulChannel<RouteMapObjectDisplayFlagOptionSet?>

Set of flags for displaying different parts of the route. If not specified, the display logic based on the activity status of the route is used.

var displayFlags

Set of flags for displaying different parts of the route. If not specified, the display logic based on the activity status of the route is used.

var permanentDisplayFlagsChannel
StatefulChannel<RouteMapObjectPermanentDisplayFlagOptionSet?>

Set of flags to prevent different parts of the route from being hidden from the map when you update the distance traveled along the route. If not set, all route elements that fall within the non-displayed part of the route are hidden from the map when you update the distance traveled along the route.

var permanentDisplayFlags

Set of flags to prevent different parts of the route from being hidden from the map when you update the distance traveled along the route. If not set, all route elements that fall within the non-displayed part of the route are hidden from the map when you update the distance traveled along the route.

var isActiveChannel
StatefulChannel<Bool>

Route activity status.

var isActive

Route activity status.

var route
var routeIndex

Route index in the route editor.

var passedDistanceChannel
StatefulChannel<RouteDistance>

Distance traveled along the route.

var passedDistance

Distance traveled along the route.

var passedDistanceVisualizationChannel
StatefulChannel<RouteMapObjectPassedDistanceVisualization>
var passedDistanceVisualization
var calloutPositionChannel
StatefulChannel<[CalloutMapPosition]>

Route bubble position.

var calloutPosition

Route bubble position.

var calloutLabelFlagsChannel
StatefulChannel<RouteMapObjectCalloutLabelFlagOptionSet?>

Set of flags to display the contents of the route's bubble. If not set, then for the active route both route time and its length are displayed, and only the travel time is displayed for inactive routes.

var calloutLabelFlags

Set of flags to display the contents of the route's bubble. If not set, then for the active route both route time and its length are displayed, and only the travel time is displayed for inactive routes.

var calloutLabelDisplayModeChannel
StatefulChannel<RouteMapObjectCalloutLabelDisplayMode>

Mode of displaying values in the route's bubbles. By default, values are displayed as absolute magnitudes.

var calloutLabelDisplayMode

Mode of displaying values in the route's bubbles. By default, values are displayed as absolute magnitudes.

var lanesCalloutPositionsChannel
StatefulChannel<[LanesCalloutMapPosition]>

Lane bubbles positions. Only actual positions are returned for the current distance traveled along the route and only if the source, in which the object is placed, is working in navigation mode.

var lanesCalloutPositions

Lane bubbles positions. Only actual positions are returned for the current distance traveled along the route and only if the source, in which the object is placed, is working in navigation mode.