com.teamdev.jxmaps

Class DirectionsLeg

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.DirectionsLeg

All Implemented Interfaces:

java.lang.Cloneable

public class DirectionsLeg
extends MapObject

Represents directions leg object A single leg consisting of a set of steps in a DirectionsResult. Some fields in the leg may not be returned for all requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DirectionsLeg.ArrayProperty

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Time	getArrivalTime() Returns value of arrivalTime property.
Time	getDepartureTime() Returns value of departureTime property.
Distance	getDistance() Returns value of distance property.
Duration	getDuration() Returns value of duration property.
Duration	getDurationInTraffic() Returns value of durationInTraffic property.
java.lang.String	getEndAddress() Returns value of endAddress property.
LatLng	getEndLocation() Returns value of endLocation property.
java.lang.String	getStartAddress() Returns value of startAddress property.
LatLng	getStartLocation() Returns value of startLocation property.
DirectionsStep[]	getSteps() Returns value of steps property.
LatLng[]	getViaWaypoints() Returns value of viaWaypoints property.
void	setArrivalTime(Time value) Sets new value for arrivalTime property.
void	setDepartureTime(Time value) Sets new value for departureTime property.
void	setDistance(Distance value) Sets new value for distance property.
void	setDuration(Duration value) Sets new value for duration property.
void	setDurationInTraffic(Duration value) Sets new value for durationInTraffic property.
void	setEndAddress(java.lang.String value) Sets new value for endAddress property.
void	setEndLocation(LatLng value) Sets new value for endLocation property.
void	setStartAddress(java.lang.String value) Sets new value for startAddress property.
void	setStartLocation(LatLng value) Sets new value for startLocation property.
void	setSteps(DirectionsStep[] steps) Sets new value for steps property.
void	setViaWaypoints(LatLng[] waypoints) Sets new value for viaWaypoints 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

DirectionsLeg

public DirectionsLeg()

Creates new DirectionsLeg object

DirectionsLeg

@Deprecated
public DirectionsLeg(Map map)

Deprecated.

Creates new DirectionsLeg object

Parameters:

map - owner Map object

Method Detail

getArrivalTime

public Time getArrivalTime()

Returns value of arrivalTime property.

Represents an estimated arrival time for this leg. Only applicable for TRANSIT requests.

Returns:

property value

See Also:

setArrivalTime(com.teamdev.jxmaps.Time)

setArrivalTime

public void setArrivalTime(Time value)

Sets new value for arrivalTime property.

Parameters:

value - new property value

See Also:

getArrivalTime()

getDepartureTime

public Time getDepartureTime()

Returns value of departureTime property.

Represents an estimated departure time for this leg. Only applicable for TRANSIT requests.

Returns:

property value

See Also:

setDepartureTime(com.teamdev.jxmaps.Time)

setDepartureTime

public void setDepartureTime(Time value)

Sets new value for departureTime property.

Parameters:

value - new property value

See Also:

getDepartureTime()

getDistance

public Distance getDistance()

Returns value of distance property.

Represents the total distance covered by this leg. This property may be undefined as the distance may be unknown.

Returns:

property value

See Also:

setDistance(com.teamdev.jxmaps.Distance)

setDistance

public void setDistance(Distance value)

Sets new value for distance property.

Parameters:

value - new property value

See Also:

getDistance()

getDuration

public Duration getDuration()

Returns value of duration property.

Represents the total duration of this leg. This property may be undefined as the duration may be unknown.

Returns:

property value

See Also:

setDuration(com.teamdev.jxmaps.Duration)

setDuration

public void setDuration(Duration value)

Sets new value for duration property.

Parameters:

value - new property value

See Also:

getDuration()

getDurationInTraffic

public Duration getDurationInTraffic()

Returns value of durationInTraffic property.

Represents the total duration of this leg, taking into account current traffic conditions. This property may be undefined as the duration may be unknown. Only available to Maps API for Work customers when durationInTraffic is set to true when making the request.

Returns:

property value

See Also:

setDurationInTraffic(com.teamdev.jxmaps.Duration)

setDurationInTraffic

public void setDurationInTraffic(Duration value)

Sets new value for durationInTraffic property.

Parameters:

value - new property value

See Also:

getDurationInTraffic()

getEndAddress

public java.lang.String getEndAddress()

Returns value of endAddress property.

Represents the address of the destination of this leg.

Returns:

property value

See Also:

setEndAddress(java.lang.String)

setEndAddress

public void setEndAddress(java.lang.String value)

Sets new value for endAddress property.

Parameters:

value - new property value

See Also:

getEndAddress()

getEndLocation

public LatLng getEndLocation()

Returns value of endLocation property.

The DirectionsService calculates directions between locations by using the nearest transportation option (usually a road) at the start and end locations. end_location indicates the actual geocoded destination, which may be different than the end_location of the last step if, for example, the road is not near the destination of this leg.

Returns:

property value

See Also:

setEndLocation(com.teamdev.jxmaps.LatLng)

setEndLocation

public void setEndLocation(LatLng value)

Sets new value for endLocation property.

Parameters:

value - new property value

See Also:

getEndLocation()

getStartAddress

public java.lang.String getStartAddress()

Returns value of startAddress property.

Represents the address of the origin of this leg.

Returns:

property value

See Also:

setStartAddress(java.lang.String)

setStartAddress

public void setStartAddress(java.lang.String value)

Sets new value for startAddress property.

Parameters:

value - new property value

See Also:

getStartAddress()

getStartLocation

public LatLng getStartLocation()

Returns value of startLocation property.

The DirectionsService calculates directions between locations by using the nearest transportation option (usually a road) at the start and end locations. start_location indicates the actual geocoded origin, which may be different than the start_location of the first step if, for example, the road is not near the origin of this leg.

Returns:

property value

See Also:

setStartLocation(com.teamdev.jxmaps.LatLng)

setStartLocation

public void setStartLocation(LatLng value)

Sets new value for startLocation property.

Parameters:

value - new property value

See Also:

getStartLocation()

getSteps

public DirectionsStep[] getSteps()

Returns value of steps property.

Represents a collection of DirectionsSteps, each of which contains information about the individual steps in this leg.

Returns:

property value

See Also:

setSteps(com.teamdev.jxmaps.DirectionsStep[])

setSteps

public void setSteps(DirectionsStep[] steps)

Sets new value for steps property.

Parameters:

steps - new property value

See Also:

getSteps()

getViaWaypoints

public LatLng[] getViaWaypoints()

Returns value of viaWaypoints property.

Represents a collection of waypoints along this leg that were not specified in the original request, either as a result of a user dragging the polyline or selecting an alternate route.

Returns:

property value

See Also:

setViaWaypoints(com.teamdev.jxmaps.LatLng[])

setViaWaypoints

public void setViaWaypoints(LatLng[] waypoints)

Sets new value for viaWaypoints property.

Parameters:

waypoints - new property value

See Also:

getViaWaypoints()