com.teamdev.jxmaps

Class DirectionsRequest

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.DirectionsRequest

All Implemented Interfaces:

java.lang.Cloneable

public class DirectionsRequest
extends MapObject

Represents directions request object. Contains a directions query to be sent to the DirectionsService.

Constructor Summary

Constructors

Constructor and Description
DirectionsRequest() Creates new DirectionsRequest object.
DirectionsRequest(Map map) Deprecated.

Method Summary

Modifier and Type	Method and Description
boolean	getAvoidFerries() Returns value of avoidFerries property.
boolean	getAvoidHighways() Returns value of avoidHighways property.
boolean	getAvoidTolls() Returns value of avoidTolls property.
LatLng	getDestination() Returns LatLng value of destination property.
java.lang.String	getDestinationString() Returns string value of destination property.
boolean	getOptimizeWaypoints() Returns value of optimizeWaypoints property.
LatLng	getOrigin() Returns LatLng value of origin property.
java.lang.String	getOriginString() Returns String value of origin property.
boolean	getProvideRouteAlternatives() Returns value of provideRouteAlternatives property.
java.lang.String	getRegion() Returns value of region property.
TransitOptions	getTransitOptions() Returns value of transitOptions property.
TravelMode	getTravelMode() Returns value of travelMode property.
UnitSystem	getUnitSystem() Returns value of unitSystem property.
DirectionsGeocodedWaypoint[]	getWaypoints() Returns value of waypoints property.
void	setAvoidFerries(boolean value) Sets new value for avoidFerries property.
void	setAvoidHighways(boolean value) Sets new value for avoidHighways property.
void	setAvoidTolls(boolean value) Sets new value for avoidTolls property.
void	setDestination(LatLng destination) Sets new LatLng value for destination property.
void	setDestinationString(java.lang.String destination) Sets new String value for destination property.
void	setOptimizeWaypoints(boolean value) Sets new value for optimizeWaypoints property.
void	setOrigin(LatLng origin) Sets new LatLng value for origin property.
void	setOriginString(java.lang.String origin) Sets new String value for origin property.
void	setProvideRouteAlternatives(boolean value) Sets new value for provideRouteAlternatives property.
void	setRegion(java.lang.String value) Sets new value for region property.
void	setTransitOptions(TransitOptions options) Sets new value for transitOptions property.
void	setTravelMode(TravelMode mode) Sets new value for travelMode property.
void	setUnitSystem(UnitSystem value) Sets new value for unitSystem property.
void	setWaypoints(DirectionsGeocodedWaypoint[] waypoints) Sets new value for waypoints property.

Methods inherited from class com.teamdev.jxmaps.MapObject

addEventListener, attachObject, cacheProperties, cacheProperties, clone, createJSValue, dispose, fromJSValue, getJSObject, getMap, getProperties, invokeMethod, propertyChanged, removeEventListener, updateProperty

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DirectionsRequest

public DirectionsRequest()

Creates new DirectionsRequest object.

DirectionsRequest

@Deprecated
public DirectionsRequest(Map map)

Deprecated.

Creates new DirectionsRequest object.

Parameters:

map - owner Map object

Method Detail

getOrigin

public LatLng getOrigin()

Returns LatLng value of origin property.

Location of origin. This can be specified as either a string to be geocoded or a LatLng. Required.

Returns:

property value

See Also:

setOrigin(com.teamdev.jxmaps.LatLng)

setOrigin

public void setOrigin(LatLng origin)

Sets new LatLng value for origin property.

Parameters:

origin - new property value

See Also:

getOrigin()

getOriginString

public java.lang.String getOriginString()

Returns String value of origin property.

Returns:

property value

See Also:

setOriginString(java.lang.String)

setOriginString

public void setOriginString(java.lang.String origin)

Sets new String value for origin property.

Parameters:

origin - new property value

See Also:

getOriginString()

getDestination

public LatLng getDestination()

Returns LatLng value of destination property.

Location of destination. This can be specified as either a string to be geocoded or a LatLng. Required.

Returns:

property value

See Also:

setDestinationString(java.lang.String)

setDestination

public void setDestination(LatLng destination)

Sets new LatLng value for destination property.

Parameters:

destination - new property value

See Also:

getDestination()

getDestinationString

public java.lang.String getDestinationString()

Returns string value of destination property.

Location of destination. This can be specified as either a string to be geocoded or a LatLng. Required.

Returns:

property value

See Also:

setDestinationString(java.lang.String)

setDestinationString

public void setDestinationString(java.lang.String destination)

Sets new String value for destination property.

Parameters:

destination - new property value

See Also:

getDestinationString()

getTravelMode

