Skip to main content

DirectionsQuery

Zusammenfassung

Provides access to directions properties and query methods.

Diskussion

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.

Eigenschaften

Name Erläuterung Datentyp

edges

(Schreibgeschützt)

The edges in the sequence being traversed.

TraversedJunction

junctions

(Schreibgeschützt)

The junctions in the sequence being traversed.

TraversedJunction

routeID

(Schreibgeschützt)

The ID of the route in the result (zero based).

Integer

routeName

(Schreibgeschützt)

The name of the route

String

softRestrictionNames

(Schreibgeschützt)

An iterable of enabled soft restrictions.

Iterable

Methoden

adjacentEdges(junction)

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

Name Erläuterung Datentyp

junction

The adjacent edge from the specified junction.

TraversedJunction

Rückgabewert

Datentyp Erläuterung

AdjacentNetworkEdge

An iterable of adjacent edges.

attributeValue(element, attribute)

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

Name Erläuterung Datentyp

element

The element that will be queried for the attribute value.

TraversedElement

attribute

The attribute that the value will be applied to.

Attribute

Rückgabewert

Datentyp Erläuterung

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 Erläuterung Datentyp

element

A TraversedEdge, TraversedJunction, or TraversedTurn object.

TraversedElement

mapped_field_name

The mapped field name.

String

Rückgabewert

Datentyp Erläuterung

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 Erläuterung Datentyp

turn

The from edge of the specified turn.

TraversedTurn

Rückgabewert

Datentyp Erläuterung

TraversedEdge

A traversed edge.

fromJunction(edge)

Returns the from junction for the specified edge.

Name Erläuterung Datentyp

edge

The edge that will get the from junction.

TraversedEdge

Rückgabewert

Datentyp Erläuterung

TraversedJunction

A traversed junction.

nextTraversedEdge(junction)

Returns the next edge of the specified junction.

Name Erläuterung Datentyp

junction

The next traversed edge from the specified junction.

TraversedJunction

Rückgabewert

Datentyp Erläuterung

TraversedEdge

A traversed edge, or None is also a possible return value.

previousTraversedEdge(junction)

Returns the previous edge of the specified junction.

Name Erläuterung Datentyp

junction

The previous traversed edge from the specified junction

TraversedJunction

Rückgabewert

Datentyp Erläuterung

TraversedEdge

A traversed edge, or None is also a possible return value.

toEdge(turn)

Returns the to edge of the specified turn.

Name Erläuterung Datentyp

turn

The to edge of the specified turn.

TraversedTurn

Rückgabewert

Datentyp Erläuterung

TraversedEdge

A traversed edge.

toJunction(edge)

Returns the to junction for the specified edge.

Name Erläuterung Datentyp

edge

The edge that will get the to junction.

TraversedEdge

Rückgabewert

Datentyp Erläuterung

TraversedJunction

A traversed junction.

turns(junction)

Returns the turns of the specified junction.

Name Erläuterung Datentyp

junction

The turns of the specified junction.

TraversedJunction

Rückgabewert

Datentyp Erläuterung

TraversedTurn

An iterable of traversed turns.