2Gis Full SDK for Compose/ru.dgis.sdk.compose.routeeditor

Package-level declarations

Types

class BriefRouteDurationProvider(trafficRouter: TrafficRouter, coroutineDispatcher: CoroutineDispatcher = Dispatchers.IO)

Provider for fetching ETA (Estimated Time of Arrival) for different transport modes using brief route information.

DefaultRouteEditorViewModel

@Stable

class DefaultRouteEditorViewModel(val routeEditor: RouteEditor, val allowedTransportTypes: EnumSet<TransportMode> = EnumSet.allOf(TransportMode::class.java), val briefRouteDurationProvider: BriefRouteDurationProvider? = null, val routeSearchOptionsProvider: RouteSearchOptionsProvider = DefaultRouteSearchOptionsProvider, val onStartNavigation: (TrafficRoute, RouteBuildOptions) -> Unit = { _, _ -> }) : RouteEditorViewModel, Closeable

DefaultRouteSearchOptionsProvider

object DefaultRouteSearchOptionsProvider : RouteSearchOptionsProvider

Default implementation of RouteSearchOptionsProvider that uses standard SDK options for all transport modes.

FeatureType

enum FeatureType : Enum<FeatureType>

Types of route features with associated visual properties and priority Priority order matches the design specification from highest to lowest

RouteCardColors

@Immutable

data class RouteCardColors(val cardBackground: Color = RouteEditorColors.SurfaceWhite, val primaryText: Color = RouteEditorColors.PrimaryText, val secondaryText: Color = RouteEditorColors.SecondaryText, val buttonBackground: Color = RouteEditorColors.Primary, val buttonText: Color = RouteEditorColors.SurfaceWhite)

Color scheme for route cards

RouteCardDimensions

object RouteCardDimensions

Dimensions for route card components

RouteEditorColors

object RouteEditorColors

Brand colors used throughout the application

RouteEditorComposableColors

@Immutable

data class RouteEditorComposableColors(val routePointsDisplayColors: RoutePointsDisplayColors, val transportationModesColors: TransportationModesColors, val routeCardColors: RouteCardColors, val bottomSheetSurfaceColor: Color)

Aggregated colors for the RouteEditorComposable and its children

RouteEditorTextStyles

@Immutable

data class RouteEditorTextStyles(val Primary: TextStyle = TextStyle( fontSize = 19.sp, fontWeight = FontWeight.Medium, // 500 color = RouteEditorColors.PrimaryText, ), val Secondary: TextStyle = TextStyle( fontSize = 15.sp, fontWeight = FontWeight.Normal, // 400 color = RouteEditorColors.SecondaryText, ), val ETA: TextStyle = TextStyle( fontSize = 14.sp, fontWeight = FontWeight.Medium, color = RouteEditorColors.PrimaryText, ))

Brand text styles with consistent typography

RouteEditorUiState

@Immutable

data class RouteEditorUiState(val startPointTitle: String = "--", val destinationPointTitle: String = "--", val routes: List<RouteUiInfo> = emptyList(), val selectedTransportMode: TransportMode = TransportMode.CAR, val selectedRouteIndex: Long? = null, val intermediatePoints: List<UiIntermediateRoutePoint> = emptyList(), val durations: Map<TransportMode, Duration?> = emptyMap(), val allowedTransportTypes: EnumSet<TransportMode> = EnumSet.allOf(TransportMode::class.java))

RouteEditorViewModel

interface RouteEditorViewModel

ViewModel for managing route planning and editing functionality.

RouteFeature

@Immutable

data class RouteFeature(val type: FeatureType, val quantity: Int? = null)

Represents a feature or attribute of a route (e.g., traffic, tolls, accidents, road conditions)

RoutePointsDisplayColors

@Immutable

data class RoutePointsDisplayColors(val background: Color = RouteEditorColors.SurfaceWhite, val surfaceWhite: Color = RouteEditorColors.SurfaceWhite, val listBackground: Color = Color(0xFFF5F5F5), val divider: Color = Color(0xFFE0E0E0), val draggingBackground: Color = Color(0xFFEEEEEE), val primaryGreen: Color = RouteEditorColors.Primary, val primaryText: Color = Color.Black, val secondaryText: Color = Color.Gray, val startPointIcon: Color = RouteEditorColors.Primary, val endPointIcon: Color = RouteEditorColors.Accent, val intermediatePointIcon: Color = RouteEditorColors.Accent, val removeButtonTint: Color = RouteEditorColors.IconFill, val dragHandleTint: Color = Color.Gray, val verticalConnector: Color = Color(0xFFDDDDDD), val iconBackground: Color = RouteEditorColors.IconBackground)

RouteSearchOptionsProvider

interface RouteSearchOptionsProvider

Provider interface for creating route search options for different transport modes. Each method has a default implementation that can be overridden to customize routing behavior for specific transport modes.

RouteUiInfo

@Immutable

data class RouteUiInfo(val duration: Duration, val distanceMeters: Int, @StringRes val descriptionRes: Int, val features: List<RouteFeature> = emptyList())

Data class representing route information

RouteUiPoint

@Immutable

data class RouteUiPoint(val routeSearchPoint: RouteSearchPoint, val label: String? = null)

Represents a route point with an optional custom label for display in the UI.

TransportationModesColors

@Immutable

data class TransportationModesColors(val background: Color = RouteEditorColors.BackgroundGrey, val selectedItemBackground: Color = RouteEditorColors.SurfaceWhite, val unselectedItemBackground: Color = Color.Transparent, val selectedIconTint: Color = RouteEditorTextStyles.default.Primary.color, val unselectedIconTint: Color = RouteEditorTextStyles.default.Secondary.color, val selectedTextColor: Color = RouteEditorTextStyles.default.Primary.color, val unselectedTextColor: Color = RouteEditorTextStyles.default.Secondary.color, val selectedTransportTypeBorderColor: Color = RouteEditorColors.Primary)

Color scheme for transportation modes components

TransportMode

@Immutable

enum TransportMode : Enum<TransportMode>

Transportation mode options with drawable resources

UiIntermediateRoutePoint

@Immutable

data class UiIntermediateRoutePoint(val title: String, val idx: Int)

Functions

ExpandedRoutePointsDarkPreview

@Preview(name = "Expanded - Dark", showBackground = true, heightDp = 600, uiMode = 32)