2022-05-26 23:06:25 +08:00
---
aliases:
2022-12-10 00:36:04 +08:00
- ../../features/panels/text/
- ../../panels/visualizations/text-panel/
- ../../reference/alertlist/
- ../../visualizations/text-panel/
2022-05-26 23:06:25 +08:00
keywords:
- grafana
- text
- documentation
- panel
Explicitly set all front matter labels in the source files (#71548)
* Set every page to have defaults of 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/enterprise-licensing pages to have 'Enterprise' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/recorded-queries pages to have labels cloud,enterprise
* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/stats-and-license pages to have labels cloud,enterprise
* Set alerting pages to have labels cloud,enterprise,oss
* Set breaking-changes pages to have labels cloud,enterprise,oss
* Set dashboards pages to have labels cloud,enterprise,oss
* Set datasources pages to have labels cloud,enterprise,oss
* Set explore pages to have labels cloud,enterprise,oss
* Set fundamentals pages to have labels cloud,enterprise,oss
* Set introduction/grafana-cloud pages to have labels cloud
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix introduction pages products
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set panels-visualizations pages to have labels cloud,enterprise,oss
* Set release-notes pages to have labels cloud,enterprise,oss
* Set search pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set troubleshooting pages to have labels cloud,enterprise,oss
* Set whatsnew pages to have labels cloud,enterprise,oss
* Apply updated labels from review
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
2023-07-18 16:10:12 +08:00
labels:
products:
- cloud
- enterprise
- oss
2023-12-13 04:27:29 +08:00
description: Configure options for Grafana's text visualization
2022-05-26 23:06:25 +08:00
title: Text
2023-09-01 02:31:37 +08:00
weight: 100
2024-05-21 23:16:47 +08:00
refs:
disable_sanitize_html:
- pattern: /docs/grafana/
destination: /docs/grafana/< GRAFANA_VERSION > /setup-grafana/configure-grafana/#disable_sanitize_html
- pattern: /docs/grafana-cloud/
destination: /docs/grafana/< GRAFANA_VERSION > /setup-grafana/configure-grafana/#disable_sanitize_html
variables:
2024-05-22 22:40:20 +08:00
- pattern: /docs/grafana/
destination: /docs/grafana/< GRAFANA_VERSION > /dashboards/variables/variable-syntax/
2024-05-21 23:16:47 +08:00
- pattern: /docs/grafana-cloud/
destination: /docs/grafana-cloud/visualizations/dashboards/variables/variable-syntax/
2022-05-26 23:06:25 +08:00
---
2020-05-11 21:46:43 +08:00
2021-06-04 19:32:44 +08:00
# Text
2020-05-11 21:46:43 +08:00
2025-03-31 22:17:52 +08:00
Text visualizations let you include text or HTML in your dashboards.
This can be used to add contextual information and descriptions or embed complex HTML.
2020-05-11 21:46:43 +08:00
2025-03-31 22:17:52 +08:00
For example, if you want to display important links on your dashboard, you can use a text visualization to add these links:
2024-03-26 00:13:56 +08:00
2025-03-31 22:17:52 +08:00
{{< figure src = "/media/docs/grafana/panels-visualizations/screenshot-text-visualization-v11.6.png" max-width = "750px" alt = "A text panel showing important links" > }}
2024-03-26 00:13:56 +08:00
2024-05-14 00:31:47 +08:00
{{< docs / play title = "Text Panel" url = "https://play.grafana.org/d/adl33bxy1ih34b/" > }}
2024-03-26 00:13:56 +08:00
Use a text visualization when you need to:
- Add important links or useful annotations.
- Provide instructions or guidance on how to interpret different panels, configure settings, or take specific actions based on the displayed data.
- Announce any scheduled maintenance or downtime that might impact your dashboards.
2025-03-31 22:17:52 +08:00
## Configuration options
2024-05-03 02:17:23 +08:00
2025-03-31 22:17:52 +08:00
{{< docs / shared lookup = "visualizations/config-options-intro.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2022-08-24 23:13:00 +08:00
2025-03-31 22:17:52 +08:00
### Panel options
2022-08-24 23:13:00 +08:00
2025-03-31 22:17:52 +08:00
{{< docs / shared lookup = "visualizations/panel-options.md" source = "grafana" version = "<GRAFANA_VERSION>" > }}
2022-08-24 23:13:00 +08:00
2025-03-31 22:17:52 +08:00
### Text options
2022-08-24 23:13:00 +08:00
2025-03-31 22:17:52 +08:00
Use the following options to refine your text visualization.
2022-08-24 23:13:00 +08:00
2025-03-31 22:17:52 +08:00
<!-- prettier - ignore - start -->
2022-08-24 23:13:00 +08:00
2025-03-31 22:17:52 +08:00
| Option | Description |
| ------ | ----------- |
| Mode | Determines how embedded content appears. Choose from:< ul >< li > **Markdown** - Formats the content as [markdown ](https://en.wikipedia.org/wiki/Markdown ).</ li >< li > **HTML** - Renders the content as [sanitized ](https://github.com/grafana/grafana/blob/main/packages/grafana-data/src/text/sanitize.ts ) HTML. If you require more direct control over the output, you can set the [disable_sanitize_html ](ref:disable_sanitize_html ) flag which enables you to directly enter HTML.</ li >< li > **Code** - Renders content inside a read-only code editor. [Variables ](ref:variables ) in the content are expanded for display.</ li ></ ul >< p > To allow embedding of iframes and other websites, you need set `allow_embedding = true` in your Grafana `config.ini` or environment variables (depending on your employment).</ p > |
| Language | When you choose **Code** as your text mode, select an appropriate language to apply syntax highlighting to the embedded text. |
| Show line numbers | Displays line numbers in the panel preview when you choose **Code** as your text mode. |
| Show mini map | Displays a small outline of the embedded text in the panel preview when you choose **Code** as your text mode. |
2022-08-24 23:13:00 +08:00
2025-03-31 22:17:52 +08:00
<!-- prettier - ignore - end -->