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-08-29 12:53:08 +02:00
parent 9cde3d5c08
commit b66efd4d74
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/API.md
View File

@ -45,7 +45,7 @@ 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 (Note for Santana: we can remove this option?) ##### Dynamic/static options
| Option | type | Default | Description | | Option | type | Default | Description |
|-----------|:-----------|:----------|:---------------------------------------| |-----------|:-----------|:----------|:---------------------------------------|
| is_time | boolean | ```true``` | Determines if the drawing is static or dynamic/animated | | is_time | boolean | ```true``` | Determines if the drawing is static or dynamic/animated |
@ -55,7 +55,7 @@ One of two core classes for the Torque library - it is used to create an animate
| Option | type | Default | Description | | Option | type | Default | Description |
|-----------|:-----------|:----------|:---------------------------------------| |-----------|:-----------|:----------|:---------------------------------------|
| resolution| numeric | ```2``` | The x and y dimensions of each pixel as returned by the data| | resolution| numeric | ```2``` | The x and y dimensions of each pixel as returned by the data|
| blendmode | boolean | ```null``` | The HTML5 Canvas composite operation for when multiple pixels overlap on the canvas | | blendmode | boolean | ```source-over``` | The HTML5 Canvas composite operation for when multiple pixels overlap on the canvas |
##### Time options ##### Time options
| Option | type | Default | Description | | Option | type | Default | Description |
@ -67,7 +67,7 @@ One of two core classes for the Torque library - it is used to create an animate
| Method | options | returns | Description | | Method | options | returns | Description |
|-----------|:-----------|:----------|:---------------------------------------| |-----------|:-----------|:----------|:---------------------------------------|
| ```setKey(time)``` | ```time numeric``` | ```this``` | sets the animation to the step indicated by ```time```, must be between 0 and N where N equals the number of steps| | ```setTime(time)``` | ```time numeric``` | ```this``` | sets the animation to the step indicated by ```time```, must be between 0 and N where N equals the number of steps|
| ```play```| | ```this```| starts the animation | ```play```| | ```this```| starts the animation
| ```stop```| | ```this```| stops the animation and set time to step 0 | ```stop```| | ```this```| stops the animation and set time to step 0
| ```pause```| | ```this```| stops the animation but keep the current time (play enables the animation again) | ```pause```| | ```this```| stops the animation but keep the current time (play enables the animation again)
@ -126,7 +126,7 @@ One of two core classes for the Torque library - it is used to create a static t
| Option | type | Default | Description | | Option | type | Default | Description |
|-----------|:-----------|:----------|:---------------------------------------| |-----------|:-----------|:----------|:---------------------------------------|
| resolution| numeric | ```2``` | The x and y dimensions of each pixel as returned by the data| | resolution| numeric | ```2``` | The x and y dimensions of each pixel as returned by the data|
| blendmode | boolean | ```null``` | The HTML5 Canvas composite operation for when multiple pixels overlap on the canvas | | blendmode | boolean | ```source-over``` | The HTML5 Canvas composite operation for when multiple pixels overlap on the canvas |
### Filtering options ### Filtering options