Preview

Customization options for the navigation preview user experience in a PreviewViewController.

See more

public struct PreviewOptions

PreviewViewController is a user interface for the preview mode experience. It allows to present banners that contain information that is important for the user before actually starting turn-by-turn navigation session (e.g. final destination presentation, main and alternative routes preview etc). By default Mapbox Navigation SDK provides such banners:

• DestinationPreviewViewController - banner that is shown at the bottom of the screen and allows to show information about the final destination, preview available routes and start active navigation session
• RoutePreviewViewController - banner that is shown at the bottom of the screen and allows to preview information about the current Route (expected travel time, distance and expected time of arrival)
• BannerDismissalViewController - banner that is shown at the top of the screen and allows to dismiss already presented banner

Internally PreviewViewController relies on two components:

• NavigationMapView - wraps MapView and provides convenience functions for adding and removing route lines, route duration annotations, shows user location indicator etc
• NavigationView - wraps NavigationMapView and provides the ability to show drop-in related UI components like SpeedLimitView, WayNameView, top and bottom BannerContainerViews etc

PreviewViewController works as an initial step before switching to the active navigation. Use NavigationViewController for turn-by-turn navigation experience.

See more

public class PreviewViewController : UIViewController

extension PreviewViewController: StyleManagerDelegate

PreviewViewControllerDelegate allows to observe Banner presentation and dismissal events.

See more

public protocol PreviewViewControllerDelegate : AnyObject, UnimplementedLogging

A banner protocol provides the ability to show content inside NavigationView. Components that conform to Banner protocol must be instances of the UIViewController. Banners are injected into BannerContainerView and can have various properties: can be shown at the top or at the bottom of the screen, can be expanded and collapsed and can have custom height.

By default Mapbox Navigation SDK provides several default banners:

• DestinationPreviewViewController - banner that is shown at the bottom of the screen and allows to show information about the final destination, preview available routes and start active navigation session
• RoutePreviewViewController - banner that is shown at the bottom of the screen and allows to preview information about the current Route (expected travel time, distance and expected time of arrival)
• BannerDismissalViewController - banner that is shown at the top of the screen and allows to dismiss already presented banner

See more

public protocol Banner : UIViewController

Configuration of the banner that allows to change its default behavior.

See more

public struct BannerConfiguration

Banner that is shown at the top of the screen and allows to dismiss already presented banners that were added to the PreviewViewController.

See more

public class BannerDismissalViewController : UIViewController, Banner

The interface for an object that serves as the banner dismissal delegate.

See more

public protocol BannerDismissalViewControllerDelegate : AnyObject

Banner that is shown at the bottom of the screen and allows to show final destination information in PreviewViewController.

See more

public class DestinationPreviewViewController : UIViewController, Banner, DestinationDataSource

The interface for an object that serves as the destination preview delegate.

See more

public protocol DestinationPreviewViewControllerDelegate : AnyObject

Customization options for the destination(s) preview using DestinationPreviewViewController banner.

See more

public struct DestinationOptions

A protocol, that allows to provide destination information.

Banner instances should conform to this protocol, to provide the options that are required for the destination presentation in the PreviewViewController.

By default Mapbox Navigation SDK provides DestinationPreviewViewController that conforms to this protocol and allows to present banner that shows final destination related information.

See more

public protocol DestinationDataSource : AnyObject

Banner that is shown at the bottom of the screen and allows to show route-related information in PreviewViewController.

See more

public class RoutePreviewViewController : UIViewController, Banner, RoutePreviewDataSource

The interface for an object that serves as the routes preview delegate.

See more

public protocol RoutePreviewViewControllerDelegate : AnyObject

Customization options for the routes(s) preview using RoutePreviewViewController banner.

See more

public struct RoutePreviewOptions

A protocol, that allows to provide routes related information.

Banner instances should conform to this protocol, to provide the options that are required for the route(s) presentation in the PreviewViewController.

By default Mapbox Navigation SDK provides RoutePreviewViewController that conforms to this protocol and allows to present banner that shows route related information (expected travel time, arrival time and duration).

See more

public protocol RoutePreviewDataSource : AnyObject