From acfcdd30e1253e020c69a0b27d58fa742b1645f5 Mon Sep 17 00:00:00 2001
From: Peter Pisljar <peter.pisljar@gmail.com>
Date: Fri, 28 Jul 2017 14:41:39 +0200
Subject: [PATCH] adding docs for goal and gauge (#13140)

* adding docs for goal and gauge
---
 docs/visualize.asciidoc      |  3 +++
 docs/visualize/goal.asciidoc | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)
 create mode 100644 docs/visualize/goal.asciidoc

diff --git a/docs/visualize.asciidoc b/docs/visualize.asciidoc
index de4f4d57ec362..40620bc4661e8 100644
--- a/docs/visualize.asciidoc
+++ b/docs/visualize.asciidoc
@@ -34,6 +34,7 @@ To create a visualization:
 [horizontal]
 <<data-table,Data table>>:: Display the raw data of a composed aggregation.
 <<metric-chart,Metric>>:: Display a single number.
+<<goal-chart,Goal and Gauge>>:: Display a gauge.
 * *Maps*
 [horizontal]
 <<tilemap,Coordinate map>>:: Associate the results of an aggregation with geographic locations.
@@ -143,6 +144,8 @@ include::visualize/markdown.asciidoc[]
 
 include::visualize/metric.asciidoc[]
 
+include::visualize/goal.asciidoc[]
+
 include::visualize/pie.asciidoc[]
 
 include::visualize/tilemap.asciidoc[]
diff --git a/docs/visualize/goal.asciidoc b/docs/visualize/goal.asciidoc
new file mode 100644
index 0000000000000..32306411ae8b2
--- /dev/null
+++ b/docs/visualize/goal.asciidoc
@@ -0,0 +1,36 @@
+[[goal-chart]]
+== Goal and Gauge
+
+A goal visualization displays how your metric progresses toward a fixed goal. A gauge visualization displays in which 
+predefined range falls your metric.
+
+include::y-axis-aggs.asciidoc[]
+
+Open the *Advanced* link to display more customization options:
+
+*JSON Input*:: A text field where you can add specific JSON-formatted properties to merge with the aggregation
+definition, as in the following example:
+
+[source,shell]
+{ "script" : "doc['grade'].value * 1.2" }
+
+NOTE: In Elasticsearch releases 1.4.3 and later, this functionality requires you to enable
+{ref}/modules-scripting.html[dynamic Groovy scripting].
+
+The availability of these options varies depending on the aggregation you choose.
+
+Click the *Options* tab to change the following options:
+
+- *Gauge Type* select between arc, circle and metric display type.
+- *Percentage Mode* will show all values as percentages
+- *Vertical Split* will put the gauges one under another instead of one next to another
+- *Show Labels* selects whether you want to show or hide the labels
+- *Sub Text* text for the label that appears below the value
+- *Auto Extend Range* automatically grows the gauge if value is over its extents.
+- *Ranges* you can add custom ranges. Each range will get assigned a color. If value falls within that range it will get
+assigned that color. A chart with a single range is called a goal chart. A chart with multiple ranges is called a gauge
+chart.
+- *Color Options* define how to color your ranges (which color schema to use). Color options are only visible if more than
+one range is defined.
+- *Style - Show Scale* shows or hides the scale
+- *Style - Color Labels* whether the labels should have the same color as the range where the value falls in