From daf9d8f884435e85ab4085a92af65bd6871a361a Mon Sep 17 00:00:00 2001 From: "grafana-delivery-bot[bot]" <132647405+grafana-delivery-bot[bot]@users.noreply.github.com> Date: Wed, 1 May 2024 18:15:13 -0400 Subject: [PATCH] [v11.0.x] Docs: add field overrides shared content (#87205) Docs: add field overrides shared content (#87197) * Added field overrides shared file * Added link to overrides file in visualizations pages * ihm/010524-field-override-shared-content/ run lint --------- Co-authored-by: jev forsberg (cherry picked from commit d5cfcc8187e59bb0393a352c58b2044e77991db5) Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> --- .../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/heatmap/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/xy-chart/index.md | 8 ++++---- .../shared/visualizations/overrides-options.md | 17 +++++++++++++++++ 17 files changed, 81 insertions(+), 4 deletions(-) create mode 100644 docs/sources/shared/visualizations/overrides-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 ec121fda0f4..70475a223c8 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md @@ -203,6 +203,10 @@ You can set standard min/max options to define hard limits of the Y-axis. For mo {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Add a field override]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides#add-a-field-override" [Add a field override]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-overrides#add-a-field-override" diff --git a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md index a55e0a60622..e79c2530b3f 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md @@ -142,6 +142,10 @@ This option only applies when bar size is set to manual. {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Calculation types]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" [Calculation types]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/calculation-types" diff --git a/docs/sources/panels-visualizations/visualizations/candlestick/index.md b/docs/sources/panels-visualizations/visualizations/candlestick/index.md index b56c02ac444..8935e6d2627 100644 --- a/docs/sources/panels-visualizations/visualizations/candlestick/index.md +++ b/docs/sources/panels-visualizations/visualizations/candlestick/index.md @@ -134,6 +134,10 @@ The candlestick visualization is based on the time series visualization. It can {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [time series visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/time-series" [time series visualization]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/time-series" diff --git a/docs/sources/panels-visualizations/visualizations/canvas/index.md b/docs/sources/panels-visualizations/visualizations/canvas/index.md index fa6a3b77716..e07fa69a908 100644 --- a/docs/sources/panels-visualizations/visualizations/canvas/index.md +++ b/docs/sources/panels-visualizations/visualizations/canvas/index.md @@ -181,6 +181,10 @@ If multiple elements use the same field name, and you want to control which elem {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [data links]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-data-links" [data links]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-data-links" diff --git a/docs/sources/panels-visualizations/visualizations/gauge/index.md b/docs/sources/panels-visualizations/visualizations/gauge/index.md index 66fff2e0675..2ead9ab9b71 100644 --- a/docs/sources/panels-visualizations/visualizations/gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/gauge/index.md @@ -117,6 +117,10 @@ Adjust the sizes of the gauge text. {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Calculation types]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" [Calculation types]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/calculation-types" diff --git a/docs/sources/panels-visualizations/visualizations/geomap/index.md b/docs/sources/panels-visualizations/visualizations/geomap/index.md index 189407300ae..15233e2f691 100644 --- a/docs/sources/panels-visualizations/visualizations/geomap/index.md +++ b/docs/sources/panels-visualizations/visualizations/geomap/index.md @@ -613,6 +613,10 @@ Displays debug information in the upper right corner. This can be useful for deb {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [provisioning docs page]: "/docs/grafana/ -> /docs/grafana//administration/provisioning" [provisioning docs page]: "/docs/grafana-cloud/ -> /docs/grafana//administration/provisioning" diff --git a/docs/sources/panels-visualizations/visualizations/heatmap/index.md b/docs/sources/panels-visualizations/visualizations/heatmap/index.md index 8f6d62c41b3..a43c60ce3d2 100644 --- a/docs/sources/panels-visualizations/visualizations/heatmap/index.md +++ b/docs/sources/panels-visualizations/visualizations/heatmap/index.md @@ -178,6 +178,10 @@ Choose whether you want to display the heatmap legend on the visualization by to {{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +### Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + ### Exemplars Set the color used to show exemplar data. diff --git a/docs/sources/panels-visualizations/visualizations/histogram/index.md b/docs/sources/panels-visualizations/visualizations/histogram/index.md index d3b58bc2c63..f1300d2cba8 100644 --- a/docs/sources/panels-visualizations/visualizations/histogram/index.md +++ b/docs/sources/panels-visualizations/visualizations/histogram/index.md @@ -137,6 +137,10 @@ Gradient color is generated based on the hue of the line color. {{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [color scheme]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" [color scheme]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options#color-scheme" diff --git a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md index b5bab1dc035..2aa0fd5f9a6 100644 --- a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md @@ -121,6 +121,10 @@ Select values to display in the legend. You can select more than one. {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Calculation types]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" [Calculation types]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/calculation-types" diff --git a/docs/sources/panels-visualizations/visualizations/stat/index.md b/docs/sources/panels-visualizations/visualizations/stat/index.md index fe320a7cf8c..2b5616293e4 100644 --- a/docs/sources/panels-visualizations/visualizations/stat/index.md +++ b/docs/sources/panels-visualizations/visualizations/stat/index.md @@ -201,6 +201,10 @@ Adjust the sizes of the gauge text. {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Calculation types]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" [Calculation types]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/calculation-types" diff --git a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md index 7a0c47c2dad..90708573e46 100644 --- a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md +++ b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md @@ -150,6 +150,10 @@ The visualization can be used with time series data as well. In this case, the t {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Color scheme]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" [Color scheme]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options#color-scheme" diff --git a/docs/sources/panels-visualizations/visualizations/status-history/index.md b/docs/sources/panels-visualizations/visualizations/status-history/index.md index bf614a737a4..6431627c84c 100644 --- a/docs/sources/panels-visualizations/visualizations/status-history/index.md +++ b/docs/sources/panels-visualizations/visualizations/status-history/index.md @@ -130,6 +130,10 @@ To assign colors to boolean or string values, use the [Value mappings][]. {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Value mappings]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-value-mappings" [Value mappings]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-value-mappings" diff --git a/docs/sources/panels-visualizations/visualizations/table/index.md b/docs/sources/panels-visualizations/visualizations/table/index.md index 8a6a61fa24b..e41f49ad256 100644 --- a/docs/sources/panels-visualizations/visualizations/table/index.md +++ b/docs/sources/panels-visualizations/visualizations/table/index.md @@ -246,6 +246,10 @@ If you want to show the number of rows in the dataset instead of the number of v {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [calculations]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" [calculations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/calculation-types" diff --git a/docs/sources/panels-visualizations/visualizations/time-series/index.md b/docs/sources/panels-visualizations/visualizations/time-series/index.md index f3075b35994..f5f64d7fb66 100644 --- a/docs/sources/panels-visualizations/visualizations/time-series/index.md +++ b/docs/sources/panels-visualizations/visualizations/time-series/index.md @@ -313,6 +313,10 @@ The following image shows a bar chart with the **Green-Yellow-Red (by value)** c {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Color scheme]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" [Color scheme]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options#color-scheme" diff --git a/docs/sources/panels-visualizations/visualizations/trend/index.md b/docs/sources/panels-visualizations/visualizations/trend/index.md index 84a6b9381e8..6d16d65ed34 100644 --- a/docs/sources/panels-visualizations/visualizations/trend/index.md +++ b/docs/sources/panels-visualizations/visualizations/trend/index.md @@ -58,6 +58,10 @@ For example, you could represent engine power and torque versus speed where spee {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + {{% docs/reference %}} [Time series visualization]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/time-series" [Time series visualization]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/time-series" diff --git a/docs/sources/panels-visualizations/visualizations/xy-chart/index.md b/docs/sources/panels-visualizations/visualizations/xy-chart/index.md index a789d0b6d13..9734301d73b 100644 --- a/docs/sources/panels-visualizations/visualizations/xy-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/xy-chart/index.md @@ -234,6 +234,10 @@ The transform option is only available as an override. {{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +## Field overrides + +{{< docs/shared lookup="visualizations/overrides-options.md" source="grafana" version="" >}} + ## Other visualization options ### Panel options @@ -244,10 +248,6 @@ Learn about [panel options][] that you can set for a visualization. Learn about [standard options][] that you can set for a visualization. -### Field overrides - -Learn about [field overrides][Configure field overrides] that you can set for a visualization. - {{% docs/reference %}} [Color scheme]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" [Color scheme]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options#color-scheme" diff --git a/docs/sources/shared/visualizations/overrides-options.md b/docs/sources/shared/visualizations/overrides-options.md new file mode 100644 index 00000000000..ef50b1759c1 --- /dev/null +++ b/docs/sources/shared/visualizations/overrides-options.md @@ -0,0 +1,17 @@ +--- +title: Field overrides options +comments: | + This file is used in the following visualizations: bar chart, bar gauge, candlestick, canvas, gauge, geomap, heatmap, histogram, pie chart, stat, state timeline, status history, table, time series, trend, xy chart +--- + +Overrides allow you to customize visualization settings for specific fields or series. When you add an override rule, it targets a particular set of fields and lets you define multiple options for how that field is displayed. + +Choose from one the following override options: + +- **Fields with name** - Select a field from the list of all available fields. +- **Fields with name matching regex** - Specify fields to override with a regular expression. +- **Fields with type** - Select fields by type, such as string, numeric, or time. +- **Fields returned by query** - Select all fields returned by a specific query, such as A, B, or C. +- **Fields with values** - Select all fields returned by your defined reducer condition, such as **Min**, **Max**, **Count**, **Total**. + +To learn more, refer to [Configure field overrides](../../configure-overrides/).