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

RouteEditorViewModel

interface RouteEditorViewModel

ViewModel for managing route planning and editing functionality.

Provides methods for configuring route points, selecting transport modes, managing multiple route options, and initiating navigation. The UI state is exposed as a State that can be observed for changes.

Use DefaultRouteEditorViewModel for the default implementation with support for multiple transport modes, ETA calculations, and customizable route search options.

Inheritors

DefaultRouteEditorViewModel

Properties

abstract val uiState: State<RouteEditorUiState>

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

Functions

onIntermediatePointsChanged

open fun onIntermediatePointsChanged(points: List<UiIntermediateRoutePoint>)

Updates the order of intermediate points and recalculates the route.

onStartNavigation

open fun onStartNavigation()

Initiates navigation with the currently selected route.

open fun selectRoute(index: Int)

Selects a route from the list of calculated route options.

selectTransportMode

open fun selectTransportMode(mode: TransportMode)

Changes the transport mode and recalculates the route.

open fun setPoints(startPoint: RouteUiPoint, finishPoint: RouteUiPoint, intermediatePoints: List<RouteUiPoint> = emptyList(), mode: TransportMode? = null)

Sets the route points and optionally the transport mode.

swapStartAndDestinationPoints

open fun swapStartAndDestinationPoints()

Swaps the start and destination points and recalculates the route.