NavigationMapView

 
open class NavigationMapView : UIView

NavigationMapView is a subclass of UIView, which draws MapView on its surface and provides convenience functions for adding Route lines to a map.

Class constants

  • The minimum preferred frames per second at which to render map animations.

    This property takes effect when the application has limited resources for animation, such as when the device is running on battery power. By default, this property is set to PreferredFPS.normal.

    Declaration

    Swift

    public var minimumFramesPerSecond: PreferredFPS
    View Source on GitHub

  • Maximum distance the user can tap for a selection to be valid when selecting an alternate route.

    Declaration

    Swift

    public var tapGestureDistanceThreshold: CGFloat
    View Source on GitHub

  • A collection of street road classes for which a congestion level substitution should occur.

    For any street road class included in the roadClassesWithOverriddenCongestionLevels, all route segments with an CongestionLevel.unknown traffic congestion level and a matching MapboxDirections.MapboxStreetsRoadClass will be replaced with the CongestionLevel.low congestion level.

    Declaration

    Swift

    public var roadClassesWithOverriddenCongestionLevels: Set<MapboxStreetsRoadClass>?
    View Source on GitHub

  • NavigationCamera, which allows to control camera states.

    Declaration

    Swift

    public private(set) var navigationCamera: NavigationCamera! { get }
    View Source on GitHub

  • Controls whether to show congestion levels on alternative route lines. Defaults to false.

    If true and there’re multiple routes to choose, the alternative route lines would display the congestion levels at different colors, similar to the main route. To customize the congestion colors that represent different congestion levels, override the alternativeTrafficUnknownColor, alternativeTrafficLowColor, alternativeTrafficModerateColor, alternativeTrafficHeavyColor, alternativeTrafficSevereColor property for the NavigationMapView.appearance().

    Declaration

    Swift

    public var showsCongestionForAlternativeRoutes: Bool
    View Source on GitHub

  • MapView, which is added on top of NavigationMapView and allows to render navigation related components.

    Declaration

    Swift

    public private(set) var mapView: MapView! { get }
    View Source on GitHub

  • The object that acts as the navigation delegate of the map view.

    Declaration

    Swift

    public weak var delegate: NavigationMapViewDelegate?
    View Source on GitHub

  • A type that represents a UIView that is CourseUpdatable.

    Declaration

    Swift

    public typealias UserCourseView = UIView & CourseUpdatable
    View Source on GitHub

  • A UserCourseView used to indicate the user’s location and course on the map.

    The UserCourseView‘s UserCourseView.update(location:pitch:direction:animated:) method is frequently called to ensure that its visual appearance matches the map’s camera.

    Declaration

    Swift

    public var userCourseView: UserCourseView { get set }
    View Source on GitHub

  • A TileStore instance used by map view.

    Declaration

    Swift

    open var mapTileStore: TileStore? { get }
    View Source on GitHub

  • Initializes a newly allocated NavigationMapView object with the specified frame rectangle.

    Declaration

    Swift

    public override init(frame: CGRect)

    Parameters

    frame

    The frame rectangle for the NavigationMapView.
    View Source on GitHub

  • Initializes a newly allocated NavigationMapView object with the specified frame rectangle and type of NavigationCamera.

    Declaration

    Swift

    public init(frame: CGRect, navigationCameraType: NavigationCameraType = .mobile)

    Parameters

    frame

    The frame rectangle for the NavigationMapView.
    navigationCameraType

    Type of NavigationCamera, which is used for the current instance of NavigationMapView.
    View Source on GitHub

  • Returns a NavigationMapView object initialized from data in a given unarchiver.

    Declaration

    Swift

    public required init?(coder: NSCoder)

    Parameters

    coder

    An unarchiver object.
    View Source on GitHub

  • Setups the Predictive Caching mechanism using provided Options.

    This will handle all the required manipulations to enable the feature and maintain it during the navigations. Once enabled, it will be present as long as NavigationMapView is retained. If NavigationMapView was not configured to maintain a tile storage - this function does nothing.

    Declaration

    Swift

    public func enablePredictiveCaching(options predictiveCacheOptions: PredictiveCacheOptions)

    Parameters

    options

    options, controlling caching parameters like area radius and concurrent downloading threads.
    View Source on GitHub

Overridden methods

  • Updates the map view’s preferred frames per second to the appropriate value for the current route progress.

    This method accounts for the proximity to a maneuver and the current power source. It has no effect if NavigationCameraState is in .following mode.

    Declaration

    Swift

    public func updatePreferredFrameRate(for routeProgress: RouteProgress)

    Parameters

    routeProgress

    Object, which stores current progress along specific route.
    View Source on GitHub

User tracking methods

Feature addition/removal properties and methods

  • Showcases route array. Adds routes and waypoints to map, and sets camera to point encompassing the route.

    Declaration

    Swift

    public func showcase(_ routes: [Route], animated: Bool = false)

    Parameters

    routes

    List of Route objects, which will be shown on MapView.
    animated

    Property, which determines whether camera movement will be animated while fitting first route.
    View Source on GitHub

  • Adds the route waypoints to the map given the current leg index. Previous waypoints for completed legs will be omitted.

    Declaration

    Swift

    public func showWaypoints(on route: Route, legIndex: Int = 0)

    Parameters

    route

    Route, on which a certain Waypoint will be shown.
    legIndex

    Index, which determines for which RouteLeg Waypoint will be shown.
    View Source on GitHub

  • Removes all existing Route objects from MapView, which were added by NavigationMapView.

    Declaration

    Swift

    public func removeRoutes()
    View Source on GitHub

  • Removes all existing Waypoint objects from MapView, which were added by NavigationMapView.

    Declaration

    Swift

    public func removeWaypoints()
    View Source on GitHub

  • Shows the step arrow given the current RouteProgress.

    Declaration

    Swift

    public func addArrow(route: Route, legIndex: Int, stepIndex: Int)

    Parameters

    route

    Route object, for which maneuver arrows will be shown.
    legIndex

    Zero-based index of the RouteLeg which contains the maneuver.
    stepIndex

    Zero-based index of the RouteStep which contains the maneuver.
    View Source on GitHub

  • Removes the RouteStep arrow from the MapView.

    Declaration

    Swift

    public func removeArrow()
    View Source on GitHub

  • Shows voice instructions for specific Route object.

    Declaration

    Swift

    public func showVoiceInstructionsOnMap(route: Route)

    Parameters

    route

    Route object, along which voice instructions will be shown.
    View Source on GitHub

Building Extrusion Highlighting methods

  • Receives coordinates for searching the map for buildings. If buildings are found, they will be highlighted in 2D or 3D depending on the in3D value.

    Declaration

    Swift

    public func highlightBuildings(at coordinates: [CLLocationCoordinate2D],
                               in3D extrudesBuildings: Bool = true,
                               completion: ((_ foundAllBuildings: Bool) -> Void)? = nil)

    Parameters

    coordinates

    Coordinates which represent building locations.
    extrudesBuildings

    Switch which allows to highlight buildings in either 2D or 3D. Defaults to true.
    completion

    An escaping closure to be executed when the MapView feature querying for all coordinates ends. A single Boolean argument in closure indicates whether or not buildings were found for all coordinates.
    View Source on GitHub

  • Removes the highlight from all buildings highlighted by highlightBuildings(at:in3D:).

    Declaration

    Swift

    public func unhighlightBuildings()
    View Source on GitHub

Vanishing route line methods