diff --git a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md index f1d34dddf57..f2af82434bd 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md @@ -151,15 +151,7 @@ Gradient color is generated based on the hue of the line color. ## Legend options -Legend options control the series names and statistics that appear under or to the right of the graph. - -{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="" >}} - -### Legend calculations - -Choose which of the [standard calculations](ref:standard-calculations) to show in the legend. You can have more than one. - -For more information about the legend, refer to [Configure a legend](../configure-legend/). +{{< docs/shared lookup="visualizations/legend-options-1.md" source="grafana" version="" >}} ## Text size diff --git a/docs/sources/panels-visualizations/visualizations/candlestick/index.md b/docs/sources/panels-visualizations/visualizations/candlestick/index.md index 23b73bd86c9..e5bb50eac5b 100644 --- a/docs/sources/panels-visualizations/visualizations/candlestick/index.md +++ b/docs/sources/panels-visualizations/visualizations/candlestick/index.md @@ -120,6 +120,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](ref:time-series-visualization) visualization. +## Legend options + +{{< docs/shared lookup="visualizations/legend-options-1.md" source="grafana" version="" >}} + ## Tooltip options {{< docs/shared lookup="visualizations/tooltip-options-2.md" source="grafana" version="" >}} diff --git a/docs/sources/panels-visualizations/visualizations/heatmap/index.md b/docs/sources/panels-visualizations/visualizations/heatmap/index.md index 07fd8f6f0ca..300db34b383 100644 --- a/docs/sources/panels-visualizations/visualizations/heatmap/index.md +++ b/docs/sources/panels-visualizations/visualizations/heatmap/index.md @@ -180,7 +180,7 @@ When you set the **Tooltip mode** to **Single**, this option is displayed. This ### Legend -Choose whether you want to display the heatmap legend on the visualization. +Choose whether you want to display the heatmap legend on the visualization by toggling the **Show legend** switch. ### Exemplars diff --git a/docs/sources/panels-visualizations/visualizations/histogram/index.md b/docs/sources/panels-visualizations/visualizations/histogram/index.md index ac7d26455d5..511f9692f03 100644 --- a/docs/sources/panels-visualizations/visualizations/histogram/index.md +++ b/docs/sources/panels-visualizations/visualizations/histogram/index.md @@ -134,11 +134,9 @@ 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. -{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="" >}} +## Legend options -### Legend calculations - -Choose a [standard calculations](ref:standard-calculations) to show in the legend. You can select more than one. +{{< docs/shared lookup="visualizations/legend-options-1.md" source="grafana" version="" >}} ## Value mappings diff --git a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md index 9d12794b95d..e51f138a8a8 100644 --- a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md @@ -94,25 +94,29 @@ The following example shows a pie chart with **Name** and **Percent** labels dis Use these settings to define how the legend appears in your visualization. For more information about the legend, refer to [Configure a legend]({{< relref "../../configure-legend" >}}). -### Legend visibility +### Visibility -Use the **Visibility** switch to show or hide the legend. +Toggle the switch to turn the legend on or off. -### Legend mode +### Mode -Set the display mode of the legend: +Use these settings to define how the legend appears in your visualization. - **List -** Displays the legend as a list. This is a default display mode of the legend. - **Table -** Displays the legend as a table. -### Legend placement +### Placement Choose where to display the legend. - **Bottom -** Below the graph. - **Right -** To the right of the graph. -### Legend values +#### Width + +Control how wide the legend is when placed on the right side of the visualization. This option is only displayed if you set the legend placement to **Right**. + +### Values Select values to display in the legend. You can select more than one. diff --git a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md index 9d7747ded68..45cd77f24cd 100644 --- a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md +++ b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md @@ -143,9 +143,7 @@ The visualization can be used with time series data as well. In this case, the t ## Legend options -When the legend option is enabled it can show either the value mappings or the threshold brackets. To show the value mappings in the legend, it's important that the `Color scheme` as referenced in [Color scheme](ref:color-scheme) is set to `Single color` or `Classic palette`. To see the threshold brackets in the legend set the `Color scheme` to `From thresholds`. - -{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/legend-options-2.md" source="grafana" version="" >}} ## Tooltip options diff --git a/docs/sources/panels-visualizations/visualizations/status-history/index.md b/docs/sources/panels-visualizations/visualizations/status-history/index.md index 4c41971f348..2c663cb03d4 100644 --- a/docs/sources/panels-visualizations/visualizations/status-history/index.md +++ b/docs/sources/panels-visualizations/visualizations/status-history/index.md @@ -123,9 +123,7 @@ To assign colors to boolean or string values, use the [Value mappings](ref:value ## Legend options -When the legend option is enabled it can show either the value mappings or the threshold brackets. To show the value mappings in the legend, it's important that the `Color scheme` as referenced in [Color scheme](ref:color-scheme) is set to `Single color` or `Classic palette`. To see the threshold brackets in the legend set the `Color scheme` to `From thresholds`. - -{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/legend-options-2.md" source="grafana" version="" >}} ## Tooltip options diff --git a/docs/sources/panels-visualizations/visualizations/time-series/index.md b/docs/sources/panels-visualizations/visualizations/time-series/index.md index eb0fa12f0be..09ac7ca8df7 100644 --- a/docs/sources/panels-visualizations/visualizations/time-series/index.md +++ b/docs/sources/panels-visualizations/visualizations/time-series/index.md @@ -81,9 +81,7 @@ The following video guides you through the creation steps and common customizati ## Legend options -Legend options control the series names and statistics that appear under or to the right of the visualization. - -{{< docs/shared lookup="visualizations/legend-mode.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/legend-options-1.md" source="grafana" version="" >}} ## Graph styles diff --git a/docs/sources/panels-visualizations/visualizations/trend/index.md b/docs/sources/panels-visualizations/visualizations/trend/index.md index b054d444e44..1ccd821ebc1 100644 --- a/docs/sources/panels-visualizations/visualizations/trend/index.md +++ b/docs/sources/panels-visualizations/visualizations/trend/index.md @@ -44,6 +44,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" >}} +## Legend options + +{{< docs/shared lookup="visualizations/legend-options-1.md" source="grafana" version="" >}} + ## Tooltip options {{< docs/shared lookup="visualizations/tooltip-options-2.md" source="grafana" version="" >}} diff --git a/docs/sources/shared/visualizations/legend-mode.md b/docs/sources/shared/visualizations/legend-mode.md deleted file mode 100644 index df8d1a50ec2..00000000000 --- a/docs/sources/shared/visualizations/legend-mode.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Legend mode and legend placement ---- - -### Legend mode - -Use these settings to define how the legend appears in your visualization. For more information about the legend, refer to [Configure a legend](../configure-legend/). - -- **List -** Displays the legend as a list. This is a default display mode of the legend. -- **Table -** Displays the legend as a table. -- **Hidden -** Hides the legend. - -### Legend placement - -Choose where to display the legend. - -- **Bottom -** Below the graph. -- **Right -** To the right of the graph. - -### Legend values - -Choose which of the [standard calculations]({{< relref "../../panels-visualizations/query-transform-data/calculation-types/" >}}) to show in the legend. You can have more than one. diff --git a/docs/sources/shared/visualizations/legend-options-1.md b/docs/sources/shared/visualizations/legend-options-1.md new file mode 100644 index 00000000000..8c101980d70 --- /dev/null +++ b/docs/sources/shared/visualizations/legend-options-1.md @@ -0,0 +1,35 @@ +--- +title: Legend options +comments: | + There are two legend shared files to cover the most common combinations of options. + Using two shared files ensures that content remains consistent across visualizations that share the same options and users don't have to figure out which options apply to a specific visualization when reading that content. + This file is used in the following visualizations: bar chart, candlestick, histogram, time series, trend, xy chart +--- + +Legend options control the series names and statistics that appear under or to the right of the graph. For more information about the legend, refer to [Configure a legend](../configure-legend/). + +### Visibility + +Toggle the switch to turn the legend on or off. + +### Mode + +Use these settings to define how the legend appears in your visualization. + +- **List -** Displays the legend as a list. This is a default display mode of the legend. +- **Table -** Displays the legend as a table. + +### Placement + +Choose where to display the legend. + +- **Bottom -** Below the graph. +- **Right -** To the right of the graph. + +#### Width + +Control how wide the legend is when placed on the right side of the visualization. This option is only displayed if you set the legend placement to **Right**. + +### Values + +Choose which of the [standard calculations](../../query-transform-data/calculation-types/) to show in the legend. You can have more than one. diff --git a/docs/sources/shared/visualizations/legend-options-2.md b/docs/sources/shared/visualizations/legend-options-2.md new file mode 100644 index 00000000000..9abfe0adfc7 --- /dev/null +++ b/docs/sources/shared/visualizations/legend-options-2.md @@ -0,0 +1,33 @@ +--- +title: Legend mode and legend placement +comments: | + There are two legend shared files to cover the most common combinations of options. + Using two shared files ensures that content remains consistent across visualizations that share the same options and users don't have to figure out which options apply to a specific visualization when reading that content. + This file is used in the following visualizations: state timeline, status history +--- + +When the legend option is enabled it can show either the value mappings or the threshold brackets. To show the value mappings in the legend, it's important that the **Color scheme** as referenced in [Color scheme](../../configure-standard-options#color-scheme) is set to **Single color** or **Classic palette**. To see the threshold brackets in the legend set the **Color scheme** to **From thresholds**. + +For more information about the legend, refer to [Configure a legend](../configure-legend/). + +### Visibility + +Toggle the switch to turn the legend on or off. + +### Mode + +Use these settings to define how the legend appears in your visualization. + +- **List -** Displays the legend as a list. This is a default display mode of the legend. +- **Table -** Displays the legend as a table. + +### Placement + +Choose where to display the legend. + +- **Bottom -** Below the graph. +- **Right -** To the right of the graph. + +#### Width + +Control how wide the legend is when placed on the right side of the visualization. This option is only displayed if you set the legend placement to **Right**.