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

DefaultRouteEditorViewModel

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

Default implementation of RouteEditorViewModel that manages the route editor UI state.

Handles route building, transport mode switching, intermediate point management, and ETA fetching. Implements Closeable — must be closed when no longer needed to release the underlying coroutine scope.

Parameters

routeEditor

the RouteEditor instance used for route building.

allowedTransportTypes

set of transport modes available in the UI.

briefRouteDurationProvider

optional provider for ETAs of non-selected transport modes.

routeSearchOptionsProvider

provider for creating route search options per transport mode.

scheduleProvider

optional provider for public transport schedule info.

onStartNavigation

callback invoked when the user starts navigation on a route.

onChangeRoute

callback invoked when the route configuration changes.

Constructors

DefaultRouteEditorViewModel

constructor(routeEditor: RouteEditor, allowedTransportTypes: EnumSet<TransportMode> = EnumSet.allOf(TransportMode::class.java), briefRouteDurationProvider: BriefRouteDurationProvider? = null, routeSearchOptionsProvider: RouteSearchOptionsProvider = DefaultRouteSearchOptionsProvider, scheduleProvider: PublicTransportScheduleProvider? = null, onStartNavigation: (TrafficRoute, RouteBuildOptions) -> Unit = { _, _ -> }, onChangeRoute: () -> Unit = { })

Properties

allowedTransportTypes

val allowedTransportTypes: EnumSet<TransportMode>

briefRouteDurationProvider

val briefRouteDurationProvider: BriefRouteDurationProvider? = null

Optional provider for fetching ETAs for non-selected transport modes. When provided, enables displaying estimated times for all transport modes in the UI. Note: This will make additional API requests which may count towards your usage quota. The currently selected transport mode's ETA is always obtained from the full route.

onStartNavigation

val onStartNavigation: (TrafficRoute, RouteBuildOptions) -> Unit

routeEditor

val routeEditor: RouteEditor

routeSearchOptionsProvider

val routeSearchOptionsProvider: RouteSearchOptionsProvider

Provider for creating route search options for different transport modes. Can be customized by implementing the interface and overriding specific methods for the transport modes that need custom routing behavior.

scheduleProvider

val scheduleProvider: PublicTransportScheduleProvider? = null

Optional provider for fetching public transport schedule information. When provided, enables async schedule loading for public transport route cards.

uiState

open override val uiState: State<RouteEditorUiState>

Current UI state containing route information, selected transport mode, point titles, and route options.