ru.dgis.sdk.map.RouteEditorSource | Android SDK | 2GIS Documentation
Android SDK
Maps
Search
Navigation
On-Premise
Urbi Pro

RouteEditorSource

Interface of the class that controls the display of routes on the map.

Extends: ru.dgis.sdk.map.Source
RouteEditorSource(
	context: Context,
	routeEditor: RouteEditor,
	activeDisplayFlags: EnumSet?<RouteMapObjectDisplayFlag> = null,
	inactiveDisplayFlags: EnumSet?<RouteMapObjectDisplayFlag> = null,
	activeCalloutLabelFlags: EnumSet?<RouteMapObjectCalloutLabelFlag> = null,
	inactiveCalloutLabelFlags: EnumSet?<RouteMapObjectCalloutLabelFlag> = null,
	calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.ABSOLUTE_VALUES,
	activePermanentDisplayFlags: EnumSet?<RouteMapObjectPermanentDisplayFlag> = null,
	inactivePermanentDisplayFlags: EnumSet?<RouteMapObjectPermanentDisplayFlag> = null
)

Function to create IRouteEditorSource.

Parameters
context
routeEditor
activeDisplayFlags
inactiveDisplayFlags
activeCalloutLabelFlags
inactiveCalloutLabelFlags
calloutLabelDisplayMode
activePermanentDisplayFlags
inactivePermanentDisplayFlags
Returns
Methods
fun setRoutesVisible(visible: Boolean): Unit

Enable or disable the routes display on the map.

Parameters
visible
Returns
fun setShowOnlyActiveRoute(showOnlyActiveRoute: Boolean): Unit

Show all routes on the map (false) or only the current active route (true).

Parameters
showOnlyActiveRoute
Returns
fun setPassedDistanceVisualization(passedDistanceVisualization: RouteMapObjectPassedDistanceVisualization): Unit

Change how distance traveled along a route is visualized.

Parameters
passedDistanceVisualization
Returns
Properties
val objects

Route objects on the map.

val routeSourceSettings

Settings for displaying maneuvers on the route.

var activeDisplayFlags

Display flags for the active route. See IRouteMapObject::display_flags.

var inactiveDisplayFlags

Display flags for inactive routes. See IRouteMapObject::display_flags.

var activeCalloutLabelFlags

Flags enabling the display of content in callouts for inactive routes. See IRouteMapObject::callout_label_flags.

var inactiveCalloutLabelFlags

Flags enabling the display of content in callouts for inactive routes. See IRouteMapObject::callout_label_flags.

var calloutLabelDisplayMode

Display mode for values in route callouts. See IRouteMapObject::callout_label_display_mode.

var activePermanentDisplayFlags

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

var inactivePermanentDisplayFlags

Flags excluding the hiding of components of inactive routes from the map. See IRouteMapObject::permanent_display_flags.