Show / Hide Table of Contents

Class Waypoint

Encapsulates a waypoint. Waypoints mark both the beginning and end of a route, and include intermediate stops along the route.

Inheritance
object
Waypoint
Implements
IMessage<Waypoint>
IEquatable<Waypoint>
IDeepCloneable<Waypoint>
IBufferMessage
IMessage
Inherited Members
object.GetHashCode()
object.GetType()
object.ToString()
Namespace: Google.Maps.Routing.V2
Assembly: Google.Maps.Routing.V2.dll
Syntax
public sealed class Waypoint : IMessage<Waypoint>, IEquatable<Waypoint>, IDeepCloneable<Waypoint>, IBufferMessage, IMessage

Constructors

Waypoint()

Declaration
public Waypoint()

Waypoint(Waypoint)

Declaration
public Waypoint(Waypoint other)
Parameters
Type Name Description
Waypoint other

Properties

Address

Human readable address or a plus code. See https://plus.codes for details.

Declaration
public string Address { get; set; }
Property Value
Type Description
string

HasAddress

Gets whether the "address" field is set

Declaration
public bool HasAddress { get; }
Property Value
Type Description
bool

HasPlaceId

Gets whether the "place_id" field is set

Declaration
public bool HasPlaceId { get; }
Property Value
Type Description
bool

Location

A point specified using geographic coordinates, including an optional heading.

Declaration
public Location Location { get; set; }
Property Value
Type Description
Location

LocationTypeCase

Declaration
public Waypoint.LocationTypeOneofCase LocationTypeCase { get; }
Property Value
Type Description
Waypoint.LocationTypeOneofCase

PlaceId

The POI Place ID associated with the waypoint.

Declaration
public string PlaceId { get; set; }
Property Value
Type Description
string

SideOfRoad

Indicates that the location of this waypoint is meant to have a preference for the vehicle to stop at a particular side of road. When you set this value, the route will pass through the location so that the vehicle can stop at the side of road that the location is biased towards from the center of the road. This option works only for DRIVE and TWO_WHEELER [RouteTravelMode][google.maps.routing.v2.RouteTravelMode].

Declaration
public bool SideOfRoad { get; set; }
Property Value
Type Description
bool

VehicleStopover

Indicates that the waypoint is meant for vehicles to stop at, where the intention is to either pickup or drop-off. When you set this value, the calculated route won't include non-via waypoints on roads that are unsuitable for pickup and drop-off. This option works only for DRIVE and TWO_WHEELER travel modes, and when the location_type is [Location][google.maps.routing.v2.Location].

Declaration
public bool VehicleStopover { get; set; }
Property Value
Type Description
bool

Via

Marks this waypoint as a milestone rather a stopping point. For each non-via waypoint in the request, the response appends an entry to the [legs][google.maps.routing.v2.Route.legs] array to provide the details for stopovers on that leg of the trip. Set this value to true when you want the route to pass through this waypoint without stopping over. Via waypoints don't cause an entry to be added to the legs array, but they do route the journey through the waypoint. You can only set this value on waypoints that are intermediates. The request fails if you set this field on terminal waypoints. If ComputeRoutesRequest.optimize_waypoint_order is set to true then this field cannot be set to true; otherwise, the request fails.

Declaration
public bool Via { get; set; }
Property Value
Type Description
bool
In this article
Back to top Generated by DocFX