EHorizonOptions

class EHorizonOptions

Defines options for EHorizon.

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.

Parameters

length

the minimum length of the MPP in meters. This does not include the trailingLength. The actual MPP length may be bigger. Double in range 1.0, 20000.0. Default value 500.0

expansion

the number of branches to include from the MPP. When set to 0 only the MPP is returned. Higher values will result in deeper nesting. Int in range 0, 2. Default value 0

branchLength

when expansion is set to anything but 0, this specifies the minimum length in meters branches will be expanded from the MPP. Double in range 1.0, 5000.0. Default value 50.0

minTimeDeltaBetweenUpdates

the minimum time which should pass between consecutive navigation statuses to update electronic horizon (seconds). If null electronic horizon will be updated on each navigation status. Default value null

alertServiceOptions

control how Navigation SDK extracts road objects from the road graph and which objects are collected.

Types

Builder
Link copied to clipboard
class Builder
Build a new EHorizonOptions

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Regenerate whenever a change is made
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Regenerate whenever a change is made
toBuilder
Link copied to clipboard
fun toBuilder(): EHorizonOptions.Builder
Get a builder to customize a subset of current options.
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

alertServiceOptions
Link copied to clipboard
val alertServiceOptions: AlertServiceOptions
control how Navigation SDK extracts road objects from the road graph and which objects are collected.
branchLength
Link copied to clipboard
val branchLength: Double
when expansion is set to anything but 0, this specifies the minimum length in meters branches will be expanded from the MPP.
expansion
Link copied to clipboard
val expansion: Int
the number of branches to include from the MPP.
length
Link copied to clipboard
val length: Double
the minimum length of the MPP in meters.
minTimeDeltaBetweenUpdates
Link copied to clipboard
val minTimeDeltaBetweenUpdates: Double?
the minimum time which should pass between consecutive navigation statuses to update electronic horizon (seconds).