public TravelMode getTravelMode()

Returns value of travelMode property.

Represents the type of routing requested. Required.

Returns:

property value

See Also:

setTravelMode(com.teamdev.jxmaps.TravelMode)

setTravelMode

public void setTravelMode(TravelMode mode)

Sets new value for travelMode property.

Parameters:

mode - new property value

See Also:

getTravelMode()

getAvoidFerries

public boolean getAvoidFerries()

Returns value of avoidFerries property.

If true, instructs the Directions service to avoid ferries where possible. Optional.

Returns:

property value

See Also:

setAvoidFerries(boolean)

setAvoidFerries

public void setAvoidFerries(boolean value)

Sets new value for avoidFerries property.

Parameters:

value - new property value

See Also:

getAvoidFerries()

getAvoidHighways

public boolean getAvoidHighways()

Returns value of avoidHighways property.

If true, instructs the Directions service to avoid highways where possible. Optional.

Returns:

property value

See Also:

setAvoidHighways(boolean)

setAvoidHighways

public void setAvoidHighways(boolean value)

Sets new value for avoidHighways property.

Parameters:

value - new property value

See Also:

getAvoidHighways()

setAvoidTolls

public void setAvoidTolls(boolean value)

Sets new value for avoidTolls property.

Parameters:

value - new property value

See Also:

getAvoidTolls()

getAvoidTolls

public boolean getAvoidTolls()

Returns value of avoidTolls property.

If true, instructs the Directions service to avoid toll roads where possible. Optional.

Returns:

property value

See Also:

setAvoidTolls(boolean)

getOptimizeWaypoints

public boolean getOptimizeWaypoints()

Returns value of optimizeWaypoints property.

If set to true, the DirectionService will attempt to re-order the supplied intermediate waypoints to minimize overall cost of the route. If waypoints are optimized, inspect DirectionsRoute.waypoint_order in the response to determine the new ordering.

Returns:

property value

See Also:

setOptimizeWaypoints(boolean)

setOptimizeWaypoints

public void setOptimizeWaypoints(boolean value)

Sets new value for optimizeWaypoints property.

Parameters:

value - new property value

See Also:

getOptimizeWaypoints()

getProvideRouteAlternatives

public boolean getProvideRouteAlternatives()

Returns value of provideRouteAlternatives property.

Indicates whether or not route alternatives should be provided. Optional.

Returns:

property value

See Also:

setProvideRouteAlternatives(boolean)

setProvideRouteAlternatives

public void setProvideRouteAlternatives(boolean value)

Sets new value for provideRouteAlternatives property.

Parameters:

value - new property value

See Also:

getProvideRouteAlternatives()

getRegion

public java.lang.String getRegion()

Returns value of region property.

Represents the region code used as a bias for geocoding requests. Optional.

Returns:

property value

See Also:

setRegion(java.lang.String)

setRegion

public void setRegion(java.lang.String value)

Sets new value for region property.

Parameters:

value - new property value

See Also:

getRegion()

getUnitSystem

public UnitSystem getUnitSystem()

Returns value of unitSystem property.

Represents the preferred unit system to use when displaying distance. Defaults to the unit system used in the country of origin.

Returns:

property value

See Also:

setUnitSystem(com.teamdev.jxmaps.UnitSystem)

setUnitSystem

public void setUnitSystem(UnitSystem value)

Sets new value for unitSystem property.

Parameters:

value - new property value

See Also:

getUnitSystem()

getTransitOptions

public TransitOptions getTransitOptions()

Returns value of transitOptions property.

Represents the settings that apply only to requests where travelMode is TRANSIT. This object will have no effect for other travel modes.

Returns:

property value

See Also:

setTransitOptions(com.teamdev.jxmaps.TransitOptions)

setTransitOptions

public void setTransitOptions(TransitOptions options)

Sets new value for transitOptions property.

Parameters:

options - new property value

See Also:

getTransitOptions()

getWaypoints

public DirectionsGeocodedWaypoint[] getWaypoints()

Returns value of waypoints property.

Collection of intermediate waypoints. Directions will be calculated from the origin to the destination by way of each waypoint in this array. The maximum allowed waypoints is 8, plus the origin, and destination. Maps API for Work customers are allowed 23 waypoints, plus the origin, and destination. Waypoints are not supported for transit directions. Optional.

Returns:

property value

See Also:

setWaypoints(com.teamdev.jxmaps.DirectionsGeocodedWaypoint[])

setWaypoints

public void setWaypoints(DirectionsGeocodedWaypoint[] waypoints)

Sets new value for waypoints property.

Parameters:

waypoints - new property value

See Also:

getWaypoints()