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

updated api

Browse Source
This commit is contained in:
javi 2013-11-11 16:55:34 +01:00
parent 59c150a11b
commit bf294e3aaf
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/API.md
View File

@ -23,7 +23,6 @@ One of two core classes for the Torque library - it is used to create an animate
column : 'date', column : 'date',
countby : 'count(cartodb_id)', countby : 'count(cartodb_id)',
resolution : 1, resolution : 1,
is_time : true,
steps : 750, steps : 750,
pixel_size : 3, pixel_size : 3,
blendmode : 'lighter' blendmode : 'lighter'
@ -45,11 +44,6 @@ One of two core classes for the Torque library - it is used to create an animate
| 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 |
##### Dynamic/static options
| Option | type | Default | Description |
|-----------|:-----------|:----------|:---------------------------------------|
| is_time | boolean | ```true``` | Determines if the drawing is static or dynamic/animated |
##### Display options ##### Display options
| Option | type | Default | Description | | Option | type | Default | Description |
@ -60,7 +54,7 @@ One of two core classes for the Torque library - it is used to create an animate
##### Time options ##### Time options
| Option | type | Default | Description | | Option | type | Default | Description |
|-----------|:-----------|:----------|:---------------------------------------| |-----------|:-----------|:----------|:---------------------------------------|
| steps | integer | ```100``` | The number of steps to divide the data into for animated renderings | | steps | integer | ```100``` | The maximun number of steps to divide the data into for animated renderings |
| animationDuration | integer | ```null``` | time in seconds the animation last | | animationDuration | integer | ```null``` | time in seconds the animation last |
### Time methods ### Time methods
@ -133,6 +127,8 @@ One of two core classes for the Torque library - it is used to create a static t
| Method | options | returns | Description | | Method | options | returns | Description |
|-----------|:-----------|:----------|:---------------------------------------| |-----------|:-----------|:----------|:---------------------------------------|
| ```setKey(keys)``` | ```keys numeric/array``` | ```this``` | which data categories to display on the map | | ```setKey(keys)``` | ```keys numeric/array``` | ```this``` | which data categories to display on the map |
| ```setSQL(sql)``` | ```sql string ``` | ```this``` | by default sql torque layer uses is
"select * from table", this method changes the sql query torque uses to fetch the data |
### Style options ### Style options