Route class

Contains a route, which consists of a series of connected road segments that join beginning, ending, and intermediate waypoints.

Inheritance

• Object
• GeneratedMessage
• Route

Constructors

Route.new({Iterable<RouteLeg>? legs, int? distanceMeters, Duration? duration, Duration? staticDuration, Polyline? polyline, String? description, Iterable<String>? warnings, Viewport? viewport, RouteTravelAdvisory? travelAdvisory, Iterable<int>? optimizedIntermediateWaypointIndex, Route_RouteLocalizedValues? localizedValues, String? routeToken, Iterable<RouteLabel>? routeLabels, PolylineDetails? polylineDetails})

factory

Route.fromBuffer(List<int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Route.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])

factory

Properties

description ↔ String

A description of the route.

getter/setter pair

distanceMeters ↔ int

The travel distance of the route, in meters.

getter/setter pair

duration ↔ Duration

The length of time needed to navigate the route. If you set the routing_preference to TRAFFIC_UNAWARE, then this value is the same as static_duration. If you set the routing_preference to either TRAFFIC_AWARE or TRAFFIC_AWARE_OPTIMAL, then this value is calculated taking traffic conditions into account.

getter/setter pair

eventPlugin → EventPlugin?

Subclasses can override this getter to be notified of changes to protobuf fields.

no setter, inherited

hashCode → int

Calculates a hash code based on the contents of the protobuf.

no setter, inherited

info_ → BuilderInfo

no setter, override

isFrozen → bool

Returns true if this message is marked read-only. Otherwise false.

no setter, inherited

legs → List<RouteLeg>

A collection of legs (path segments between waypoints) that make up the route. Each leg corresponds to the trip between two non-via google.maps.routing.v2.Waypoint. For example, a route with no intermediate waypoints has only one leg. A route that includes one non-via intermediate waypoint has two legs. A route that includes one via intermediate waypoint has one leg. The order of the legs matches the order of waypoints from origin to intermediates to destination.

no setter

localizedValues ↔ Route_RouteLocalizedValues

Text representations of properties of the Route.

getter/setter pair

optimizedIntermediateWaypointIndex → List<int>

If you set google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order to true, this field contains the optimized ordering of intermediate waypoints. Otherwise, this field is empty. For example, if you give an input of Origin: LA; Intermediate waypoints: Dallas, Bangor, Phoenix; Destination: New York; and the optimized intermediate waypoint order is Phoenix, Dallas, Bangor, then this field contains the values 2, 0, 1. The index starts with 0 for the first intermediate waypoint provided in the input.

no setter

polyline ↔ Polyline

The overall route polyline. This polyline is the combined polyline of all legs.

getter/setter pair

polylineDetails ↔ PolylineDetails

Contains information about details along the polyline.

getter/setter pair

routeLabels → List<RouteLabel>

Labels for the Route that are useful to identify specific properties of the route to compare against others.

no setter

routeToken ↔ String

An opaque token that can be passed to Navigation SDK to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created. Treat this token as an opaque blob. Don't compare its value across requests as its value may change even if the service returns the exact same route.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

staticDuration ↔ Duration

The duration of travel through the route without taking traffic conditions into consideration.

getter/setter pair

travelAdvisory ↔ RouteTravelAdvisory

Additional information about the route.

getter/setter pair

unknownFields → UnknownFieldSet

no setter, inherited

viewport ↔ Viewport

The viewport bounding box of the polyline.

getter/setter pair

warnings → List<String>

An array of warnings to show when displaying the route.

no setter

Methods

addExtension(Extension extension, Object? value) → void

Adds an extension field value to a repeated field.

inherited

check() → void

inherited

clear() → void

Clears all data that was set in this message.

inherited

clearDescription() → void

clearDistanceMeters() → void

clearDuration() → void

clearExtension(Extension extension) → void

Clears an extension field and also removes the extension.

inherited

clearField(int tagNumber) → void

