DirectionsQuery

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

Name	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

Methods

adjacentEdges(junction)

Returns the adjacent edges of the specified junction. These edges are not traversed.

Name	Explanation	Data type
junction	The adjacent edge from the specified junction.	TraversedJunction

Return value

Data type	Explanation
AdjacentNetworkEdge	An iterable of adjacent edges.

attributeValue(element, attribute)

Returns the value of the specified network attribute for the element.

Name	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

Return value

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)

Returns the value of the specified mapped field for the specified element.

Name	Explanation	Data type
element	A TraversedEdge, TraversedJunction, or TraversedTurn object.	TraversedElement
mapped_field_name	The mapped field name.	String

Return value

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)

Returns the from edge of the specified turn.

Name	Explanation	Data type
turn	The from edge of the specified turn.	TraversedTurn

Return value

Data type	Explanation
TraversedEdge	A traversed edge.

fromJunction(edge)

Returns the from junction for the specified edge.

Name	Explanation	Data type
edge	The edge that will get the from junction.	TraversedEdge

Return value

Data type	Explanation
TraversedJunction	A traversed junction.

nextTraversedEdge(junction)

Returns the next edge of the specified junction.

Name	Explanation	Data type
junction	The next traversed edge from the specified junction.	TraversedJunction

Return value

Data type	Explanation
TraversedEdge	A traversed edge, or None is also a possible return value.

previousTraversedEdge(junction)

Returns the previous edge of the specified junction.

Name	Explanation	Data type
junction	The previous traversed edge from the specified junction	TraversedJunction

Return value

Data type	Explanation
TraversedEdge	A traversed edge, or None is also a possible return value.

toEdge(turn)

Returns the to edge of the specified turn.

Name	Explanation	Data type
turn	The to edge of the specified turn.	TraversedTurn

Return value

Data type	Explanation
TraversedEdge	A traversed edge.

toJunction(edge)

Returns the to junction for the specified edge.

Name	Explanation	Data type
edge	The edge that will get the to junction.	TraversedEdge

Return value

Data type	Explanation
TraversedJunction	A traversed junction.

turns(junction)

Returns the turns of the specified junction.

Name	Explanation	Data type
junction	The turns of the specified junction.	TraversedJunction

Return value

Data type	Explanation
TraversedTurn	An iterable of traversed turns.