From 73f8212c2f288793065ba7fef0a87230191950ad Mon Sep 17 00:00:00 2001 From: Francisco Dans Date: Fri, 13 Mar 2015 19:08:43 +0100 Subject: [PATCH] adds doc for getvalueforbbox --- doc/API.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/API.md b/doc/API.md index 04bbbd5..5166960 100644 --- a/doc/API.md +++ b/doc/API.md @@ -102,6 +102,13 @@ torqueLayer.setSQL("SELECT * FROM table LIMIT 100"); | Method | options | returns | Description | |-----------|:-----------|:----------|:---------------------------------------| | ```getValueForPos(x, y[, step])```| | an object like { bbox:[], value: VALUE } if there is value for the pos, null otherwise | allows to get the value for the coordinate (in map reference system) for a concrete step. If step is not specified the animation one is used. This method is expensive in terms of CPU so be careful. It returns the value from the raster data not the rendered data | +| ```getValueForBBox(xstart, ystart, xend, yend)```| | a number | returns an accumulated numerical value from all the torque areas within the specified bounds | +| ```getActivePointsBBox(step)```| | list of bbox | returns the list of bounding boxes active for ``step`` +| ```invalidate()```| | | forces a reload of the layer data. + +### Interaction methods (only available for Leaflet) +| Method | options | returns | Description | +|-----------|:-----------|:----------|:---------------------------------------| | ```getActivePointsBBox(step)```| | list of bbox | returns the list of bounding boxes active for ``step`` | ```invalidate()```| | | forces a reload of the layer data.