Clears the contents of a given field.

inherited

clearLocalizedValues() → void

clearPolyline() → void

clearPolylineDetails() → void

clearRouteToken() → void

clearStaticDuration() → void

clearTravelAdvisory() → void

clearViewport() → void

clone() → Route

Creates a deep copy of the fields in this message. (The generated code uses mergeFromMessage.)

override

copyWith(void updates(Route)) → Route

Apply updates to a copy of this message.

override

createEmptyInstance() → Route

Creates an empty instance of the same message type as this.

override

createMapField<K, V>(int tagNumber, MapFieldInfo<K, V> fi) → Map<K, V>

Creates a Map representing a map field.

inherited

createRepeatedField<T>(int tagNumber, FieldInfo<T> fi) → List<T>

Creates List implementing a mutable repeated field.

inherited

ensureDuration() → Duration

ensureLocalizedValues() → Route_RouteLocalizedValues

ensurePolyline() → Polyline

ensurePolylineDetails() → PolylineDetails

ensureStaticDuration() → Duration

ensureTravelAdvisory() → RouteTravelAdvisory

ensureViewport() → Viewport

extensionsAreInitialized() → bool

inherited

freeze() → GeneratedMessage

Make this message read-only.

inherited

getDefaultForField(int tagNumber) → dynamic

Returns the default value for the given field.

inherited

getExtension(Extension extension) → dynamic

Returns the value of extension.

inherited

getField(int tagNumber) → dynamic

Returns the value of the field associated with tagNumber, or the default value if it is not set.

inherited

getFieldOrNull(int tagNumber) → dynamic

Returns the value of a field, ignoring any defaults.

inherited

getTagNumber(String fieldName) → int?

inherited

hasDescription() → bool

hasDistanceMeters() → bool

hasDuration() → bool

hasExtension(Extension extension) → bool

Returns true if a value of extension is present.

inherited

hasField(int tagNumber) → bool

Whether this message has a field associated with tagNumber.

inherited

hasLocalizedValues() → bool

hasPolyline() → bool

hasPolylineDetails() → bool

hasRequiredFields() → bool

Whether the message has required fields.

inherited

hasRouteToken() → bool

hasStaticDuration() → bool

hasTravelAdvisory() → bool

hasViewport() → bool

isInitialized() → bool

Whether all required fields in the message and embedded messages are set.

inherited

mergeFromBuffer(List<int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges serialized protocol buffer data into this message.

inherited

mergeFromCodedBufferReader(CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

inherited

mergeFromJson(String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from data, a JSON object, encoded as described by GeneratedMessage.writeToJson.

inherited

mergeFromJsonMap(Map<String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void

Merges field values from a JSON object represented as a Dart map.

inherited

mergeFromMessage(GeneratedMessage other) → void

Merges the contents of the other into this message.

inherited

mergeFromProto3Json(Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void

Merges field values from json, a JSON object using proto3 encoding.

inherited

mergeUnknownFields(UnknownFieldSet unknownFieldSet) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

setExtension(Extension extension, Object value) → void

Sets the value of a non-repeated extension field to value.

inherited

setField(int tagNumber, Object value) → void

Sets the value of a field by its tagNumber.

inherited

toBuilder() → GeneratedMessage

Creates a writable, shallow copy of this message.

inherited

toDebugString() → String

Returns a String representation of this message.

inherited

toProto3Json({TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object?

Returns an Object representing Proto3 JSON serialization of this.

inherited

toString() → String

Returns a String representation of this message.

inherited

writeToBuffer() → Uint8List

inherited

writeToCodedBufferWriter(CodedBufferWriter output) → void

inherited

writeToJson() → String

Returns a JSON string that encodes this message.

inherited

writeToJsonMap() → Map<String, dynamic>

Returns the JSON encoding of this message as a Dart Map.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create() → Route

createRepeated() → PbList<Route>

getDefault() → Route