com.google.maps.gwt.client
Class DirectionsRoute

java.lang.Object
  extended by JavaScriptObject
      extended by com.google.maps.gwt.client.DirectionsRoute

public class DirectionsRoute
extends JavaScriptObject

A single route containing a set of legs in a DirectionsResult . (This object was formerly known as "DirectionsTrip".) Note that though this object is "JSON-like," it is not strictly JSON, as it directly and indirectly includes LatLng objects. THIS SOURCE CODE IS GENERATED, DO NOT MODIFY


Constructor Summary
protected DirectionsRoute()
          Protected constructor avoids default public constructor.
 
Method Summary
 LatLngBounds getBounds()
          The bounds for this route.
 java.lang.String getCopyrights()
          Copyrights text to be displayed for this route.
  getLegs()
          An array of DirectionsLeg s, each of which contains information about the steps of which it is composed.
  getOverviewPath()
          An array of LatLng s representing the entire course of this route.
 JsArrayString getWarnings()
          Warnings to be displayed when showing these directions.
 JsArrayNumber getWaypointOrder()
          If optimizeWaypoints was set to true , this field will contain the re-ordered permutation of the input waypoints.
 void setBounds(LatLngBounds bounds)
          The bounds for this route.
 void setCopyrights(java.lang.String copyrights)
          Copyrights text to be displayed for this route.
 void setLegs( legs)
          An array of DirectionsLeg s, each of which contains information about the steps of which it is composed.
 void setOverviewPath( overview_path)
          An array of LatLng s representing the entire course of this route.
 void setWarnings(JsArrayString warnings)
          Warnings to be displayed when showing these directions.
 void setWaypointOrder(JsArrayNumber waypoint_order)
          If optimizeWaypoints was set to true , this field will contain the re-ordered permutation of the input waypoints.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DirectionsRoute

protected DirectionsRoute()
Protected constructor avoids default public constructor.

Method Detail

getBounds

public final LatLngBounds getBounds()
The bounds for this route.


getCopyrights

public final java.lang.String getCopyrights()
Copyrights text to be displayed for this route.


getLegs

public final  getLegs()
An array of DirectionsLeg s, each of which contains information about the steps of which it is composed. There will be one leg for each waypoint or destination specified. So a route with no waypoints will contain one DirectionsLeg and a route with one waypoint will contain two. (This property was formerly known as "routes".)


getOverviewPath

public final  getOverviewPath()
An array of LatLng s representing the entire course of this route. The path is simplified in order to make it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs).


getWarnings

public final JsArrayString getWarnings()
Warnings to be displayed when showing these directions.


getWaypointOrder

public final JsArrayNumber getWaypointOrder()
If optimizeWaypoints was set to true , this field will contain the re-ordered permutation of the input waypoints. For example, if the input was:
  Origin: Los Angeles
  Waypoints: Dallas, Bangor, Phoenix
  Destination: New York
and the optimized output was ordered as follows:
  Origin: Los Angeles
  Waypoints: Phoenix, Dallas, Bangor
  Destination: New York
then this field will be an Array containing the values [2, 0, 1]. Note that the numbering of waypoints is zero-based.
If any of the input waypoints has stopover set to false , this field will be empty, since route optimization is not available for such queries.


setBounds

public final void setBounds(LatLngBounds bounds)
The bounds for this route.


setCopyrights

public final void setCopyrights(java.lang.String copyrights)
Copyrights text to be displayed for this route.


setLegs

public final void setLegs( legs)
An array of DirectionsLeg s, each of which contains information about the steps of which it is composed. There will be one leg for each waypoint or destination specified. So a route with no waypoints will contain one DirectionsLeg and a route with one waypoint will contain two. (This property was formerly known as "routes".)


setOverviewPath

public final void setOverviewPath( overview_path)
An array of LatLng s representing the entire course of this route. The path is simplified in order to make it suitable in contexts where a small number of vertices is required (such as Static Maps API URLs).


setWarnings

public final void setWarnings(JsArrayString warnings)
Warnings to be displayed when showing these directions.


setWaypointOrder

public final void setWaypointOrder(JsArrayNumber waypoint_order)
If optimizeWaypoints was set to true , this field will contain the re-ordered permutation of the input waypoints. For example, if the input was:
  Origin: Los Angeles
  Waypoints: Dallas, Bangor, Phoenix
  Destination: New York
and the optimized output was ordered as follows:
  Origin: Los Angeles
  Waypoints: Phoenix, Dallas, Bangor
  Destination: New York
then this field will be an Array containing the values [2, 0, 1]. Note that the numbering of waypoints is zero-based.
If any of the input waypoints has stopover set to false , this field will be empty, since route optimization is not available for such queries.