From 05179a4ef249cf2a68b27aff50565de058c17400 Mon Sep 17 00:00:00 2001 From: Carla Date: Fri, 19 Feb 2016 10:33:35 +0100 Subject: [PATCH] rm quota info, style optional params, rm islands --- doc/isoline_functions.md | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/doc/isoline_functions.md b/doc/isoline_functions.md index 3c20066..be760a6 100644 --- a/doc/isoline_functions.md +++ b/doc/isoline_functions.md @@ -2,15 +2,9 @@ The following functions provide an isolines generator service based on time or distance. This service uses the isolines service defined for the user (currently, only the Here isolines service is available). -This service is subject to quota limitations, and extra fees may apply. Please view our [terms and conditions](https://cartodb.com/terms/). +**This service is subject to quota limitations, and extra fees may apply**. Please view our [terms and conditions](https://cartodb.com/terms/) and check out the [Quota information section](http://docs.cartodb.com/cartodb-platform/dataservices-api/quota-information/) for details and recommendations related with quota usage. -Be mindful of the following when using these functions: - -* One credit per function call will be consumed, and the results are not cached. If the query applies to a _N_ rows dataset, then _N_ credits will be used. -* You are discouraged from using dynamic queries to the isoline functions in your maps. This can result in credits consumption per map view. Note: queries to the Data Services API and any of its functions in your maps may be forbidden in the future. -* You are advised to store results of isoline queries into your datasets and refresh them as needed, so that you can have finer control on your credits' usage. - -### cdb_isodistance(_source geometry, mode text, range integer[], options text[]_) +### cdb_isodistance(_source geometry, mode text, range integer[], [options text[]]_) #### Arguments @@ -19,7 +13,7 @@ Name | Type | Description | Accepted values `source` | `geometry` | Source point, in 4326 projection, which defines the start location. | `mode` | `text` | Type of transport used to calculate the isolines. | `car` or `walk` `range` | `integer[]` | Range of the isoline, in meters. | -`options` | `text[]` | Optional. Multiple options to add more capabilities to the analysis. See [Optional isolines parameters](#optional-isoline-parameters) for details. +`options` | `text[]` | (Optional) Multiple options to add more capabilities to the analysis. See [Optional isolines parameters](#optional-isoline-parameters) for details. #### Returns @@ -49,7 +43,7 @@ SELECT the_geom FROM cdb_isodistance('POINT(-3.70568 40.42028)'::geometry, 'walk ``` -### cdb_isochrone(_source geometry, mode text, range integer[], options text[]_) +### cdb_isochrone(_source geometry, mode text, range integer[], [options text[]]_) #### Arguments @@ -60,7 +54,7 @@ Name | Type | Description | Accepted values `source` | `geometry` | Source point, in 4326 projection, which defines the start location. | `mode` | `text` | Type of transport used to calculate the isolines. | `car` or `walk` `range` | `integer[]` | Range of the isoline, in seconds. | -`options` | `text[]` | Optional. Multiple options to add more capabilities to the analysis. See [Optional isolines parameters](#optional-isoline-parameters) for details. +`options` | `text[]` | (Optional) Multiple options to add more capabilities to the analysis. See [Optional isolines parameters](#optional-isoline-parameters) for details. #### Examples @@ -89,7 +83,6 @@ Name | Type | Description | Accepted values `is_destination` | `boolean` | If true, the source point is the destination instead of the starting location | `true` or `false`. `false` by default `mode_type` | `text` | Type of route calculation | `shortest` or `fastest`. `shortest` by default `mode_traffic` | `text` | Use traffic data to calculate the route | `enabled` or `disabled`. `disabled` by default -`singlecomponent` | `boolean` | If true, the isoline service will return a single polygon area, instead of creating a separate polygon for each reachable area separated of the main polygon (known as island). | `true` or `false`. `false` by default `resolution` | `text` | Allows you to specify the level of detail needed for the isoline polygon. Unit is meters per pixel. Higher resolution may increase the response time of the service. `maxpoints` | `text` | Allows you to limit the amount of points in the returned isoline. If the isoline consists of multiple components, the sum of points from all components is considered. Each component will have at least two points. It is possible that more points than specified could be returned, in case when two * number of components` is higher than the `maxpoints` value itself. Increasing the number of `maxpoints` may increase the response time of the service. `quality` | `text` | Allows you to reduce the quality of the isoline in favor of the response time. | `1`, `2`, `3`. Default value is `1`, corresponding to the best quality option.