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

Merge pull request #126 from CartoDB/updateAPIdoc

Browse Source 
Added some missing methods
This commit is contained in:
Francisco Dans 2015-02-16 09:51:49 +01:00
commit 2c04ed0a40
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/API.md
View File

@ -45,8 +45,14 @@ One of two core classes for the Torque library - it is used to create an animate
| ```toggle()```| | ```this```| toggles (pause/play) the animation | ```toggle()```| | ```this```| toggles (pause/play) the animation
| ```getStep()``` | | current animation step (integer) | gets the current animation step | ```getStep()``` | | current animation step (integer) | gets the current animation step
| ```getTime()``` | | current animation time (Date) | gets the real animation time | ```getTime()``` | | current animation time (Date) | gets the real animation time
| ```isRunning()``` | | `true`/`false` | describes whether the Torque layer is playing or is stopped
### Layer control methods
| Method | options | returns | Description |
|-----------|:-----------|:----------|:---------------------------------------|
| ```hide()``` | none |```this``` | hides the Torque layer |
| ```show()```| none| ```this``` | shows the Torque layer |
### Style methods ### Style methods