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

RouteEditorSource

Interface of the class that controls 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
)

IRouteEditorSource creation function.

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 on the map (false) or only the currently active route (true).

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

Active route display flags. See IRouteMapObject::display_flags.t::display_flags.

var inactiveDisplayFlags

Inactive route display flags. See IRouteMapObject::display_flags.t::display_flags.

var activeCalloutLabelFlags

Flags to enable displaying content in the active route's callouts. See IRouteMapObject::callout_label_flags.t::callout_label_flags.

var inactiveCalloutLabelFlags

Flags to include displaying content in inactive route's callouts. See IRouteMapObject::callout_label_flags.t::callout_label_flags.

var calloutLabelDisplayMode

Mode for displaying values in route callouts. See IRouteMapObject::callout_label_display_mode.t::callout_label_display_mode.

var activePermanentDisplayFlags

Flags to prevent components of an active route from being hidden from the map. See IRouteMapObject::permanent_display_flags.t::permanent_display_flags.

var inactivePermanentDisplayFlags

Flags that exclude inactive route components from hiding from the map. See IRouteMapObject::permanent_display_flags.t::permanent_display_flags.