Skip to content

Function: clearRoute()

ts
function clearRoute(): Promise<void>;

Clear the active route.

Clears the currently displayed route/directions and resets the itinerary state (destination set + routing options revert to the configured defaults). Equivalent to the user clicking the navigation "back" button inside the map iframe, but invokable programmatically.

Idempotent: safe to call when no route is active.

Returns

Promise<void>

Throws

MAPSTED-1090 when the API is not READY.