From 9d34224c131fa1070e627918f6d2c973695b01c9 Mon Sep 17 00:00:00 2001 From: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Date: Wed, 22 May 2024 16:26:47 -0400 Subject: [PATCH] [v10.4.x] Docs: Add value mappings shared content (#88191) Docs: Add value mappings shared content (#86996) * Added value mappings shared file * Fixed name of file * Fixed list of visualizations using shared file * Added shared file to visualizations * Updated shared file and added to canvas * Updated shared file intro text * Removed future tense (cherry picked from commit d5fde99c6d46ee17725aa01213f2b779a5728df8) --- .../visualizations/bar-chart/index.md | 4 ++++ .../visualizations/bar-gauge/index.md | 4 ++++ .../visualizations/candlestick/index.md | 4 ++++ .../visualizations/canvas/index.md | 4 ++++ .../visualizations/gauge/index.md | 4 ++++ .../visualizations/geomap/index.md | 4 ++++ .../visualizations/histogram/index.md | 4 ++++ .../visualizations/pie-chart/index.md | 4 ++++ .../visualizations/stat/index.md | 4 ++++ .../visualizations/state-timeline/index.md | 4 ++++ .../visualizations/status-history/index.md | 4 ++++ .../visualizations/table/index.md | 4 ++++ .../visualizations/time-series/index.md | 4 ++++ .../visualizations/trend/index.md | 4 ++++ .../visualizations/value-mappings-options.md | 20 +++++++++++++++++++ 15 files changed, 76 insertions(+) create mode 100644 docs/sources/shared/visualizations/value-mappings-options.md diff --git a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md index d607c510d5b..f1d34dddf57 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md @@ -214,3 +214,7 @@ Set a **Soft min** or **soft max** option for better control of Y-axis limits. B You can set standard min/max options to define hard limits of the Y-axis. For more information, refer to [Standard options definitions](ref:standard-options-definitions). {{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md index 6e9fc2d7ff0..ac5ccdd4b44 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md @@ -135,3 +135,7 @@ 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 %}} + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/candlestick/index.md b/docs/sources/panels-visualizations/visualizations/candlestick/index.md index c0e2c2f2938..23b73bd86c9 100644 --- a/docs/sources/panels-visualizations/visualizations/candlestick/index.md +++ b/docs/sources/panels-visualizations/visualizations/candlestick/index.md @@ -123,3 +123,7 @@ The candlestick visualization is based on the time series visualization. It can ## Tooltip options {{< docs/shared lookup="visualizations/tooltip-options-2.md" source="grafana" version="" >}} + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/canvas/index.md b/docs/sources/panels-visualizations/visualizations/canvas/index.md index 8a52b6d4a9d..c11424c76ca 100644 --- a/docs/sources/panels-visualizations/visualizations/canvas/index.md +++ b/docs/sources/panels-visualizations/visualizations/canvas/index.md @@ -160,3 +160,7 @@ If multiple elements use the same field name, and you want to control which elem 1. Reference the new unique field alias to create the element and field override. {{< video-embed src="/media/docs/grafana/canvas-data-links-9-4-0.mp4" max-width="750px" caption="Data links demo" >}} + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/gauge/index.md b/docs/sources/panels-visualizations/visualizations/gauge/index.md index 20c14525fd0..bdb62f9f5a8 100644 --- a/docs/sources/panels-visualizations/visualizations/gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/gauge/index.md @@ -110,3 +110,7 @@ Adjust the sizes of the gauge text. - **Title -** Enter a numeric value for the gauge title size. - **Value -** Enter a numeric value for the gauge value size. + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/geomap/index.md b/docs/sources/panels-visualizations/visualizations/geomap/index.md index b6ff5059c47..394c67f34fc 100644 --- a/docs/sources/panels-visualizations/visualizations/geomap/index.md +++ b/docs/sources/panels-visualizations/visualizations/geomap/index.md @@ -613,3 +613,7 @@ Displays debug information in the upper right corner. This can be useful for deb - **None** displays tooltips only when a data point is clicked. - **Details** displays tooltips when a mouse pointer hovers over a data point. + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/histogram/index.md b/docs/sources/panels-visualizations/visualizations/histogram/index.md index 852b1a33fc5..ac7d26455d5 100644 --- a/docs/sources/panels-visualizations/visualizations/histogram/index.md +++ b/docs/sources/panels-visualizations/visualizations/histogram/index.md @@ -139,3 +139,7 @@ Gradient color is generated based on the hue of the line color. ### Legend calculations Choose a [standard calculations](ref:standard-calculations) to show in the legend. You can select more than one. + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md index 9fec92a798f..9d12794b95d 100644 --- a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md @@ -118,3 +118,7 @@ Select values to display in the legend. You can select more than one. - **Percent:** The percentage of the whole. - **Value:** The raw numerical value. + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/stat/index.md b/docs/sources/panels-visualizations/visualizations/stat/index.md index 6ce40324fff..977fa6f8308 100644 --- a/docs/sources/panels-visualizations/visualizations/stat/index.md +++ b/docs/sources/panels-visualizations/visualizations/stat/index.md @@ -194,3 +194,7 @@ Adjust the sizes of the gauge text. - **Title -** Enter a numeric value for the gauge title size. - **Value -** Enter a numeric value for the gauge value size. + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md index 047d28adf5f..9d7747ded68 100644 --- a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md +++ b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md @@ -150,3 +150,7 @@ When the legend option is enabled it can show either the value mappings or the t ## Tooltip options {{< docs/shared lookup="visualizations/tooltip-options-1.md" source="grafana" version="" >}} + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/status-history/index.md b/docs/sources/panels-visualizations/visualizations/status-history/index.md index 4173efb7361..4c41971f348 100644 --- a/docs/sources/panels-visualizations/visualizations/status-history/index.md +++ b/docs/sources/panels-visualizations/visualizations/status-history/index.md @@ -130,3 +130,7 @@ When the legend option is enabled it can show either the value mappings or the t ## Tooltip options {{< docs/shared lookup="visualizations/tooltip-options-1.md" source="grafana" version="" >}} + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/table/index.md b/docs/sources/panels-visualizations/visualizations/table/index.md index 3d22ef752d4..8a4de7f6d31 100644 --- a/docs/sources/panels-visualizations/visualizations/table/index.md +++ b/docs/sources/panels-visualizations/visualizations/table/index.md @@ -247,3 +247,7 @@ The system applies the calculation to all numeric fields if you do not select a ### Count rows If you want to show the number of rows in the dataset instead of the number of values in the selected fields, select the **Count** calculation and enable **Count rows**. + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/time-series/index.md b/docs/sources/panels-visualizations/visualizations/time-series/index.md index 3acc9b9390c..eb0fa12f0be 100644 --- a/docs/sources/panels-visualizations/visualizations/time-series/index.md +++ b/docs/sources/panels-visualizations/visualizations/time-series/index.md @@ -327,3 +327,7 @@ The following image shows a line chart with the **Green-Yellow-Red (by value)** The following image shows a bar chart with the **Green-Yellow-Red (by value)** color scheme option selected. {{< figure src="/static/img/docs/time-series-panel/gradient_mode_scheme_bars.png" max-width="1200px" caption="Color scheme: Green-Yellow-Red" >}} + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/trend/index.md b/docs/sources/panels-visualizations/visualizations/trend/index.md index f59b01ca816..b054d444e44 100644 --- a/docs/sources/panels-visualizations/visualizations/trend/index.md +++ b/docs/sources/panels-visualizations/visualizations/trend/index.md @@ -47,3 +47,7 @@ For example, you could represent engine power and torque versus speed where spee ## Tooltip options {{< docs/shared lookup="visualizations/tooltip-options-2.md" source="grafana" version="" >}} + +## Value mappings + +{{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} diff --git a/docs/sources/shared/visualizations/value-mappings-options.md b/docs/sources/shared/visualizations/value-mappings-options.md new file mode 100644 index 00000000000..937801addec --- /dev/null +++ b/docs/sources/shared/visualizations/value-mappings-options.md @@ -0,0 +1,20 @@ +--- +title: Value mappings options +comments: | + This file is used in the following visualizations: bar chart, bar gauge, candlestick, canvas, gauge, geomap, histogram, pie chart, stat, state timeline, status history, table, time series, trend +--- + +Value mapping is a technique you can use to change how data appears in a visualization. + +For each value mapping, set the following options: + +- **Condition** - Choose what's mapped to the display text and (optionally) color: + - **Value** - Specific values + - **Range** - Numerical ranges + - **Regex** - Regular expressions + - **Special** - Special values like `Null`, `NaN` (not a number), or boolean values like `true` and `false` +- **Display text** +- **Color** (Optional) +- **Icon** (Canvas only) + +To learn more, refer to [Configure value mappings](../../configure-value-mappings/).