Packagecom.yahoo.maps.api.utils
Classpublic class Distance

A utility class which provides static methods which allow you to convert units of measurement and get point-to-point distance between two locations.



Public Methods
 MethodDefined by
  
getDistance(pointOne:LatLon, pointTwo:LatLon):DistanceResult
[static] Returns the point-to-point distance from one location to another.
Distance
  
[static] Measures the shortest distance between two LatLon points along the surface of a sphere.
Distance
  
metersToKilometers(meters:Number):Number
[static] Converts a distance in meters to kilometers.
Distance
  
metersToMiles(meters:Number):Number
[static] Converts a distance in meters to miles.
Distance
  
metersToNauticalMiles(meters:Number):Number
[static] Converts a distance in meters to nautical miles.
Distance
  
milesToMeters(miles:Number):Number
[static] Converts a distance in miles to meters.
Distance
Method detail
getDistance()method
public static function getDistance(pointOne:LatLon, pointTwo:LatLon):DistanceResult

Returns the point-to-point distance from one location to another.
Returns a DistanceResult object containing the meters, miles and nautical miles.

Parameters
pointOne:LatLon — The beginning location as a latitude and longitude pair.
 
pointTwo:LatLon — The ending location as a latitude and longitude pair.

Returns
DistanceResult — A DistanceResult object

Example
    var result:DistanceResult = Distance.getDistance( new LatLon(33.945, -118.4), new LatLon(47.448,-122.298) );
   

getGeodesicDistance()method 
public static function getGeodesicDistance(pointOne:LatLon, pointTwo:LatLon):DistanceResult

Measures the shortest distance between two LatLon points along the surface of a sphere.

Parameters
pointOne:LatLon — The beginning location as a latitude and longitude pair.
 
pointTwo:LatLon — The ending location as a latitude and longitude pair.

Returns
DistanceResult — A DistanceResult object
metersToKilometers()method 
public static function metersToKilometers(meters:Number):Number

Converts a distance in meters to kilometers.

Parameters
meters:Number

Returns
Number
metersToMiles()method 
public static function metersToMiles(meters:Number):Number

Converts a distance in meters to miles.

Parameters
meters:Number

Returns
Number
metersToNauticalMiles()method 
public static function metersToNauticalMiles(meters:Number):Number

Converts a distance in meters to nautical miles.

Parameters
meters:Number

Returns
Number
milesToMeters()method 
public static function milesToMeters(miles:Number):Number

Converts a distance in miles to meters.

Parameters
miles:Number

Returns
Number