Skip to content

Commit e432a03

Browse files
authored
Update api-doc.md
1 parent 450fda8 commit e432a03

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/web/api-doc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,11 +46,11 @@ ch.disable | `false` | Use this parameter in combination with one or mo
4646
weighting | `fastest` | Which kind of 'best' route calculation you need. Other option is `shortest` (e.g. for foot and bike) and `curvature` (only for motorcycle)
4747
edge_traversal |`false` | Use `true` if you want to consider turn restrictions for bike and motor vehicles. Keep in mind that the response time is roughly 2 times slower.
4848
algorithm |`dijkstrabi`| The algorithm to calculate the route. Other options are `dijkstra`, `astar`, `astarbi`, `alternative_route` and `round_trip`
49-
heading | NaN | Favour a heading direction for a certain point. Specify either one heading for the start point or as many as there are points. In this case headings are associated by their order to the specific points. Headings are given as north based clockwise angle between 0 and 360 degree.
49+
heading | NaN | Favour a heading direction for a certain point. Specify either one heading for the start point or as many as there are points. In this case headings are associated by their order to the specific points. Headings are given as north based clockwise angle between 0 and 360 degree. This parameter also influences the tour generated with `algorithm=round_trip` and force the initial direction.
5050
heading_penalty | 120 | Penalty for omitting a specified heading. The penalty corresponds to the accepted time delay in seconds in comparison to the route without a heading.
5151
pass_through | `false` | If `true` u-turns are avoided at via-points with regard to the `heading_penalty`.
5252
round_trip.distance | 10000 | If `algorithm=round_trip` this parameter configures approximative length of the resulting round trip
53-
round_trip.seed | 0 | If `algorithm=round_trip` this parameter introduces randomness if e.g. the first try wasn't good
53+
round_trip.seed | 0 | If `algorithm=round_trip` this parameter introduces randomness if e.g. the first try wasn't good.
5454
alternative_route.max_paths | 2 | If `algorithm=alternative_route` this parameter sets the number of maximum paths which should be calculated. Increasing can lead to worse alternatives.
5555
alternative_route.max_weight_factor | 1.4 | If `algorithm=alternative_route` this parameter sets the factor by which the alternatives routes can be longer than the optimal route. Increasing can lead to worse alternatives.
5656
alternative_route.max_share_factor | 0.6 | If `algorithm=alternative_route` this parameter specifies how much alternatives routes can have maximum in common with the optimal route. Increasing can lead to worse alternatives.

0 commit comments

Comments
 (0)