TraversedEdge

Summary

Represents a single edge of a route.

Discussion

This object is acquired through the DirectionsQuery class and cannot be created. A typical route is an alternating sequence of edges and junctions, for example, RouteJunction -> RouteEdge -> RouteJunction -> RouteEdge -> RouteJunction.

The TraversedEdge class is inherited from the TraversedElement class, therefore, all the properties of the TraversedElement class are also accessible from the TraversedEdge class.

Properties

Name	Explanation	Data type
administrativeArea (Read only)	The name of the administrative area the edge is in.	String
arrivalTime (Read only)	The time at the start of the edge (in UTC).	DateTime
departureTime (Read only)	The time at the end of the edge (in UTC).	DateTime
directionPoints (Read and Write)	The direction points associated with the edge.	DirectionPoint
drivingSide (Read only)	The driving side value.	DrivingSide
element (Read only)	The network edge element.	Edge
floorName (Read only)	The name of a floor the edge is on.	String
fromLevel (Read only)	The starting level of the edge.	Integer
fromPosition (Read only)	The position on a network element where the route edge starts. The values are in the range of 0.0 to 1.0.	Float
generalizedAzimuths (Read only)	A generalized azimuth calculated farther away than the `immediateAzimuths` property value from the start and end of the edge.	Object
immediateAzimuths (Read only)	The azimuth calculated at close proximity to the start and end of the edge. The tuple contains float values.	tuple
names (Read only)	An iterable of the names of the edge.	DirectionsName
referenceLandmarks (Read only)	An iterable of reference landmarks related to the edge.	ReferenceLandmark
spatialLandmarks (Read only)	An iterable of spatial landmarks related to the edge.	SpatialLandmark
timezoneID (Read only)	The ID of the time zone the edge is in.	Integer
toLevel (Read only)	The ending level of the edge.	Integer
toPostition (Read only)	The position on a network element where the route edge ends. The values are in the range of 0.0 to 1.0.	Float

Methods

`getName(index, mapping, fallback)`

Gets the name of the edge. The full name or a portion of the name can be returned depending on the mapping parameter value.

Name	Explanation	Data type
index	The type of name that will be retrieved (for example, PrimaryName = 0, AlternateName1 = 1, AlternateName2 = 2, and so on depending on the network dataset’s direction configuration). The default value is 0.	Integer
mapping	The portion of the name that will be returned. The default value is DirectionsFieldMapping.FullName.	DirectionsFieldMapping
fallback	The value if the edge does not contain the requested mapped property. The default value is "".	String

Name

Explanation

Data type

index

The type of name that will be retrieved (for example, PrimaryName = 0, AlternateName1 = 1, AlternateName2 = 2, and so on depending on the network dataset’s direction configuration).

The default value is 0.

Integer

mapping

The portion of the name that will be returned.

The default value is DirectionsFieldMapping.FullName.

DirectionsFieldMapping

fallback

The value if the edge does not contain the requested mapped property.

The default value is "".

String

Return value

Data type	Explanation
String	The name from the edge. `None` is also a valid return value.

`getNames(mapping, fallback)`

Gets the names of the edge.

Name	Explanation	Data type
mapping	The portion of the name that will be returned. The default value is DirectionsFieldMapping.FullName.	DirectionsFieldMapping
fallback	The value if the edge does not contain the requested mapped property. The default value is "".	String