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

Docs: Share panel image preview (#98039)

Browse Source
This commit is contained in:
Isabel Matwawana
2024-12-18 14:31:31 -05:00
committed by GitHub
parent 52673ad390
commit 62b326a08c
1 changed files with 31 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sources/dashboards/share-dashboards-panels/_index.md
+31 -7
View File
@@ -52,6 +52,21 @@ refs:
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#configuration destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#configuration
- pattern: /docs/grafana-cloud/ - pattern: /docs/grafana-cloud/
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#configuration destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#configuration
max-width:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#viewport-maximum-width
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#viewport-maximum-width
max-height:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#viewport-maximum-height
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#viewport-maximum-height
max-scale:
- pattern: /docs/grafana/
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#maximum-device-scale-factor
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/<GRAFANA_VERSION>/setup-grafana/image-rendering/#maximum-device-scale-factor
--- ---
# Share dashboards and panels # Share dashboards and panels
@@ -239,20 +254,29 @@ To share a personalized, direct link to your panel within your organization, fol
- **Lock time range** - Change the current relative time range to an absolute time range. This option is enabled by default. - **Lock time range** - Change the current relative time range to an absolute time range. This option is enabled by default.
- **Shorten link** - Shorten the panel link. This option is disabled by default. - **Shorten link** - Shorten the panel link. This option is disabled by default.
1. Select the theme for the dashboard. Choose from **Current**, **Dark**, or **Light**. 1. Select the theme for the dashboard. Choose from **Current**, **Dark**, or **Light**.
1. Do one or both of the following: 1. Click **Copy link**.
- Click **Copy link**. 1. Send the copied link to a Grafana user with authorization to view it.
- Click **Render image**, which [renders the panel as a PNG image](ref:image-rendering). 1. (Optional) To [generate an image of the panel as a PNG file](ref:image-rendering), customize the image settings:
1. Send the copied link or image URL to a Grafana user with authorization to view it.
- **Width** - In pixels. The default is 1000.
- **Height** - In pixels. The default is 500.
- **Scale factor** - The default is 1.
There are maximums for [width](ref:max-width), [height](ref:max-height), and [scale factor](ref:max-scale) in the image renderer configuration that you can customize if needed.
1. (Optional) Click **Generate image** to see a preview of the panel image.
1. (Optional) Click **Download image**.
1. Send the copied image to a Grafana user with authorization to view it.
1. Click the **X** at the top-right corner to close the share drawer. 1. Click the **X** at the top-right corner to close the share drawer.
#### Query string parameters for server-side rendered images #### Query string parameters for server-side rendered images
When you click **Render image** in the panel link settings, Grafana generates a PNG image of the panel with the following default parameters: When you click **Generate image** in the panel link settings, Grafana generates a PNG image of the panel with the following default parameters:
| Parameter | Description | | Parameter | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------ | | --------- | ------------------------------------------------------------------------------------------------------------------------------ |
| width | Width in pixels. Default is 800. | | width | Width in pixels. Default is 1000. |
| height | Height in pixels. Default is 400. | | height | Height in pixels. Default is 500. |
| tz | Timezone in the format `UTC%2BHH%3AMM` where HH and MM are offset in hours and minutes after UTC. | | tz | Timezone in the format `UTC%2BHH%3AMM` where HH and MM are offset in hours and minutes after UTC. |
| timeout | Number of seconds. The timeout can be increased if the query for the panel needs more than the default 30 seconds. | | timeout | Number of seconds. The timeout can be increased if the query for the panel needs more than the default 30 seconds. |
| scale | Numeric value to configure device scale factor. Default is 1. Use a higher value to produce more detailed images (higher DPI). | | scale | Numeric value to configure device scale factor. Default is 1. Use a higher value to produce more detailed images (higher DPI). |