From 54c503dcc3d930a1bcb74d3c3293d41971e2a245 Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Wed, 7 Oct 2020 11:21:28 -0700 Subject: [PATCH] Docs: Update stat-panel.md (#28088) --- .../panels/visualizations/stat-panel.md | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/sources/panels/visualizations/stat-panel.md b/docs/sources/panels/visualizations/stat-panel.md index 74c6525c58b..e636af32c72 100644 --- a/docs/sources/panels/visualizations/stat-panel.md +++ b/docs/sources/panels/visualizations/stat-panel.md @@ -15,6 +15,18 @@ The Stat panel shows a one large stat value with an optional graph sparkline. Yo > **Note:** This panel replaces the Singlestat panel, which was deprecated in Grafana 7.0. + +By default, the Stat panel displays one of the following: + +- Just the value for a single series or field. +- Both the value and name for multiple series or fields. + +You can use the **Text mode** to control whether the text is displayed or not. + +Example screenshot: + +{{< docs-imagebox img="/img/docs/v71/stat-panel-text-modes.png" max-width="1025px" caption="Stat panel" >}} + ## Data and field options Stat visualizations allow you to apply: @@ -33,12 +45,21 @@ Use the following options to refine your visualization: - **Show -** Choose how Grafana displays your data. - **Calculate -** Show a calculated value based on all rows. - - **All values -** Show a separate stat for every row. If you select this option, then you can also select a **Limit**, or the maximum number of rows to display. + - **Calculation -** Select a calculation to apply. For information about available calculations, refer to the [Calculation list]({{< relref "../calculations-list.md" >}}). + - **All values -** Show a separate stat for every row. + - **Limit -** The maximum number of rows to display. +- **Fields -** Select a field name or field type (including **All fields** or **Numeric fields**) to include in this panel. - **Value -** Select a reducer function that Grafana will use to reduce many fields to a single value. Click the **Value** list to see functions and brief descriptions. - **Orientation -** Choose a stacking direction. - **Auto -** Grafana selects what it thinks is the best orientation. - **Horizontal -** Bars stretch horizontally, left to right. - **Vertical -** Bars stretch vertically, top to bottom. +- **Text mode -** (Only available in Grafana 7.1+.) You can use the Text mode option to control what text the panel renders. If the value is not important, only the name and color is, then change the **Text mode** to **Name**. The value will still be used to determine color and is displayed in a tooltip. + - **Auto -** If the data contains multiple series or fields, show both name and value. + - **Value -** Show only value, never name. Name is displayed in the hover tooltip instead. + - **Value and name -** Always show value and name. + - **Name -** Show name instead of value. Value is displayed in the hover tooltip. + - **None -** Show nothing (empty). Name and value are displayed in the hover tooltip. - **Color mode** - **Value -** Colors only the value and graph area. - **Background -** Colors the background as well. @@ -47,25 +68,4 @@ Use the following options to refine your visualization: - **Area -** Shows the area graph below the value. This requires that your query returns a time column. - **Alignment mode -** Choose an alignment mode. - **Auto -** If only a single value is shown (no repeat), then the value is centered. If multiple series or rows are shown, then the value is left-aligned. - - **Center -** Stat value is centered. -- **Text mode** (Only available in Grafana 7.1+.) - - **Auto -** If the data contains multiple series or fields, show both name and value. - - **Value -** Show only value, never name. Name is displayed in the hover tooltip instead. - - **Value and name -** Always show value and name. - - **Name -** Show name instead of value. Value is displayed in the hover tooltip. - - **None -** Show nothing (empty). Name and value are displayed in the hover tooltip. - -## Text mode - -> Only available in Grafana 7.1+. - -By default, the Stat panel displays: - -- Just the value for a single series or field. -- Both the value and name for multiple series or fields. - -You can use the Text mode option to control what text the panel renders. If the value is not important, only name and color is, then change the `Text mode` to **Name**. The value will still be used to determine color and is displayed in a tooltip. - -Example screenshot: - -{{< docs-imagebox img="/img/docs/v71/stat-panel-text-modes.png" max-width="1025px" caption="Stat panel" >}} + - **Center -** Stat value is centered. \ No newline at end of file