aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMisiek <creating.www@gmail.com>2016-07-12 10:04:06 +0200
committerMisiek <creating.www@gmail.com>2016-07-12 10:23:58 +0200
commitf6a8a400223ffd7cd402eade90fcf1015ffa1d4c (patch)
treeeb2cf276e343d935777a86d4dc159e98e0e4b21e
parent49d99df20bad7a36e19a65ed8c6e4438d46278d7 (diff)
downloadtipboard-f6a8a400223ffd7cd402eade90fcf1015ffa1d4c.tar.gz
tipboard-f6a8a400223ffd7cd402eade90fcf1015ffa1d4c.tar.bz2
tipboard-f6a8a400223ffd7cd402eade90fcf1015ffa1d4c.zip
Simplify documentation
-rw-r--r--doc/tile__line_chart.rst20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/tile__line_chart.rst b/doc/tile__line_chart.rst
index ce7152d..3ad764d 100644
--- a/doc/tile__line_chart.rst
+++ b/doc/tile__line_chart.rst
@@ -52,7 +52,7 @@ Example::
::
- value = {<jqplot_config>}
+ value = {<jqplot_config>, simplify: <simplify_config>}
where:
@@ -74,6 +74,24 @@ Example::
-- this will set up the grid (in white color), black background and will turn
off shadow effects as well as borders.
+simplify_config
+
+::
+
+ simplify_config = {
+ tolerancy: 10,
+ data_points_limit: 50, // we will TRY to achieve lower number of data points than this
+ max_simplifying_steps: 5,
+ simplify_step_multiplicator: 1.5
+ };
+
+Each option is self-describing. This feature tries to optimize dataset to achieve points count lower than `data_points_limit`. If simplify_config is not set, there won't be any simplify process at all (you will just have your raw data displayed).
+
+::
+
+ curl -X POST http://127.0.0.1:7272/api/v0.1/dev_key/tileconfig/test_line
+ -d 'value={"simplify": {"tolerancy": 2}}'
+
.. note::
In case of displaying multiple plots on a single chart (e.g. for more than