MapBoxOptions class

Configuration options for the MapBoxNavigation.

When used to change configuration, null values will be interpreted as "do not change this configuration option".

Constructors

MapBoxOptions({double? initialLatitude, double? initialLongitude, String? language, double? zoom, double? bearing, double? tilt, bool? alternatives, MapBoxNavigationMode? mode, VoiceUnits? units, bool? allowsUTurnAtWayPoints, bool? enableRefresh, bool? voiceInstructionsEnabled, bool? bannerInstructionsEnabled, bool? longPressDestinationEnabled, bool? simulateRoute, bool? isOptimized, String? mapStyleUrlDay, String? mapStyleUrlNight, bool? enableFreeDriveMode, EdgeInsets? padding, bool? animateBuildRoute})

Properties

allowsUTurnAtWayPoints → bool?

If the value of this property is true, a returned route may require an immediate U-turn at an intermediate waypoint. At an intermediate waypoint, if the value of this property is false, each returned route may continue straight ahead or turn to either side but may not U-turn. This property has no effect if only two waypoints are specified. same as 'not continueStraight' on Android

final

alternatives → bool?

When true, alternate routes will be presented

final

animateBuildRoute → bool?

Should animate the building of the Route. Default is True

final

bannerInstructionsEnabled → bool?

final

bearing → double?

Bearing is the direction that the camera is pointing in and measured in degrees clockwise from north.

final

enableFreeDriveMode → bool?

Free-drive mode is a unique Mapbox Navigation SDK feature that allows drivers to navigate without a set destination. This mode is sometimes referred to as passive navigation. No destination is required when set to true.

final

enableRefresh → bool?

final

hashCode → int

The hash code for this object.

no setter, inherited

initialLatitude → double?

The initial Latitude of the Map View

final

initialLongitude → double?

The initial Longitude of the Map View

final

isOptimized → bool?

if true, will reorder the routes to optimize navigation for time and shortest distance using the Travelling Salesman Algorithm. Always false for now

final

language → String?

2-letter ISO 639-1 code for language. This property affects the sentence contained within the RouteStep.instructions property, but it does not affect any road names contained in that property or other properties such as RouteStep.name. Defaults to "en" if an unsupported language is specified. The languages in this link are supported: https://docs.mapbox.com/android/navigation/overview/localization/ or https://docs.mapbox.com/ios/api/navigation/0.14.1/localization-and-internationalization.html

final

longPressDestinationEnabled → bool?

When the user long presses on a point on the map, set that as the destination

final

mapStyleUrlDay → String?

The Url of the style the Navigation MapView should use during the day

final

mapStyleUrlNight → String?

The Url of the style the Navigation MapView should use at night

final

mode → MapBoxNavigationMode?

The navigation mode desired. Defaults to drivingWithTraffic

final

padding → EdgeInsets?

Padding applied to the MapView when embedded

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

simulateRoute → bool?

if true will simulate the route as if you were driving. Always true on iOS Simulator

final

tilt → double?

Tilt is the camera's angle from the nadir (directly facing the Earth) and uses unit degrees. The camera's minimum (default) tilt is 0 degrees, and the maximum tilt is 60. Tilt levels use six decimal point of precision, which enables you to restrict/set/lock a map's bearing with extreme precision.

final

units → VoiceUnits?

The unit of measure said in voice instructions

final

voiceInstructionsEnabled → bool?

final

zoom → double?

Zoom controls the scale of the map and consumes any value between 0 and 22. At zoom level 0, the viewport shows continents and other world features. A middle value of 11 will show city level details, and at a higher zoom level, the map will begin to show buildings and points of interest.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

updatesMap(MapBoxOptions newOptions) → Map<String, dynamic>

Operators

operator ==(Object other) → bool

The equality operator.

inherited