From 3d696b3504e0c685ca8b126cd1a7cdac5325e807 Mon Sep 17 00:00:00 2001 From: Ihor Yeromin Date: Fri, 17 Nov 2023 22:01:03 +0200 Subject: [PATCH] Docs: Gauge and Bar Gauge updates (#76240) Co-authored-by: nmarrs Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --- .../visualizations/bar-gauge/index.md | 33 ++++++++++++++++--- .../visualizations/gauge/index.md | 15 +++++++++ 2 files changed, 44 insertions(+), 4 deletions(-) diff --git a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md index 955229cf0db..da808ec57e7 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md @@ -91,17 +91,42 @@ This option only applies when the orientation of the bar gauge is horizontal. Wh Select this if you want to render the unfilled region of the bars as dark gray. Not applicable to Retro LCD display mode. +### Bar size + +Choose a bar size mode. + +- **Auto -** Grafana determines the best bar gauge size. +- **Manual -** Manually configure the bar gauge size. + ### Min width -Limit the minimum width of the bar column in the vertical direction. +Limit the minimum width of the bar column when the gauge is oriented vertically. -Automatically show x-axis scrollbar when there is a large amount of data. +Automatically show x-axis scrollbar when there's a large amount of data. + +{{% admonition type="note" %}} +This option only applies when bar size is set to manual. +{{% /admonition %}} ### Min height -Limit the minimum height of the bar row in the horizontal direction. +Limit the minimum height of the bar row when the gauge is oriented horizontally. -Automatically show y-axis scrollbar when there is a large amount of data. +Automatically show y-axis scrollbar when there's a large amount of data. + +{{% admonition type="note" %}} +This option only applies when bar size is set to manual. +{{% /admonition %}} + +### Max height + +Limit the maximum height of the bar row when the gauge is oriented horizontally. + +Automatically show y-axis scrollbar when there's a large amount of data. + +{{% admonition type="note" %}} +This option only applies when bar size is set to manual. +{{% /admonition %}} {{% docs/reference %}} [Calculation types]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/calculation-types" diff --git a/docs/sources/panels-visualizations/visualizations/gauge/index.md b/docs/sources/panels-visualizations/visualizations/gauge/index.md index 3e6975afb60..5a1beaccda2 100644 --- a/docs/sources/panels-visualizations/visualizations/gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/gauge/index.md @@ -65,18 +65,33 @@ Controls if threshold values are shown. Controls if a threshold band is shown outside the inner gauge value band. +### Gauge size + +Choose a gauge size mode. + +- **Auto -** Grafana determines the best gauge size. +- **Manual -** Manually configure the gauge size. + ### Min width Set the minimum width of vertically-oriented gauges. If you set a minimum width, the x-axis scrollbar is automatically displayed when there's a large amount of data. +{{% admonition type="note" %}} +This option only applies when gauge size is set to manual. +{{% /admonition %}} + ### Min height Set the minimum height of horizontally-oriented gauges. If you set a minimum height, the y-axis scrollbar is automatically displayed when there's a large amount of data. +{{% admonition type="note" %}} +This option only applies when gauge size is set to manual. +{{% /admonition %}} + ### Neutral Set the starting value from which every gauge will be filled.