Install in Dash
VisualInstructionBanner Class Reference
VisualInstructionBanner
open class VisualInstructionBanner: NSObject, NSSecureCodingA visual instruction banner contains all the information necessary for creating a visual cue about a given RouteStep.
-
The distance at which the visual instruction should be shown, measured in meters from the beginning of the step.
Declaration
Swift
@objc public let distanceAlongStep: CLLocationDistance -
The most important information to convey to the user about the
RouteStep.Declaration
Swift
@objc public let primaryInstruction: VisualInstruction -
Less important details about the
RouteStep.Declaration
Swift
@objc public let secondaryInstruction: VisualInstruction? -
Which side of a bidirectional road the driver should drive on, also known as the rule of the road.
Declaration
Swift
@objc public var drivingSide: DrivingSide -
Initializes a new visual instruction banner object based on the given JSON dictionary representation and a driving side.
Declaration
Swift
public convenience init(json: [String: Any], drivingSide: DrivingSide)Parameters
jsonA JSON object that conforms to the primary or secondary banner format described in the Directions API documentation.
drivingSideThe side of the road the user should drive on. This value should be consistent with the containing route step.
-
Initializes a new visual instruction banner object that displays the given information.
Declaration
Swift
@objc public init(distanceAlongStep: CLLocationDistance, primaryInstruction: VisualInstruction, secondaryInstruction: VisualInstruction?, drivingSide: DrivingSide)Parameters
distanceAlongStepThe distance at which the visual instruction should be shown, measured in meters from the beginning of the step.
primaryInstructionThe most important information to convey to the user about the
RouteStep.secondaryInstructionLess important details about the
RouteStep.drivingSideWhich side of a bidirectional road the driver should drive on.
View Source on GitHub