Variable MapboxNavigationConst

Type Declaration

• addCircleLayer: function

  • addCircleLayer(id: string, options: CircleLayerOptions): Promise<void>

    Adds a circle layer to the map backed by a GeoJSON source.

    Parameters

    • id: string

      Unique layer identifier.

    • options: CircleLayerOptions

      Layer options including source ID and paint properties.

    Returns Promise<void>

• addGeoJsonSource: function

  • addGeoJsonSource(id: string, options: GeoJsonSourceOptions): Promise<void>

    Adds a GeoJSON data source to the map.

    Parameters

    • id: string

      Unique source identifier.

    • options: GeoJsonSourceOptions

      GeoJSON data to add.

    Returns Promise<void>

• addImage: function

  • addImage(id: string, uri: string): Promise<void>

    Adds an image asset to the map style for use in symbol layers.

    Parameters

    • id: string

      Unique image identifier.

    • uri: string

      HTTP/HTTPS URL or local file URI of the image.

    Returns Promise<void>

• addLineLayer: function

  • addLineLayer(id: string, options: LineLayerOptions): Promise<void>

    Adds a line layer to the map backed by a GeoJSON source.

    Parameters

    • id: string

      Unique layer identifier.

    • options: LineLayerOptions

      Layer options including source ID and paint properties.

    Returns Promise<void>

• configureTts: function

  • configureTts(options: ConfigureTtsOptions): Promise<void>

    Configures text-to-speech playback settings.

    Parameters

    • options: ConfigureTtsOptions

      TTS options (volume, rate, engine, etc.).

    Returns Promise<void>

    Throws

    DirectionsError When configuration fails.

• getCurrentLocation: function

  • getCurrentLocation(): Promise<{ latitude: number; longitude: number } | null>

    Returns the current map-matched GPS location, if available.

    Returns Promise<{ latitude: number; longitude: number } | null>

    Latitude/longitude, or null when no location is available.

• getLocationPermissionStatus: function

  • getLocationPermissionStatus(): LocationPermissionStatus

    Returns the current location permission status synchronously.

    Returns LocationPermissionStatus

    The current permission status.

• getSessionState: function

  • getSessionState(): Promise<SessionState>

    Returns the current session state.

    Returns Promise<SessionState>

    One of 'idle', 'freeDrive', or 'activeGuidance'.

• navigateNextLeg: function

  • navigateNextLeg(): Promise<void>

    Advances navigation to the next leg of a multi-leg route.

    Returns Promise<void>

    Throws

    DirectionsError When advancement fails.

• pauseFreeDrive: function

  • pauseFreeDrive(): Promise<void>

    Pauses the current free drive session.

    Returns Promise<void>

• pauseRouteRefresh: function

  • pauseRouteRefresh(): Promise<void>

    Pauses automatic background route refresh.

    Returns Promise<void>

• refreshRouteNow: function

  • refreshRouteNow(): Promise<void>

    Triggers an immediate route refresh to update traffic and ETA data.

    Returns Promise<void>

• removeImage: function

  • removeImage(id: string): Promise<void>

    Removes a previously added image from the map style.

    Parameters

    • id: string

      Image identifier to remove.

    Returns Promise<void>

• removeLayer: function

  • removeLayer(id: string): Promise<void>

    Removes a previously added layer from the map.

    Parameters

    • id: string

      Layer identifier to remove.

    Returns Promise<void>

• removeSource: function

  • removeSource(id: string): Promise<void>

    Removes a previously added GeoJSON source from the map.

    Parameters

    • id: string

      Source identifier to remove.

    Returns Promise<void>

• requestLocationPermission: function

  • requestLocationPermission(
        options?: RequestLocationPermissionOptions,
    ): Promise<LocationPermissionStatus>

    Requests location permission from the user.

    Parameters

    • Optionaloptions: RequestLocationPermissionOptions

      Permission options (background, precise).

    Returns Promise<LocationPermissionStatus>

    The resulting permission status.

    Throws

    DirectionsError When the request fails.

• requestRoutes: function

  • requestRoutes(options: RequestRoutesOptions): Promise<DirectionsResponse>

    Requests routes between the given waypoints.

    Parameters

    • options: RequestRoutesOptions

      Routing options including waypoints, profile, and preferences.

    Returns Promise<DirectionsResponse>

    The full Directions API response envelope.

    Throws

    DirectionsError When routing fails.

• resumeRouteRefresh: function

  • resumeRouteRefresh(): Promise<void>

    Resumes automatic background route refresh after a pause.

    Returns Promise<void>

• setAccessToken: function

  • setAccessToken(token: string): void

    Sets the Mapbox access token. Must be called before any other method.

    Parameters

    • token: string

      A valid Mapbox public access token.

    Returns void

• setCamera: function

  • setCamera(options: CameraOptions): Promise<void>

    Programmatically moves the map camera.

    Parameters

    • options: CameraOptions

      Camera target, zoom, bearing, pitch, animation duration, and padding.

    Returns Promise<void>

• setKeepScreenOn: function

  • setKeepScreenOn(enabled: boolean): void

    Keeps the screen on (or allows it to sleep) during navigation.

    Parameters

    • enabled: boolean

      true to prevent screen sleep; false to restore default.

    Returns void

• setSimulated: function

  • setSimulated(enabled: boolean, speedMultiplier?: number): Promise<void>

    Enables or disables route simulation (replaying route geometry instead of real GPS).

    Parameters

    • enabled: boolean

      true to enable simulation.

    • OptionalspeedMultiplier: number

      Playback speed. Default: 1.

    Returns Promise<void>

• startActiveGuidance: function

  • startActiveGuidance(options: StartActiveGuidanceOptions): Promise<void>

    Starts an active guidance session from a previously returned route response.

    Parameters

    • options: StartActiveGuidanceOptions

      Options including the route response and optional route index.

    Returns Promise<void>

    Throws

    DirectionsError When the session cannot be started.

• startFreeDrive: function

  • startFreeDrive(): Promise<void>

    Starts a free drive session (passive tracking without active navigation).

    Returns Promise<void>

• startHistoryRecording: function

  • startHistoryRecording(): Promise<void>

    Starts recording navigation history to a binary file.

    Returns Promise<void>

• stopHistoryRecording: function

  • stopHistoryRecording(): Promise<string>

    Stops recording navigation history and returns the path to the recorded file.

    Returns Promise<string>

    Absolute file path to the history recording.

• stopNavigation: function

  • stopNavigation(): Promise<void>

    Stops the active navigation session and returns to idle state.

    Returns Promise<void>

    Throws

    DirectionsError When stop fails.