cartodb4/dataservices-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed some typos in the reference docs

Browse Source
This commit is contained in:
Mario de Frutos
2016-02-12 11:16:35 +01:00
parent 3889904afe
commit bde183e9c1
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/reference.md
+7 -3
View File
@@ -323,7 +323,7 @@ This function provides an isolines generator sirves based on time or distance.
#### Arguments #### Arguments
Name | Type | Description | Accepted values Name | Type | Description | Accepted values
--- | --- | --- --- | --- | --- | ---
`source` | `geometry` | Source point, in 4326 projection, taken as the start point `source` | `geometry` | Source point, in 4326 projection, taken as the start point
`mode` | `geometry` | Type of transport used to calculate the isolines. | `car` and `walk` `mode` | `geometry` | Type of transport used to calculate the isolines. | `car` and `walk`
`range` | `integer[]` | Range of the isoline in meters `range` | `integer[]` | Range of the isoline in meters
@@ -334,7 +334,7 @@ Name | Type | Description | Accepted values
The options values must be pass in the following way: `option=value`. The options values must be pass in the following way: `option=value`.
Name | Type | Description | Accepted values Name | Type | Description | Accepted values
--- | --- | --- --- | --- | --- | ---
`is_destination` | `boolean` | If is true the source point is the destination instead of the starting one. `is_destination` | `boolean` | If is true the source point is the destination instead of the starting one.
`mode_type` | `text` | Type of route calculation | `shortest` or `fastest`. By default is `shortest` `mode_type` | `text` | Type of route calculation | `shortest` or `fastest`. By default is `shortest`
`mode_traffic` | `text` | Use the traffic data to calculate the route. | `enabled` or `disabled`. By default is `disabled` `mode_traffic` | `text` | Use the traffic data to calculate the route. | `enabled` or `disabled`. By default is `disabled`
@@ -345,7 +345,7 @@ Name | Type | Description | Accepted values
#### Returns #### Returns
Name | Type | Description | Accepted values Name | Type | Description
--- | --- | --- --- | --- | ---
`center` | `geometry` | Source point, in 4326 projection, taken as the start point `center` | `geometry` | Source point, in 4326 projection, taken as the start point
`data_range` | `integer` | The range that belongs to the generated isoline. `data_range` | `integer` | The range that belongs to the generated isoline.
@@ -355,8 +355,10 @@ Name | Type | Description | Accepted values
##### Select ##### Select
```bash
SELECT cdb_isodistance('010100000000000000008006C00DEB9D3C72F44340', 'car', ARRAY[1000,2000]::integer[]); SELECT cdb_isodistance('010100000000000000008006C00DEB9D3C72F44340', 'car', ARRAY[1000,2000]::integer[]);
SELECT cdb_isodistance('010100000000000000008006C00DEB9D3C72F44340', 'walk', ARRAY[1000]::integer[], ARRAY['mode_traffic=enabled,quality=3']::text[]); SELECT cdb_isodistance('010100000000000000008006C00DEB9D3C72F44340', 'walk', ARRAY[1000]::integer[], ARRAY['mode_traffic=enabled,quality=3']::text[]);
```
### cdb_isochrone(_source geometry, mode text, range integer[], options text[]_) ### cdb_isochrone(_source geometry, mode text, range integer[], options text[]_)
@@ -366,5 +368,7 @@ This function uses the same parameters and info as the `cdb_isodistance` functio
##### Select ##### Select
```bash
SELECT cdb_isochrone('010100000000000000008006C00DEB9D3C72F44340', 'car', ARRAY[300,900,12000]::integer[]); SELECT cdb_isochrone('010100000000000000008006C00DEB9D3C72F44340', 'car', ARRAY[300,900,12000]::integer[]);
SELECT cdb_isodistance('010100000000000000008006C00DEB9D3C72F44340', 'walk', ARRAY[300,900]::integer[], ARRAY['mode_traffic=enabled,quality=3']::text[]); SELECT cdb_isodistance('010100000000000000008006C00DEB9D3C72F44340', 'walk', ARRAY[300,900]::integer[], ARRAY['mode_traffic=enabled,quality=3']::text[]);
```