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

RouteMapObject

Route object on the map.

Extends: ru.dgis.sdk.map.MapObject
RouteMapObject(
	trafficRoute: TrafficRoute,
	isActive: Boolean,
	index: RouteIndex,
	displayFlags: EnumSet?<RouteMapObjectDisplayFlag> = null,
	calloutLabelFlags: EnumSet?<RouteMapObjectCalloutLabelFlag> = null,
	calloutLabelDisplayMode: RouteMapObjectCalloutLabelDisplayMode = RouteMapObjectCalloutLabelDisplayMode.ABSOLUTE_VALUES,
	permanentDisplayFlags: EnumSet?<RouteMapObjectPermanentDisplayFlag> = null
)
Parameters
trafficRoute
isActive
index
displayFlags
calloutLabelFlags
calloutLabelDisplayMode
permanentDisplayFlags
Returns
Properties
val displayFlagsChannel

Set of flags to display various parts of the route. If not specified, display logic based on the activity status of the route is used.

var displayFlags

Set of flags to display various parts of the route. If not specified, display logic based on the activity status of the route is used.

val permanentDisplayFlagsChannel

Set of flags to prevent various parts of the route from being hidden from the map when updating the distance traveled along the route. If not specified, then when updating the distance traveled along the route, all route elements that fall into the undisplayed part of the route are hidden from the map.

var permanentDisplayFlags

Set of flags to prevent various parts of the route from being hidden from the map when updating the distance traveled along the route. If not specified, then when updating the distance traveled along the route, all route elements that fall into the undisplayed part of the route are hidden from the map.

val isActiveChannel

Route activity status.

var isActive

Route activity status.

val route
val routeIndex

Route index in the route editor.

val passedDistanceChannel

Distance traveled along the route.

var passedDistance

Distance traveled along the route.

val passedDistanceVisualizationChannel
var passedDistanceVisualization
val calloutPositionChannel
val calloutPosition

Route callout position.

val calloutLabelFlagsChannel

Set of flags for displaying the contents of the route callouts. If not specified, both the time of movement along the route and its length are displayed for the active route, and only the time of movement for inactive routes.

var calloutLabelFlags

Set of flags for displaying the contents of the route callouts. If not specified, both the time of movement along the route and its length are displayed for the active route, and only the time of movement for inactive routes.

val calloutLabelDisplayModeChannel

Mode for displaying values in route callouts. By default, values are displayed as absolute values.

var calloutLabelDisplayMode

Mode for displaying values in route callouts. By default, values are displayed as absolute values.

val lanesCalloutPositionsChannel

Lane callout positions. Only relevant positions are returned for the current distance traveled along the route, and only if the source where the object is placed is in navigation mode.

val lanesCalloutPositions

Lane callout positions. Only relevant positions are returned for the current distance traveled along the route, and only if the source where the object is placed is in navigation mode.