cartodb/torque
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

continuing leaflet api doc style parameters table

Browse Source
This commit is contained in:
Andrew Hill 2013-08-20 14:39:07 -04:00
parent 7f0259f2fc
commit 604302eca5
1 changed files with 9 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/API.md
View File

@ -35,16 +35,20 @@ The core class of the Torque library - it is used to create a torque layer with
##### Provider options ##### Provider options
| Option | type | Default | Description | | Option | type | Default | Description |
|-----------|:----------|:----------|:---------------------------------------| |-----------|:----------|:----------|:---------------------------------------|
| provider | string | sql_api | Where is the data coming from? Alternative is 'url_template'| | provider | string | ```sql_api``` | Where is the data coming from? Alternative is 'url_template'|
##### CartoDB data options ##### CartoDB data options
| Option | type | Default | Description | | Option | type | Default | Description |
|-----------|:----------|:----------|:---------------------------------------| |-----------|:----------|:----------|:---------------------------------------|
| user | string | null | CartoDB account name. Found as, accountname.cartodb.com| | user | string | ```null``` | CartoDB account name. Found as, accountname.cartodb.com|
| table | string | null | CartoDB table name where data is found | | table | string | ```null``` | CartoDB table name where data is found |
| column | string | null | CartoDB table's column name where date information is found (for dynamic type torque layer only)| | column | string | ```null``` | CartoDB table's column name where date information is found (for dynamic type torque layer only)|
| countby | string | null | The aggregation method to use for each pixel displayed where multiple data are found. Any valid PostgreSQL aggregate function | | countby | string | ```null``` | The aggregation method to use for each pixel displayed where multiple data are found. Any valid PostgreSQL aggregate function |
##### Visualization options
| Option | type | Default | Description |
|-----------|:----------|:----------|:---------------------------------------|
| is_time | boolean | ```true``` | Where is the data coming from? Alternative is 'url_template'|
provider: 'sql_api', provider: 'sql_api',