Class nokia.maps.routing.WaypointParameterList
Class Summary
The class WaypointParameterList wraps a list of waypoints
that may have different representations.
A waypoint can be specified using a nokia.maps.geo.Coordinate,
a nokia.maps.search.Place or a nokia.maps.search.Location.
Method Summary
addCoordinate
(coord)
This method adds an object containing geographical coordinates to the given instance of
WaypointParameterList.
addLocation
(location)
This method adds a location object to the given instance of
WaypointParameterList.
addPlace
(place)
This method adds a place object to the given instance of
WaypointParameterList.
clear
()
This method clears the given instance of the waypoint parameter list.
size
()
: Number
This method retreives the size of the given instance of the waypoint parameter list.
toCoordinates
()
: nokia.maps.geo.Coordinate[]
This method converts the given instance of the
WaypontParameterList to an array of instances of nokia.maps.geo.Coordinate.
Constructor Detail
Method Detail
addCoordinate
(coord)
This method adds an object containing geographical coordinates to the given instance of
WaypointParameterList.
Parameters:
| {nokia.maps.geo.Coordinate} | coord | An object containing the geographical coordinates of a location |
addLocation
(location)
This method adds a location object to the given instance of
WaypointParameterList.
Parameters:
| {nokia.maps.search.Location} | location | A location object to be added |
addPlace
(place)
This method adds a place object to the given instance of
WaypointParameterList.
Parameters:
| {nokia.maps.search.Place} | place | A place object to be added |
size
()
: Number
This method retreives the size of the given instance of the waypoint parameter list.
Returns:
| {Number} | A numeric value representing the number of waypoint parameters in the list |
toCoordinates
()
: nokia.maps.geo.Coordinate[]
This method converts the given instance of the
WaypontParameterList
to an array of instances of nokia.maps.geo.Coordinate.
Returns:
| {nokia.maps.geo.Coordinate[]} | An array of latitude-longitude objects |