From 655be362e66bdad0bf220933058b1d25bf7ad8d6 Mon Sep 17 00:00:00 2001 From: Andrew Hill Date: Tue, 20 Aug 2013 17:16:37 -0400 Subject: [PATCH] moving setKey under play options in the torquelayer --- doc/API.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/API.md b/doc/API.md index 755e907..901d6de 100644 --- a/doc/API.md +++ b/doc/API.md @@ -13,7 +13,7 @@ depending on the map provider you are using you need to use different layer type The core class of the Torque library - it is used to create a torque layer with custom settings. -#### Usage example +### Usage example ```js // initialize a torque layer that uses the CartoDB account details and SQL API to pull in data @@ -30,7 +30,7 @@ The core class of the Torque library - it is used to create a torque layer with }); ``` -#### Options +### Options ##### Provider options | Option | type | Default | Description | @@ -55,9 +55,17 @@ The core class of the Torque library - it is used to create a torque layer with ##### Display options | Option | type | Default | Description | |-----------|:-----------|:----------|:---------------------------------------| -| resolution| numeric | ```2``` | The x and y dimensions of each pixel when rendered on the map. Must match the format of 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 | +## Play options + +| Method | options | returns | Description | +|-----------|:-----------|:----------|:---------------------------------------| +| ```setTime(numeric)``` | ```time``` | ```this``` | sets the animation to the step indicated by ```time```, must be between 0 and N where N equals the number of steps| + + + ## L.TorqueLayer.setKey(time: number) _Arguments_