mirror of
https://github.com/grafana/grafana.git
synced 2025-08-01 10:50:19 +08:00

* Update dashboards pages to use `docs/reference` shortcode Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Update panels-visualizations pages to use `docs/reference` shortcode Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Use raw Markdown admonitions for contextual links See https://discourse.gohugo.io/t/markdown-reference-links-in-shortcodes/5770/3. Should be resolved by https://docs.google.com/document/d/19xd4CD3IrAqQqNR3xQeLfuIV-u2iNSQSBEvPZE9J4qU/edit#heading=h.5sybau7waq2q. Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Prefer "Warning" over "Caution" Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Prettier Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix some links missing destinations Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix 'time range controls' link Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Add missing 'HTTP APIs' link Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix dashboard links missing destinations Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix links missing destinations in panels and visualizations documentation Signed-off-by: Jack Baldry <jack.baldry@grafana.com> * Fix dud link Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> --------- Signed-off-by: Jack Baldry <jack.baldry@grafana.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
127 lines
5.2 KiB
Markdown
127 lines
5.2 KiB
Markdown
---
|
|
aliases:
|
|
- ../panels/add-panels-dynamically/
|
|
- ../panels/configure-panel-options/
|
|
- ../panels/repeat-panels-or-rows/
|
|
- ../panels/working-with-panels/add-title-and-description/
|
|
- ../panels/working-with-panels/view-json-model/
|
|
keywords:
|
|
- panel
|
|
- dynamic
|
|
- add
|
|
- title
|
|
- description
|
|
- JSON model
|
|
labels:
|
|
products:
|
|
- cloud
|
|
- enterprise
|
|
- oss
|
|
menuTitle: Configure panel options
|
|
title: Configure panel options
|
|
weight: 2
|
|
---
|
|
|
|
# Configure panel options
|
|
|
|
A Grafana panel is a visual representation of data that you can customize by defining a data source query, transforming and formatting data, and configuring visualization settings.
|
|
|
|
A panel editor includes a query builder and a series of options that you can use to transform data and add information to your panels.
|
|
|
|
This topic describes how to:
|
|
|
|
- Open a panel for editing
|
|
- Add a panel title and description
|
|
- View a panel JSON model
|
|
- Configure repeating rows and panels
|
|
|
|
## Edit a panel
|
|
|
|
After you add a panel to a dashboard, you can open it at any time to change or update queries, add data transformation, and change visualization settings.
|
|
|
|
1. Open the dashboard that contains the panel you want to edit.
|
|
|
|
1. Hover over any part of the panel to display the actions menu on the top right corner.
|
|
|
|
1. Click the menu and select **Edit**.
|
|
|
|

|
|
|
|
To use a keyboard shortcut to open the panel, hover over the panel and press `e`.
|
|
|
|
The panel opens in edit mode.
|
|
|
|
## Add a title and description to a panel
|
|
|
|
Add a title and description to a panel to share with users any important information about the visualization. For example, use the description to document the purpose of the visualization.
|
|
|
|
1. [Edit a panel](#edit-a-panel).
|
|
|
|
1. In the panel display options pane, locate the **Panel options** section.
|
|
|
|
1. Enter a **Title**.
|
|
|
|
Text entered in this field appears at the top of your panel in the panel editor and in the dashboard.
|
|
|
|
1. Write a description of the panel and the data you are displaying.
|
|
|
|
Text entered in this field appears in a tooltip in the upper-left corner of the panel.
|
|
|
|
You can use [variables you have defined][] in the **Title** and **Description** field, but not [global variables][].
|
|
|
|

|
|
|
|
## View a panel JSON model
|
|
|
|
Explore and export panel, panel data, and data frame JSON models.
|
|
|
|
1. Open the dashboard that contains the panel.
|
|
|
|
1. Hover over any part of the panel to display the actions menu on the top right corner.
|
|
1. Click the menu and select **Inspect > Panel JSON**.
|
|
1. In the **Select source** field, select one of the following options:
|
|
|
|
- **Panel JSON:** Displays a JSON object representing the panel.
|
|
- **Panel data:** Displays a JSON object representing the data that was passed to the panel.
|
|
- **DataFrame structure:** Displays the data structure of the panel, including any transformations, field configurations, and override configurations that have been applied.
|
|
|
|
1. To explore the JSON, click `>` to expand or collapse portions of the JSON model.
|
|
|
|
## Configure repeating panels
|
|
|
|
You can configure Grafana to dynamically add panels or rows to a dashboard. A dynamic panel is a panel that the system creates based on the value of a variable. Variables dynamically change your queries across all panels in a dashboard. For more information about repeating rows, refer to [Configure repeating rows][].
|
|
|
|
{{% admonition type="note" %}}
|
|
Repeating panels require variables to have one or more items selected; you cannot repeat a panel zero times to hide it.
|
|
{{% /admonition %}}
|
|
|
|
To see an example of repeating panels, refer to [this dashboard with repeating panels](https://play.grafana.org/d/testdata-repeating/testdata-repeating-panels?orgId=1).
|
|
|
|
**Before you begin:**
|
|
|
|
- Ensure that the query includes a multi-value variable.
|
|
|
|
**To configure repeating panels:**
|
|
|
|
1. [Edit the panel](#edit-a-panel) you want to repeat.
|
|
|
|
1. On the display options pane, click **Panel options > Repeat options**.
|
|
|
|
1. Select a `direction`.
|
|
|
|
- Choose `horizontal` to arrange panels side-by-side. Grafana adjusts the width of a repeated panel. Currently, you cannot mix other panels on a row with a repeated panel.
|
|
- Choose `vertical` to arrange panels in a column. The width of repeated panels is the same as the original, repeated panel.
|
|
|
|
1. To propagate changes to all panels, reload the dashboard.
|
|
|
|
{{% docs/reference %}}
|
|
[variables you have defined]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/variables"
|
|
[variables you have defined]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/variables"
|
|
|
|
[global variables]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/variables/add-template-variables#global-variables"
|
|
[global variables]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/variables/add-template-variables#global-variables"
|
|
|
|
[Configure repeating rows]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/build-dashboards/create-dashboard#configure-repeating-rows"
|
|
[Configure repeating rows]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/build-dashboards/create-dashboard#configure-repeating-rows"
|
|
{{% /docs/reference %}}
|