RouteEditorSource | iOS SDK | Urbi Documentation
iOS SDK
Maps
Search
Navigation
Urbi Pro
CityLens
On‑Premise
Account

RouteEditorSource

Interface of the class managing the display of routes on the map.

Extends: Source
public convenience init(
    context: Context,
    routeEditor: RouteEditor,
    activeDisplayFlags: RouteMapObjectDisplayFlagOptionSet? = nil,
    inactiveDisplayFlags: RouteMapObjectDisplayFlagOptionSet? = nil,
    activeCalloutLabelFlags: RouteMapObjectCalloutLabelFlagOptionSet? = nil,
    inactiveCalloutLabelFlags: RouteMapObjectCalloutLabelFlagOptionSet? = nil,
    calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.absoluteValues,
    activePermanentDisplayFlags: RouteMapObjectPermanentDisplayFlagOptionSet? = nil,
    inactivePermanentDisplayFlags: RouteMapObjectPermanentDisplayFlagOptionSet? = nil
)

Function to create IRouteEditorSource

Parameters
context
routeEditor
activeDisplayFlags
inactiveDisplayFlags
activeCalloutLabelFlags
inactiveCalloutLabelFlags
calloutLabelDisplayMode
activePermanentDisplayFlags
inactivePermanentDisplayFlags
Methods
public func setRoutesVisible(
    visible: Bool
)

Enable or disable the display of routes on the map.

Parameters
visible
public func setShowOnlyActiveRoute(
    showOnlyActiveRoute: Bool
)

Display all routes (false) or only the currently active one (true) on the map.

Parameters
showOnlyActiveRoute
public func setPassedDistanceVisualization(
    passedDistanceVisualization: RouteMapObjectPassedDistanceVisualization
)

Change the way to visualize the distance traveled along the route.

Parameters
passedDistanceVisualization
Properties
var objects

Objects of the route on the map.

var routeSourceSettings

Settings for displaying maneuvers on the route.

var activeDisplayFlags

Flags for displaying the active route. See IRouteMapObject::display_flags.

var inactiveDisplayFlags

Flags for displaying inactive routes. See IRouteMapObject::display_flags.

var activeCalloutLabelFlags

Flags that enable the display of content in the callouts of the active route. See IRouteMapObject::callout_label_flags.

var inactiveCalloutLabelFlags

Flags that enable displaying content in the callouts of inactive route. See IRouteMapObject::callout_label_flags.

var calloutLabelDisplayMode

The mode of displaying values in the route callouts. See IRouteMapObject::callout_label_display_mode.

var activePermanentDisplayFlags

Flags that exclude hiding components of the active route from the map. See IRouteMapObject::permanent_display_flags.

var inactivePermanentDisplayFlags

Flags that exclude hiding components of the active route from the map. See IRouteMapObject::permanent_display_flags.