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
Property | 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 |
Method Overview
Method | Explanation |
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. |
getNames (mapping, fallback) | Gets the names of the edge. |
Methods
getName (index, mapping, fallback)
Parameter | 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 |
Data Type | Explanation |
String | The name from the edge. None is also a valid return value. |
getNames (mapping, fallback)
Parameter | 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 |
Data Type | Explanation |
Iterable | An iterable of string consisting of the names (primary and alternatives) from the edge. "None" is also a possible return value. |