diff --git a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md index ed87d1427ea..4893307d3a0 100644 --- a/docs/sources/panels-visualizations/visualizations/bar-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/bar-chart/index.md @@ -135,15 +135,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][] 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 @@ -204,12 +196,12 @@ 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="" >}} {{% 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//panels-visualizations/configure-overrides#add-a-field-override" +[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" -[standard calculations]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" +[standard calculations]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" [standard calculations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/calculation-types" -[Standard options definitions]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#max" -[Standard options definitions]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-standard-options#max" +[Standard options definitions]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#max" +[Standard options definitions]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options#max" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/candlestick/index.md b/docs/sources/panels-visualizations/visualizations/candlestick/index.md index 099222aa64b..bc375dc9a7a 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. +## 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="" >}} @@ -123,6 +127,6 @@ The candlestick visualization is based on the time series visualization. It can {{< docs/shared lookup="visualizations/value-mappings-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//panels-visualizations/visualizations/time-series" +[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" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/heatmap/index.md b/docs/sources/panels-visualizations/visualizations/heatmap/index.md index 18c757800e4..a71b5305f6d 100644 --- a/docs/sources/panels-visualizations/visualizations/heatmap/index.md +++ b/docs/sources/panels-visualizations/visualizations/heatmap/index.md @@ -117,7 +117,7 @@ This setting configures the axis value. When selected, the axis appears in reverse order. -{{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} +{{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} ## Colors @@ -172,13 +172,13 @@ 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 Set the color used to show exemplar data. {{% docs/reference %}} -[Introduction to histograms and heatmaps]: "/docs/grafana/ -> /docs/grafana//fundamentals/intro-histograms" -[Introduction to histograms and heatmaps]: "/docs/grafana-cloud/ -> /docs/grafana//fundamentals/intro-histograms" +[Introduction to histograms and heatmaps]: "/docs/grafana/ -> /docs/grafana//fundamentals/intro-histograms" +[Introduction to histograms and heatmaps]: "/docs/grafana-cloud/ -> /docs/grafana//fundamentals/intro-histograms" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/histogram/index.md b/docs/sources/panels-visualizations/visualizations/histogram/index.md index 37dc3c95e28..260b281f39c 100644 --- a/docs/sources/panels-visualizations/visualizations/histogram/index.md +++ b/docs/sources/panels-visualizations/visualizations/histogram/index.md @@ -121,20 +121,18 @@ 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][] to show in the legend. You can select more than one. +{{< docs/shared lookup="visualizations/legend-options-1.md" source="grafana" version="" >}} ## Value mappings {{< docs/shared lookup="visualizations/value-mappings-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//panels-visualizations/configure-standard-options#color-scheme" +[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" -[standard calculations]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" +[standard calculations]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" [standard calculations]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/calculation-types" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md index c10605930f3..b5bab1dc035 100644 --- a/docs/sources/panels-visualizations/visualizations/pie-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/pie-chart/index.md @@ -88,25 +88,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. @@ -118,6 +122,6 @@ Select values to display in the legend. You can select more than one. {{< docs/shared lookup="visualizations/value-mappings-options.md" source="grafana" version="" >}} {{% docs/reference %}} -[Calculation types]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/calculation-types" +[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" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md index 3bf01a2a768..138d9a08a09 100644 --- a/docs/sources/panels-visualizations/visualizations/state-timeline/index.md +++ b/docs/sources/panels-visualizations/visualizations/state-timeline/index.md @@ -114,9 +114,9 @@ Controls line width of state regions. Controls the opacity of state regions. -{{< docs/shared lookup="visualizations/connect-null-values.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/connect-null-values.md" source="grafana" version="" >}} -{{< docs/shared lookup="visualizations/disconnect-values.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/disconnect-values.md" source="grafana" version="" >}} ## Value mappings @@ -132,9 +132,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][] 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 @@ -145,9 +143,6 @@ When the legend option is enabled it can show either the value mappings or the t {{< docs/shared lookup="visualizations/value-mappings-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//panels-visualizations/configure-standard-options#color-scheme" - -[Value mappings]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-value-mappings" -[Value mappings]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-value-mappings" +[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" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/status-history/index.md b/docs/sources/panels-visualizations/visualizations/status-history/index.md index c478ee225f7..e89e1ae6f57 100644 --- a/docs/sources/panels-visualizations/visualizations/status-history/index.md +++ b/docs/sources/panels-visualizations/visualizations/status-history/index.md @@ -112,9 +112,7 @@ To assign colors to boolean or string values, use the [Value mappings][]. ## 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][] 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 @@ -125,9 +123,6 @@ When the legend option is enabled it can show either the value mappings or the t {{< docs/shared lookup="visualizations/value-mappings-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//panels-visualizations/configure-value-mappings" - -[Color scheme]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" -[Color scheme]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" +[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" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/time-series/index.md b/docs/sources/panels-visualizations/visualizations/time-series/index.md index 91eb649aa1c..f1f9cc26630 100644 --- a/docs/sources/panels-visualizations/visualizations/time-series/index.md +++ b/docs/sources/panels-visualizations/visualizations/time-series/index.md @@ -56,9 +56,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 @@ -141,9 +139,9 @@ Set the style of the line. To change the color, use the standard [color scheme][ ![Line styles examples](/static/img/docs/time-series-panel/line-styles-examples-v9.png) -{{< docs/shared lookup="visualizations/connect-null-values.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/connect-null-values.md" source="grafana" version="" >}} -{{< docs/shared lookup="visualizations/disconnect-values.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/disconnect-values.md" source="grafana" version="" >}} ### Stack series @@ -260,7 +258,7 @@ Use this option to transform the series values without affecting the values show The transform option is only available as an override. {{% /admonition %}} -{{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} +{{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} ## Color options @@ -308,18 +306,18 @@ 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="" >}} {{% docs/reference %}} -[Color scheme]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" -[Color scheme]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" +[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" -[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//panels-visualizations/configure-overrides#add-a-field-override" +[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" -[Configure standard options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#max" -[Configure standard options]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-standard-options#max" +[Configure standard options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#max" +[Configure standard options]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options#max" -[color scheme]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" -[color scheme]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" +[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" -[Configure field overrides]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides" -[Configure field overrides]: "/docs/grafana-cloud/ -> /docs/grafana//panels-visualizations/configure-overrides" +[Configure field overrides]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides" +[Configure field overrides]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-overrides" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/trend/index.md b/docs/sources/panels-visualizations/visualizations/trend/index.md index 1fa72c8d947..422fd8e16c3 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" >}} +## 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="" >}} @@ -47,6 +51,6 @@ For example, you could represent engine power and torque versus speed where spee {{< docs/shared lookup="visualizations/value-mappings-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//panels-visualizations/visualizations/time-series" +[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" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/visualizations/xy-chart/index.md b/docs/sources/panels-visualizations/visualizations/xy-chart/index.md index 141e83966f7..b66bda35b23 100644 --- a/docs/sources/panels-visualizations/visualizations/xy-chart/index.md +++ b/docs/sources/panels-visualizations/visualizations/xy-chart/index.md @@ -149,9 +149,7 @@ Set the maximum height of the tooltip box. The default is 600 pixels. ## 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-options-2.md" source="grafana" version="" >}} +{{< docs/shared lookup="visualizations/legend-options-1.md" source="grafana" version="" >}} ## Axis options @@ -230,7 +228,7 @@ Use this option to transform the series values without affecting the values show The transform option is only available as an override. {{% /admonition %}} -{{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} +{{< docs/shared lookup="visualizations/multiple-y-axes.md" source="grafana" version="" leveloffset="+2" >}} ## Other visualization options @@ -251,27 +249,27 @@ Learn about [data links][] that you can set for a visualization. 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/ -> /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" -[Add a field override]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides#add-a-field-override" +[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" -[Configure standard options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#max" +[Configure standard options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#max" [Configure standard options]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options#max" -[color scheme]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options#color-scheme" +[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" -[Configure field overrides]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides" +[Configure field overrides]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides" [Configure field overrides]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-overrides" -[panel options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-panel-options" +[panel options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-panel-options" [panel options]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-panel-options" -[standard options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options" +[standard options]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-standard-options" [standard options]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-standard-options" -[data links]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-data-links" +[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" {{% /docs/reference %}} 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 index 3b10fad3b4d..9abfe0adfc7 100644 --- a/docs/sources/shared/visualizations/legend-options-2.md +++ b/docs/sources/shared/visualizations/legend-options-2.md @@ -1,14 +1,22 @@ --- -title: Legend options +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. For more information about the legend, refer to [Configure a legend](../configure-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. @@ -20,6 +28,6 @@ Choose where to display the legend. - **Bottom -** Below the graph. - **Right -** To the right of the graph. -### Values +#### Width -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. +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**.