RouteOptionsV4

 
open class RouteOptionsV4: RouteOptions

A RouteOptionsV4 object is a structure that specifies the criteria for results returned by the Mapbox Directions API v4.

Pass an instance of this class into the Directions.calculate(_:completionHandler:) method.

Specifying the Response Format

  • The format of the returned route steps’ instructions.

    By default, the value of this property is text, specifying plain text instructions.

    Declaration

    Swift

    open var instructionFormat: InstructionFormat = .text
    View Source on GitHub

  • A Boolean value indicating whether the returned routes and their route steps should include any geographic coordinate data.

    If the value of this property is true, the returned routes and their route steps include coordinates; if the value of this property is `false, they do not.

    The default value of this property is true.

    Declaration

    Swift

    open var includesShapes: Bool = true
    View Source on GitHub