public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docs: Add actions to visualizations (#100684)

Browse Source
This commit is contained in:
Isabel Matwawana
2025-02-26 18:35:30 -05:00
committed by GitHub
parent 2b0029267c
commit e0a4a69c2e
20 changed files with 183 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/shared/visualizations/datalink-options-1.md
+9 -4
View File
@@ -1,12 +1,16 @@
---
title: Data link options
title: Data links and actions options
comments: |
This file is used in the following visualizations: bar gauge, gauge, pie chart, stat, table
This file is used in the following visualizations: bar gauge, gauge, pie chart, stat
---
Data links allow you to link to other panels, dashboards, and external resources while maintaining the context of the source panel.
You can create links that include the series name or even the value under the cursor.
To learn more, refer to [Configure data links](../../configure-data-links/).
To learn more, refer to [Configure data links and actions](../../configure-data-links/).
{{< admonition type="note" >}}
Actions are not supported for this visualization.
{{< /admonition >}}
For each data link, set the following options:
@@ -14,4 +18,5 @@ For each data link, set the following options:
- **URL**
- **Open in new tab**
Data links for this visualization don't include the **One click** switch, however, if there's only one data link configured, that data link has single-click functionality. If multiple data links are configured, then clicking the visualization opens a menu that displays all the data links.
Data links for this visualization don't include the **One click** switch, however, if there's only one data link configured, that data link has single-click functionality.
If multiple data links are configured, then clicking the visualization opens a menu that displays all the data links.
docs/sources/shared/visualizations/datalink-options-2.md
+21 -3
View File
@@ -1,10 +1,11 @@
---
title: Data link options
title: Data links and actions options
comments: |
This file is used in the following visualizations: bar chart, candlestick, state timeline, status history, time series, trend, xy chart
---
Data links allow you to link to other panels, dashboards, and external resources while maintaining the context of the source panel. You can create links that include the series name or even the value under the cursor.
_Data links_ allow you to link to other panels, dashboards, and external resources and _actions_ let you trigger basic, unauthenticated, API calls.
In both cases, you can carry out these tasks while maintaining the context of the source panel.
For each data link, set the following options:
@@ -13,4 +14,21 @@ For each data link, set the following options:
- **Open in new tab**
- **One click** - Opens the data link with a single click. Only one data link can have **One click** enabled at a time.
To learn more, refer to [Configure data links](../../configure-data-links/).
For each action, define the following API call settings:
<!-- prettier-ignore-start -->
| Option | Description |
| -------------------- | ----------------------------------------------------------------- |
| Title | A human-readable label for the action that's displayed in the UI. |
| Confirmation message | A descriptive prompt to confirm or cancel the action. |
| Method | Select from **POST**, **PUT**, or **GET**. |
| URL | The request URL.</p><p>To add a variable, click in the **URL** field and enter `$` or press Ctrl+Space or Cmd+Space to see a list of available variables. |
| Query parameters | **Key** and **Value** pairs. Click the **+** icon to add as many key/value pairs as you need. |
| Headers | Comprised of **Key** and **Value** pairs and a **Content-Type**.</p><p>Click the **+** icon to add as many key/value pairs as you need. |
| Content-Type | Select from the following: **application/json**, **text/plain**, **application/XML**, and **application/x-www-form-urlencoded**. |
| Body | The body of the request. |
<!-- prettier-ignore-end -->
To learn more, refer to [Configure data links and actions](../../configure-data-links/).
docs/sources/shared/visualizations/datalink-options-3.md
+36
View File
@@ -0,0 +1,36 @@
---
title: Data links and actions options
comments: |
This file is used in the following visualizations: table
---
_Data links_ allow you to link to other panels, dashboards, and external resources and _actions_ let you trigger basic, unauthenticated, API calls.
In both cases, you can carry out these tasks while maintaining the context of the source panel.
For each data link, set the following options:
- **Title**
- **URL**
- **Open in new tab**
Data links for this visualization don't include the **One click** switch, however, if there's only one data link configured, that data link has single-click functionality.
If multiple data links are configured, then clicking the visualization opens a menu that displays all the data links.
For each action, define the following API call settings:
<!-- prettier-ignore-start -->
| Option | Description |
| -------------------- | ----------------------------------------------------------------- |
| Title | A human-readable label for the action that's displayed in the UI. |
| Confirmation message | A descriptive prompt to confirm or cancel the action. |
| Method | Select from **POST**, **PUT**, or **GET**. |
| URL | The request URL.</p><p>To add a variable, click in the **URL** field and enter `$` or press Ctrl+Space or Cmd+Space to see a list of available variables. |
| Query parameters | **Key** and **Value** pairs. Click the **+** icon to add as many key/value pairs as you need. |
| Headers | Comprised of **Key** and **Value** pairs and a **Content-Type**.</p><p>Click the **+** icon to add as many key/value pairs as you need. |
| Content-Type | Select from the following: **application/json**, **text/plain**, **application/XML**, and **application/x-www-form-urlencoded**. |
| Body | The body of the request. |
<!-- prettier-ignore-end -->
To learn more, refer to [Configure data links and actions](../../configure-data-links/).
docs/sources/shared/visualizations/datalink-options.md
+8 -3
View File
@@ -1,10 +1,15 @@
---
title: Data link options
title: Data links and actions options
comments: |
This file is used in the following visualizations: geomap, heatmap, histogram
---
Data links allow you to link to other panels, dashboards, and external resources while maintaining the context of the source panel. You can create links that include the series name or even the value under the cursor.
Data links allow you to link to other panels, dashboards, and external resources while maintaining the context of the source panel.
You can create links that include the series name or even the value under the cursor.
{{< admonition type="note" >}}
Actions are not supported for this visualization.
{{< /admonition >}}
For each data link, set the following options:
@@ -12,4 +17,4 @@ For each data link, set the following options:
- **URL**
- **Open in new tab**
To learn more, refer to [Configure data links](../../configure-data-links/).
To learn more, refer to [Configure data links and actions](../../configure-data-links/).