Edge

 
public struct Edge

An edge in a routing graph. For example, an edge may represent a road segment between two intersections or between the two ends of a bridge. An edge may traverse multiple road objects, and a road object may be associated with multiple edges.

An electronic horizon is a probable path (or paths) of a vehicle. The road network ahead of the user is represented as a tree of edges. Each intersection has outlet edges. In turn, each edge has a probability of transition to another edge, as well as details about the road segment that the edge traverses. You can use these details to influence application behavior based on predicted upcoming conditions.

During active turn-by-turn navigation, the user-selected route and its metadata influence the path of the electronic horizon determined by RouteController. During passive navigation (free-driving), no route is actively selected, so PassiveLocationManager will determine the most probable path from the vehicle’s current location. You can receive notifications about changes in the current state of the electronic horizon by observing the Notification.Name.electronicHorizonDidUpdatePosition, Notification.Name.electronicHorizonDidEnterRoadObject, and Notification.Name.electronicHorizonDidExitRoadObject notifications.

Use a RoadGraph object to get an edge with a given identifier.

Note

The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.

  • Unique identifier of a directed edge.

    Use a RoadGraph object to get more information about the edge with a given identifier.

    Declaration

    Swift

    public typealias Identifier = UInt
    View Source on GitHub

  • Unique identifier of the directed edge.

    Declaration

    Swift

    public let identifier: Identifier
    View Source on GitHub

  • The level of the edge.

    A value of 0 indicates that the edge is part of the most probable path (MPP), a value of 1 indicates an edge that branches away from the MPP, and so on.

    Declaration

    Swift

    public let level: UInt
    View Source on GitHub

  • The probability that the user will transition onto this edge, with 1 being certain and 0 being unlikely.

    Declaration

    Swift

    public let probability: Double
    View Source on GitHub

  • The edges to which the user could transition from this edge.

    The most probable path may be split at some point if some of edges have a low probability difference (±0.05). For example, outletEdges can contain more than one edge with level set to 0. Currently, there is a maximum limit of one split per electronic horizon.

    Declaration

    Swift

    public let outletEdges: [Edge]
    View Source on GitHub

  • Initializes a new Edge object.

    Declaration

    Swift

    public init(identifier: Identifier, level: UInt, probability: Double, outletEdges: [Edge])

    Parameters

    identifier

    The unique identifier of a directed edge.
    level

    The level of the edge.
    probability

    The probability that the user will transition onto this edge.
    outletEdges

    The edges to which the user could transition from this edge.
    View Source on GitHub

  • Indicates how many directions the user may travel along an edge.

    Note

    The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.
    See more

    Declaration

    Swift

    public enum Directionality
    View Source on GitHub

  • Edge metadata

    See more

    Declaration

    Swift

    public struct Metadata
    View Source on GitHub