From 569aed35b46013cbca959a3b60b5ad072f15dcfe Mon Sep 17 00:00:00 2001 From: ppisljar Date: Thu, 27 Jul 2017 10:19:00 +0200 Subject: [PATCH 1/2] adding docs for goal and gauge --- docs/visualize.asciidoc | 3 +++ docs/visualize/goal.asciidoc | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+) create mode 100644 docs/visualize/goal.asciidoc diff --git a/docs/visualize.asciidoc b/docs/visualize.asciidoc index de4f4d57ec362a..40620bc4661e8e 100644 --- a/docs/visualize.asciidoc +++ b/docs/visualize.asciidoc @@ -34,6 +34,7 @@ To create a visualization: [horizontal] <>:: Display the raw data of a composed aggregation. <>:: Display a single number. +<>:: Display a gauge. * *Maps* [horizontal] <>:: 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 00000000000000..2d1b45dc84628b --- /dev/null +++ b/docs/visualize/goal.asciidoc @@ -0,0 +1,35 @@ +[[goal-chart]] +== Goal and Gauge + +A goal visualization displays how your metric progresses toward a fixed goal. Gauge visualization displays in which +predefined range falls your metric. + +include::y-axis-aggs.asciidoc[] + +You can click 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* you can 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 if you want to show the labels or not +- *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. Chart with single range is called goal chart. Chart with multiple ranges is called 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* should the labels get the color of the current values range From 1d83bfd290008fe01038235c80eedd975d87fb44 Mon Sep 17 00:00:00 2001 From: ppisljar Date: Fri, 28 Jul 2017 12:55:46 +0200 Subject: [PATCH 2/2] updating based on review --- docs/visualize/goal.asciidoc | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/visualize/goal.asciidoc b/docs/visualize/goal.asciidoc index 2d1b45dc84628b..32306411ae8b28 100644 --- a/docs/visualize/goal.asciidoc +++ b/docs/visualize/goal.asciidoc @@ -1,12 +1,12 @@ [[goal-chart]] == Goal and Gauge -A goal visualization displays how your metric progresses toward a fixed goal. Gauge visualization displays in which +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[] -You can click the *Advanced* link to display more customization options: +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: @@ -21,15 +21,16 @@ The availability of these options varies depending on the aggregation you choose Click the *Options* tab to change the following options: -- *Gauge Type* you can select between arc, circle and metric display type. +- *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 if you want to show the labels or not +- *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. Chart with single range is called goal chart. Chart with multiple ranges is called gauge chart. +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* should the labels get the color of the current values range +- *Style - Color Labels* whether the labels should have the same color as the range where the value falls in