From 90b594e998bc3b4e66edf39b09edd5c46131a106 Mon Sep 17 00:00:00 2001 From: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Date: Wed, 1 May 2024 18:30:24 -0400 Subject: [PATCH] Docs: add standard options shared content (#87199) * Added standard options shared file * Added missing option to shared file and added shared file link to visualizations pages * Fixed links --- .../visualizations/bar-chart/index.md | 4 ++++ .../visualizations/bar-gauge/index.md | 12 +++++++---- .../visualizations/candlestick/index.md | 4 ++++ .../visualizations/canvas/index.md | 4 ++++ .../visualizations/gauge/index.md | 12 +++++++---- .../visualizations/geomap/index.md | 12 +++++++---- .../visualizations/histogram/index.md | 4 ++++ .../visualizations/pie-chart/index.md | 4 ++++ .../visualizations/stat/index.md | 12 +++++++---- .../visualizations/state-timeline/index.md | 20 +++++++++---------- .../visualizations/status-history/index.md | 16 +++++++-------- .../visualizations/table/index.md | 12 +++++++---- .../visualizations/time-series/index.md | 12 +++++++---- .../visualizations/trend/index.md | 4 ++++ .../visualizations/xy-chart/index.md | 15 ++++++++++---- .../shared/visualizations/standard-options.md | 19 ++++++++++++++++++ 16 files changed, 120 insertions(+), 46 deletions(-) create mode 100644 docs/sources/shared/visualizations/standard-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 70475a223c8..8d75a2685d9 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md @@ -191,6 +191,10 @@ You can set standard min/max options to define hard limits of the Y-axis. For mo {{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} +## Standard options + +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} + ## Data links {{< docs/shared lookup="visualizations/datalink-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 e79c2530b3f..059f5b3ce11 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-gauge/index.md @@ -130,18 +130,22 @@ Automatically show y-axis scrollbar when there's a large amount of data. This option only applies when bar size is set to manual. {{% /admonition %}} -## Data links +## Standard options -{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} -## Thresholds +## Data links -{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Field overrides {{< docs/shared lookup="visualizations/overrides-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 8935e6d2627..c0a96d09ae6 100644 --- a/docs/sources/panels-visualizations/visualizations/candlestick/index.md +++ b/docs/sources/panels-visualizations/visualizations/candlestick/index.md @@ -114,6 +114,10 @@ If your data can't be mapped to these dimensions for some reason (for example, b The candlestick visualization is based on the time series visualization. It can visualize additional data dimensions beyond open, high, low, close, and volume The **Include** and **Ignore** options allow it to visualize other included data such as simple moving averages, Bollinger bands and more, using the same styles and configurations available in the [time series][time series visualization] visualization. +## Standard options + +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} + ## Legend options {{< docs/shared lookup="visualizations/legend-options-1.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 e07fa69a908..306d88c65be 100644 --- a/docs/sources/panels-visualizations/visualizations/canvas/index.md +++ b/docs/sources/panels-visualizations/visualizations/canvas/index.md @@ -173,6 +173,10 @@ If multiple elements use the same field name, and you want to control which elem {{< video-embed src="/media/docs/grafana/canvas-data-links-9-4-0.mp4" max-width="750px" caption="Data links demo" >}} +## Standard options + +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} + ## Thresholds {{< docs/shared lookup="visualizations/thresholds-options-2.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 2ead9ab9b71..92c6ea9e8f7 100644 --- a/docs/sources/panels-visualizations/visualizations/gauge/index.md +++ b/docs/sources/panels-visualizations/visualizations/gauge/index.md @@ -105,18 +105,22 @@ 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. -## Data links +## Standard options -{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} -## Thresholds +## Data links -{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Field overrides {{< docs/shared lookup="visualizations/overrides-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 cbf4d4d17ae..190c1727957 100644 --- a/docs/sources/panels-visualizations/visualizations/geomap/index.md +++ b/docs/sources/panels-visualizations/visualizations/geomap/index.md @@ -603,18 +603,22 @@ 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. -## Data links +## Standard options -{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} -## Thresholds +## Data links -{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Field overrides {{< docs/shared lookup="visualizations/overrides-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 f1300d2cba8..1095200ffa4 100644 --- a/docs/sources/panels-visualizations/visualizations/histogram/index.md +++ b/docs/sources/panels-visualizations/visualizations/histogram/index.md @@ -121,6 +121,10 @@ Transparency of the gradient is calculated based on the values on the Y-axis. Th Gradient color is generated based on the hue of the line color. +## Standard options + +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} + ## Legend options {{< docs/shared lookup="visualizations/legend-options-1.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 2aa0fd5f9a6..d37bdacbd44 100644 --- a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md @@ -80,6 +80,10 @@ The following example shows a pie chart with **Name** and **Percent** labels dis ![Pie chart labels](/static/img/docs/pie-chart-panel/pie-chart-labels-7-5.png) +## Standard options + +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} + ## Tooltip options {{< docs/shared lookup="visualizations/tooltip-options-1.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 2b5616293e4..b4a04bc7db4 100644 --- a/docs/sources/panels-visualizations/visualizations/stat/index.md +++ b/docs/sources/panels-visualizations/visualizations/stat/index.md @@ -189,18 +189,22 @@ 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. -## Data links +## Standard options -{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} -## Thresholds +## Data links -{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Field overrides {{< docs/shared lookup="visualizations/overrides-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 90708573e46..5106f1de5fb 100644 --- a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md +++ b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md @@ -118,18 +118,16 @@ Controls the opacity of state regions. {{< docs/shared lookup="visualizations/disconnect-values.md" source="grafana" version="" >}} -## Value mappings - -To assign colors to boolean or string values, you can use [Value mappings][]. - -{{< figure src="/static/img/docs/v8/value_mappings_side_editor.png" max-width="300px" caption="Value mappings side editor" >}} - ## Time series data with thresholds The visualization can be used with time series data as well. In this case, the thresholds are used to turn the time series into discrete colored state regions. {{< figure src="/static/img/docs/v8/state_timeline_time_series.png" max-width="1025px" caption="state timeline with time series" >}} +## Standard options + +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} + ## Legend options {{< docs/shared lookup="visualizations/legend-options-2.md" source="grafana" version="" >}} @@ -142,14 +140,16 @@ The visualization can be used with time series data as well. In this case, the t {{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} -## Thresholds - -{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} - ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +{{< figure src="/static/img/docs/v8/value_mappings_side_editor.png" max-width="300px" caption="Value mappings side editor" >}} + +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Field overrides {{< docs/shared lookup="visualizations/overrides-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 6431627c84c..02d16c7e20f 100644 --- a/docs/sources/panels-visualizations/visualizations/status-history/index.md +++ b/docs/sources/panels-visualizations/visualizations/status-history/index.md @@ -104,11 +104,9 @@ Controls line width of state regions. Controls the opacity of state regions. -## Value mappings - -To assign colors to boolean or string values, use the [Value mappings][]. +## Standard options -{{< figure src="/static/img/docs/v8/value_mappings_side_editor.png" max-width="300px" caption="Value mappings side editor" >}} +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} ## Legend options @@ -122,14 +120,16 @@ To assign colors to boolean or string values, use the [Value mappings][]. {{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} -## Thresholds - -{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} - ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +{{< figure src="/static/img/docs/v8/value_mappings_side_editor.png" max-width="300px" caption="Value mappings side editor" >}} + +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Field overrides {{< docs/shared lookup="visualizations/overrides-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 e41f49ad256..66ba141324f 100644 --- a/docs/sources/panels-visualizations/visualizations/table/index.md +++ b/docs/sources/panels-visualizations/visualizations/table/index.md @@ -234,18 +234,22 @@ The system applies the calculation to all numeric fields if you do not select a 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**. -## Data links +## Standard options -{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} -## Thresholds +## Data links -{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-2.md" source="grafana" version="" >}} + ## Field overrides {{< docs/shared lookup="visualizations/overrides-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 f5f64d7fb66..a4a10cfd94a 100644 --- a/docs/sources/panels-visualizations/visualizations/time-series/index.md +++ b/docs/sources/panels-visualizations/visualizations/time-series/index.md @@ -301,18 +301,22 @@ The following image shows a bar chart with the **Green-Yellow-Red (by value)** c {{< figure src="/static/img/docs/time-series-panel/gradient_mode_scheme_bars.png" max-width="1200px" caption="Color scheme: Green-Yellow-Red" >}} -## Data links +## Standard options -{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} -## Thresholds +## Data links -{{< docs/shared lookup="visualizations/thresholds-options-1.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} +## Thresholds + +{{< docs/shared lookup="visualizations/thresholds-options-1.md" source="grafana" version="" >}} + ## Field overrides {{< docs/shared lookup="visualizations/overrides-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 6d16d65ed34..85268c1f1e4 100644 --- a/docs/sources/panels-visualizations/visualizations/trend/index.md +++ b/docs/sources/panels-visualizations/visualizations/trend/index.md @@ -38,6 +38,10 @@ For example, you could represent engine power and torque versus speed where spee {{< figure src="/media/docs/grafana/screenshot-grafana-10-0-trend-panel-new-colors.png" max-width="750px" caption="Trend engine power and torque curves" >}} +## Standard options + +{{< docs/shared lookup="visualizations/standard-options.md" source="grafana" version="" >}} + ## Legend options {{< docs/shared lookup="visualizations/legend-options-1.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/xy-chart/index.md b/docs/sources/panels-visualizations/visualizations/xy-chart/index.md index 9734301d73b..39731ae2a4f 100644 --- a/docs/sources/panels-visualizations/visualizations/xy-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/xy-chart/index.md @@ -230,6 +230,17 @@ The transform option is only available as an override. {{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} +## Standard options + +**Standard options** in the panel editor pane let you change how field data is displayed in your visualizations. When you set a standard option, the change is applied to all fields or series. For more granular control over the display of fields, refer to [Configure field overrides][]. + +You can customize the following standard options: + +- **Field min/max** - Enable **Field min/max** to have Grafana calculate the min or max of each field individually, based on the minimum or maximum value of the field. +- **Color scheme** - Set single or multiple colors for your entire visualization. + +To learn more, refer to [Configure standard options][]. + ## Data links {{< docs/shared lookup="visualizations/datalink-options.md" source="grafana" version="" >}} @@ -244,10 +255,6 @@ The transform option is only available as an override. Learn about [panel options][] that you can set for a visualization. -### Standard options - -Learn about [standard options][] 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/standard-options.md b/docs/sources/shared/visualizations/standard-options.md new file mode 100644 index 00000000000..1601ce8324e --- /dev/null +++ b/docs/sources/shared/visualizations/standard-options.md @@ -0,0 +1,19 @@ +--- +title: Standard 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 +--- + +**Standard options** in the panel editor pane let you change how field data is displayed in your visualizations. When you set a standard option, the change is applied to all fields or series. For more granular control over the display of fields, refer to [Configure overrides](../../configure-overrides/). + +You can customize the following standard options: + +- **Unit** - Choose which unit a field should use. +- **Min**/**Max** - Set the minimum and maximum values used in percentage threshold calculations or leave these field empty for them to be calculated automatically. +- **Field min/max** - Enable **Field min/max** to have Grafana calculate the min or max of each field individually, based on the minimum or maximum value of the field. +- **Decimals** - Specify the number of decimals Grafana includes in the rendered value. +- **Display name** - Set the display title of all fields. You can use variables in the field title. +- **Color scheme** - Set single or multiple colors for your entire visualization. +- **No value** - Enter what Grafana should display if the field value is empty or null. The default value is a hyphen (-). + +To learn more, refer to [Configure standard options](../../configure-standard-options/).