From 604302eca5019d1538691a82bda2f97fa4f6ba68 Mon Sep 17 00:00:00 2001 From: Andrew Hill Date: Tue, 20 Aug 2013 14:39:07 -0400 Subject: [PATCH] continuing leaflet api doc style parameters table --- doc/API.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/doc/API.md b/doc/API.md index 265fec1..bcb9b85 100644 --- a/doc/API.md +++ b/doc/API.md @@ -35,16 +35,20 @@ The core class of the Torque library - it is used to create a torque layer with ##### Provider options | Option | type | Default | Description | |-----------|:----------|:----------|:---------------------------------------| -| provider | string | sql_api | Where is the data coming from? Alternative is 'url_template'| +| provider | string | ```sql_api``` | Where is the data coming from? Alternative is 'url_template'| ##### CartoDB data options | Option | type | Default | Description | |-----------|:----------|:----------|:---------------------------------------| -| user | string | null | CartoDB account name. Found as, accountname.cartodb.com| -| table | string | null | CartoDB table name where data is found | -| 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 | +| user | string | ```null``` | CartoDB account name. Found as, accountname.cartodb.com| +| table | string | ```null``` | CartoDB table name where data is found | +| 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 | +##### Visualization options +| Option | type | Default | Description | +|-----------|:----------|:----------|:---------------------------------------| +| is_time | boolean | ```true``` | Where is the data coming from? Alternative is 'url_template'| provider: 'sql_api',