com.teamdev.jxmaps

Class PathElevationRequest

java.lang.Object

com.teamdev.jxmaps.MapObject

com.teamdev.jxmaps.PathElevationRequest

All Implemented Interfaces:

java.lang.Cloneable

public class PathElevationRequest
extends MapObject

Represents an elevation query sent by the ElevationService containing the path along which to return sampled data. This request defines a continuous path along the earth along which elevation samples should be taken at evenly-spaced distances. All paths from vertex to vertex use segments of the great circle between those two points.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LatLng[]	getPath() Returns value of path property.
int	getSamples() Returns value of samples property.
void	setPath(LatLng[] points) Sets new value for path property.
void	setSamples(int value) Sets new value for samples 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

PathElevationRequest

public PathElevationRequest()

Creates new PathElevationRequest object.

PathElevationRequest

@Deprecated
public PathElevationRequest(Map map)

Deprecated.

Creates new PathElevationRequest object.

Parameters:

map - owner Map object

Method Detail

getPath

public LatLng[] getPath()

Returns value of path property.

Represents the path along which to collect elevation values.

Returns:

property value

See Also:

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

setPath

public void setPath(LatLng[] points)

Sets new value for path property.

Parameters:

points - new property value

See Also:

getPath()

getSamples

public int getSamples()

Returns value of samples property.

Contains the number of equidistant points along the given path for which to retrieve elevation data, including the endpoints. The number of samples must be a value between 2 and 512 inclusive. Required.

Returns:

property value

See Also:

setSamples(int)

setSamples

public void setSamples(int value)

Sets new value for samples property.

Parameters:

value - new property value

See Also:

getSamples()