Menu

This is documentation for the next version of Grafana. For the latest stable release, go to the latest version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow Panels and visualizationsbreadcrumb arrow Visualizationsbreadcrumb arrow Text
Grafana Cloud Enterprise Open source

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:

A text panel showing important links
Give it a try using Grafana Play
Give it a try using Grafana Play

With Grafana Play, you can explore and see how it works, learning from practical examples to accelerate your development. This feature can be seen on Text Panel.

Try it

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

The following section describes the configuration options available in the panel editor pane for this visualization. These options are, as much as possible, ordered as they appear in Grafana.

Panel options

In the Panel options section of the panel editor pane, set basic options like panel title and description, as well as panel links. To learn more, refer to Configure panel options.

Text options

Use the following options to refine your text visualization.

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

LanguageWhen you choose Code as your text mode, select an appropriate language to apply syntax highlighting to the embedded text.
Show line numbersDisplays line numbers in the panel preview when you choose Code as your text mode.
Show mini mapDisplays a small outline of the embedded text in the panel preview when you choose Code as your text mode.