diff options
Diffstat (limited to 'web/api/formatters/json/README.md')
| -rw-r--r-- | web/api/formatters/json/README.md | 37 |
1 files changed, 18 insertions, 19 deletions
diff --git a/web/api/formatters/json/README.md b/web/api/formatters/json/README.md index 033bf8eb0..8a0e37bfc 100644 --- a/web/api/formatters/json/README.md +++ b/web/api/formatters/json/README.md @@ -2,26 +2,26 @@ The CSV formatter presents [results of database queries](../../queries) in the following formats: -format|content type|description -:---:|:---:|:----- -`json`|application/json|return the query result as a json object -`jsonp`|application/json|return the query result as a JSONP javascript callback -`datatable`|application/json|return the query result as a Google `datatable` -`datasource`|application/json|return the query result as a Google Visualization Provider `datasource` javascript callback +| format | content type | description| +|:----:|:----------:|:----------| +| `json` | application/json | return the query result as a json object| +| `jsonp` | application/json | return the query result as a JSONP javascript callback| +| `datatable` | application/json | return the query result as a Google `datatable`| +| `datasource` | application/json | return the query result as a Google Visualization Provider `datasource` javascript callback| The CSV formatter respects the following API `&options=`: -option|supported|description -:---:|:---:|:--- -`google_json`|yes|enable the Google flavor of JSON (using double quotes for strings and `Date()` function for dates -`objectrows`|yes|return each row as an object, instead of an array -`nonzero`|yes|to return only the dimensions that have at least a non-zero value -`flip`|yes|to return the rows older to newer (the default is newer to older) -`seconds`|yes|to return the date and time in unix timestamp -`ms`|yes|to return the date and time in unit timestamp as milliseconds -`percent`|yes|to replace all values with their percentage over the row total -`abs`|yes|to turn all values positive -`null2zero`|yes|to replace gaps with zeros (the default prints the string `null` +| option | supported | description| +|:----:|:-------:|:----------| +| `google_json` | yes | enable the Google flavor of JSON (using double quotes for strings and `Date()` function for dates| +| `objectrows` | yes | return each row as an object, instead of an array| +| `nonzero` | yes | to return only the dimensions that have at least a non-zero value| +| `flip` | yes | to return the rows older to newer (the default is newer to older)| +| `seconds` | yes | to return the date and time in unix timestamp| +| `ms` | yes | to return the date and time in unit timestamp as milliseconds| +| `percent` | yes | to replace all values with their percentage over the row total| +| `abs` | yes | to turn all values positive| +| `null2zero` | yes | to replace gaps with zeros (the default prints the string `null`| ## Examples @@ -148,5 +148,4 @@ google.visualization.Query.setResponse({version:'0.6',reqId:'0',status:'ok',sig: }}); ``` - -[]() +[](<>) |