mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 17:12:29 +08:00
44ae127a6e
* docs: update text panel * Apply suggestions from code review Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com> --------- Co-authored-by: Isabel Matwawana <76437239+imatwawana@users.noreply.github.com>
65 lines
2.3 KiB
Markdown
65 lines
2.3 KiB
Markdown
---
|
|
aliases:
|
|
- ../../features/panels/text/
|
|
- ../../panels/visualizations/text-panel/
|
|
- ../../reference/alertlist/
|
|
- ../../visualizations/text-panel/
|
|
keywords:
|
|
- grafana
|
|
- text
|
|
- documentation
|
|
- panel
|
|
labels:
|
|
products:
|
|
- cloud
|
|
- enterprise
|
|
- oss
|
|
description: Configure options for Grafana's text visualization
|
|
title: Text
|
|
weight: 100
|
|
---
|
|
|
|
# Text
|
|
|
|
Text visualizations enable you to directly include text or HTML in your dashboards. This can be used to add contextual information and descriptions or embed complex HTML.
|
|
|
|
For example, if you want to display important links to your dashboard, you can use a text visualization to add these links:
|
|
|
|
{{< figure src="/static/img/docs/text-panel/text-panel.png" max-width="1025px" alt="A text panel showing important links" >}}
|
|
|
|
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.
|
|
|
|
## Mode
|
|
|
|
**Mode** determines how embedded content appears.
|
|
|
|
### Markdown
|
|
|
|
This option formats the content as [markdown](https://en.wikipedia.org/wiki/Markdown).
|
|
|
|
### HTML
|
|
|
|
This setting 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][] flag which enables you to directly enter HTML.
|
|
|
|
### Code
|
|
|
|
This setting renders content inside a read-only code editor. Select an appropriate language to apply syntax highlighting
|
|
to the embedded text.
|
|
|
|
## Variables
|
|
|
|
[Variables][] in the content will be expanded for display.
|
|
|
|
{{% docs/reference %}}
|
|
[disable_sanitize_html]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/setup-grafana/configure-grafana#disable_sanitize_html"
|
|
[disable_sanitize_html]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/setup-grafana/configure-grafana#disable_sanitize_html"
|
|
|
|
[Variables]: "/docs/grafana/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/variables/variable-syntax"
|
|
[Variables]: "/docs/grafana-cloud/ -> /docs/grafana/<GRAFANA VERSION>/dashboards/variables/variable-syntax"
|
|
{{% /docs/reference %}}
|