RouteEditorSource | iOS SDK | 2GIS 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
)

Enables or disables the display of routes on the map.

Parameters
visible
public func setShowOnlyActiveRoute(
    showOnlyActiveRoute: Bool
)

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

Parameters
showOnlyActiveRoute
public func setPassedDistanceVisualization(
    passedDistanceVisualization: RouteMapObjectPassedDistanceVisualization
)

Changes 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 to display the active route. See IRouteMapObject::display_flags.

var inactiveDisplayFlags

Flags to display inactive routes. See IRouteMapObject::display_flags.

var activeCalloutLabelFlags

Flags that enable the display of the contents of the active route bubbles. See IRouteMapObject::callout_label_flags.

var inactiveCalloutLabelFlags

Flags that enable the display of the contents of inactive routes. See IRouteMapObject::callout_label_flags.

var calloutLabelDisplayMode

Mode of displaying the contents of route bubbles. See IRouteMapObject::callout_label_display_mode.

var activePermanentDisplayFlags

Flags that prevent components of the active route from being hidden on the map. See IRouteMapObject::permanent_display_flags.

var inactivePermanentDisplayFlags

Flags that prevent components of inactive routes from being hidden on the map. See IRouteMapObject::permanent_display_flags.