opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-07-28 05:32:08 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
grafana/docs/sources/panels-visualizations/visualizations/text/index.md
Isabel Matwawana 608a2a7535 Docs: text visualization refactor (#102939) 
* Added Config options section, bumped heading levels, added missing options, and restructured Text options section

* Moved variables content

* Replaced screenshot

* Moved sentence

* Used previous wording

* test commit

* Revert test commit

* Ran prettier
2025-03-31 10:17:52 -04:00

3.4 KiB
Raw Blame History

aliases keywords labels description title weight refs
../../features/panels/text/
../../panels/visualizations/text-panel/
../../reference/alertlist/
../../visualizations/text-panel/
grafana
text
documentation
panel
products
cloud
enterprise
oss
Configure options for Grafana's text visualization Text 100
disable_sanitize_html variables
pattern destination
/docs/grafana/ /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#disable_sanitize_html
pattern destination
/docs/grafana-cloud/ /docs/grafana/<GRAFANA_VERSION>/setup-grafana/configure-grafana/#disable_sanitize_html
pattern destination
/docs/grafana/ /docs/grafana/<GRAFANA_VERSION>/dashboards/variables/variable-syntax/
pattern destination
/docs/grafana-cloud/ /docs/grafana-cloud/visualizations/dashboards/variables/variable-syntax/

Text

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.

For example, if you want to display important links on your dashboard, you can use a text visualization to add these links:

{{< figure src="/media/docs/grafana/panels-visualizations/screenshot-text-visualization-v11.6.png" max-width="750px" alt="A text panel showing important links" >}}

{{< docs/play title="Text Panel" url="https://play.grafana.org/d/adl33bxy1ih34b/" >}}

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.

Configuration options

{{< docs/shared lookup="visualizations/config-options-intro.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Panel options

{{< docs/shared lookup="visualizations/panel-options.md" source="grafana" version="<GRAFANA_VERSION>" >}}

Text options

Use the following options to refine your text visualization.

Option Description
Mode Determines how embedded content appears. Choose from:
  • Markdown - Formats the content as markdown.
  • HTML - Renders the content as sanitized 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 - Renders content inside a read-only code editor. Variables in the content are expanded for display.

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).
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.