Summary
Provides access to directions properties and query methods.
Discussion
A DirectionsQuery object is provided as a parameter to the customize method, allowing access to the output directions traversed junctions and traversed edges. The direction points associated with these elements can be accessed allowing them to be customized.
Properties
| Property | Explanation | Data Type |
| edges (Read Only) | The edges in the sequence being traversed. | TraversedJunction |
| junctions (Read Only) | The junctions in the sequence being traversed. | TraversedJunction |
| routeID (Read Only) | The ID of the route in the result (zero based). | Integer |
| routeName (Read Only) | The name of the route | String |
| softRestrictionNames (Read Only) | An iterable of enabled soft restrictions. | Iterable |
Method Overview
| Method | Explanation |
| adjacentEdges (junction) | Returns the adjacent edges of the specified junction. These edges are not traversed. |
| attributeValue (element, attribute) | Returns the value of the specified network attribute for the element. |
| fieldValue (element, mapped_field_name) | Returns the value of the specified mapped field for the specified element. |
| fromEdge (turn) | Returns the from edge of the specified turn. |
| fromJunction (edge) | Returns the from junction for the specified edge. |
| nextTraversedEdge (junction) | Returns the next edge of the specified junction. |
| previousTraversedEdge (junction) | Returns the previous edge of the specified junction. |
| toEdge (turn) | Returns the to edge of the specified turn. |
| toJunction (edge) | Returns the to junction for the specified edge. |
| turns (junction) | Returns the turns of the specified junction. |
Methods
adjacentEdges (junction)
| Parameter | Explanation | Data Type |
junction | The adjacent edge from the specified junction. | TraversedJunction |
| Data Type | Explanation |
| AdjacentNetworkEdge | An iterable of adjacent edges. |
attributeValue (element, attribute)
| Parameter | Explanation | Data Type |
element | The element that will be queried for the attribute value. | TraversedElement |
attribute | The attribute that the value will be applied to. | Attribute |
| Data Type | Explanation |
| Object | The attribute value or None if the attribute doesn't exist. This could also be an integer, a float, or a boolean. |
fieldValue (element, mapped_field_name)
| Parameter | Explanation | Data Type |
element | A TraversedEdge, TraversedJunction, or TraversedTurn object. | TraversedElement |
mapped_field_name | The mapped field name. | String |
| Data Type | Explanation |
| Object | The field value or None if the field doesn't exist or is not mapped. This could also be an integer, a float, or a string. |
fromEdge (turn)
| Parameter | Explanation | Data Type |
turn | The from edge of the specified turn. | TraversedTurn |
| Data Type | Explanation |
| TraversedEdge | A traversed edge. |
fromJunction (edge)
| Parameter | Explanation | Data Type |
edge | The edge that will get the from junction. | TraversedEdge |
| Data Type | Explanation |
| TraversedJunction | A traversed junction. |
nextTraversedEdge (junction)
| Parameter | Explanation | Data Type |
junction | The next traversed edge from the specified junction. | TraversedJunction |
| Data Type | Explanation |
| TraversedEdge | A traversed edge, or None is also a possible return value. |
previousTraversedEdge (junction)
| Parameter | Explanation | Data Type |
junction | The previous traversed edge from the specified junction | TraversedJunction |
| Data Type | Explanation |
| TraversedEdge | A traversed edge, or None is also a possible return value. |
toEdge (turn)
| Parameter | Explanation | Data Type |
turn | The to edge of the specified turn. | TraversedTurn |
| Data Type | Explanation |
| TraversedEdge | A traversed edge. |
toJunction (edge)
| Parameter | Explanation | Data Type |
edge | The edge that will get the to junction. | TraversedEdge |
| Data Type | Explanation |
| TraversedJunction | A traversed junction. |
turns (junction)
| Parameter | Explanation | Data Type |
junction | The turns of the specified junction. | TraversedJunction |
| Data Type | Explanation |
| TraversedTurn | An iterable of traversed turns. |