DirectionsApi class

The Mapbox Directions API will show you how to get where you're going.

https://docs.mapbox.com/api/navigation/#directions

Constructors

DirectionsApi(MapboxApi api, {String version = 'v5', String endpoint = 'https://api.mapbox.com/directions'})

Properties

api ↔ MapboxApi

getter/setter pair

endpoint ↔ String

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

version ↔ String

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

request({NavigationProfile? profile, List<List<double>> coordinates = const <List<double>>[], bool alternatives = false, List<NavigationAnnotations> annotations = const <NavigationAnnotations>[], List<NavigationBearings> bearings = const <NavigationBearings>[], bool continueStraight = false, List<NavigationExclude> excludes = const <NavigationExclude>[], NavigationGeometries geometries = NavigationGeometries.POLYLINE, NavigationOverview overview = NavigationOverview.SIMPLIFIED, List<double> radiuses = const <double>[], List<NavigationApproaches> approaches = const <NavigationApproaches>[], bool steps = false, bool bannerInstructions = false, String language = 'en', bool roundaboutExits = false, bool voiceInstructions = false, NavigationVoiceUnits voiceUnits = NavigationVoiceUnits.IMPERIAL, List<String> waypointNames = const <String>[], List<List<double>> waypointTargets = const <List<double>>[], List<List<double>> waypoints = const <List<double>>[], double walkingSpeed = 1.42, double walkwayBias = 0, double alleyBias = 0}) → Future<DirectionsApiResponse>

Retrieve directions between waypoints. Directions requests must specify at least two waypoints as starting and ending points.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited