DirectionPoint
Summary
A maneuver or an event along a route.
Discussion
Direction points are associated with a junction or an edge. They (direction points) hold the information that will be reported in the output directions.
The DirectionsCustomizer class is used to update, add, or remove direction points.
Syntax
DirectionPoint(element)
| Name | Explanation | Data type |
|---|---|---|
|
element |
The element the direction point is associated with. The element can be a traversed junction or a traversed edge. |
Object |
Properties
| Name | Explanation | Data type |
|---|---|---|
|
alternateName (Read and Write) |
The alternate name components in the directions. |
DirectionsName |
|
arrivalTime (Read only) |
The time when the direction point will be reached (in local time). The value generated by the engine for new points. |
DateTime |
|
azimuth (Read only) |
The bearing, in degrees, of the vehicle departing the point in range [0, 360]. A value of zero indicates north. The value is generated by the engine for new points. |
Float |
|
branchNames (Read and Write) |
The signpost branch name components in the directions. |
DirectionsName |
|
directionPointType (Read and Write) |
The direction point type. |
DirectionPointType |
|
displayText (Read and Write) |
The directions text formatted for display in the UI. |
String |
|
exitName (Read and Write) |
The highway exit name components in the directions. |
DirectionsName |
|
exitNumber (Read only) |
The exit number on a roundabout. |
Integer |
|
intersectingNames (Read and Write) |
The iterable of name components of the intersecting or cross street in the directions. |
DirectionsName |
|
name (Read and Write) |
The name components of the direction point. |
DirectionsName |
|
positionAlong (Read and Write) |
The position of the direction point along an edge. The value must be between the edge's from and to positions. If it's on a junction, the value must be 0.0. |
Float |
|
shortVoiceInstruction (Read and Write) |
A shortened version of the directions text formatted for voice guidance. The text will include expanded abbreviations and plurals. |
String |
|
towardNames (Read and Write) |
The signpost toward destination name components in the directions. |
DirectionsName |
|
voiceInstruction (Read and Write) |
The directions text formatted for voice guidance. The text will include expanded abbreviations and plurals. |
String |