From 6fb1da42bf05d3369067a04320ec44295a44e6be Mon Sep 17 00:00:00 2001 From: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> Date: Thu, 4 Apr 2024 17:06:20 -0400 Subject: [PATCH] Docs: add xychart to panel config docs (#85615) * Added xy chart to panel config docs * Fixed typo --- .../configure-data-links/index.md | 20 ++++++++++--------- .../configure-legend/index.md | 5 ++++- .../configure-overrides/index.md | 20 ++++++++++--------- .../configure-standard-options/index.md | 5 ++++- .../configure-tooltips/index.md | 18 +++++++++-------- 5 files changed, 40 insertions(+), 28 deletions(-) diff --git a/docs/sources/panels-visualizations/configure-data-links/index.md b/docs/sources/panels-visualizations/configure-data-links/index.md index 9996e398e38..aae72a662a4 100644 --- a/docs/sources/panels-visualizations/configure-data-links/index.md +++ b/docs/sources/panels-visualizations/configure-data-links/index.md @@ -42,15 +42,14 @@ If there's only one data link in the visualization, clicking anywhere on the vis You can configure data links for the following visualizations: -| | | | -| -------------------------- | ---------------------- | -------------------------------- | -| [Bar chart][bar chart] | [Geomap][geomap] | [State timeline][state timeline] | -| [Bar gauge][bar gauge] | [Heatmap][heatmap] | [Status history][status history] | -| [Candlestick][candlestick] | [Histogram][histogram] | [Table][table] | -| [Canvas][canvas] | [Pie chart][pie chart] | [Time series][time series] | -| [Gauge][gauge] | [Stat][stat] | [Trend][trend] | - - +| | | | +| -------------------------- | -------------------------------- | -------------------------------- | +| [Bar chart][bar chart] | [Heatmap][heatmap] | [Status history][status history] | +| [Bar gauge][bar gauge] | [Histogram][histogram] | [Table][table] | +| [Candlestick][candlestick] | [Pie chart][pie chart] | [Time series][time series] | +| [Canvas][canvas] | [Stat][stat] | [Trend][trend] | +| [Gauge][gauge] | [State timeline][state timeline] | [XY chart][xy chart] | +| [Geomap][geomap] | | | ## Data link variables @@ -199,6 +198,9 @@ If you want to add all of the current dashboard's variables to the URL, then use [trend]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/trend" [trend]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/trend" +[xy chart]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/xy-chart" +[xy chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/xy-chart" + [Cloudwatch]: "/docs/grafana/ -> /docs/grafana//datasources/aws-cloudwatch/query-editor#deep-link-grafana-panels-to-the-cloudwatch-console-1" [Cloudwatch]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/connect-externally-hosted/data-sources/aws-cloudwatch/query-editor#deep-link-grafana-panels-to-the-cloudwatch-console-1" diff --git a/docs/sources/panels-visualizations/configure-legend/index.md b/docs/sources/panels-visualizations/configure-legend/index.md index fb261794066..a74d55c9588 100644 --- a/docs/sources/panels-visualizations/configure-legend/index.md +++ b/docs/sources/panels-visualizations/configure-legend/index.md @@ -28,7 +28,7 @@ Legends are supported for the following visualizations: - [Status history][status history] - [Time series][time series] - [Trend][trend] - +- [XY chart][xy chart] [Geomaps][] and [heatmaps][] also have legends, but they only provide the choice to display or not display a legend and don't support other legend options. @@ -151,4 +151,7 @@ This feature is only supported for the following visualizations: bar chart, hist [heatmaps]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/heatmap" [heatmaps]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/heatmap" + +[xy chart]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/xy-chart" +[xy chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/xy-chart" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/configure-overrides/index.md b/docs/sources/panels-visualizations/configure-overrides/index.md index 64472b81107..ea02548062d 100644 --- a/docs/sources/panels-visualizations/configure-overrides/index.md +++ b/docs/sources/panels-visualizations/configure-overrides/index.md @@ -35,15 +35,14 @@ After you've set them, your overrides appear in both the **All** and **Overrides You can configure field overrides for the following visualizations: -| | | | -| -------------------------- | ---------------------- | -------------------------------- | -| [Bar chart][bar chart] | [Geomap][geomap] | [State timeline][state timeline] | -| [Bar gauge][bar gauge] | [Heatmap][heatmap] | [Status history][status history] | -| [Candlestick][candlestick] | [Histogram][histogram] | [Table][table] | -| [Canvas][canvas] | [Pie chart][pie chart] | [Time series][time series] | -| [Gauge][gauge] | [Stat][stat] | [Trend][trend] | - - +| | | | +| -------------------------- | -------------------------------- | -------------------------------- | +| [Bar chart][bar chart] | [Heatmap][heatmap] | [Status history][status history] | +| [Bar gauge][bar gauge] | [Histogram][histogram] | [Table][table] | +| [Candlestick][candlestick] | [Pie chart][pie chart] | [Time series][time series] | +| [Canvas][canvas] | [Stat][stat] | [Trend][trend] | +| [Gauge][gauge] | [State timeline][state timeline] | [XY chart][xy chart] | +| [Geomap][geomap] | | | ## Override rules @@ -223,6 +222,9 @@ The changes you make take effect immediately. [trend]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/trend" [trend]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/trend" +[xy chart]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/xy-chart" +[xy chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/xy-chart" + [Rename by regex transformation]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/query-transform-data/transform-data#rename-by-regex" [Rename by regex transformation]: "/docs/grafana-cloud -> /docs/grafana-cloud/visualizations/panels-visualizations/query-transform-data/transform-data#rename-by-regex" {{% /docs/reference %}} diff --git a/docs/sources/panels-visualizations/configure-standard-options/index.md b/docs/sources/panels-visualizations/configure-standard-options/index.md index a72a65672c8..3c9a0b4dc2a 100644 --- a/docs/sources/panels-visualizations/configure-standard-options/index.md +++ b/docs/sources/panels-visualizations/configure-standard-options/index.md @@ -41,7 +41,7 @@ You can configure standard options for the following visualizations: | [Bar gauge][bar gauge] | [Histogram][histogram] | [Table][table] | | [Candlestick][candlestick] | [Pie chart][pie chart] | [Time series][time series] | | [Canvas][canvas] | [Stat][stat] | [Trend][trend] | -| [Gauge][gauge] | [State timeline][state timeline] | | +| [Gauge][gauge] | [State timeline][state timeline] | [XY chart][xy chart] | ## Standard options @@ -192,6 +192,9 @@ Enter what Grafana should display if the field value is empty or null. The defau [trend]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/trend" [trend]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/trend" +[xy chart]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/xy-chart" +[xy chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/xy-chart" + [variables]: "/docs/grafana/ -> /docs/grafana//dashboards/variables" [variables]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/dashboards/variables" diff --git a/docs/sources/panels-visualizations/configure-tooltips/index.md b/docs/sources/panels-visualizations/configure-tooltips/index.md index e5e6b207c98..0c486671e99 100644 --- a/docs/sources/panels-visualizations/configure-tooltips/index.md +++ b/docs/sources/panels-visualizations/configure-tooltips/index.md @@ -23,14 +23,13 @@ When you hover your cursor over a visualization, Grafana can display tooltips th You can configure tooltips for the following visualizations: -| | | -| -------------------------- | -------------------------------- | -| [Bar chart][bar chart] | [State timeline][state timeline] | -| [Candlestick][candlestick] | [Status history][status history] | -| [Heatmap][heatmap] | [Time series][time series] | -| [Pie chart][pie chart] | [Trend][trend] | - - +| | | +| -------------------------------- | -------------------------------- | +| [Bar chart][bar chart] | [Status history][status history] | +| [Candlestick][candlestick] | [Time series][time series] | +| [Heatmap][heatmap] | [Trend][trend] | +| [Pie chart][pie chart] | [XY chart][xy chart] | +| [State timeline][state timeline] | | Some visualizations, for example [candlestick][] and [flame graph][], have tooltips, but they aren't configurable. These visualizations don't have a **Tooltip** section in the panel editor pane. [Geomaps][geomaps] provide you the option to have tooltips triggered upon click or hover under the **Map controls** options in the panel editor pane. @@ -109,6 +108,9 @@ For the heatmap visualization only, when you set the **Tooltip mode** to **Singl [trend]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/trend" [trend]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/trend" +[xy chart]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/visualizations/xy-chart" +[xy chart]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/visualizations/xy-chart" + [field override]: "/docs/grafana/ -> /docs/grafana//panels-visualizations/configure-overrides" [field override]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/visualizations/panels-visualizations/configure-overrides" {{% /docs/reference %}}