Reference documentation and code samples for the Google Maps Route Optimization V1 Client class Waypoint.
Encapsulates a waypoint. Waypoints mark arrival and departure locations of VisitRequests, and start and end locations of Vehicles.
Generated from protobuf message google.maps.routeoptimization.v1.Waypoint
Namespace
Google \ Maps \ RouteOptimization \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ location |
Google\Maps\RouteOptimization\V1\Location
A point specified using geographic coordinates, including an optional heading. |
↳ place_id |
string
The POI Place ID associated with the waypoint. |
↳ side_of_road |
bool
Optional. 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 doesn't work for the 'WALKING' travel mode. |
getLocation
A point specified using geographic coordinates, including an optional heading.
| Returns | |
|---|---|
| Type | Description |
Google\Maps\RouteOptimization\V1\Location|null |
|
hasLocation
setLocation
A point specified using geographic coordinates, including an optional heading.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Maps\RouteOptimization\V1\Location
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPlaceId
The POI Place ID associated with the waypoint.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPlaceId
setPlaceId
The POI Place ID associated with the waypoint.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSideOfRoad
Optional. 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 doesn't work for the 'WALKING' travel mode.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setSideOfRoad
Optional. 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 doesn't work for the 'WALKING' travel mode.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLocationType
| Returns | |
|---|---|
| Type | Description |
string |
|