adding docs for goal and gauge #13140
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ppisljar
added
Feature:Visualizations
thomasneirynck
approved these changes
Jul 27, 2017
docs/visualize/goal.asciidoc
Outdated
| [[goal-chart]] | ||
| == Goal and Gauge | ||
|
|
||
| A goal visualization displays how your metric progresses toward a fixed goal. Gauge visualization displays in which |
There was a problem hiding this comment.
A gauge visualization displays in which predefined range your metric falls
docs/visualize/goal.asciidoc
Outdated
|
|
||
| include::y-axis-aggs.asciidoc[] | ||
|
|
||
| You can click the *Advanced* link to display more customization options: |
There was a problem hiding this comment.
Open the *Advanced* link for more customization options.
docs/visualize/goal.asciidoc
Outdated
|
|
||
| Click the *Options* tab to change the following options: | ||
|
|
||
| - *Gauge Type* you can select between arc, circle and metric display type. |
There was a problem hiding this comment.
select between arc, circle and metric display type.
docs/visualize/goal.asciidoc
Outdated
| - *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 |
There was a problem hiding this comment.
selects whether you want to show or hide labels
docs/visualize/goal.asciidoc
Outdated
| - *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. |
There was a problem hiding this comment.
... if the value exceeds the configured range.
docs/visualize/goal.asciidoc
Outdated
| - *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. |
There was a problem hiding this comment.
`A chart with a single range is called a goal chart. A chart with multiple ranges is called a gauge chart.
docs/visualize/goal.asciidoc
Outdated
| - *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 |
There was a problem hiding this comment.
whether the labels should have the same color as the range where the value falls in
ppisljar
added a commit
that referenced
this pull request
Jul 28, 2017
* adding docs for goal and gauge
ppisljar
added a commit
that referenced
this pull request
Jul 28, 2017
* adding docs for goal and gauge
ppisljar
added a commit
that referenced
this pull request
Jul 28, 2017
* adding docs for goal and gauge
ppisljar
added a commit
that referenced
this pull request
Jul 28, 2017
* adding docs for goal and gauge
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #12991