add note about function equivalence with 2 points

This commit is contained in:
Carla 2016-05-25 14:49:32 +02:00
parent ae86785ece
commit bf121ea3e3

View File

@ -60,6 +60,8 @@ Name | Type | Description
`length` | `real` | Length in the defined unit in the `units` field. `kilometers` by default .
`the_geom` | `geometry(LineString)` | LineString geometry of the calculated route in the 4326 projection.
*Note*: A request to the function _cdb\_route\_with\_waypoints(waypoints geometry(Point)[], mode text, [options text[], units text])_ with only two points in the geometry array (automatically defined as origin and destination) is equivalent to performing a request to _cdb\_route\_point\_to\_point(origin geometry(Point), destination geometry(Point), mode text, [options text[], units text])_ with these two locations as parameters.
#### Examples
##### Insert the values from the calculated route in your table